@@ -16,2437 +16,2437 @@ |
||
16 | 16 | class Transactions_Admin_Page extends EE_Admin_Page |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var EE_Transaction |
|
21 | - */ |
|
22 | - private $_transaction; |
|
23 | - |
|
24 | - /** |
|
25 | - * @var EE_Session |
|
26 | - */ |
|
27 | - private $_session; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var array $_txn_status |
|
31 | - */ |
|
32 | - private static $_txn_status; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var array $_pay_status |
|
36 | - */ |
|
37 | - private static $_pay_status; |
|
38 | - |
|
39 | - /** |
|
40 | - * @var array $_existing_reg_payment_REG_IDs |
|
41 | - */ |
|
42 | - protected $_existing_reg_payment_REG_IDs = null; |
|
43 | - |
|
44 | - |
|
45 | - /** |
|
46 | - * @Constructor |
|
47 | - * @access public |
|
48 | - * @param bool $routing |
|
49 | - * @throws EE_Error |
|
50 | - * @throws InvalidArgumentException |
|
51 | - * @throws ReflectionException |
|
52 | - * @throws InvalidDataTypeException |
|
53 | - * @throws InvalidInterfaceException |
|
54 | - */ |
|
55 | - public function __construct($routing = true) |
|
56 | - { |
|
57 | - parent::__construct($routing); |
|
58 | - } |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * _init_page_props |
|
63 | - * |
|
64 | - * @return void |
|
65 | - */ |
|
66 | - protected function _init_page_props() |
|
67 | - { |
|
68 | - $this->page_slug = TXN_PG_SLUG; |
|
69 | - $this->page_label = esc_html__('Transactions', 'event_espresso'); |
|
70 | - $this->_admin_base_url = TXN_ADMIN_URL; |
|
71 | - $this->_admin_base_path = TXN_ADMIN; |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * _ajax_hooks |
|
77 | - * |
|
78 | - * @return void |
|
79 | - */ |
|
80 | - protected function _ajax_hooks() |
|
81 | - { |
|
82 | - add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds')); |
|
83 | - add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds')); |
|
84 | - add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment')); |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - /** |
|
89 | - * _define_page_props |
|
90 | - * |
|
91 | - * @return void |
|
92 | - */ |
|
93 | - protected function _define_page_props() |
|
94 | - { |
|
95 | - $this->_admin_page_title = $this->page_label; |
|
96 | - $this->_labels = array( |
|
97 | - 'buttons' => array( |
|
98 | - 'add' => esc_html__('Add New Transaction', 'event_espresso'), |
|
99 | - 'edit' => esc_html__('Edit Transaction', 'event_espresso'), |
|
100 | - 'delete' => esc_html__('Delete Transaction', 'event_espresso'), |
|
101 | - ), |
|
102 | - ); |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - /** |
|
107 | - * grab url requests and route them |
|
108 | - * |
|
109 | - * @access private |
|
110 | - * @return void |
|
111 | - * @throws EE_Error |
|
112 | - * @throws InvalidArgumentException |
|
113 | - * @throws InvalidDataTypeException |
|
114 | - * @throws InvalidInterfaceException |
|
115 | - */ |
|
116 | - public function _set_page_routes() |
|
117 | - { |
|
118 | - |
|
119 | - $this->_set_transaction_status_array(); |
|
120 | - |
|
121 | - $txn_id = ! empty($this->_req_data['TXN_ID']) |
|
122 | - && ! is_array($this->_req_data['TXN_ID']) |
|
123 | - ? $this->_req_data['TXN_ID'] |
|
124 | - : 0; |
|
125 | - |
|
126 | - $this->_page_routes = array( |
|
127 | - |
|
128 | - 'default' => array( |
|
129 | - 'func' => '_transactions_overview_list_table', |
|
130 | - 'capability' => 'ee_read_transactions', |
|
131 | - ), |
|
132 | - |
|
133 | - 'view_transaction' => array( |
|
134 | - 'func' => '_transaction_details', |
|
135 | - 'capability' => 'ee_read_transaction', |
|
136 | - 'obj_id' => $txn_id, |
|
137 | - ), |
|
138 | - |
|
139 | - 'send_payment_reminder' => array( |
|
140 | - 'func' => '_send_payment_reminder', |
|
141 | - 'noheader' => true, |
|
142 | - 'capability' => 'ee_send_message', |
|
143 | - ), |
|
144 | - |
|
145 | - 'espresso_apply_payment' => array( |
|
146 | - 'func' => 'apply_payments_or_refunds', |
|
147 | - 'noheader' => true, |
|
148 | - 'capability' => 'ee_edit_payments', |
|
149 | - ), |
|
150 | - |
|
151 | - 'espresso_apply_refund' => array( |
|
152 | - 'func' => 'apply_payments_or_refunds', |
|
153 | - 'noheader' => true, |
|
154 | - 'capability' => 'ee_edit_payments', |
|
155 | - ), |
|
156 | - |
|
157 | - 'espresso_delete_payment' => array( |
|
158 | - 'func' => 'delete_payment', |
|
159 | - 'noheader' => true, |
|
160 | - 'capability' => 'ee_delete_payments', |
|
161 | - ), |
|
162 | - |
|
163 | - ); |
|
164 | - } |
|
165 | - |
|
166 | - |
|
167 | - protected function _set_page_config() |
|
168 | - { |
|
169 | - $this->_page_config = array( |
|
170 | - 'default' => array( |
|
171 | - 'nav' => array( |
|
172 | - 'label' => esc_html__('Overview', 'event_espresso'), |
|
173 | - 'order' => 10, |
|
174 | - ), |
|
175 | - 'list_table' => 'EE_Admin_Transactions_List_Table', |
|
176 | - 'help_tabs' => array( |
|
177 | - 'transactions_overview_help_tab' => array( |
|
178 | - 'title' => esc_html__('Transactions Overview', 'event_espresso'), |
|
179 | - 'filename' => 'transactions_overview', |
|
180 | - ), |
|
181 | - 'transactions_overview_table_column_headings_help_tab' => array( |
|
182 | - 'title' => esc_html__('Transactions Table Column Headings', 'event_espresso'), |
|
183 | - 'filename' => 'transactions_overview_table_column_headings', |
|
184 | - ), |
|
185 | - 'transactions_overview_views_filters_help_tab' => array( |
|
186 | - 'title' => esc_html__('Transaction Views & Filters & Search', 'event_espresso'), |
|
187 | - 'filename' => 'transactions_overview_views_filters_search', |
|
188 | - ), |
|
189 | - ), |
|
190 | - 'help_tour' => array('Transactions_Overview_Help_Tour'), |
|
191 | - /** |
|
192 | - * commented out because currently we are not displaying tips for transaction list table status but this |
|
193 | - * may change in a later iteration so want to keep the code for then. |
|
194 | - */ |
|
195 | - //'qtips' => array( 'Transactions_List_Table_Tips' ), |
|
196 | - 'require_nonce' => false, |
|
197 | - ), |
|
198 | - 'view_transaction' => array( |
|
199 | - 'nav' => array( |
|
200 | - 'label' => esc_html__('View Transaction', 'event_espresso'), |
|
201 | - 'order' => 5, |
|
202 | - 'url' => isset($this->_req_data['TXN_ID']) |
|
203 | - ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url) |
|
204 | - : $this->_admin_base_url, |
|
205 | - 'persistent' => false, |
|
206 | - ), |
|
207 | - 'help_tabs' => array( |
|
208 | - 'transactions_view_transaction_help_tab' => array( |
|
209 | - 'title' => esc_html__('View Transaction', 'event_espresso'), |
|
210 | - 'filename' => 'transactions_view_transaction', |
|
211 | - ), |
|
212 | - 'transactions_view_transaction_transaction_details_table_help_tab' => array( |
|
213 | - 'title' => esc_html__('Transaction Details Table', 'event_espresso'), |
|
214 | - 'filename' => 'transactions_view_transaction_transaction_details_table', |
|
215 | - ), |
|
216 | - 'transactions_view_transaction_attendees_registered_help_tab' => array( |
|
217 | - 'title' => esc_html__('Attendees Registered', 'event_espresso'), |
|
218 | - 'filename' => 'transactions_view_transaction_attendees_registered', |
|
219 | - ), |
|
220 | - 'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array( |
|
221 | - 'title' => esc_html__('Primary Registrant & Billing Information', 'event_espresso'), |
|
222 | - 'filename' => 'transactions_view_transaction_primary_registrant_billing_information', |
|
223 | - ), |
|
224 | - ), |
|
225 | - 'qtips' => array('Transaction_Details_Tips'), |
|
226 | - 'help_tour' => array('Transaction_Details_Help_Tour'), |
|
227 | - 'metaboxes' => array('_transaction_details_metaboxes'), |
|
228 | - |
|
229 | - 'require_nonce' => false, |
|
230 | - ), |
|
231 | - ); |
|
232 | - } |
|
233 | - |
|
234 | - |
|
235 | - /** |
|
236 | - * The below methods aren't used by this class currently |
|
237 | - */ |
|
238 | - protected function _add_screen_options() |
|
239 | - { |
|
240 | - //noop |
|
241 | - } |
|
242 | - |
|
243 | - protected function _add_feature_pointers() |
|
244 | - { |
|
245 | - //noop |
|
246 | - } |
|
247 | - |
|
248 | - public function admin_init() |
|
249 | - { |
|
250 | - // IF a registration was JUST added via the admin... |
|
251 | - if (isset( |
|
252 | - $this->_req_data['redirect_from'], |
|
253 | - $this->_req_data['EVT_ID'], |
|
254 | - $this->_req_data['event_name'] |
|
255 | - )) { |
|
256 | - // then set a cookie so that we can block any attempts to use |
|
257 | - // the back button as a way to enter another registration. |
|
258 | - setcookie( |
|
259 | - 'ee_registration_added', |
|
260 | - $this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/' |
|
261 | - ); |
|
262 | - // and update the global |
|
263 | - $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID']; |
|
264 | - } |
|
265 | - EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__( |
|
266 | - 'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.', |
|
267 | - 'event_espresso' |
|
268 | - ); |
|
269 | - EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
270 | - 'An error occurred! Please refresh the page and try again.', |
|
271 | - 'event_espresso' |
|
272 | - ); |
|
273 | - EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status; |
|
274 | - EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status; |
|
275 | - EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso'); |
|
276 | - EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__( |
|
277 | - 'This transaction has been overpaid ! Payments Total', |
|
278 | - 'event_espresso' |
|
279 | - ); |
|
280 | - } |
|
281 | - |
|
282 | - public function admin_notices() |
|
283 | - { |
|
284 | - //noop |
|
285 | - } |
|
286 | - |
|
287 | - public function admin_footer_scripts() |
|
288 | - { |
|
289 | - //noop |
|
290 | - } |
|
291 | - |
|
292 | - |
|
293 | - /** |
|
294 | - * _set_transaction_status_array |
|
295 | - * sets list of transaction statuses |
|
296 | - * |
|
297 | - * @access private |
|
298 | - * @return void |
|
299 | - * @throws EE_Error |
|
300 | - * @throws InvalidArgumentException |
|
301 | - * @throws InvalidDataTypeException |
|
302 | - * @throws InvalidInterfaceException |
|
303 | - */ |
|
304 | - private function _set_transaction_status_array() |
|
305 | - { |
|
306 | - self::$_txn_status = EEM_Transaction::instance()->status_array(true); |
|
307 | - } |
|
308 | - |
|
309 | - |
|
310 | - /** |
|
311 | - * get_transaction_status_array |
|
312 | - * return the transaction status array for wp_list_table |
|
313 | - * |
|
314 | - * @access public |
|
315 | - * @return array |
|
316 | - */ |
|
317 | - public function get_transaction_status_array() |
|
318 | - { |
|
319 | - return self::$_txn_status; |
|
320 | - } |
|
321 | - |
|
322 | - |
|
323 | - /** |
|
324 | - * get list of payment statuses |
|
325 | - * |
|
326 | - * @access private |
|
327 | - * @return void |
|
328 | - * @throws EE_Error |
|
329 | - * @throws InvalidArgumentException |
|
330 | - * @throws InvalidDataTypeException |
|
331 | - * @throws InvalidInterfaceException |
|
332 | - */ |
|
333 | - private function _get_payment_status_array() |
|
334 | - { |
|
335 | - self::$_pay_status = EEM_Payment::instance()->status_array(true); |
|
336 | - $this->_template_args['payment_status'] = self::$_pay_status; |
|
337 | - |
|
338 | - } |
|
339 | - |
|
340 | - |
|
341 | - /** |
|
342 | - * _add_screen_options_default |
|
343 | - * |
|
344 | - * @access protected |
|
345 | - * @return void |
|
346 | - * @throws InvalidArgumentException |
|
347 | - * @throws InvalidDataTypeException |
|
348 | - * @throws InvalidInterfaceException |
|
349 | - */ |
|
350 | - protected function _add_screen_options_default() |
|
351 | - { |
|
352 | - $this->_per_page_screen_option(); |
|
353 | - } |
|
354 | - |
|
355 | - |
|
356 | - /** |
|
357 | - * load_scripts_styles |
|
358 | - * |
|
359 | - * @access public |
|
360 | - * @return void |
|
361 | - */ |
|
362 | - public function load_scripts_styles() |
|
363 | - { |
|
364 | - //enqueue style |
|
365 | - wp_register_style( |
|
366 | - 'espresso_txn', |
|
367 | - TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
368 | - array(), |
|
369 | - EVENT_ESPRESSO_VERSION |
|
370 | - ); |
|
371 | - wp_enqueue_style('espresso_txn'); |
|
372 | - //scripts |
|
373 | - wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array( |
|
374 | - 'ee_admin_js', |
|
375 | - 'ee-datepicker', |
|
376 | - 'jquery-ui-datepicker', |
|
377 | - 'jquery-ui-draggable', |
|
378 | - 'ee-dialog', |
|
379 | - 'ee-accounting', |
|
380 | - 'ee-serialize-full-array', |
|
381 | - ), EVENT_ESPRESSO_VERSION, true); |
|
382 | - wp_enqueue_script('espresso_txn'); |
|
383 | - } |
|
384 | - |
|
385 | - |
|
386 | - /** |
|
387 | - * load_scripts_styles_view_transaction |
|
388 | - * |
|
389 | - * @access public |
|
390 | - * @return void |
|
391 | - */ |
|
392 | - public function load_scripts_styles_view_transaction() |
|
393 | - { |
|
394 | - //styles |
|
395 | - wp_enqueue_style('espresso-ui-theme'); |
|
396 | - } |
|
397 | - |
|
398 | - |
|
399 | - /** |
|
400 | - * load_scripts_styles_default |
|
401 | - * |
|
402 | - * @access public |
|
403 | - * @return void |
|
404 | - */ |
|
405 | - public function load_scripts_styles_default() |
|
406 | - { |
|
407 | - //styles |
|
408 | - wp_enqueue_style('espresso-ui-theme'); |
|
409 | - } |
|
410 | - |
|
411 | - |
|
412 | - /** |
|
413 | - * _set_list_table_views_default |
|
414 | - * |
|
415 | - * @access protected |
|
416 | - * @return void |
|
417 | - */ |
|
418 | - protected function _set_list_table_views_default() |
|
419 | - { |
|
420 | - $this->_views = array( |
|
421 | - 'all' => array( |
|
422 | - 'slug' => 'all', |
|
423 | - 'label' => esc_html__('View All Transactions', 'event_espresso'), |
|
424 | - 'count' => 0, |
|
425 | - ), |
|
426 | - 'abandoned' => array( |
|
427 | - 'slug' => 'abandoned', |
|
428 | - 'label' => esc_html__('Abandoned Transactions', 'event_espresso'), |
|
429 | - 'count' => 0, |
|
430 | - ), |
|
431 | - 'failed' => array( |
|
432 | - 'slug' => 'failed', |
|
433 | - 'label' => esc_html__('Failed Transactions', 'event_espresso'), |
|
434 | - 'count' => 0, |
|
435 | - ), |
|
436 | - ); |
|
437 | - } |
|
438 | - |
|
439 | - |
|
440 | - /** |
|
441 | - * _set_transaction_object |
|
442 | - * This sets the _transaction property for the transaction details screen |
|
443 | - * |
|
444 | - * @access private |
|
445 | - * @return void |
|
446 | - * @throws EE_Error |
|
447 | - * @throws InvalidArgumentException |
|
448 | - * @throws RuntimeException |
|
449 | - * @throws InvalidDataTypeException |
|
450 | - * @throws InvalidInterfaceException |
|
451 | - * @throws ReflectionException |
|
452 | - */ |
|
453 | - private function _set_transaction_object() |
|
454 | - { |
|
455 | - if ($this->_transaction instanceof EE_Transaction) { |
|
456 | - return; |
|
457 | - } //get out we've already set the object |
|
458 | - |
|
459 | - $TXN_ID = ! empty($this->_req_data['TXN_ID']) |
|
460 | - ? absint($this->_req_data['TXN_ID']) |
|
461 | - : false; |
|
462 | - |
|
463 | - //get transaction object |
|
464 | - $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
465 | - $this->_session = $this->_transaction instanceof EE_Transaction |
|
466 | - ? $this->_transaction->get('TXN_session_data') |
|
467 | - : null; |
|
468 | - $this->_transaction->verify_abandoned_transaction_status(); |
|
469 | - |
|
470 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
471 | - $error_msg = sprintf( |
|
472 | - esc_html__( |
|
473 | - 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
|
474 | - 'event_espresso' |
|
475 | - ), |
|
476 | - $TXN_ID |
|
477 | - ); |
|
478 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
479 | - } |
|
480 | - } |
|
481 | - |
|
482 | - |
|
483 | - /** |
|
484 | - * _transaction_legend_items |
|
485 | - * |
|
486 | - * @access protected |
|
487 | - * @return array |
|
488 | - * @throws EE_Error |
|
489 | - * @throws InvalidArgumentException |
|
490 | - * @throws ReflectionException |
|
491 | - * @throws InvalidDataTypeException |
|
492 | - * @throws InvalidInterfaceException |
|
493 | - */ |
|
494 | - protected function _transaction_legend_items() |
|
495 | - { |
|
496 | - EE_Registry::instance()->load_helper('MSG_Template'); |
|
497 | - $items = array(); |
|
498 | - |
|
499 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
500 | - 'ee_read_global_messages', |
|
501 | - 'view_filtered_messages' |
|
502 | - )) { |
|
503 | - $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
504 | - if (is_array($related_for_icon) |
|
505 | - && isset($related_for_icon['css_class'], $related_for_icon['label']) |
|
506 | - ) { |
|
507 | - $items['view_related_messages'] = array( |
|
508 | - 'class' => $related_for_icon['css_class'], |
|
509 | - 'desc' => $related_for_icon['label'], |
|
510 | - ); |
|
511 | - } |
|
512 | - } |
|
513 | - |
|
514 | - $items = apply_filters( |
|
515 | - 'FHEE__Transactions_Admin_Page___transaction_legend_items__items', |
|
516 | - array_merge( |
|
517 | - $items, |
|
518 | - array( |
|
519 | - 'view_details' => array( |
|
520 | - 'class' => 'dashicons dashicons-cart', |
|
521 | - 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
522 | - ), |
|
523 | - 'view_invoice' => array( |
|
524 | - 'class' => 'dashicons dashicons-media-spreadsheet', |
|
525 | - 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
526 | - ), |
|
527 | - 'view_receipt' => array( |
|
528 | - 'class' => 'dashicons dashicons-media-default', |
|
529 | - 'desc' => esc_html__('View Transaction Receipt', 'event_espresso'), |
|
530 | - ), |
|
531 | - 'view_registration' => array( |
|
532 | - 'class' => 'dashicons dashicons-clipboard', |
|
533 | - 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
534 | - ), |
|
535 | - 'payment_overview_link' => array( |
|
536 | - 'class' => 'dashicons dashicons-money', |
|
537 | - 'desc' => esc_html__('Make Payment on Frontend', 'event_espresso'), |
|
538 | - ), |
|
539 | - ) |
|
540 | - ) |
|
541 | - ); |
|
542 | - |
|
543 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
544 | - 'ee_send_message', |
|
545 | - 'espresso_transactions_send_payment_reminder' |
|
546 | - )) { |
|
547 | - if (EEH_MSG_Template::is_mt_active('payment_reminder')) { |
|
548 | - $items['send_payment_reminder'] = array( |
|
549 | - 'class' => 'dashicons dashicons-email-alt', |
|
550 | - 'desc' => esc_html__('Send Payment Reminder', 'event_espresso'), |
|
551 | - ); |
|
552 | - } else { |
|
553 | - $items['blank*'] = array( |
|
554 | - 'class' => '', |
|
555 | - 'desc' => '', |
|
556 | - ); |
|
557 | - } |
|
558 | - } else { |
|
559 | - $items['blank*'] = array( |
|
560 | - 'class' => '', |
|
561 | - 'desc' => '', |
|
562 | - ); |
|
563 | - } |
|
564 | - $more_items = apply_filters( |
|
565 | - 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
|
566 | - array( |
|
567 | - 'overpaid' => array( |
|
568 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
569 | - 'desc' => EEH_Template::pretty_status( |
|
570 | - EEM_Transaction::overpaid_status_code, |
|
571 | - false, |
|
572 | - 'sentence' |
|
573 | - ), |
|
574 | - ), |
|
575 | - 'complete' => array( |
|
576 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
577 | - 'desc' => EEH_Template::pretty_status( |
|
578 | - EEM_Transaction::complete_status_code, |
|
579 | - false, |
|
580 | - 'sentence' |
|
581 | - ), |
|
582 | - ), |
|
583 | - 'incomplete' => array( |
|
584 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
585 | - 'desc' => EEH_Template::pretty_status( |
|
586 | - EEM_Transaction::incomplete_status_code, |
|
587 | - false, |
|
588 | - 'sentence' |
|
589 | - ), |
|
590 | - ), |
|
591 | - 'abandoned' => array( |
|
592 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
593 | - 'desc' => EEH_Template::pretty_status( |
|
594 | - EEM_Transaction::abandoned_status_code, |
|
595 | - false, |
|
596 | - 'sentence' |
|
597 | - ), |
|
598 | - ), |
|
599 | - 'failed' => array( |
|
600 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
601 | - 'desc' => EEH_Template::pretty_status( |
|
602 | - EEM_Transaction::failed_status_code, |
|
603 | - false, |
|
604 | - 'sentence' |
|
605 | - ), |
|
606 | - ), |
|
607 | - ) |
|
608 | - ); |
|
609 | - |
|
610 | - return array_merge($items, $more_items); |
|
611 | - } |
|
612 | - |
|
613 | - |
|
614 | - /** |
|
615 | - * _transactions_overview_list_table |
|
616 | - * |
|
617 | - * @access protected |
|
618 | - * @return void |
|
619 | - * @throws DomainException |
|
620 | - * @throws EE_Error |
|
621 | - * @throws InvalidArgumentException |
|
622 | - * @throws InvalidDataTypeException |
|
623 | - * @throws InvalidInterfaceException |
|
624 | - * @throws ReflectionException |
|
625 | - */ |
|
626 | - protected function _transactions_overview_list_table() |
|
627 | - { |
|
628 | - $this->_admin_page_title = esc_html__('Transactions', 'event_espresso'); |
|
629 | - $event = isset($this->_req_data['EVT_ID']) |
|
630 | - ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) |
|
631 | - : null; |
|
632 | - $this->_template_args['admin_page_header'] = $event instanceof EE_Event |
|
633 | - ? sprintf( |
|
634 | - esc_html__( |
|
635 | - '%sViewing Transactions for the Event: %s%s', |
|
636 | - 'event_espresso' |
|
637 | - ), |
|
638 | - '<h3>', |
|
639 | - '<a href="' |
|
640 | - . EE_Admin_Page::add_query_args_and_nonce( |
|
641 | - array('action' => 'edit', 'post' => $event->ID()), |
|
642 | - EVENTS_ADMIN_URL |
|
643 | - ) |
|
644 | - . '" title="' |
|
645 | - . esc_attr__( |
|
646 | - 'Click to Edit event', |
|
647 | - 'event_espresso' |
|
648 | - ) |
|
649 | - . '">' . $event->get('EVT_name') . '</a>', |
|
650 | - '</h3>' |
|
651 | - ) |
|
652 | - : ''; |
|
653 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
654 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
655 | - } |
|
656 | - |
|
657 | - |
|
658 | - /** |
|
659 | - * _transaction_details |
|
660 | - * generates HTML for the View Transaction Details Admin page |
|
661 | - * |
|
662 | - * @access protected |
|
663 | - * @return void |
|
664 | - * @throws DomainException |
|
665 | - * @throws EE_Error |
|
666 | - * @throws InvalidArgumentException |
|
667 | - * @throws InvalidDataTypeException |
|
668 | - * @throws InvalidInterfaceException |
|
669 | - * @throws RuntimeException |
|
670 | - * @throws ReflectionException |
|
671 | - */ |
|
672 | - protected function _transaction_details() |
|
673 | - { |
|
674 | - do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction); |
|
675 | - |
|
676 | - $this->_set_transaction_status_array(); |
|
677 | - |
|
678 | - $this->_template_args = array(); |
|
679 | - $this->_template_args['transactions_page'] = $this->_wp_page_slug; |
|
680 | - |
|
681 | - $this->_set_transaction_object(); |
|
682 | - |
|
683 | - $primary_registration = $this->_transaction->primary_registration(); |
|
684 | - $attendee = $primary_registration instanceof EE_Registration |
|
685 | - ? $primary_registration->attendee() |
|
686 | - : null; |
|
687 | - |
|
688 | - $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID(); |
|
689 | - $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso'); |
|
690 | - |
|
691 | - $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp'); |
|
692 | - $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
693 | - |
|
694 | - $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')]; |
|
695 | - $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
|
696 | - $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID'); |
|
697 | - |
|
698 | - $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total'); |
|
699 | - $this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid'); |
|
700 | - |
|
701 | - $amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid'); |
|
702 | - $this->_template_args['amount_due'] = EEH_Template::format_currency( |
|
703 | - $amount_due, |
|
704 | - true |
|
705 | - ); |
|
706 | - if (EE_Registry::instance()->CFG->currency->sign_b4) { |
|
707 | - $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign |
|
708 | - . $this->_template_args['amount_due']; |
|
709 | - } else { |
|
710 | - $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign; |
|
711 | - } |
|
712 | - $this->_template_args['amount_due_class'] = ''; |
|
713 | - |
|
714 | - if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) { |
|
715 | - // paid in full |
|
716 | - $this->_template_args['amount_due'] = false; |
|
717 | - } elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) { |
|
718 | - // overpaid |
|
719 | - $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
720 | - } elseif ($this->_transaction->get('TXN_total') > 0 |
|
721 | - && $this->_transaction->get('TXN_paid') > 0 |
|
722 | - ) { |
|
723 | - // monies owing |
|
724 | - $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn'; |
|
725 | - } elseif ($this->_transaction->get('TXN_total') > 0 |
|
726 | - && $this->_transaction->get('TXN_paid') == 0 |
|
727 | - ) { |
|
728 | - // no payments made yet |
|
729 | - $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
730 | - } elseif ($this->_transaction->get('TXN_total') == 0) { |
|
731 | - // free event |
|
732 | - $this->_template_args['amount_due'] = false; |
|
733 | - } |
|
734 | - |
|
735 | - $payment_method = $this->_transaction->payment_method(); |
|
736 | - |
|
737 | - $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method |
|
738 | - ? $payment_method->admin_name() |
|
739 | - : esc_html__('Unknown', 'event_espresso'); |
|
740 | - |
|
741 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
742 | - // link back to overview |
|
743 | - $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER']) |
|
744 | - ? $_SERVER['HTTP_REFERER'] |
|
745 | - : TXN_ADMIN_URL; |
|
746 | - |
|
747 | - |
|
748 | - // next link |
|
749 | - $next_txn = $this->_transaction->next( |
|
750 | - null, |
|
751 | - array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
752 | - 'TXN_ID' |
|
753 | - ); |
|
754 | - $this->_template_args['next_transaction'] = $next_txn |
|
755 | - ? $this->_next_link( |
|
756 | - EE_Admin_Page::add_query_args_and_nonce( |
|
757 | - array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']), |
|
758 | - TXN_ADMIN_URL |
|
759 | - ), |
|
760 | - 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
761 | - ) |
|
762 | - : ''; |
|
763 | - // previous link |
|
764 | - $previous_txn = $this->_transaction->previous( |
|
765 | - null, |
|
766 | - array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
767 | - 'TXN_ID' |
|
768 | - ); |
|
769 | - $this->_template_args['previous_transaction'] = $previous_txn |
|
770 | - ? $this->_previous_link( |
|
771 | - EE_Admin_Page::add_query_args_and_nonce( |
|
772 | - array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']), |
|
773 | - TXN_ADMIN_URL |
|
774 | - ), |
|
775 | - 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
776 | - ) |
|
777 | - : ''; |
|
778 | - |
|
779 | - // were we just redirected here after adding a new registration ??? |
|
780 | - if (isset( |
|
781 | - $this->_req_data['redirect_from'], |
|
782 | - $this->_req_data['EVT_ID'], |
|
783 | - $this->_req_data['event_name'] |
|
784 | - )) { |
|
785 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
786 | - 'ee_edit_registrations', |
|
787 | - 'espresso_registrations_new_registration', |
|
788 | - $this->_req_data['EVT_ID'] |
|
789 | - )) { |
|
790 | - $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="'; |
|
791 | - $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce( |
|
792 | - array( |
|
793 | - 'page' => 'espresso_registrations', |
|
794 | - 'action' => 'new_registration', |
|
795 | - 'return' => 'default', |
|
796 | - 'TXN_ID' => $this->_transaction->ID(), |
|
797 | - 'event_id' => $this->_req_data['EVT_ID'], |
|
798 | - ), |
|
799 | - REG_ADMIN_URL |
|
800 | - ); |
|
801 | - $this->_admin_page_title .= '">'; |
|
802 | - |
|
803 | - $this->_admin_page_title .= sprintf( |
|
804 | - esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'), |
|
805 | - htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8') |
|
806 | - ); |
|
807 | - $this->_admin_page_title .= '</a>'; |
|
808 | - } |
|
809 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
810 | - } |
|
811 | - // grab messages at the last second |
|
812 | - $this->_template_args['notices'] = EE_Error::get_notices(); |
|
813 | - // path to template |
|
814 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
815 | - $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
816 | - $template_path, |
|
817 | - $this->_template_args, |
|
818 | - true |
|
819 | - ); |
|
820 | - |
|
821 | - // the details template wrapper |
|
822 | - $this->display_admin_page_with_sidebar(); |
|
823 | - |
|
824 | - } |
|
825 | - |
|
826 | - |
|
827 | - /** |
|
828 | - * _transaction_details_metaboxes |
|
829 | - * |
|
830 | - * @access protected |
|
831 | - * @return void |
|
832 | - * @throws EE_Error |
|
833 | - * @throws InvalidArgumentException |
|
834 | - * @throws InvalidDataTypeException |
|
835 | - * @throws InvalidInterfaceException |
|
836 | - * @throws RuntimeException |
|
837 | - * @throws ReflectionException |
|
838 | - */ |
|
839 | - protected function _transaction_details_metaboxes() |
|
840 | - { |
|
841 | - |
|
842 | - $this->_set_transaction_object(); |
|
843 | - |
|
844 | - add_meta_box( |
|
845 | - 'edit-txn-details-mbox', |
|
846 | - esc_html__('Transaction Details', 'event_espresso'), |
|
847 | - array($this, 'txn_details_meta_box'), |
|
848 | - $this->_wp_page_slug, |
|
849 | - 'normal', |
|
850 | - 'high' |
|
851 | - ); |
|
852 | - add_meta_box( |
|
853 | - 'edit-txn-attendees-mbox', |
|
854 | - esc_html__('Attendees Registered in this Transaction', 'event_espresso'), |
|
855 | - array($this, 'txn_attendees_meta_box'), |
|
856 | - $this->_wp_page_slug, |
|
857 | - 'normal', |
|
858 | - 'high', |
|
859 | - array('TXN_ID' => $this->_transaction->ID()) |
|
860 | - ); |
|
861 | - add_meta_box( |
|
862 | - 'edit-txn-registrant-mbox', |
|
863 | - esc_html__('Primary Contact', 'event_espresso'), |
|
864 | - array($this, 'txn_registrant_side_meta_box'), |
|
865 | - $this->_wp_page_slug, |
|
866 | - 'side', |
|
867 | - 'high' |
|
868 | - ); |
|
869 | - add_meta_box( |
|
870 | - 'edit-txn-billing-info-mbox', |
|
871 | - esc_html__('Billing Information', 'event_espresso'), |
|
872 | - array($this, 'txn_billing_info_side_meta_box'), |
|
873 | - $this->_wp_page_slug, |
|
874 | - 'side', |
|
875 | - 'high' |
|
876 | - ); |
|
877 | - } |
|
878 | - |
|
879 | - |
|
880 | - /** |
|
881 | - * Callback for transaction actions metabox. |
|
882 | - * |
|
883 | - * @param EE_Transaction|null $transaction |
|
884 | - * @throws DomainException |
|
885 | - * @throws EE_Error |
|
886 | - * @throws InvalidArgumentException |
|
887 | - * @throws InvalidDataTypeException |
|
888 | - * @throws InvalidInterfaceException |
|
889 | - * @throws ReflectionException |
|
890 | - * @throws RuntimeException |
|
891 | - */ |
|
892 | - public function getActionButtons(EE_Transaction $transaction = null) |
|
893 | - { |
|
894 | - $content = ''; |
|
895 | - $actions = array(); |
|
896 | - if (! $transaction instanceof EE_Transaction) { |
|
897 | - return $content; |
|
898 | - } |
|
899 | - /** @var EE_Registration $primary_registration */ |
|
900 | - $primary_registration = $transaction->primary_registration(); |
|
901 | - $attendee = $primary_registration instanceof EE_Registration |
|
902 | - ? $primary_registration->attendee() |
|
903 | - : null; |
|
904 | - |
|
905 | - if ($attendee instanceof EE_Attendee |
|
906 | - && EE_Registry::instance()->CAP->current_user_can( |
|
907 | - 'ee_send_message', |
|
908 | - 'espresso_transactions_send_payment_reminder' |
|
909 | - ) |
|
910 | - ) { |
|
911 | - $actions['payment_reminder'] = |
|
912 | - EEH_MSG_Template::is_mt_active('payment_reminder') |
|
913 | - && $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code |
|
914 | - && $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code |
|
915 | - ? EEH_Template::get_button_or_link( |
|
916 | - EE_Admin_Page::add_query_args_and_nonce( |
|
917 | - array( |
|
918 | - 'action' => 'send_payment_reminder', |
|
919 | - 'TXN_ID' => $this->_transaction->ID(), |
|
920 | - 'redirect_to' => 'view_transaction', |
|
921 | - ), |
|
922 | - TXN_ADMIN_URL |
|
923 | - ), |
|
924 | - esc_html__(' Send Payment Reminder', 'event_espresso'), |
|
925 | - 'button secondary-button', |
|
926 | - 'dashicons dashicons-email-alt' |
|
927 | - ) |
|
928 | - : ''; |
|
929 | - } |
|
930 | - |
|
931 | - if ($primary_registration instanceof EE_Registration |
|
932 | - && EEH_MSG_Template::is_mt_active('receipt') |
|
933 | - ) { |
|
934 | - $actions['receipt'] = EEH_Template::get_button_or_link( |
|
935 | - $primary_registration->receipt_url(), |
|
936 | - esc_html__('View Receipt', 'event_espresso'), |
|
937 | - 'button secondary-button', |
|
938 | - 'dashicons dashicons-media-default' |
|
939 | - ); |
|
940 | - } |
|
941 | - |
|
942 | - if ($primary_registration instanceof EE_Registration |
|
943 | - && EEH_MSG_Template::is_mt_active('invoice') |
|
944 | - ) { |
|
945 | - $actions['invoice'] = EEH_Template::get_button_or_link( |
|
946 | - $primary_registration->invoice_url(), |
|
947 | - esc_html__('View Invoice', 'event_espresso'), |
|
948 | - 'button secondary-button', |
|
949 | - 'dashicons dashicons-media-spreadsheet' |
|
950 | - ); |
|
951 | - } |
|
952 | - $actions = array_filter( |
|
953 | - apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction) |
|
954 | - ); |
|
955 | - if ($actions) { |
|
956 | - $content = '<ul>'; |
|
957 | - $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
958 | - $content .= '</uL>'; |
|
959 | - } |
|
960 | - return $content; |
|
961 | - } |
|
962 | - |
|
963 | - |
|
964 | - /** |
|
965 | - * txn_details_meta_box |
|
966 | - * generates HTML for the Transaction main meta box |
|
967 | - * |
|
968 | - * @return void |
|
969 | - * @throws DomainException |
|
970 | - * @throws EE_Error |
|
971 | - * @throws InvalidArgumentException |
|
972 | - * @throws InvalidDataTypeException |
|
973 | - * @throws InvalidInterfaceException |
|
974 | - * @throws RuntimeException |
|
975 | - * @throws ReflectionException |
|
976 | - */ |
|
977 | - public function txn_details_meta_box() |
|
978 | - { |
|
979 | - $this->_set_transaction_object(); |
|
980 | - $this->_template_args['TXN_ID'] = $this->_transaction->ID(); |
|
981 | - $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration |
|
982 | - ? $this->_transaction->primary_registration()->attendee() |
|
983 | - : null; |
|
984 | - $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
985 | - 'ee_edit_payments', |
|
986 | - 'apply_payment_or_refund_from_registration_details' |
|
987 | - ); |
|
988 | - $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
989 | - 'ee_delete_payments', |
|
990 | - 'delete_payment_from_registration_details' |
|
991 | - ); |
|
992 | - |
|
993 | - //get line table |
|
994 | - EEH_Autoloader::register_line_item_display_autoloaders(); |
|
995 | - $Line_Item_Display = new EE_Line_Item_Display( |
|
996 | - 'admin_table', |
|
997 | - 'EE_Admin_Table_Line_Item_Display_Strategy' |
|
998 | - ); |
|
999 | - $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item( |
|
1000 | - $this->_transaction->total_line_item() |
|
1001 | - ); |
|
1002 | - $this->_template_args['REG_code'] = $this->_transaction->get_first_related('Registration') |
|
1003 | - ->get('REG_code'); |
|
1004 | - |
|
1005 | - // process taxes |
|
1006 | - $taxes = $this->_transaction->get_many_related( |
|
1007 | - 'Line_Item', |
|
1008 | - array(array('LIN_type' => EEM_Line_Item::type_tax)) |
|
1009 | - ); |
|
1010 | - $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false; |
|
1011 | - |
|
1012 | - $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
1013 | - $this->_transaction->get('TXN_total'), |
|
1014 | - false, |
|
1015 | - false |
|
1016 | - ); |
|
1017 | - $this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total'); |
|
1018 | - $this->_template_args['TXN_status'] = $this->_transaction->get('STS_ID'); |
|
1019 | - |
|
1020 | - // process payment details |
|
1021 | - $payments = $this->_transaction->get_many_related('Payment'); |
|
1022 | - if (! empty($payments)) { |
|
1023 | - $this->_template_args['payments'] = $payments; |
|
1024 | - $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
|
1025 | - } else { |
|
1026 | - $this->_template_args['payments'] = false; |
|
1027 | - $this->_template_args['existing_reg_payments'] = array(); |
|
1028 | - } |
|
1029 | - |
|
1030 | - $this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL); |
|
1031 | - $this->_template_args['delete_payment_url'] = add_query_arg( |
|
1032 | - array('action' => 'espresso_delete_payment'), |
|
1033 | - TXN_ADMIN_URL |
|
1034 | - ); |
|
1035 | - |
|
1036 | - if (isset($txn_details['invoice_number'])) { |
|
1037 | - $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code']; |
|
1038 | - $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__( |
|
1039 | - 'Invoice Number', |
|
1040 | - 'event_espresso' |
|
1041 | - ); |
|
1042 | - } |
|
1043 | - |
|
1044 | - $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction |
|
1045 | - ->get_first_related('Registration') |
|
1046 | - ->get('REG_session'); |
|
1047 | - $this->_template_args['txn_details']['registration_session']['label'] = esc_html__( |
|
1048 | - 'Registration Session', |
|
1049 | - 'event_espresso' |
|
1050 | - ); |
|
1051 | - |
|
1052 | - $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) |
|
1053 | - ? $this->_session['ip_address'] |
|
1054 | - : ''; |
|
1055 | - $this->_template_args['txn_details']['ip_address']['label'] = esc_html__( |
|
1056 | - 'Transaction placed from IP', |
|
1057 | - 'event_espresso' |
|
1058 | - ); |
|
1059 | - |
|
1060 | - $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) |
|
1061 | - ? $this->_session['user_agent'] |
|
1062 | - : ''; |
|
1063 | - $this->_template_args['txn_details']['user_agent']['label'] = esc_html__( |
|
1064 | - 'Registrant User Agent', |
|
1065 | - 'event_espresso' |
|
1066 | - ); |
|
1067 | - |
|
1068 | - $reg_steps = '<ul>'; |
|
1069 | - foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) { |
|
1070 | - if ($reg_step_status === true) { |
|
1071 | - $reg_steps .= '<li style="color:#70cc50">' |
|
1072 | - . sprintf( |
|
1073 | - esc_html__('%1$s : Completed', 'event_espresso'), |
|
1074 | - ucwords(str_replace('_', ' ', $reg_step)) |
|
1075 | - ) |
|
1076 | - . '</li>'; |
|
1077 | - } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) { |
|
1078 | - $reg_steps .= '<li style="color:#2EA2CC">' |
|
1079 | - . sprintf( |
|
1080 | - esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
|
1081 | - ucwords(str_replace('_', ' ', $reg_step)), |
|
1082 | - date( |
|
1083 | - get_option('date_format') . ' ' . get_option('time_format'), |
|
1084 | - ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)) |
|
1085 | - ) |
|
1086 | - ) |
|
1087 | - . '</li>'; |
|
1088 | - } else { |
|
1089 | - $reg_steps .= '<li style="color:#E76700">' |
|
1090 | - . sprintf( |
|
1091 | - esc_html__('%1$s : Never Initiated', 'event_espresso'), |
|
1092 | - ucwords(str_replace('_', ' ', $reg_step)) |
|
1093 | - ) |
|
1094 | - . '</li>'; |
|
1095 | - } |
|
1096 | - } |
|
1097 | - $reg_steps .= '</ul>'; |
|
1098 | - $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps; |
|
1099 | - $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__( |
|
1100 | - 'Registration Step Progress', |
|
1101 | - 'event_espresso' |
|
1102 | - ); |
|
1103 | - |
|
1104 | - |
|
1105 | - $this->_get_registrations_to_apply_payment_to(); |
|
1106 | - $this->_get_payment_methods($payments); |
|
1107 | - $this->_get_payment_status_array(); |
|
1108 | - $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction. |
|
1109 | - |
|
1110 | - $this->_template_args['transaction_form_url'] = add_query_arg(array( |
|
1111 | - 'action' => 'edit_transaction', |
|
1112 | - 'process' => 'transaction', |
|
1113 | - ), TXN_ADMIN_URL); |
|
1114 | - $this->_template_args['apply_payment_form_url'] = add_query_arg(array( |
|
1115 | - 'page' => 'espresso_transactions', |
|
1116 | - 'action' => 'espresso_apply_payment', |
|
1117 | - ), WP_AJAX_URL); |
|
1118 | - $this->_template_args['delete_payment_form_url'] = add_query_arg(array( |
|
1119 | - 'page' => 'espresso_transactions', |
|
1120 | - 'action' => 'espresso_delete_payment', |
|
1121 | - ), WP_AJAX_URL); |
|
1122 | - |
|
1123 | - $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction); |
|
1124 | - |
|
1125 | - // 'espresso_delete_payment_nonce' |
|
1126 | - |
|
1127 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
1128 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
1129 | - } |
|
1130 | - |
|
1131 | - |
|
1132 | - /** |
|
1133 | - * _get_registration_payment_IDs |
|
1134 | - * generates an array of Payment IDs and their corresponding Registration IDs |
|
1135 | - * |
|
1136 | - * @access protected |
|
1137 | - * @param EE_Payment[] $payments |
|
1138 | - * @return array |
|
1139 | - * @throws EE_Error |
|
1140 | - * @throws InvalidArgumentException |
|
1141 | - * @throws InvalidDataTypeException |
|
1142 | - * @throws InvalidInterfaceException |
|
1143 | - * @throws ReflectionException |
|
1144 | - */ |
|
1145 | - protected function _get_registration_payment_IDs($payments = array()) |
|
1146 | - { |
|
1147 | - $existing_reg_payments = array(); |
|
1148 | - // get all reg payments for these payments |
|
1149 | - $reg_payments = EEM_Registration_Payment::instance()->get_all(array( |
|
1150 | - array( |
|
1151 | - 'PAY_ID' => array( |
|
1152 | - 'IN', |
|
1153 | - array_keys($payments), |
|
1154 | - ), |
|
1155 | - ), |
|
1156 | - )); |
|
1157 | - if (! empty($reg_payments)) { |
|
1158 | - foreach ($payments as $payment) { |
|
1159 | - if (! $payment instanceof EE_Payment) { |
|
1160 | - continue; |
|
1161 | - } elseif (! isset($existing_reg_payments[$payment->ID()])) { |
|
1162 | - $existing_reg_payments[$payment->ID()] = array(); |
|
1163 | - } |
|
1164 | - foreach ($reg_payments as $reg_payment) { |
|
1165 | - if ($reg_payment instanceof EE_Registration_Payment |
|
1166 | - && $reg_payment->payment_ID() === $payment->ID() |
|
1167 | - ) { |
|
1168 | - $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID(); |
|
1169 | - } |
|
1170 | - } |
|
1171 | - } |
|
1172 | - } |
|
1173 | - |
|
1174 | - return $existing_reg_payments; |
|
1175 | - } |
|
1176 | - |
|
1177 | - |
|
1178 | - /** |
|
1179 | - * _get_registrations_to_apply_payment_to |
|
1180 | - * generates HTML for displaying a series of checkboxes in the admin payment modal window |
|
1181 | - * which allows the admin to only apply the payment to the specific registrations |
|
1182 | - * |
|
1183 | - * @access protected |
|
1184 | - * @return void |
|
1185 | - * @throws \EE_Error |
|
1186 | - */ |
|
1187 | - protected function _get_registrations_to_apply_payment_to() |
|
1188 | - { |
|
1189 | - // we want any registration with an active status (ie: not deleted or cancelled) |
|
1190 | - $query_params = array( |
|
1191 | - array( |
|
1192 | - 'STS_ID' => array( |
|
1193 | - 'IN', |
|
1194 | - array( |
|
1195 | - EEM_Registration::status_id_approved, |
|
1196 | - EEM_Registration::status_id_pending_payment, |
|
1197 | - EEM_Registration::status_id_not_approved, |
|
1198 | - ), |
|
1199 | - ), |
|
1200 | - ), |
|
1201 | - ); |
|
1202 | - $registrations_to_apply_payment_to = EEH_HTML::br() |
|
1203 | - . EEH_HTML::div( |
|
1204 | - '', |
|
1205 | - 'txn-admin-apply-payment-to-registrations-dv', |
|
1206 | - '', |
|
1207 | - 'clear: both; margin: 1.5em 0 0; display: none;' |
|
1208 | - ); |
|
1209 | - $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
1210 | - $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
|
1211 | - $registrations_to_apply_payment_to .= EEH_HTML::thead( |
|
1212 | - EEH_HTML::tr( |
|
1213 | - EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
1214 | - EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
1215 | - EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
1216 | - EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
1217 | - EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1218 | - EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1219 | - EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
|
1220 | - ) |
|
1221 | - ); |
|
1222 | - $registrations_to_apply_payment_to .= EEH_HTML::tbody(); |
|
1223 | - // get registrations for TXN |
|
1224 | - $registrations = $this->_transaction->registrations($query_params); |
|
1225 | - $existing_reg_payments = $this->_template_args['existing_reg_payments']; |
|
1226 | - foreach ($registrations as $registration) { |
|
1227 | - if ($registration instanceof EE_Registration) { |
|
1228 | - $attendee_name = $registration->attendee() instanceof EE_Attendee |
|
1229 | - ? $registration->attendee()->full_name() |
|
1230 | - : esc_html__('Unknown Attendee', 'event_espresso'); |
|
1231 | - $owing = $registration->final_price() - $registration->paid(); |
|
1232 | - $taxable = $registration->ticket()->taxable() |
|
1233 | - ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
1234 | - : ''; |
|
1235 | - $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments) |
|
1236 | - ? ' checked="checked"' |
|
1237 | - : ''; |
|
1238 | - $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
1239 | - $registrations_to_apply_payment_to .= EEH_HTML::tr( |
|
1240 | - EEH_HTML::td($registration->ID()) . |
|
1241 | - EEH_HTML::td($attendee_name) . |
|
1242 | - EEH_HTML::td( |
|
1243 | - $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
1244 | - ) . |
|
1245 | - EEH_HTML::td($registration->event_name()) . |
|
1246 | - EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1247 | - EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1248 | - EEH_HTML::td( |
|
1249 | - '<input type="checkbox" value="' . $registration->ID() |
|
1250 | - . '" name="txn_admin_payment[registrations]"' |
|
1251 | - . $checked . $disabled . '>', |
|
1252 | - '', |
|
1253 | - 'jst-cntr' |
|
1254 | - ), |
|
1255 | - 'apply-payment-registration-row-' . $registration->ID() |
|
1256 | - ); |
|
1257 | - } |
|
1258 | - } |
|
1259 | - $registrations_to_apply_payment_to .= EEH_HTML::tbodyx(); |
|
1260 | - $registrations_to_apply_payment_to .= EEH_HTML::tablex(); |
|
1261 | - $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1262 | - $registrations_to_apply_payment_to .= EEH_HTML::p( |
|
1263 | - esc_html__( |
|
1264 | - 'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.', |
|
1265 | - 'event_espresso' |
|
1266 | - ), |
|
1267 | - '', |
|
1268 | - 'clear description' |
|
1269 | - ); |
|
1270 | - $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1271 | - $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to; |
|
1272 | - } |
|
1273 | - |
|
1274 | - |
|
1275 | - /** |
|
1276 | - * _get_reg_status_selection |
|
1277 | - * |
|
1278 | - * @todo this will need to be adjusted either once MER comes along OR we move default reg status to tickets |
|
1279 | - * instead of events. |
|
1280 | - * @access protected |
|
1281 | - * @return void |
|
1282 | - * @throws EE_Error |
|
1283 | - */ |
|
1284 | - protected function _get_reg_status_selection() |
|
1285 | - { |
|
1286 | - //first get all possible statuses |
|
1287 | - $statuses = EEM_Registration::reg_status_array(array(), true); |
|
1288 | - //let's add a "don't change" option. |
|
1289 | - $status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso'); |
|
1290 | - $status_array = array_merge($status_array, $statuses); |
|
1291 | - $this->_template_args['status_change_select'] = EEH_Form_Fields::select_input( |
|
1292 | - 'txn_reg_status_change[reg_status]', |
|
1293 | - $status_array, |
|
1294 | - 'NAN', |
|
1295 | - 'id="txn-admin-payment-reg-status-inp"', |
|
1296 | - 'txn-reg-status-change-reg-status' |
|
1297 | - ); |
|
1298 | - $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input( |
|
1299 | - 'delete_txn_reg_status_change[reg_status]', |
|
1300 | - $status_array, |
|
1301 | - 'NAN', |
|
1302 | - 'delete-txn-admin-payment-reg-status-inp', |
|
1303 | - 'delete-txn-reg-status-change-reg-status' |
|
1304 | - ); |
|
1305 | - } |
|
1306 | - |
|
1307 | - |
|
1308 | - /** |
|
1309 | - * _get_payment_methods |
|
1310 | - * Gets all the payment methods available generally, or the ones that are already |
|
1311 | - * selected on these payments (in case their payment methods are no longer active). |
|
1312 | - * Has the side-effect of updating the template args' payment_methods item |
|
1313 | - * |
|
1314 | - * @access private |
|
1315 | - * @param EE_Payment[] to show on this page |
|
1316 | - * @return void |
|
1317 | - * @throws EE_Error |
|
1318 | - * @throws InvalidArgumentException |
|
1319 | - * @throws InvalidDataTypeException |
|
1320 | - * @throws InvalidInterfaceException |
|
1321 | - * @throws ReflectionException |
|
1322 | - */ |
|
1323 | - private function _get_payment_methods($payments = array()) |
|
1324 | - { |
|
1325 | - $payment_methods_of_payments = array(); |
|
1326 | - foreach ($payments as $payment) { |
|
1327 | - if ($payment instanceof EE_Payment) { |
|
1328 | - $payment_methods_of_payments[] = $payment->get('PMD_ID'); |
|
1329 | - } |
|
1330 | - } |
|
1331 | - if ($payment_methods_of_payments) { |
|
1332 | - $query_args = array( |
|
1333 | - array( |
|
1334 | - 'OR*payment_method_for_payment' => array( |
|
1335 | - 'PMD_ID' => array('IN', $payment_methods_of_payments), |
|
1336 | - 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
1337 | - ), |
|
1338 | - ), |
|
1339 | - ); |
|
1340 | - } else { |
|
1341 | - $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
1342 | - } |
|
1343 | - $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
|
1344 | - } |
|
1345 | - |
|
1346 | - |
|
1347 | - /** |
|
1348 | - * txn_attendees_meta_box |
|
1349 | - * generates HTML for the Attendees Transaction main meta box |
|
1350 | - * |
|
1351 | - * @access public |
|
1352 | - * @param WP_Post $post |
|
1353 | - * @param array $metabox |
|
1354 | - * @return void |
|
1355 | - * @throws DomainException |
|
1356 | - * @throws EE_Error |
|
1357 | - */ |
|
1358 | - public function txn_attendees_meta_box($post, $metabox = array('args' => array())) |
|
1359 | - { |
|
1360 | - |
|
1361 | - /** @noinspection NonSecureExtractUsageInspection */ |
|
1362 | - extract($metabox['args']); |
|
1363 | - $this->_template_args['post'] = $post; |
|
1364 | - $this->_template_args['event_attendees'] = array(); |
|
1365 | - // process items in cart |
|
1366 | - $line_items = $this->_transaction->get_many_related( |
|
1367 | - 'Line_Item', |
|
1368 | - array(array('LIN_type' => 'line-item')) |
|
1369 | - ); |
|
1370 | - if (! empty($line_items)) { |
|
1371 | - foreach ($line_items as $item) { |
|
1372 | - if ($item instanceof EE_Line_Item) { |
|
1373 | - switch ($item->OBJ_type()) { |
|
1374 | - case 'Event': |
|
1375 | - break; |
|
1376 | - case 'Ticket': |
|
1377 | - $ticket = $item->ticket(); |
|
1378 | - //right now we're only handling tickets here. |
|
1379 | - //Cause its expected that only tickets will have attendees right? |
|
1380 | - if (! $ticket instanceof EE_Ticket) { |
|
1381 | - continue; |
|
1382 | - } |
|
1383 | - try { |
|
1384 | - $event_name = $ticket->get_event_name(); |
|
1385 | - } catch (Exception $e) { |
|
1386 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1387 | - $event_name = esc_html__('Unknown Event', 'event_espresso'); |
|
1388 | - } |
|
1389 | - $event_name .= ' - ' . $item->get('LIN_name'); |
|
1390 | - $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price')); |
|
1391 | - // now get all of the registrations for this transaction that use this ticket |
|
1392 | - $registrations = $ticket->get_many_related( |
|
1393 | - 'Registration', |
|
1394 | - array(array('TXN_ID' => $this->_transaction->ID())) |
|
1395 | - ); |
|
1396 | - foreach ($registrations as $registration) { |
|
1397 | - if (! $registration instanceof EE_Registration) { |
|
1398 | - continue; |
|
1399 | - } |
|
1400 | - $this->_template_args['event_attendees'][$registration->ID()]['STS_ID'] |
|
1401 | - = $registration->status_ID(); |
|
1402 | - $this->_template_args['event_attendees'][$registration->ID()]['att_num'] |
|
1403 | - = $registration->count(); |
|
1404 | - $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name'] |
|
1405 | - = $event_name; |
|
1406 | - $this->_template_args['event_attendees'][$registration->ID()]['ticket_price'] |
|
1407 | - = $ticket_price; |
|
1408 | - // attendee info |
|
1409 | - $attendee = $registration->get_first_related('Attendee'); |
|
1410 | - if ($attendee instanceof EE_Attendee) { |
|
1411 | - $this->_template_args['event_attendees'][$registration->ID()]['att_id'] |
|
1412 | - = $attendee->ID(); |
|
1413 | - $this->_template_args['event_attendees'][$registration->ID()]['attendee'] |
|
1414 | - = $attendee->full_name(); |
|
1415 | - $this->_template_args['event_attendees'][$registration->ID()]['email'] |
|
1416 | - = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
1417 | - . esc_html__( |
|
1418 | - ' Event', |
|
1419 | - 'event_espresso' |
|
1420 | - ) |
|
1421 | - . '">' . $attendee->email() . '</a>'; |
|
1422 | - $this->_template_args['event_attendees'][$registration->ID()]['address'] |
|
1423 | - = EEH_Address::format($attendee, 'inline', false, false); |
|
1424 | - } else { |
|
1425 | - $this->_template_args['event_attendees'][$registration->ID()]['att_id'] = ''; |
|
1426 | - $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = ''; |
|
1427 | - $this->_template_args['event_attendees'][$registration->ID()]['email'] = ''; |
|
1428 | - $this->_template_args['event_attendees'][$registration->ID()]['address'] = ''; |
|
1429 | - } |
|
1430 | - } |
|
1431 | - break; |
|
1432 | - |
|
1433 | - } |
|
1434 | - } |
|
1435 | - } |
|
1436 | - |
|
1437 | - $this->_template_args['transaction_form_url'] = add_query_arg( |
|
1438 | - array( |
|
1439 | - 'action' => 'edit_transaction', |
|
1440 | - 'process' => 'attendees', |
|
1441 | - ), |
|
1442 | - TXN_ADMIN_URL |
|
1443 | - ); |
|
1444 | - echo EEH_Template::display_template( |
|
1445 | - TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
1446 | - $this->_template_args, |
|
1447 | - true |
|
1448 | - ); |
|
1449 | - |
|
1450 | - } else { |
|
1451 | - echo sprintf( |
|
1452 | - esc_html__( |
|
1453 | - '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s', |
|
1454 | - 'event_espresso' |
|
1455 | - ), |
|
1456 | - '<p class="important-notice">', |
|
1457 | - '</p>' |
|
1458 | - ); |
|
1459 | - } |
|
1460 | - } |
|
1461 | - |
|
1462 | - |
|
1463 | - /** |
|
1464 | - * txn_registrant_side_meta_box |
|
1465 | - * generates HTML for the Edit Transaction side meta box |
|
1466 | - * |
|
1467 | - * @access public |
|
1468 | - * @return void |
|
1469 | - * @throws DomainException |
|
1470 | - * @throws EE_Error |
|
1471 | - * @throws InvalidArgumentException |
|
1472 | - * @throws InvalidDataTypeException |
|
1473 | - * @throws InvalidInterfaceException |
|
1474 | - * @throws ReflectionException |
|
1475 | - */ |
|
1476 | - public function txn_registrant_side_meta_box() |
|
1477 | - { |
|
1478 | - $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
|
1479 | - ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
|
1480 | - : null; |
|
1481 | - if (! $primary_att instanceof EE_Attendee) { |
|
1482 | - $this->_template_args['no_attendee_message'] = esc_html__( |
|
1483 | - 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
|
1484 | - 'event_espresso' |
|
1485 | - ); |
|
1486 | - $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
1487 | - } |
|
1488 | - $this->_template_args['ATT_ID'] = $primary_att->ID(); |
|
1489 | - $this->_template_args['prime_reg_fname'] = $primary_att->fname(); |
|
1490 | - $this->_template_args['prime_reg_lname'] = $primary_att->lname(); |
|
1491 | - $this->_template_args['prime_reg_email'] = $primary_att->email(); |
|
1492 | - $this->_template_args['prime_reg_phone'] = $primary_att->phone(); |
|
1493 | - $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
1494 | - 'action' => 'edit_attendee', |
|
1495 | - 'post' => $primary_att->ID(), |
|
1496 | - ), REG_ADMIN_URL); |
|
1497 | - // get formatted address for registrant |
|
1498 | - $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
|
1499 | - echo EEH_Template::display_template( |
|
1500 | - TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
1501 | - $this->_template_args, |
|
1502 | - true |
|
1503 | - ); |
|
1504 | - } |
|
1505 | - |
|
1506 | - |
|
1507 | - /** |
|
1508 | - * txn_billing_info_side_meta_box |
|
1509 | - * generates HTML for the Edit Transaction side meta box |
|
1510 | - * |
|
1511 | - * @access public |
|
1512 | - * @return void |
|
1513 | - * @throws DomainException |
|
1514 | - * @throws EE_Error |
|
1515 | - */ |
|
1516 | - public function txn_billing_info_side_meta_box() |
|
1517 | - { |
|
1518 | - |
|
1519 | - $this->_template_args['billing_form'] = $this->_transaction->billing_info(); |
|
1520 | - $this->_template_args['billing_form_url'] = add_query_arg( |
|
1521 | - array('action' => 'edit_transaction', 'process' => 'billing'), |
|
1522 | - TXN_ADMIN_URL |
|
1523 | - ); |
|
1524 | - |
|
1525 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
1526 | - echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/ |
|
1527 | - } |
|
1528 | - |
|
1529 | - |
|
1530 | - /** |
|
1531 | - * apply_payments_or_refunds |
|
1532 | - * registers a payment or refund made towards a transaction |
|
1533 | - * |
|
1534 | - * @access public |
|
1535 | - * @return void |
|
1536 | - * @throws EE_Error |
|
1537 | - * @throws InvalidArgumentException |
|
1538 | - * @throws ReflectionException |
|
1539 | - * @throws RuntimeException |
|
1540 | - * @throws InvalidDataTypeException |
|
1541 | - * @throws InvalidInterfaceException |
|
1542 | - */ |
|
1543 | - public function apply_payments_or_refunds() |
|
1544 | - { |
|
1545 | - $json_response_data = array('return_data' => false); |
|
1546 | - $valid_data = $this->_validate_payment_request_data(); |
|
1547 | - $has_access = EE_Registry::instance()->CAP->current_user_can( |
|
1548 | - 'ee_edit_payments', |
|
1549 | - 'apply_payment_or_refund_from_registration_details' |
|
1550 | - ); |
|
1551 | - if (! empty($valid_data) && $has_access) { |
|
1552 | - $PAY_ID = $valid_data['PAY_ID']; |
|
1553 | - //save the new payment |
|
1554 | - $payment = $this->_create_payment_from_request_data($valid_data); |
|
1555 | - // get the TXN for this payment |
|
1556 | - $transaction = $payment->transaction(); |
|
1557 | - // verify transaction |
|
1558 | - if ($transaction instanceof EE_Transaction) { |
|
1559 | - // calculate_total_payments_and_update_status |
|
1560 | - $this->_process_transaction_payments($transaction); |
|
1561 | - $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
|
1562 | - $this->_remove_existing_registration_payments($payment, $PAY_ID); |
|
1563 | - // apply payment to registrations (if applicable) |
|
1564 | - if (! empty($REG_IDs)) { |
|
1565 | - $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
|
1566 | - $this->_maybe_send_notifications(); |
|
1567 | - // now process status changes for the same registrations |
|
1568 | - $this->_process_registration_status_change($transaction, $REG_IDs); |
|
1569 | - } |
|
1570 | - $this->_maybe_send_notifications($payment); |
|
1571 | - //prepare to render page |
|
1572 | - $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs); |
|
1573 | - do_action( |
|
1574 | - 'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', |
|
1575 | - $transaction, |
|
1576 | - $payment |
|
1577 | - ); |
|
1578 | - } else { |
|
1579 | - EE_Error::add_error( |
|
1580 | - esc_html__( |
|
1581 | - 'A valid Transaction for this payment could not be retrieved.', |
|
1582 | - 'event_espresso' |
|
1583 | - ), |
|
1584 | - __FILE__, |
|
1585 | - __FUNCTION__, |
|
1586 | - __LINE__ |
|
1587 | - ); |
|
1588 | - } |
|
1589 | - } else { |
|
1590 | - if ($has_access) { |
|
1591 | - EE_Error::add_error( |
|
1592 | - esc_html__( |
|
1593 | - 'The payment form data could not be processed. Please try again.', |
|
1594 | - 'event_espresso' |
|
1595 | - ), |
|
1596 | - __FILE__, |
|
1597 | - __FUNCTION__, |
|
1598 | - __LINE__ |
|
1599 | - ); |
|
1600 | - } else { |
|
1601 | - EE_Error::add_error( |
|
1602 | - esc_html__( |
|
1603 | - 'You do not have access to apply payments or refunds to a registration.', |
|
1604 | - 'event_espresso' |
|
1605 | - ), |
|
1606 | - __FILE__, |
|
1607 | - __FUNCTION__, |
|
1608 | - __LINE__ |
|
1609 | - ); |
|
1610 | - } |
|
1611 | - } |
|
1612 | - $notices = EE_Error::get_notices( |
|
1613 | - false, |
|
1614 | - false, |
|
1615 | - false |
|
1616 | - ); |
|
1617 | - $this->_template_args = array( |
|
1618 | - 'data' => $json_response_data, |
|
1619 | - 'error' => $notices['errors'], |
|
1620 | - 'success' => $notices['success'], |
|
1621 | - ); |
|
1622 | - $this->_return_json(); |
|
1623 | - } |
|
1624 | - |
|
1625 | - |
|
1626 | - /** |
|
1627 | - * _validate_payment_request_data |
|
1628 | - * |
|
1629 | - * @return array |
|
1630 | - * @throws EE_Error |
|
1631 | - */ |
|
1632 | - protected function _validate_payment_request_data() |
|
1633 | - { |
|
1634 | - if (! isset($this->_req_data['txn_admin_payment'])) { |
|
1635 | - return false; |
|
1636 | - } |
|
1637 | - $payment_form = $this->_generate_payment_form_section(); |
|
1638 | - try { |
|
1639 | - if ($payment_form->was_submitted()) { |
|
1640 | - $payment_form->receive_form_submission(); |
|
1641 | - if (! $payment_form->is_valid()) { |
|
1642 | - $submission_error_messages = array(); |
|
1643 | - foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
|
1644 | - if ($validation_error instanceof EE_Validation_Error) { |
|
1645 | - $submission_error_messages[] = sprintf( |
|
1646 | - _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'), |
|
1647 | - $validation_error->get_form_section()->html_label_text(), |
|
1648 | - $validation_error->getMessage() |
|
1649 | - ); |
|
1650 | - } |
|
1651 | - } |
|
1652 | - EE_Error::add_error( |
|
1653 | - implode('<br />', $submission_error_messages), |
|
1654 | - __FILE__, |
|
1655 | - __FUNCTION__, |
|
1656 | - __LINE__ |
|
1657 | - ); |
|
1658 | - |
|
1659 | - return array(); |
|
1660 | - } |
|
1661 | - } |
|
1662 | - } catch (EE_Error $e) { |
|
1663 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1664 | - |
|
1665 | - return array(); |
|
1666 | - } |
|
1667 | - |
|
1668 | - return $payment_form->valid_data(); |
|
1669 | - } |
|
1670 | - |
|
1671 | - |
|
1672 | - /** |
|
1673 | - * _generate_payment_form_section |
|
1674 | - * |
|
1675 | - * @return EE_Form_Section_Proper |
|
1676 | - * @throws EE_Error |
|
1677 | - */ |
|
1678 | - protected function _generate_payment_form_section() |
|
1679 | - { |
|
1680 | - return new EE_Form_Section_Proper( |
|
1681 | - array( |
|
1682 | - 'name' => 'txn_admin_payment', |
|
1683 | - 'subsections' => array( |
|
1684 | - 'PAY_ID' => new EE_Text_Input( |
|
1685 | - array( |
|
1686 | - 'default' => 0, |
|
1687 | - 'required' => false, |
|
1688 | - 'html_label_text' => esc_html__('Payment ID', 'event_espresso'), |
|
1689 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1690 | - ) |
|
1691 | - ), |
|
1692 | - 'TXN_ID' => new EE_Text_Input( |
|
1693 | - array( |
|
1694 | - 'default' => 0, |
|
1695 | - 'required' => true, |
|
1696 | - 'html_label_text' => esc_html__('Transaction ID', 'event_espresso'), |
|
1697 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1698 | - ) |
|
1699 | - ), |
|
1700 | - 'type' => new EE_Text_Input( |
|
1701 | - array( |
|
1702 | - 'default' => 1, |
|
1703 | - 'required' => true, |
|
1704 | - 'html_label_text' => esc_html__('Payment or Refund', 'event_espresso'), |
|
1705 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1706 | - ) |
|
1707 | - ), |
|
1708 | - 'amount' => new EE_Text_Input( |
|
1709 | - array( |
|
1710 | - 'default' => 0, |
|
1711 | - 'required' => true, |
|
1712 | - 'html_label_text' => esc_html__('Payment amount', 'event_espresso'), |
|
1713 | - 'validation_strategies' => array(new EE_Float_Normalization()), |
|
1714 | - ) |
|
1715 | - ), |
|
1716 | - 'status' => new EE_Text_Input( |
|
1717 | - array( |
|
1718 | - 'default' => EEM_Payment::status_id_approved, |
|
1719 | - 'required' => true, |
|
1720 | - 'html_label_text' => esc_html__('Payment status', 'event_espresso'), |
|
1721 | - ) |
|
1722 | - ), |
|
1723 | - 'PMD_ID' => new EE_Text_Input( |
|
1724 | - array( |
|
1725 | - 'default' => 2, |
|
1726 | - 'required' => true, |
|
1727 | - 'html_label_text' => esc_html__('Payment Method', 'event_espresso'), |
|
1728 | - 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1729 | - ) |
|
1730 | - ), |
|
1731 | - 'date' => new EE_Text_Input( |
|
1732 | - array( |
|
1733 | - 'default' => time(), |
|
1734 | - 'required' => true, |
|
1735 | - 'html_label_text' => esc_html__('Payment date', 'event_espresso'), |
|
1736 | - ) |
|
1737 | - ), |
|
1738 | - 'txn_id_chq_nmbr' => new EE_Text_Input( |
|
1739 | - array( |
|
1740 | - 'default' => '', |
|
1741 | - 'required' => false, |
|
1742 | - 'html_label_text' => esc_html__('Transaction or Cheque Number', 'event_espresso'), |
|
1743 | - 'validation_strategies' => array( |
|
1744 | - new EE_Max_Length_Validation_Strategy( |
|
1745 | - esc_html__('Input too long', 'event_espresso'), |
|
1746 | - 100 |
|
1747 | - ), |
|
1748 | - ), |
|
1749 | - ) |
|
1750 | - ), |
|
1751 | - 'po_number' => new EE_Text_Input( |
|
1752 | - array( |
|
1753 | - 'default' => '', |
|
1754 | - 'required' => false, |
|
1755 | - 'html_label_text' => esc_html__('Purchase Order Number', 'event_espresso'), |
|
1756 | - 'validation_strategies' => array( |
|
1757 | - new EE_Max_Length_Validation_Strategy( |
|
1758 | - esc_html__('Input too long', 'event_espresso'), |
|
1759 | - 100 |
|
1760 | - ), |
|
1761 | - ), |
|
1762 | - ) |
|
1763 | - ), |
|
1764 | - 'accounting' => new EE_Text_Input( |
|
1765 | - array( |
|
1766 | - 'default' => '', |
|
1767 | - 'required' => false, |
|
1768 | - 'html_label_text' => esc_html__('Extra Field for Accounting', 'event_espresso'), |
|
1769 | - 'validation_strategies' => array( |
|
1770 | - new EE_Max_Length_Validation_Strategy( |
|
1771 | - esc_html__('Input too long', 'event_espresso'), |
|
1772 | - 100 |
|
1773 | - ), |
|
1774 | - ), |
|
1775 | - ) |
|
1776 | - ), |
|
1777 | - ), |
|
1778 | - ) |
|
1779 | - ); |
|
1780 | - } |
|
1781 | - |
|
1782 | - |
|
1783 | - /** |
|
1784 | - * _create_payment_from_request_data |
|
1785 | - * |
|
1786 | - * @param array $valid_data |
|
1787 | - * @return EE_Payment |
|
1788 | - * @throws EE_Error |
|
1789 | - */ |
|
1790 | - protected function _create_payment_from_request_data($valid_data) |
|
1791 | - { |
|
1792 | - $PAY_ID = $valid_data['PAY_ID']; |
|
1793 | - // get payment amount |
|
1794 | - $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0; |
|
1795 | - // payments have a type value of 1 and refunds have a type value of -1 |
|
1796 | - // so multiplying amount by type will give a positive value for payments, and negative values for refunds |
|
1797 | - $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount; |
|
1798 | - // for some reason the date string coming in has extra spaces between the date and time. This fixes that. |
|
1799 | - $date = $valid_data['date'] |
|
1800 | - ? preg_replace('/\s+/', ' ', $valid_data['date']) |
|
1801 | - : date('Y-m-d g:i a', current_time('timestamp')); |
|
1802 | - $payment = EE_Payment::new_instance( |
|
1803 | - array( |
|
1804 | - 'TXN_ID' => $valid_data['TXN_ID'], |
|
1805 | - 'STS_ID' => $valid_data['status'], |
|
1806 | - 'PAY_timestamp' => $date, |
|
1807 | - 'PAY_source' => EEM_Payment_Method::scope_admin, |
|
1808 | - 'PMD_ID' => $valid_data['PMD_ID'], |
|
1809 | - 'PAY_amount' => $amount, |
|
1810 | - 'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'], |
|
1811 | - 'PAY_po_number' => $valid_data['po_number'], |
|
1812 | - 'PAY_extra_accntng' => $valid_data['accounting'], |
|
1813 | - 'PAY_details' => $valid_data, |
|
1814 | - 'PAY_ID' => $PAY_ID, |
|
1815 | - ), |
|
1816 | - '', |
|
1817 | - array('Y-m-d', 'g:i a') |
|
1818 | - ); |
|
1819 | - |
|
1820 | - if (! $payment->save()) { |
|
1821 | - EE_Error::add_error( |
|
1822 | - sprintf( |
|
1823 | - esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
|
1824 | - $payment->ID() |
|
1825 | - ), |
|
1826 | - __FILE__, __FUNCTION__, __LINE__ |
|
1827 | - ); |
|
1828 | - } |
|
1829 | - |
|
1830 | - return $payment; |
|
1831 | - } |
|
1832 | - |
|
1833 | - |
|
1834 | - /** |
|
1835 | - * _process_transaction_payments |
|
1836 | - * |
|
1837 | - * @param \EE_Transaction $transaction |
|
1838 | - * @return void |
|
1839 | - * @throws EE_Error |
|
1840 | - * @throws InvalidArgumentException |
|
1841 | - * @throws ReflectionException |
|
1842 | - * @throws InvalidDataTypeException |
|
1843 | - * @throws InvalidInterfaceException |
|
1844 | - */ |
|
1845 | - protected function _process_transaction_payments(EE_Transaction $transaction) |
|
1846 | - { |
|
1847 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
1848 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
1849 | - //update the transaction with this payment |
|
1850 | - if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) { |
|
1851 | - EE_Error::add_success(esc_html__( |
|
1852 | - 'The payment has been processed successfully.', 'event_espresso'), |
|
1853 | - __FILE__, |
|
1854 | - __FUNCTION__, |
|
1855 | - __LINE__ |
|
1856 | - ); |
|
1857 | - } else { |
|
1858 | - EE_Error::add_error( |
|
1859 | - esc_html__( |
|
1860 | - 'The payment was processed successfully but the amount paid for the transaction was not updated.', |
|
1861 | - 'event_espresso' |
|
1862 | - ) |
|
1863 | - , |
|
1864 | - __FILE__, |
|
1865 | - __FUNCTION__, |
|
1866 | - __LINE__ |
|
1867 | - ); |
|
1868 | - } |
|
1869 | - } |
|
1870 | - |
|
1871 | - |
|
1872 | - /** |
|
1873 | - * _get_REG_IDs_to_apply_payment_to |
|
1874 | - * returns a list of registration IDs that the payment will apply to |
|
1875 | - * |
|
1876 | - * @param \EE_Payment $payment |
|
1877 | - * @return array |
|
1878 | - * @throws EE_Error |
|
1879 | - */ |
|
1880 | - protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment) |
|
1881 | - { |
|
1882 | - $REG_IDs = array(); |
|
1883 | - // grab array of IDs for specific registrations to apply changes to |
|
1884 | - if (isset($this->_req_data['txn_admin_payment']['registrations'])) { |
|
1885 | - $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations']; |
|
1886 | - } |
|
1887 | - //nothing specified ? then get all reg IDs |
|
1888 | - if (empty($REG_IDs)) { |
|
1889 | - $registrations = $payment->transaction()->registrations(); |
|
1890 | - $REG_IDs = ! empty($registrations) |
|
1891 | - ? array_keys($registrations) |
|
1892 | - : $this->_get_existing_reg_payment_REG_IDs($payment); |
|
1893 | - } |
|
1894 | - |
|
1895 | - // ensure that REG_IDs are integers and NOT strings |
|
1896 | - return array_map('intval', $REG_IDs); |
|
1897 | - } |
|
1898 | - |
|
1899 | - |
|
1900 | - /** |
|
1901 | - * @return array |
|
1902 | - */ |
|
1903 | - public function existing_reg_payment_REG_IDs() |
|
1904 | - { |
|
1905 | - return $this->_existing_reg_payment_REG_IDs; |
|
1906 | - } |
|
1907 | - |
|
1908 | - |
|
1909 | - /** |
|
1910 | - * @param array $existing_reg_payment_REG_IDs |
|
1911 | - */ |
|
1912 | - public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null) |
|
1913 | - { |
|
1914 | - $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs; |
|
1915 | - } |
|
1916 | - |
|
1917 | - |
|
1918 | - /** |
|
1919 | - * _get_existing_reg_payment_REG_IDs |
|
1920 | - * returns a list of registration IDs that the payment is currently related to |
|
1921 | - * as recorded in the database |
|
1922 | - * |
|
1923 | - * @param \EE_Payment $payment |
|
1924 | - * @return array |
|
1925 | - * @throws EE_Error |
|
1926 | - */ |
|
1927 | - protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment) |
|
1928 | - { |
|
1929 | - if ($this->existing_reg_payment_REG_IDs() === null) { |
|
1930 | - // let's get any existing reg payment records for this payment |
|
1931 | - $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration'); |
|
1932 | - // but we only want the REG IDs, so grab the array keys |
|
1933 | - $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) |
|
1934 | - ? array_keys($existing_reg_payment_REG_IDs) |
|
1935 | - : array(); |
|
1936 | - $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs); |
|
1937 | - } |
|
1938 | - |
|
1939 | - return $this->existing_reg_payment_REG_IDs(); |
|
1940 | - } |
|
1941 | - |
|
1942 | - |
|
1943 | - /** |
|
1944 | - * _remove_existing_registration_payments |
|
1945 | - * this calculates the difference between existing relations |
|
1946 | - * to the supplied payment and the new list registration IDs, |
|
1947 | - * removes any related registrations that no longer apply, |
|
1948 | - * and then updates the registration paid fields |
|
1949 | - * |
|
1950 | - * @param \EE_Payment $payment |
|
1951 | - * @param int $PAY_ID |
|
1952 | - * @return bool; |
|
1953 | - * @throws EE_Error |
|
1954 | - * @throws InvalidArgumentException |
|
1955 | - * @throws ReflectionException |
|
1956 | - * @throws InvalidDataTypeException |
|
1957 | - * @throws InvalidInterfaceException |
|
1958 | - */ |
|
1959 | - protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0) |
|
1960 | - { |
|
1961 | - // newly created payments will have nothing recorded for $PAY_ID |
|
1962 | - if ($PAY_ID == 0) { |
|
1963 | - return false; |
|
1964 | - } |
|
1965 | - $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
1966 | - if (empty($existing_reg_payment_REG_IDs)) { |
|
1967 | - return false; |
|
1968 | - } |
|
1969 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
1970 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
1971 | - |
|
1972 | - return $transaction_payments->delete_registration_payments_and_update_registrations( |
|
1973 | - $payment, |
|
1974 | - array( |
|
1975 | - array( |
|
1976 | - 'PAY_ID' => $payment->ID(), |
|
1977 | - 'REG_ID' => array('IN', $existing_reg_payment_REG_IDs), |
|
1978 | - ), |
|
1979 | - ) |
|
1980 | - ); |
|
1981 | - } |
|
1982 | - |
|
1983 | - |
|
1984 | - /** |
|
1985 | - * _update_registration_payments |
|
1986 | - * this applies the payments to the selected registrations |
|
1987 | - * but only if they have not already been paid for |
|
1988 | - * |
|
1989 | - * @param EE_Transaction $transaction |
|
1990 | - * @param \EE_Payment $payment |
|
1991 | - * @param array $REG_IDs |
|
1992 | - * @return void |
|
1993 | - * @throws EE_Error |
|
1994 | - * @throws InvalidArgumentException |
|
1995 | - * @throws ReflectionException |
|
1996 | - * @throws RuntimeException |
|
1997 | - * @throws InvalidDataTypeException |
|
1998 | - * @throws InvalidInterfaceException |
|
1999 | - */ |
|
2000 | - protected function _update_registration_payments( |
|
2001 | - EE_Transaction $transaction, |
|
2002 | - EE_Payment $payment, |
|
2003 | - $REG_IDs = array() |
|
2004 | - ) { |
|
2005 | - // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments() |
|
2006 | - // so let's do that using our set of REG_IDs from the form |
|
2007 | - $registration_query_where_params = array( |
|
2008 | - 'REG_ID' => array('IN', $REG_IDs), |
|
2009 | - ); |
|
2010 | - // but add in some conditions regarding payment, |
|
2011 | - // so that we don't apply payments to registrations that are free or have already been paid for |
|
2012 | - // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
|
2013 | - if (! $payment->is_a_refund()) { |
|
2014 | - $registration_query_where_params['REG_final_price'] = array('!=', 0); |
|
2015 | - $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
|
2016 | - } |
|
2017 | - $registrations = $transaction->registrations(array($registration_query_where_params)); |
|
2018 | - if (! empty($registrations)) { |
|
2019 | - /** @type EE_Payment_Processor $payment_processor */ |
|
2020 | - $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
|
2021 | - $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
|
2022 | - } |
|
2023 | - } |
|
2024 | - |
|
2025 | - |
|
2026 | - /** |
|
2027 | - * _process_registration_status_change |
|
2028 | - * This processes requested registration status changes for all the registrations |
|
2029 | - * on a given transaction and (optionally) sends out notifications for the changes. |
|
2030 | - * |
|
2031 | - * @param EE_Transaction $transaction |
|
2032 | - * @param array $REG_IDs |
|
2033 | - * @return bool |
|
2034 | - * @throws EE_Error |
|
2035 | - * @throws InvalidArgumentException |
|
2036 | - * @throws ReflectionException |
|
2037 | - * @throws InvalidDataTypeException |
|
2038 | - * @throws InvalidInterfaceException |
|
2039 | - */ |
|
2040 | - protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array()) |
|
2041 | - { |
|
2042 | - // first if there is no change in status then we get out. |
|
2043 | - if ( |
|
2044 | - ! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
2045 | - || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN' |
|
2046 | - ) { |
|
2047 | - //no error message, no change requested, just nothing to do man. |
|
2048 | - return false; |
|
2049 | - } |
|
2050 | - /** @type EE_Transaction_Processor $transaction_processor */ |
|
2051 | - $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
2052 | - |
|
2053 | - // made it here dude? Oh WOW. K, let's take care of changing the statuses |
|
2054 | - return $transaction_processor->manually_update_registration_statuses( |
|
2055 | - $transaction, |
|
2056 | - sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']), |
|
2057 | - array(array('REG_ID' => array('IN', $REG_IDs))) |
|
2058 | - ); |
|
2059 | - } |
|
2060 | - |
|
2061 | - |
|
2062 | - /** |
|
2063 | - * _build_payment_json_response |
|
2064 | - * |
|
2065 | - * @access public |
|
2066 | - * @param \EE_Payment $payment |
|
2067 | - * @param array $REG_IDs |
|
2068 | - * @param bool | null $delete_txn_reg_status_change |
|
2069 | - * @return array |
|
2070 | - * @throws EE_Error |
|
2071 | - * @throws InvalidArgumentException |
|
2072 | - * @throws InvalidDataTypeException |
|
2073 | - * @throws InvalidInterfaceException |
|
2074 | - * @throws ReflectionException |
|
2075 | - */ |
|
2076 | - protected function _build_payment_json_response( |
|
2077 | - EE_Payment $payment, |
|
2078 | - $REG_IDs = array(), |
|
2079 | - $delete_txn_reg_status_change = null |
|
2080 | - ) { |
|
2081 | - // was the payment deleted ? |
|
2082 | - if (is_bool($delete_txn_reg_status_change)) { |
|
2083 | - return array( |
|
2084 | - 'PAY_ID' => $payment->ID(), |
|
2085 | - 'amount' => $payment->amount(), |
|
2086 | - 'total_paid' => $payment->transaction()->paid(), |
|
2087 | - 'txn_status' => $payment->transaction()->status_ID(), |
|
2088 | - 'pay_status' => $payment->STS_ID(), |
|
2089 | - 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
2090 | - 'delete_txn_reg_status_change' => $delete_txn_reg_status_change, |
|
2091 | - ); |
|
2092 | - } else { |
|
2093 | - $this->_get_payment_status_array(); |
|
2094 | - |
|
2095 | - return array( |
|
2096 | - 'amount' => $payment->amount(), |
|
2097 | - 'total_paid' => $payment->transaction()->paid(), |
|
2098 | - 'txn_status' => $payment->transaction()->status_ID(), |
|
2099 | - 'pay_status' => $payment->STS_ID(), |
|
2100 | - 'PAY_ID' => $payment->ID(), |
|
2101 | - 'STS_ID' => $payment->STS_ID(), |
|
2102 | - 'status' => self::$_pay_status[$payment->STS_ID()], |
|
2103 | - 'date' => $payment->timestamp('Y-m-d', 'h:i a'), |
|
2104 | - 'method' => strtoupper($payment->source()), |
|
2105 | - 'PM_ID' => $payment->payment_method() ? $payment->payment_method()->ID() : 1, |
|
2106 | - 'gateway' => $payment->payment_method() |
|
2107 | - ? $payment->payment_method()->admin_name() |
|
2108 | - : esc_html__("Unknown", 'event_espresso'), |
|
2109 | - 'gateway_response' => $payment->gateway_response(), |
|
2110 | - 'txn_id_chq_nmbr' => $payment->txn_id_chq_nmbr(), |
|
2111 | - 'po_number' => $payment->po_number(), |
|
2112 | - 'extra_accntng' => $payment->extra_accntng(), |
|
2113 | - 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
2114 | - ); |
|
2115 | - } |
|
2116 | - } |
|
2117 | - |
|
2118 | - |
|
2119 | - /** |
|
2120 | - * delete_payment |
|
2121 | - * delete a payment or refund made towards a transaction |
|
2122 | - * |
|
2123 | - * @access public |
|
2124 | - * @return void |
|
2125 | - * @throws EE_Error |
|
2126 | - * @throws InvalidArgumentException |
|
2127 | - * @throws ReflectionException |
|
2128 | - * @throws InvalidDataTypeException |
|
2129 | - * @throws InvalidInterfaceException |
|
2130 | - */ |
|
2131 | - public function delete_payment() |
|
2132 | - { |
|
2133 | - $json_response_data = array('return_data' => false); |
|
2134 | - $PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
2135 | - ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
2136 | - : 0; |
|
2137 | - $can_delete = EE_Registry::instance()->CAP->current_user_can( |
|
2138 | - 'ee_delete_payments', |
|
2139 | - 'delete_payment_from_registration_details' |
|
2140 | - ); |
|
2141 | - if ($PAY_ID && $can_delete) { |
|
2142 | - $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) |
|
2143 | - ? $this->_req_data['delete_txn_reg_status_change'] |
|
2144 | - : false; |
|
2145 | - $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID); |
|
2146 | - if ($payment instanceof EE_Payment) { |
|
2147 | - $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
2148 | - /** @type EE_Transaction_Payments $transaction_payments */ |
|
2149 | - $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
2150 | - if ($transaction_payments->delete_payment_and_update_transaction($payment)) { |
|
2151 | - $json_response_data['return_data'] = $this->_build_payment_json_response( |
|
2152 | - $payment, |
|
2153 | - $REG_IDs, |
|
2154 | - $delete_txn_reg_status_change |
|
2155 | - ); |
|
2156 | - if ($delete_txn_reg_status_change) { |
|
2157 | - $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
2158 | - //MAKE sure we also add the delete_txn_req_status_change to the |
|
2159 | - //$_REQUEST global because that's how messages will be looking for it. |
|
2160 | - $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
2161 | - $this->_maybe_send_notifications(); |
|
2162 | - $this->_process_registration_status_change($payment->transaction(), $REG_IDs); |
|
2163 | - } |
|
2164 | - } |
|
2165 | - } else { |
|
2166 | - EE_Error::add_error( |
|
2167 | - esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'), |
|
2168 | - __FILE__, __FUNCTION__, __LINE__ |
|
2169 | - ); |
|
2170 | - } |
|
2171 | - } else { |
|
2172 | - if ($can_delete) { |
|
2173 | - EE_Error::add_error( |
|
2174 | - esc_html__( |
|
2175 | - 'A valid Payment ID was not received, therefore payment form data could not be loaded.', |
|
2176 | - 'event_espresso' |
|
2177 | - ), |
|
2178 | - __FILE__, __FUNCTION__, __LINE__ |
|
2179 | - ); |
|
2180 | - } else { |
|
2181 | - EE_Error::add_error( |
|
2182 | - esc_html__( |
|
2183 | - 'You do not have access to delete a payment.', |
|
2184 | - 'event_espresso' |
|
2185 | - ), |
|
2186 | - __FILE__, |
|
2187 | - __FUNCTION__, |
|
2188 | - __LINE__ |
|
2189 | - ); |
|
2190 | - } |
|
2191 | - } |
|
2192 | - $notices = EE_Error::get_notices(false, false, false); |
|
2193 | - $this->_template_args = array( |
|
2194 | - 'data' => $json_response_data, |
|
2195 | - 'success' => $notices['success'], |
|
2196 | - 'error' => $notices['errors'], |
|
2197 | - 'attention' => $notices['attention'], |
|
2198 | - ); |
|
2199 | - $this->_return_json(); |
|
2200 | - } |
|
2201 | - |
|
2202 | - |
|
2203 | - /** |
|
2204 | - * _registration_payment_data_array |
|
2205 | - * adds info for 'owing' and 'paid' for each registration to the json response |
|
2206 | - * |
|
2207 | - * @access protected |
|
2208 | - * @param array $REG_IDs |
|
2209 | - * @return array |
|
2210 | - * @throws EE_Error |
|
2211 | - * @throws InvalidArgumentException |
|
2212 | - * @throws InvalidDataTypeException |
|
2213 | - * @throws InvalidInterfaceException |
|
2214 | - * @throws ReflectionException |
|
2215 | - */ |
|
2216 | - protected function _registration_payment_data_array($REG_IDs) |
|
2217 | - { |
|
2218 | - $registration_payment_data = array(); |
|
2219 | - //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
|
2220 | - if (! empty($REG_IDs)) { |
|
2221 | - $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
|
2222 | - foreach ($registrations as $registration) { |
|
2223 | - if ($registration instanceof EE_Registration) { |
|
2224 | - $registration_payment_data[$registration->ID()] = array( |
|
2225 | - 'paid' => $registration->pretty_paid(), |
|
2226 | - 'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()), |
|
2227 | - ); |
|
2228 | - } |
|
2229 | - } |
|
2230 | - } |
|
2231 | - |
|
2232 | - return $registration_payment_data; |
|
2233 | - } |
|
2234 | - |
|
2235 | - |
|
2236 | - /** |
|
2237 | - * _maybe_send_notifications |
|
2238 | - * determines whether or not the admin has indicated that notifications should be sent. |
|
2239 | - * If so, will toggle a filter switch for delivering registration notices. |
|
2240 | - * If passed an EE_Payment object, then it will trigger payment notifications instead. |
|
2241 | - * |
|
2242 | - * @access protected |
|
2243 | - * @param \EE_Payment | null $payment |
|
2244 | - */ |
|
2245 | - protected function _maybe_send_notifications($payment = null) |
|
2246 | - { |
|
2247 | - switch ($payment instanceof EE_Payment) { |
|
2248 | - // payment notifications |
|
2249 | - case true : |
|
2250 | - if ( |
|
2251 | - isset( |
|
2252 | - $this->_req_data['txn_payments'], |
|
2253 | - $this->_req_data['txn_payments']['send_notifications'] |
|
2254 | - ) && |
|
2255 | - filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN) |
|
2256 | - ) { |
|
2257 | - $this->_process_payment_notification($payment); |
|
2258 | - } |
|
2259 | - break; |
|
2260 | - // registration notifications |
|
2261 | - case false : |
|
2262 | - if ( |
|
2263 | - isset( |
|
2264 | - $this->_req_data['txn_reg_status_change'], |
|
2265 | - $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
2266 | - ) && |
|
2267 | - filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN) |
|
2268 | - ) { |
|
2269 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true'); |
|
2270 | - } |
|
2271 | - break; |
|
2272 | - } |
|
2273 | - } |
|
2274 | - |
|
2275 | - |
|
2276 | - /** |
|
2277 | - * _send_payment_reminder |
|
2278 | - * generates HTML for the View Transaction Details Admin page |
|
2279 | - * |
|
2280 | - * @access protected |
|
2281 | - * @return void |
|
2282 | - * @throws EE_Error |
|
2283 | - * @throws InvalidArgumentException |
|
2284 | - * @throws InvalidDataTypeException |
|
2285 | - * @throws InvalidInterfaceException |
|
2286 | - */ |
|
2287 | - protected function _send_payment_reminder() |
|
2288 | - { |
|
2289 | - $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
2290 | - $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
2291 | - $query_args = isset($this->_req_data['redirect_to']) ? array( |
|
2292 | - 'action' => $this->_req_data['redirect_to'], |
|
2293 | - 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
2294 | - ) : array(); |
|
2295 | - do_action( |
|
2296 | - 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', |
|
2297 | - $transaction |
|
2298 | - ); |
|
2299 | - $this->_redirect_after_action( |
|
2300 | - false, |
|
2301 | - esc_html__('payment reminder', 'event_espresso'), |
|
2302 | - esc_html__('sent', 'event_espresso'), |
|
2303 | - $query_args, |
|
2304 | - true |
|
2305 | - ); |
|
2306 | - } |
|
2307 | - |
|
2308 | - |
|
2309 | - /** |
|
2310 | - * get_transactions |
|
2311 | - * get transactions for given parameters (used by list table) |
|
2312 | - * |
|
2313 | - * @param int $perpage how many transactions displayed per page |
|
2314 | - * @param boolean $count return the count or objects |
|
2315 | - * @param string $view |
|
2316 | - * @return mixed int = count || array of transaction objects |
|
2317 | - * @throws EE_Error |
|
2318 | - * @throws InvalidArgumentException |
|
2319 | - * @throws InvalidDataTypeException |
|
2320 | - * @throws InvalidInterfaceException |
|
2321 | - */ |
|
2322 | - public function get_transactions($perpage, $count = false, $view = '') |
|
2323 | - { |
|
2324 | - |
|
2325 | - $TXN = EEM_Transaction::instance(); |
|
2326 | - |
|
2327 | - $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
2328 | - ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
2329 | - : date( |
|
2330 | - 'm/d/Y', |
|
2331 | - strtotime('-10 year') |
|
2332 | - ); |
|
2333 | - $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
2334 | - ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
2335 | - : date('m/d/Y'); |
|
2336 | - |
|
2337 | - //make sure our timestamps start and end right at the boundaries for each day |
|
2338 | - $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
2339 | - $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
2340 | - |
|
2341 | - |
|
2342 | - //convert to timestamps |
|
2343 | - $start_date = strtotime($start_date); |
|
2344 | - $end_date = strtotime($end_date); |
|
2345 | - |
|
2346 | - //makes sure start date is the lowest value and vice versa |
|
2347 | - $start_date = min($start_date, $end_date); |
|
2348 | - $end_date = max($start_date, $end_date); |
|
2349 | - |
|
2350 | - //convert to correct format for query |
|
2351 | - $start_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2352 | - 'TXN_timestamp', |
|
2353 | - date('Y-m-d H:i:s', $start_date), |
|
2354 | - 'Y-m-d H:i:s' |
|
2355 | - ); |
|
2356 | - $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2357 | - 'TXN_timestamp', |
|
2358 | - date('Y-m-d H:i:s', $end_date), |
|
2359 | - 'Y-m-d H:i:s' |
|
2360 | - ); |
|
2361 | - |
|
2362 | - |
|
2363 | - //set orderby |
|
2364 | - $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
2365 | - |
|
2366 | - switch ($this->_req_data['orderby']) { |
|
2367 | - case 'TXN_ID': |
|
2368 | - $orderby = 'TXN_ID'; |
|
2369 | - break; |
|
2370 | - case 'ATT_fname': |
|
2371 | - $orderby = 'Registration.Attendee.ATT_fname'; |
|
2372 | - break; |
|
2373 | - case 'event_name': |
|
2374 | - $orderby = 'Registration.Event.EVT_name'; |
|
2375 | - break; |
|
2376 | - default: //'TXN_timestamp' |
|
2377 | - $orderby = 'TXN_timestamp'; |
|
2378 | - } |
|
2379 | - |
|
2380 | - $sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
2381 | - $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
2382 | - $per_page = ! empty($perpage) ? $perpage : 10; |
|
2383 | - $per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page; |
|
2384 | - |
|
2385 | - $offset = ($current_page - 1) * $per_page; |
|
2386 | - $limit = array($offset, $per_page); |
|
2387 | - |
|
2388 | - $_where = array( |
|
2389 | - 'TXN_timestamp' => array('BETWEEN', array($start_date, $end_date)), |
|
2390 | - 'Registration.REG_count' => 1, |
|
2391 | - ); |
|
2392 | - |
|
2393 | - if (isset($this->_req_data['EVT_ID'])) { |
|
2394 | - $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID']; |
|
2395 | - } |
|
2396 | - |
|
2397 | - if (isset($this->_req_data['s'])) { |
|
2398 | - $search_string = '%' . $this->_req_data['s'] . '%'; |
|
2399 | - $_where['OR'] = array( |
|
2400 | - 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
|
2401 | - 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
|
2402 | - 'Registration.Event.EVT_short_desc' => array('LIKE', $search_string), |
|
2403 | - 'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
2404 | - 'Registration.Attendee.ATT_fname' => array('LIKE', $search_string), |
|
2405 | - 'Registration.Attendee.ATT_lname' => array('LIKE', $search_string), |
|
2406 | - 'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
2407 | - 'Registration.Attendee.ATT_email' => array('LIKE', $search_string), |
|
2408 | - 'Registration.Attendee.ATT_address' => array('LIKE', $search_string), |
|
2409 | - 'Registration.Attendee.ATT_address2' => array('LIKE', $search_string), |
|
2410 | - 'Registration.Attendee.ATT_city' => array('LIKE', $search_string), |
|
2411 | - 'Registration.REG_final_price' => array('LIKE', $search_string), |
|
2412 | - 'Registration.REG_code' => array('LIKE', $search_string), |
|
2413 | - 'Registration.REG_count' => array('LIKE', $search_string), |
|
2414 | - 'Registration.REG_group_size' => array('LIKE', $search_string), |
|
2415 | - 'Registration.Ticket.TKT_name' => array('LIKE', $search_string), |
|
2416 | - 'Registration.Ticket.TKT_description' => array('LIKE', $search_string), |
|
2417 | - 'Payment.PAY_source' => array('LIKE', $search_string), |
|
2418 | - 'Payment.Payment_Method.PMD_name' => array('LIKE', $search_string), |
|
2419 | - 'TXN_session_data' => array('LIKE', $search_string), |
|
2420 | - 'Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
2421 | - ); |
|
2422 | - } |
|
2423 | - |
|
2424 | - //failed transactions |
|
2425 | - $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
2426 | - || ($count && $view === 'failed'); |
|
2427 | - $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
2428 | - || ($count && $view === 'abandoned'); |
|
2429 | - |
|
2430 | - if ($failed) { |
|
2431 | - $_where['STS_ID'] = EEM_Transaction::failed_status_code; |
|
2432 | - } else if ($abandoned) { |
|
2433 | - $_where['STS_ID'] = EEM_Transaction::abandoned_status_code; |
|
2434 | - } else { |
|
2435 | - $_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code); |
|
2436 | - $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code); |
|
2437 | - } |
|
2438 | - |
|
2439 | - $query_params = array( |
|
2440 | - $_where, |
|
2441 | - 'order_by' => array($orderby => $sort), |
|
2442 | - 'limit' => $limit, |
|
2443 | - 'default_where_conditions' => EEM_Base::default_where_conditions_this_only, |
|
2444 | - ); |
|
2445 | - |
|
2446 | - $transactions = $count |
|
2447 | - ? $TXN->count(array($_where), 'TXN_ID', true) |
|
2448 | - : $TXN->get_all($query_params); |
|
2449 | - |
|
2450 | - return $transactions; |
|
2451 | - } |
|
19 | + /** |
|
20 | + * @var EE_Transaction |
|
21 | + */ |
|
22 | + private $_transaction; |
|
23 | + |
|
24 | + /** |
|
25 | + * @var EE_Session |
|
26 | + */ |
|
27 | + private $_session; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var array $_txn_status |
|
31 | + */ |
|
32 | + private static $_txn_status; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var array $_pay_status |
|
36 | + */ |
|
37 | + private static $_pay_status; |
|
38 | + |
|
39 | + /** |
|
40 | + * @var array $_existing_reg_payment_REG_IDs |
|
41 | + */ |
|
42 | + protected $_existing_reg_payment_REG_IDs = null; |
|
43 | + |
|
44 | + |
|
45 | + /** |
|
46 | + * @Constructor |
|
47 | + * @access public |
|
48 | + * @param bool $routing |
|
49 | + * @throws EE_Error |
|
50 | + * @throws InvalidArgumentException |
|
51 | + * @throws ReflectionException |
|
52 | + * @throws InvalidDataTypeException |
|
53 | + * @throws InvalidInterfaceException |
|
54 | + */ |
|
55 | + public function __construct($routing = true) |
|
56 | + { |
|
57 | + parent::__construct($routing); |
|
58 | + } |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * _init_page_props |
|
63 | + * |
|
64 | + * @return void |
|
65 | + */ |
|
66 | + protected function _init_page_props() |
|
67 | + { |
|
68 | + $this->page_slug = TXN_PG_SLUG; |
|
69 | + $this->page_label = esc_html__('Transactions', 'event_espresso'); |
|
70 | + $this->_admin_base_url = TXN_ADMIN_URL; |
|
71 | + $this->_admin_base_path = TXN_ADMIN; |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * _ajax_hooks |
|
77 | + * |
|
78 | + * @return void |
|
79 | + */ |
|
80 | + protected function _ajax_hooks() |
|
81 | + { |
|
82 | + add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds')); |
|
83 | + add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds')); |
|
84 | + add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment')); |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + /** |
|
89 | + * _define_page_props |
|
90 | + * |
|
91 | + * @return void |
|
92 | + */ |
|
93 | + protected function _define_page_props() |
|
94 | + { |
|
95 | + $this->_admin_page_title = $this->page_label; |
|
96 | + $this->_labels = array( |
|
97 | + 'buttons' => array( |
|
98 | + 'add' => esc_html__('Add New Transaction', 'event_espresso'), |
|
99 | + 'edit' => esc_html__('Edit Transaction', 'event_espresso'), |
|
100 | + 'delete' => esc_html__('Delete Transaction', 'event_espresso'), |
|
101 | + ), |
|
102 | + ); |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + /** |
|
107 | + * grab url requests and route them |
|
108 | + * |
|
109 | + * @access private |
|
110 | + * @return void |
|
111 | + * @throws EE_Error |
|
112 | + * @throws InvalidArgumentException |
|
113 | + * @throws InvalidDataTypeException |
|
114 | + * @throws InvalidInterfaceException |
|
115 | + */ |
|
116 | + public function _set_page_routes() |
|
117 | + { |
|
118 | + |
|
119 | + $this->_set_transaction_status_array(); |
|
120 | + |
|
121 | + $txn_id = ! empty($this->_req_data['TXN_ID']) |
|
122 | + && ! is_array($this->_req_data['TXN_ID']) |
|
123 | + ? $this->_req_data['TXN_ID'] |
|
124 | + : 0; |
|
125 | + |
|
126 | + $this->_page_routes = array( |
|
127 | + |
|
128 | + 'default' => array( |
|
129 | + 'func' => '_transactions_overview_list_table', |
|
130 | + 'capability' => 'ee_read_transactions', |
|
131 | + ), |
|
132 | + |
|
133 | + 'view_transaction' => array( |
|
134 | + 'func' => '_transaction_details', |
|
135 | + 'capability' => 'ee_read_transaction', |
|
136 | + 'obj_id' => $txn_id, |
|
137 | + ), |
|
138 | + |
|
139 | + 'send_payment_reminder' => array( |
|
140 | + 'func' => '_send_payment_reminder', |
|
141 | + 'noheader' => true, |
|
142 | + 'capability' => 'ee_send_message', |
|
143 | + ), |
|
144 | + |
|
145 | + 'espresso_apply_payment' => array( |
|
146 | + 'func' => 'apply_payments_or_refunds', |
|
147 | + 'noheader' => true, |
|
148 | + 'capability' => 'ee_edit_payments', |
|
149 | + ), |
|
150 | + |
|
151 | + 'espresso_apply_refund' => array( |
|
152 | + 'func' => 'apply_payments_or_refunds', |
|
153 | + 'noheader' => true, |
|
154 | + 'capability' => 'ee_edit_payments', |
|
155 | + ), |
|
156 | + |
|
157 | + 'espresso_delete_payment' => array( |
|
158 | + 'func' => 'delete_payment', |
|
159 | + 'noheader' => true, |
|
160 | + 'capability' => 'ee_delete_payments', |
|
161 | + ), |
|
162 | + |
|
163 | + ); |
|
164 | + } |
|
165 | + |
|
166 | + |
|
167 | + protected function _set_page_config() |
|
168 | + { |
|
169 | + $this->_page_config = array( |
|
170 | + 'default' => array( |
|
171 | + 'nav' => array( |
|
172 | + 'label' => esc_html__('Overview', 'event_espresso'), |
|
173 | + 'order' => 10, |
|
174 | + ), |
|
175 | + 'list_table' => 'EE_Admin_Transactions_List_Table', |
|
176 | + 'help_tabs' => array( |
|
177 | + 'transactions_overview_help_tab' => array( |
|
178 | + 'title' => esc_html__('Transactions Overview', 'event_espresso'), |
|
179 | + 'filename' => 'transactions_overview', |
|
180 | + ), |
|
181 | + 'transactions_overview_table_column_headings_help_tab' => array( |
|
182 | + 'title' => esc_html__('Transactions Table Column Headings', 'event_espresso'), |
|
183 | + 'filename' => 'transactions_overview_table_column_headings', |
|
184 | + ), |
|
185 | + 'transactions_overview_views_filters_help_tab' => array( |
|
186 | + 'title' => esc_html__('Transaction Views & Filters & Search', 'event_espresso'), |
|
187 | + 'filename' => 'transactions_overview_views_filters_search', |
|
188 | + ), |
|
189 | + ), |
|
190 | + 'help_tour' => array('Transactions_Overview_Help_Tour'), |
|
191 | + /** |
|
192 | + * commented out because currently we are not displaying tips for transaction list table status but this |
|
193 | + * may change in a later iteration so want to keep the code for then. |
|
194 | + */ |
|
195 | + //'qtips' => array( 'Transactions_List_Table_Tips' ), |
|
196 | + 'require_nonce' => false, |
|
197 | + ), |
|
198 | + 'view_transaction' => array( |
|
199 | + 'nav' => array( |
|
200 | + 'label' => esc_html__('View Transaction', 'event_espresso'), |
|
201 | + 'order' => 5, |
|
202 | + 'url' => isset($this->_req_data['TXN_ID']) |
|
203 | + ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url) |
|
204 | + : $this->_admin_base_url, |
|
205 | + 'persistent' => false, |
|
206 | + ), |
|
207 | + 'help_tabs' => array( |
|
208 | + 'transactions_view_transaction_help_tab' => array( |
|
209 | + 'title' => esc_html__('View Transaction', 'event_espresso'), |
|
210 | + 'filename' => 'transactions_view_transaction', |
|
211 | + ), |
|
212 | + 'transactions_view_transaction_transaction_details_table_help_tab' => array( |
|
213 | + 'title' => esc_html__('Transaction Details Table', 'event_espresso'), |
|
214 | + 'filename' => 'transactions_view_transaction_transaction_details_table', |
|
215 | + ), |
|
216 | + 'transactions_view_transaction_attendees_registered_help_tab' => array( |
|
217 | + 'title' => esc_html__('Attendees Registered', 'event_espresso'), |
|
218 | + 'filename' => 'transactions_view_transaction_attendees_registered', |
|
219 | + ), |
|
220 | + 'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array( |
|
221 | + 'title' => esc_html__('Primary Registrant & Billing Information', 'event_espresso'), |
|
222 | + 'filename' => 'transactions_view_transaction_primary_registrant_billing_information', |
|
223 | + ), |
|
224 | + ), |
|
225 | + 'qtips' => array('Transaction_Details_Tips'), |
|
226 | + 'help_tour' => array('Transaction_Details_Help_Tour'), |
|
227 | + 'metaboxes' => array('_transaction_details_metaboxes'), |
|
228 | + |
|
229 | + 'require_nonce' => false, |
|
230 | + ), |
|
231 | + ); |
|
232 | + } |
|
233 | + |
|
234 | + |
|
235 | + /** |
|
236 | + * The below methods aren't used by this class currently |
|
237 | + */ |
|
238 | + protected function _add_screen_options() |
|
239 | + { |
|
240 | + //noop |
|
241 | + } |
|
242 | + |
|
243 | + protected function _add_feature_pointers() |
|
244 | + { |
|
245 | + //noop |
|
246 | + } |
|
247 | + |
|
248 | + public function admin_init() |
|
249 | + { |
|
250 | + // IF a registration was JUST added via the admin... |
|
251 | + if (isset( |
|
252 | + $this->_req_data['redirect_from'], |
|
253 | + $this->_req_data['EVT_ID'], |
|
254 | + $this->_req_data['event_name'] |
|
255 | + )) { |
|
256 | + // then set a cookie so that we can block any attempts to use |
|
257 | + // the back button as a way to enter another registration. |
|
258 | + setcookie( |
|
259 | + 'ee_registration_added', |
|
260 | + $this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/' |
|
261 | + ); |
|
262 | + // and update the global |
|
263 | + $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID']; |
|
264 | + } |
|
265 | + EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__( |
|
266 | + 'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.', |
|
267 | + 'event_espresso' |
|
268 | + ); |
|
269 | + EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
270 | + 'An error occurred! Please refresh the page and try again.', |
|
271 | + 'event_espresso' |
|
272 | + ); |
|
273 | + EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status; |
|
274 | + EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status; |
|
275 | + EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso'); |
|
276 | + EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__( |
|
277 | + 'This transaction has been overpaid ! Payments Total', |
|
278 | + 'event_espresso' |
|
279 | + ); |
|
280 | + } |
|
281 | + |
|
282 | + public function admin_notices() |
|
283 | + { |
|
284 | + //noop |
|
285 | + } |
|
286 | + |
|
287 | + public function admin_footer_scripts() |
|
288 | + { |
|
289 | + //noop |
|
290 | + } |
|
291 | + |
|
292 | + |
|
293 | + /** |
|
294 | + * _set_transaction_status_array |
|
295 | + * sets list of transaction statuses |
|
296 | + * |
|
297 | + * @access private |
|
298 | + * @return void |
|
299 | + * @throws EE_Error |
|
300 | + * @throws InvalidArgumentException |
|
301 | + * @throws InvalidDataTypeException |
|
302 | + * @throws InvalidInterfaceException |
|
303 | + */ |
|
304 | + private function _set_transaction_status_array() |
|
305 | + { |
|
306 | + self::$_txn_status = EEM_Transaction::instance()->status_array(true); |
|
307 | + } |
|
308 | + |
|
309 | + |
|
310 | + /** |
|
311 | + * get_transaction_status_array |
|
312 | + * return the transaction status array for wp_list_table |
|
313 | + * |
|
314 | + * @access public |
|
315 | + * @return array |
|
316 | + */ |
|
317 | + public function get_transaction_status_array() |
|
318 | + { |
|
319 | + return self::$_txn_status; |
|
320 | + } |
|
321 | + |
|
322 | + |
|
323 | + /** |
|
324 | + * get list of payment statuses |
|
325 | + * |
|
326 | + * @access private |
|
327 | + * @return void |
|
328 | + * @throws EE_Error |
|
329 | + * @throws InvalidArgumentException |
|
330 | + * @throws InvalidDataTypeException |
|
331 | + * @throws InvalidInterfaceException |
|
332 | + */ |
|
333 | + private function _get_payment_status_array() |
|
334 | + { |
|
335 | + self::$_pay_status = EEM_Payment::instance()->status_array(true); |
|
336 | + $this->_template_args['payment_status'] = self::$_pay_status; |
|
337 | + |
|
338 | + } |
|
339 | + |
|
340 | + |
|
341 | + /** |
|
342 | + * _add_screen_options_default |
|
343 | + * |
|
344 | + * @access protected |
|
345 | + * @return void |
|
346 | + * @throws InvalidArgumentException |
|
347 | + * @throws InvalidDataTypeException |
|
348 | + * @throws InvalidInterfaceException |
|
349 | + */ |
|
350 | + protected function _add_screen_options_default() |
|
351 | + { |
|
352 | + $this->_per_page_screen_option(); |
|
353 | + } |
|
354 | + |
|
355 | + |
|
356 | + /** |
|
357 | + * load_scripts_styles |
|
358 | + * |
|
359 | + * @access public |
|
360 | + * @return void |
|
361 | + */ |
|
362 | + public function load_scripts_styles() |
|
363 | + { |
|
364 | + //enqueue style |
|
365 | + wp_register_style( |
|
366 | + 'espresso_txn', |
|
367 | + TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
368 | + array(), |
|
369 | + EVENT_ESPRESSO_VERSION |
|
370 | + ); |
|
371 | + wp_enqueue_style('espresso_txn'); |
|
372 | + //scripts |
|
373 | + wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array( |
|
374 | + 'ee_admin_js', |
|
375 | + 'ee-datepicker', |
|
376 | + 'jquery-ui-datepicker', |
|
377 | + 'jquery-ui-draggable', |
|
378 | + 'ee-dialog', |
|
379 | + 'ee-accounting', |
|
380 | + 'ee-serialize-full-array', |
|
381 | + ), EVENT_ESPRESSO_VERSION, true); |
|
382 | + wp_enqueue_script('espresso_txn'); |
|
383 | + } |
|
384 | + |
|
385 | + |
|
386 | + /** |
|
387 | + * load_scripts_styles_view_transaction |
|
388 | + * |
|
389 | + * @access public |
|
390 | + * @return void |
|
391 | + */ |
|
392 | + public function load_scripts_styles_view_transaction() |
|
393 | + { |
|
394 | + //styles |
|
395 | + wp_enqueue_style('espresso-ui-theme'); |
|
396 | + } |
|
397 | + |
|
398 | + |
|
399 | + /** |
|
400 | + * load_scripts_styles_default |
|
401 | + * |
|
402 | + * @access public |
|
403 | + * @return void |
|
404 | + */ |
|
405 | + public function load_scripts_styles_default() |
|
406 | + { |
|
407 | + //styles |
|
408 | + wp_enqueue_style('espresso-ui-theme'); |
|
409 | + } |
|
410 | + |
|
411 | + |
|
412 | + /** |
|
413 | + * _set_list_table_views_default |
|
414 | + * |
|
415 | + * @access protected |
|
416 | + * @return void |
|
417 | + */ |
|
418 | + protected function _set_list_table_views_default() |
|
419 | + { |
|
420 | + $this->_views = array( |
|
421 | + 'all' => array( |
|
422 | + 'slug' => 'all', |
|
423 | + 'label' => esc_html__('View All Transactions', 'event_espresso'), |
|
424 | + 'count' => 0, |
|
425 | + ), |
|
426 | + 'abandoned' => array( |
|
427 | + 'slug' => 'abandoned', |
|
428 | + 'label' => esc_html__('Abandoned Transactions', 'event_espresso'), |
|
429 | + 'count' => 0, |
|
430 | + ), |
|
431 | + 'failed' => array( |
|
432 | + 'slug' => 'failed', |
|
433 | + 'label' => esc_html__('Failed Transactions', 'event_espresso'), |
|
434 | + 'count' => 0, |
|
435 | + ), |
|
436 | + ); |
|
437 | + } |
|
438 | + |
|
439 | + |
|
440 | + /** |
|
441 | + * _set_transaction_object |
|
442 | + * This sets the _transaction property for the transaction details screen |
|
443 | + * |
|
444 | + * @access private |
|
445 | + * @return void |
|
446 | + * @throws EE_Error |
|
447 | + * @throws InvalidArgumentException |
|
448 | + * @throws RuntimeException |
|
449 | + * @throws InvalidDataTypeException |
|
450 | + * @throws InvalidInterfaceException |
|
451 | + * @throws ReflectionException |
|
452 | + */ |
|
453 | + private function _set_transaction_object() |
|
454 | + { |
|
455 | + if ($this->_transaction instanceof EE_Transaction) { |
|
456 | + return; |
|
457 | + } //get out we've already set the object |
|
458 | + |
|
459 | + $TXN_ID = ! empty($this->_req_data['TXN_ID']) |
|
460 | + ? absint($this->_req_data['TXN_ID']) |
|
461 | + : false; |
|
462 | + |
|
463 | + //get transaction object |
|
464 | + $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
465 | + $this->_session = $this->_transaction instanceof EE_Transaction |
|
466 | + ? $this->_transaction->get('TXN_session_data') |
|
467 | + : null; |
|
468 | + $this->_transaction->verify_abandoned_transaction_status(); |
|
469 | + |
|
470 | + if (! $this->_transaction instanceof EE_Transaction) { |
|
471 | + $error_msg = sprintf( |
|
472 | + esc_html__( |
|
473 | + 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
|
474 | + 'event_espresso' |
|
475 | + ), |
|
476 | + $TXN_ID |
|
477 | + ); |
|
478 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
479 | + } |
|
480 | + } |
|
481 | + |
|
482 | + |
|
483 | + /** |
|
484 | + * _transaction_legend_items |
|
485 | + * |
|
486 | + * @access protected |
|
487 | + * @return array |
|
488 | + * @throws EE_Error |
|
489 | + * @throws InvalidArgumentException |
|
490 | + * @throws ReflectionException |
|
491 | + * @throws InvalidDataTypeException |
|
492 | + * @throws InvalidInterfaceException |
|
493 | + */ |
|
494 | + protected function _transaction_legend_items() |
|
495 | + { |
|
496 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
497 | + $items = array(); |
|
498 | + |
|
499 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
500 | + 'ee_read_global_messages', |
|
501 | + 'view_filtered_messages' |
|
502 | + )) { |
|
503 | + $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
504 | + if (is_array($related_for_icon) |
|
505 | + && isset($related_for_icon['css_class'], $related_for_icon['label']) |
|
506 | + ) { |
|
507 | + $items['view_related_messages'] = array( |
|
508 | + 'class' => $related_for_icon['css_class'], |
|
509 | + 'desc' => $related_for_icon['label'], |
|
510 | + ); |
|
511 | + } |
|
512 | + } |
|
513 | + |
|
514 | + $items = apply_filters( |
|
515 | + 'FHEE__Transactions_Admin_Page___transaction_legend_items__items', |
|
516 | + array_merge( |
|
517 | + $items, |
|
518 | + array( |
|
519 | + 'view_details' => array( |
|
520 | + 'class' => 'dashicons dashicons-cart', |
|
521 | + 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
522 | + ), |
|
523 | + 'view_invoice' => array( |
|
524 | + 'class' => 'dashicons dashicons-media-spreadsheet', |
|
525 | + 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
526 | + ), |
|
527 | + 'view_receipt' => array( |
|
528 | + 'class' => 'dashicons dashicons-media-default', |
|
529 | + 'desc' => esc_html__('View Transaction Receipt', 'event_espresso'), |
|
530 | + ), |
|
531 | + 'view_registration' => array( |
|
532 | + 'class' => 'dashicons dashicons-clipboard', |
|
533 | + 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
534 | + ), |
|
535 | + 'payment_overview_link' => array( |
|
536 | + 'class' => 'dashicons dashicons-money', |
|
537 | + 'desc' => esc_html__('Make Payment on Frontend', 'event_espresso'), |
|
538 | + ), |
|
539 | + ) |
|
540 | + ) |
|
541 | + ); |
|
542 | + |
|
543 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
544 | + 'ee_send_message', |
|
545 | + 'espresso_transactions_send_payment_reminder' |
|
546 | + )) { |
|
547 | + if (EEH_MSG_Template::is_mt_active('payment_reminder')) { |
|
548 | + $items['send_payment_reminder'] = array( |
|
549 | + 'class' => 'dashicons dashicons-email-alt', |
|
550 | + 'desc' => esc_html__('Send Payment Reminder', 'event_espresso'), |
|
551 | + ); |
|
552 | + } else { |
|
553 | + $items['blank*'] = array( |
|
554 | + 'class' => '', |
|
555 | + 'desc' => '', |
|
556 | + ); |
|
557 | + } |
|
558 | + } else { |
|
559 | + $items['blank*'] = array( |
|
560 | + 'class' => '', |
|
561 | + 'desc' => '', |
|
562 | + ); |
|
563 | + } |
|
564 | + $more_items = apply_filters( |
|
565 | + 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
|
566 | + array( |
|
567 | + 'overpaid' => array( |
|
568 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
569 | + 'desc' => EEH_Template::pretty_status( |
|
570 | + EEM_Transaction::overpaid_status_code, |
|
571 | + false, |
|
572 | + 'sentence' |
|
573 | + ), |
|
574 | + ), |
|
575 | + 'complete' => array( |
|
576 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
577 | + 'desc' => EEH_Template::pretty_status( |
|
578 | + EEM_Transaction::complete_status_code, |
|
579 | + false, |
|
580 | + 'sentence' |
|
581 | + ), |
|
582 | + ), |
|
583 | + 'incomplete' => array( |
|
584 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
585 | + 'desc' => EEH_Template::pretty_status( |
|
586 | + EEM_Transaction::incomplete_status_code, |
|
587 | + false, |
|
588 | + 'sentence' |
|
589 | + ), |
|
590 | + ), |
|
591 | + 'abandoned' => array( |
|
592 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
593 | + 'desc' => EEH_Template::pretty_status( |
|
594 | + EEM_Transaction::abandoned_status_code, |
|
595 | + false, |
|
596 | + 'sentence' |
|
597 | + ), |
|
598 | + ), |
|
599 | + 'failed' => array( |
|
600 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
601 | + 'desc' => EEH_Template::pretty_status( |
|
602 | + EEM_Transaction::failed_status_code, |
|
603 | + false, |
|
604 | + 'sentence' |
|
605 | + ), |
|
606 | + ), |
|
607 | + ) |
|
608 | + ); |
|
609 | + |
|
610 | + return array_merge($items, $more_items); |
|
611 | + } |
|
612 | + |
|
613 | + |
|
614 | + /** |
|
615 | + * _transactions_overview_list_table |
|
616 | + * |
|
617 | + * @access protected |
|
618 | + * @return void |
|
619 | + * @throws DomainException |
|
620 | + * @throws EE_Error |
|
621 | + * @throws InvalidArgumentException |
|
622 | + * @throws InvalidDataTypeException |
|
623 | + * @throws InvalidInterfaceException |
|
624 | + * @throws ReflectionException |
|
625 | + */ |
|
626 | + protected function _transactions_overview_list_table() |
|
627 | + { |
|
628 | + $this->_admin_page_title = esc_html__('Transactions', 'event_espresso'); |
|
629 | + $event = isset($this->_req_data['EVT_ID']) |
|
630 | + ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID']) |
|
631 | + : null; |
|
632 | + $this->_template_args['admin_page_header'] = $event instanceof EE_Event |
|
633 | + ? sprintf( |
|
634 | + esc_html__( |
|
635 | + '%sViewing Transactions for the Event: %s%s', |
|
636 | + 'event_espresso' |
|
637 | + ), |
|
638 | + '<h3>', |
|
639 | + '<a href="' |
|
640 | + . EE_Admin_Page::add_query_args_and_nonce( |
|
641 | + array('action' => 'edit', 'post' => $event->ID()), |
|
642 | + EVENTS_ADMIN_URL |
|
643 | + ) |
|
644 | + . '" title="' |
|
645 | + . esc_attr__( |
|
646 | + 'Click to Edit event', |
|
647 | + 'event_espresso' |
|
648 | + ) |
|
649 | + . '">' . $event->get('EVT_name') . '</a>', |
|
650 | + '</h3>' |
|
651 | + ) |
|
652 | + : ''; |
|
653 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
654 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
655 | + } |
|
656 | + |
|
657 | + |
|
658 | + /** |
|
659 | + * _transaction_details |
|
660 | + * generates HTML for the View Transaction Details Admin page |
|
661 | + * |
|
662 | + * @access protected |
|
663 | + * @return void |
|
664 | + * @throws DomainException |
|
665 | + * @throws EE_Error |
|
666 | + * @throws InvalidArgumentException |
|
667 | + * @throws InvalidDataTypeException |
|
668 | + * @throws InvalidInterfaceException |
|
669 | + * @throws RuntimeException |
|
670 | + * @throws ReflectionException |
|
671 | + */ |
|
672 | + protected function _transaction_details() |
|
673 | + { |
|
674 | + do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction); |
|
675 | + |
|
676 | + $this->_set_transaction_status_array(); |
|
677 | + |
|
678 | + $this->_template_args = array(); |
|
679 | + $this->_template_args['transactions_page'] = $this->_wp_page_slug; |
|
680 | + |
|
681 | + $this->_set_transaction_object(); |
|
682 | + |
|
683 | + $primary_registration = $this->_transaction->primary_registration(); |
|
684 | + $attendee = $primary_registration instanceof EE_Registration |
|
685 | + ? $primary_registration->attendee() |
|
686 | + : null; |
|
687 | + |
|
688 | + $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID(); |
|
689 | + $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso'); |
|
690 | + |
|
691 | + $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp'); |
|
692 | + $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
693 | + |
|
694 | + $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')]; |
|
695 | + $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
|
696 | + $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID'); |
|
697 | + |
|
698 | + $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total'); |
|
699 | + $this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid'); |
|
700 | + |
|
701 | + $amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid'); |
|
702 | + $this->_template_args['amount_due'] = EEH_Template::format_currency( |
|
703 | + $amount_due, |
|
704 | + true |
|
705 | + ); |
|
706 | + if (EE_Registry::instance()->CFG->currency->sign_b4) { |
|
707 | + $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign |
|
708 | + . $this->_template_args['amount_due']; |
|
709 | + } else { |
|
710 | + $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign; |
|
711 | + } |
|
712 | + $this->_template_args['amount_due_class'] = ''; |
|
713 | + |
|
714 | + if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) { |
|
715 | + // paid in full |
|
716 | + $this->_template_args['amount_due'] = false; |
|
717 | + } elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) { |
|
718 | + // overpaid |
|
719 | + $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
720 | + } elseif ($this->_transaction->get('TXN_total') > 0 |
|
721 | + && $this->_transaction->get('TXN_paid') > 0 |
|
722 | + ) { |
|
723 | + // monies owing |
|
724 | + $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn'; |
|
725 | + } elseif ($this->_transaction->get('TXN_total') > 0 |
|
726 | + && $this->_transaction->get('TXN_paid') == 0 |
|
727 | + ) { |
|
728 | + // no payments made yet |
|
729 | + $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn'; |
|
730 | + } elseif ($this->_transaction->get('TXN_total') == 0) { |
|
731 | + // free event |
|
732 | + $this->_template_args['amount_due'] = false; |
|
733 | + } |
|
734 | + |
|
735 | + $payment_method = $this->_transaction->payment_method(); |
|
736 | + |
|
737 | + $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method |
|
738 | + ? $payment_method->admin_name() |
|
739 | + : esc_html__('Unknown', 'event_espresso'); |
|
740 | + |
|
741 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
742 | + // link back to overview |
|
743 | + $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER']) |
|
744 | + ? $_SERVER['HTTP_REFERER'] |
|
745 | + : TXN_ADMIN_URL; |
|
746 | + |
|
747 | + |
|
748 | + // next link |
|
749 | + $next_txn = $this->_transaction->next( |
|
750 | + null, |
|
751 | + array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
752 | + 'TXN_ID' |
|
753 | + ); |
|
754 | + $this->_template_args['next_transaction'] = $next_txn |
|
755 | + ? $this->_next_link( |
|
756 | + EE_Admin_Page::add_query_args_and_nonce( |
|
757 | + array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']), |
|
758 | + TXN_ADMIN_URL |
|
759 | + ), |
|
760 | + 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
761 | + ) |
|
762 | + : ''; |
|
763 | + // previous link |
|
764 | + $previous_txn = $this->_transaction->previous( |
|
765 | + null, |
|
766 | + array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
|
767 | + 'TXN_ID' |
|
768 | + ); |
|
769 | + $this->_template_args['previous_transaction'] = $previous_txn |
|
770 | + ? $this->_previous_link( |
|
771 | + EE_Admin_Page::add_query_args_and_nonce( |
|
772 | + array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']), |
|
773 | + TXN_ADMIN_URL |
|
774 | + ), |
|
775 | + 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
776 | + ) |
|
777 | + : ''; |
|
778 | + |
|
779 | + // were we just redirected here after adding a new registration ??? |
|
780 | + if (isset( |
|
781 | + $this->_req_data['redirect_from'], |
|
782 | + $this->_req_data['EVT_ID'], |
|
783 | + $this->_req_data['event_name'] |
|
784 | + )) { |
|
785 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
786 | + 'ee_edit_registrations', |
|
787 | + 'espresso_registrations_new_registration', |
|
788 | + $this->_req_data['EVT_ID'] |
|
789 | + )) { |
|
790 | + $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="'; |
|
791 | + $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce( |
|
792 | + array( |
|
793 | + 'page' => 'espresso_registrations', |
|
794 | + 'action' => 'new_registration', |
|
795 | + 'return' => 'default', |
|
796 | + 'TXN_ID' => $this->_transaction->ID(), |
|
797 | + 'event_id' => $this->_req_data['EVT_ID'], |
|
798 | + ), |
|
799 | + REG_ADMIN_URL |
|
800 | + ); |
|
801 | + $this->_admin_page_title .= '">'; |
|
802 | + |
|
803 | + $this->_admin_page_title .= sprintf( |
|
804 | + esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'), |
|
805 | + htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8') |
|
806 | + ); |
|
807 | + $this->_admin_page_title .= '</a>'; |
|
808 | + } |
|
809 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
810 | + } |
|
811 | + // grab messages at the last second |
|
812 | + $this->_template_args['notices'] = EE_Error::get_notices(); |
|
813 | + // path to template |
|
814 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
815 | + $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
816 | + $template_path, |
|
817 | + $this->_template_args, |
|
818 | + true |
|
819 | + ); |
|
820 | + |
|
821 | + // the details template wrapper |
|
822 | + $this->display_admin_page_with_sidebar(); |
|
823 | + |
|
824 | + } |
|
825 | + |
|
826 | + |
|
827 | + /** |
|
828 | + * _transaction_details_metaboxes |
|
829 | + * |
|
830 | + * @access protected |
|
831 | + * @return void |
|
832 | + * @throws EE_Error |
|
833 | + * @throws InvalidArgumentException |
|
834 | + * @throws InvalidDataTypeException |
|
835 | + * @throws InvalidInterfaceException |
|
836 | + * @throws RuntimeException |
|
837 | + * @throws ReflectionException |
|
838 | + */ |
|
839 | + protected function _transaction_details_metaboxes() |
|
840 | + { |
|
841 | + |
|
842 | + $this->_set_transaction_object(); |
|
843 | + |
|
844 | + add_meta_box( |
|
845 | + 'edit-txn-details-mbox', |
|
846 | + esc_html__('Transaction Details', 'event_espresso'), |
|
847 | + array($this, 'txn_details_meta_box'), |
|
848 | + $this->_wp_page_slug, |
|
849 | + 'normal', |
|
850 | + 'high' |
|
851 | + ); |
|
852 | + add_meta_box( |
|
853 | + 'edit-txn-attendees-mbox', |
|
854 | + esc_html__('Attendees Registered in this Transaction', 'event_espresso'), |
|
855 | + array($this, 'txn_attendees_meta_box'), |
|
856 | + $this->_wp_page_slug, |
|
857 | + 'normal', |
|
858 | + 'high', |
|
859 | + array('TXN_ID' => $this->_transaction->ID()) |
|
860 | + ); |
|
861 | + add_meta_box( |
|
862 | + 'edit-txn-registrant-mbox', |
|
863 | + esc_html__('Primary Contact', 'event_espresso'), |
|
864 | + array($this, 'txn_registrant_side_meta_box'), |
|
865 | + $this->_wp_page_slug, |
|
866 | + 'side', |
|
867 | + 'high' |
|
868 | + ); |
|
869 | + add_meta_box( |
|
870 | + 'edit-txn-billing-info-mbox', |
|
871 | + esc_html__('Billing Information', 'event_espresso'), |
|
872 | + array($this, 'txn_billing_info_side_meta_box'), |
|
873 | + $this->_wp_page_slug, |
|
874 | + 'side', |
|
875 | + 'high' |
|
876 | + ); |
|
877 | + } |
|
878 | + |
|
879 | + |
|
880 | + /** |
|
881 | + * Callback for transaction actions metabox. |
|
882 | + * |
|
883 | + * @param EE_Transaction|null $transaction |
|
884 | + * @throws DomainException |
|
885 | + * @throws EE_Error |
|
886 | + * @throws InvalidArgumentException |
|
887 | + * @throws InvalidDataTypeException |
|
888 | + * @throws InvalidInterfaceException |
|
889 | + * @throws ReflectionException |
|
890 | + * @throws RuntimeException |
|
891 | + */ |
|
892 | + public function getActionButtons(EE_Transaction $transaction = null) |
|
893 | + { |
|
894 | + $content = ''; |
|
895 | + $actions = array(); |
|
896 | + if (! $transaction instanceof EE_Transaction) { |
|
897 | + return $content; |
|
898 | + } |
|
899 | + /** @var EE_Registration $primary_registration */ |
|
900 | + $primary_registration = $transaction->primary_registration(); |
|
901 | + $attendee = $primary_registration instanceof EE_Registration |
|
902 | + ? $primary_registration->attendee() |
|
903 | + : null; |
|
904 | + |
|
905 | + if ($attendee instanceof EE_Attendee |
|
906 | + && EE_Registry::instance()->CAP->current_user_can( |
|
907 | + 'ee_send_message', |
|
908 | + 'espresso_transactions_send_payment_reminder' |
|
909 | + ) |
|
910 | + ) { |
|
911 | + $actions['payment_reminder'] = |
|
912 | + EEH_MSG_Template::is_mt_active('payment_reminder') |
|
913 | + && $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code |
|
914 | + && $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code |
|
915 | + ? EEH_Template::get_button_or_link( |
|
916 | + EE_Admin_Page::add_query_args_and_nonce( |
|
917 | + array( |
|
918 | + 'action' => 'send_payment_reminder', |
|
919 | + 'TXN_ID' => $this->_transaction->ID(), |
|
920 | + 'redirect_to' => 'view_transaction', |
|
921 | + ), |
|
922 | + TXN_ADMIN_URL |
|
923 | + ), |
|
924 | + esc_html__(' Send Payment Reminder', 'event_espresso'), |
|
925 | + 'button secondary-button', |
|
926 | + 'dashicons dashicons-email-alt' |
|
927 | + ) |
|
928 | + : ''; |
|
929 | + } |
|
930 | + |
|
931 | + if ($primary_registration instanceof EE_Registration |
|
932 | + && EEH_MSG_Template::is_mt_active('receipt') |
|
933 | + ) { |
|
934 | + $actions['receipt'] = EEH_Template::get_button_or_link( |
|
935 | + $primary_registration->receipt_url(), |
|
936 | + esc_html__('View Receipt', 'event_espresso'), |
|
937 | + 'button secondary-button', |
|
938 | + 'dashicons dashicons-media-default' |
|
939 | + ); |
|
940 | + } |
|
941 | + |
|
942 | + if ($primary_registration instanceof EE_Registration |
|
943 | + && EEH_MSG_Template::is_mt_active('invoice') |
|
944 | + ) { |
|
945 | + $actions['invoice'] = EEH_Template::get_button_or_link( |
|
946 | + $primary_registration->invoice_url(), |
|
947 | + esc_html__('View Invoice', 'event_espresso'), |
|
948 | + 'button secondary-button', |
|
949 | + 'dashicons dashicons-media-spreadsheet' |
|
950 | + ); |
|
951 | + } |
|
952 | + $actions = array_filter( |
|
953 | + apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction) |
|
954 | + ); |
|
955 | + if ($actions) { |
|
956 | + $content = '<ul>'; |
|
957 | + $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
958 | + $content .= '</uL>'; |
|
959 | + } |
|
960 | + return $content; |
|
961 | + } |
|
962 | + |
|
963 | + |
|
964 | + /** |
|
965 | + * txn_details_meta_box |
|
966 | + * generates HTML for the Transaction main meta box |
|
967 | + * |
|
968 | + * @return void |
|
969 | + * @throws DomainException |
|
970 | + * @throws EE_Error |
|
971 | + * @throws InvalidArgumentException |
|
972 | + * @throws InvalidDataTypeException |
|
973 | + * @throws InvalidInterfaceException |
|
974 | + * @throws RuntimeException |
|
975 | + * @throws ReflectionException |
|
976 | + */ |
|
977 | + public function txn_details_meta_box() |
|
978 | + { |
|
979 | + $this->_set_transaction_object(); |
|
980 | + $this->_template_args['TXN_ID'] = $this->_transaction->ID(); |
|
981 | + $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration |
|
982 | + ? $this->_transaction->primary_registration()->attendee() |
|
983 | + : null; |
|
984 | + $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
985 | + 'ee_edit_payments', |
|
986 | + 'apply_payment_or_refund_from_registration_details' |
|
987 | + ); |
|
988 | + $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can( |
|
989 | + 'ee_delete_payments', |
|
990 | + 'delete_payment_from_registration_details' |
|
991 | + ); |
|
992 | + |
|
993 | + //get line table |
|
994 | + EEH_Autoloader::register_line_item_display_autoloaders(); |
|
995 | + $Line_Item_Display = new EE_Line_Item_Display( |
|
996 | + 'admin_table', |
|
997 | + 'EE_Admin_Table_Line_Item_Display_Strategy' |
|
998 | + ); |
|
999 | + $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item( |
|
1000 | + $this->_transaction->total_line_item() |
|
1001 | + ); |
|
1002 | + $this->_template_args['REG_code'] = $this->_transaction->get_first_related('Registration') |
|
1003 | + ->get('REG_code'); |
|
1004 | + |
|
1005 | + // process taxes |
|
1006 | + $taxes = $this->_transaction->get_many_related( |
|
1007 | + 'Line_Item', |
|
1008 | + array(array('LIN_type' => EEM_Line_Item::type_tax)) |
|
1009 | + ); |
|
1010 | + $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false; |
|
1011 | + |
|
1012 | + $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
1013 | + $this->_transaction->get('TXN_total'), |
|
1014 | + false, |
|
1015 | + false |
|
1016 | + ); |
|
1017 | + $this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total'); |
|
1018 | + $this->_template_args['TXN_status'] = $this->_transaction->get('STS_ID'); |
|
1019 | + |
|
1020 | + // process payment details |
|
1021 | + $payments = $this->_transaction->get_many_related('Payment'); |
|
1022 | + if (! empty($payments)) { |
|
1023 | + $this->_template_args['payments'] = $payments; |
|
1024 | + $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
|
1025 | + } else { |
|
1026 | + $this->_template_args['payments'] = false; |
|
1027 | + $this->_template_args['existing_reg_payments'] = array(); |
|
1028 | + } |
|
1029 | + |
|
1030 | + $this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL); |
|
1031 | + $this->_template_args['delete_payment_url'] = add_query_arg( |
|
1032 | + array('action' => 'espresso_delete_payment'), |
|
1033 | + TXN_ADMIN_URL |
|
1034 | + ); |
|
1035 | + |
|
1036 | + if (isset($txn_details['invoice_number'])) { |
|
1037 | + $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code']; |
|
1038 | + $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__( |
|
1039 | + 'Invoice Number', |
|
1040 | + 'event_espresso' |
|
1041 | + ); |
|
1042 | + } |
|
1043 | + |
|
1044 | + $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction |
|
1045 | + ->get_first_related('Registration') |
|
1046 | + ->get('REG_session'); |
|
1047 | + $this->_template_args['txn_details']['registration_session']['label'] = esc_html__( |
|
1048 | + 'Registration Session', |
|
1049 | + 'event_espresso' |
|
1050 | + ); |
|
1051 | + |
|
1052 | + $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address']) |
|
1053 | + ? $this->_session['ip_address'] |
|
1054 | + : ''; |
|
1055 | + $this->_template_args['txn_details']['ip_address']['label'] = esc_html__( |
|
1056 | + 'Transaction placed from IP', |
|
1057 | + 'event_espresso' |
|
1058 | + ); |
|
1059 | + |
|
1060 | + $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent']) |
|
1061 | + ? $this->_session['user_agent'] |
|
1062 | + : ''; |
|
1063 | + $this->_template_args['txn_details']['user_agent']['label'] = esc_html__( |
|
1064 | + 'Registrant User Agent', |
|
1065 | + 'event_espresso' |
|
1066 | + ); |
|
1067 | + |
|
1068 | + $reg_steps = '<ul>'; |
|
1069 | + foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) { |
|
1070 | + if ($reg_step_status === true) { |
|
1071 | + $reg_steps .= '<li style="color:#70cc50">' |
|
1072 | + . sprintf( |
|
1073 | + esc_html__('%1$s : Completed', 'event_espresso'), |
|
1074 | + ucwords(str_replace('_', ' ', $reg_step)) |
|
1075 | + ) |
|
1076 | + . '</li>'; |
|
1077 | + } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) { |
|
1078 | + $reg_steps .= '<li style="color:#2EA2CC">' |
|
1079 | + . sprintf( |
|
1080 | + esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
|
1081 | + ucwords(str_replace('_', ' ', $reg_step)), |
|
1082 | + date( |
|
1083 | + get_option('date_format') . ' ' . get_option('time_format'), |
|
1084 | + ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)) |
|
1085 | + ) |
|
1086 | + ) |
|
1087 | + . '</li>'; |
|
1088 | + } else { |
|
1089 | + $reg_steps .= '<li style="color:#E76700">' |
|
1090 | + . sprintf( |
|
1091 | + esc_html__('%1$s : Never Initiated', 'event_espresso'), |
|
1092 | + ucwords(str_replace('_', ' ', $reg_step)) |
|
1093 | + ) |
|
1094 | + . '</li>'; |
|
1095 | + } |
|
1096 | + } |
|
1097 | + $reg_steps .= '</ul>'; |
|
1098 | + $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps; |
|
1099 | + $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__( |
|
1100 | + 'Registration Step Progress', |
|
1101 | + 'event_espresso' |
|
1102 | + ); |
|
1103 | + |
|
1104 | + |
|
1105 | + $this->_get_registrations_to_apply_payment_to(); |
|
1106 | + $this->_get_payment_methods($payments); |
|
1107 | + $this->_get_payment_status_array(); |
|
1108 | + $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction. |
|
1109 | + |
|
1110 | + $this->_template_args['transaction_form_url'] = add_query_arg(array( |
|
1111 | + 'action' => 'edit_transaction', |
|
1112 | + 'process' => 'transaction', |
|
1113 | + ), TXN_ADMIN_URL); |
|
1114 | + $this->_template_args['apply_payment_form_url'] = add_query_arg(array( |
|
1115 | + 'page' => 'espresso_transactions', |
|
1116 | + 'action' => 'espresso_apply_payment', |
|
1117 | + ), WP_AJAX_URL); |
|
1118 | + $this->_template_args['delete_payment_form_url'] = add_query_arg(array( |
|
1119 | + 'page' => 'espresso_transactions', |
|
1120 | + 'action' => 'espresso_delete_payment', |
|
1121 | + ), WP_AJAX_URL); |
|
1122 | + |
|
1123 | + $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction); |
|
1124 | + |
|
1125 | + // 'espresso_delete_payment_nonce' |
|
1126 | + |
|
1127 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
1128 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
1129 | + } |
|
1130 | + |
|
1131 | + |
|
1132 | + /** |
|
1133 | + * _get_registration_payment_IDs |
|
1134 | + * generates an array of Payment IDs and their corresponding Registration IDs |
|
1135 | + * |
|
1136 | + * @access protected |
|
1137 | + * @param EE_Payment[] $payments |
|
1138 | + * @return array |
|
1139 | + * @throws EE_Error |
|
1140 | + * @throws InvalidArgumentException |
|
1141 | + * @throws InvalidDataTypeException |
|
1142 | + * @throws InvalidInterfaceException |
|
1143 | + * @throws ReflectionException |
|
1144 | + */ |
|
1145 | + protected function _get_registration_payment_IDs($payments = array()) |
|
1146 | + { |
|
1147 | + $existing_reg_payments = array(); |
|
1148 | + // get all reg payments for these payments |
|
1149 | + $reg_payments = EEM_Registration_Payment::instance()->get_all(array( |
|
1150 | + array( |
|
1151 | + 'PAY_ID' => array( |
|
1152 | + 'IN', |
|
1153 | + array_keys($payments), |
|
1154 | + ), |
|
1155 | + ), |
|
1156 | + )); |
|
1157 | + if (! empty($reg_payments)) { |
|
1158 | + foreach ($payments as $payment) { |
|
1159 | + if (! $payment instanceof EE_Payment) { |
|
1160 | + continue; |
|
1161 | + } elseif (! isset($existing_reg_payments[$payment->ID()])) { |
|
1162 | + $existing_reg_payments[$payment->ID()] = array(); |
|
1163 | + } |
|
1164 | + foreach ($reg_payments as $reg_payment) { |
|
1165 | + if ($reg_payment instanceof EE_Registration_Payment |
|
1166 | + && $reg_payment->payment_ID() === $payment->ID() |
|
1167 | + ) { |
|
1168 | + $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID(); |
|
1169 | + } |
|
1170 | + } |
|
1171 | + } |
|
1172 | + } |
|
1173 | + |
|
1174 | + return $existing_reg_payments; |
|
1175 | + } |
|
1176 | + |
|
1177 | + |
|
1178 | + /** |
|
1179 | + * _get_registrations_to_apply_payment_to |
|
1180 | + * generates HTML for displaying a series of checkboxes in the admin payment modal window |
|
1181 | + * which allows the admin to only apply the payment to the specific registrations |
|
1182 | + * |
|
1183 | + * @access protected |
|
1184 | + * @return void |
|
1185 | + * @throws \EE_Error |
|
1186 | + */ |
|
1187 | + protected function _get_registrations_to_apply_payment_to() |
|
1188 | + { |
|
1189 | + // we want any registration with an active status (ie: not deleted or cancelled) |
|
1190 | + $query_params = array( |
|
1191 | + array( |
|
1192 | + 'STS_ID' => array( |
|
1193 | + 'IN', |
|
1194 | + array( |
|
1195 | + EEM_Registration::status_id_approved, |
|
1196 | + EEM_Registration::status_id_pending_payment, |
|
1197 | + EEM_Registration::status_id_not_approved, |
|
1198 | + ), |
|
1199 | + ), |
|
1200 | + ), |
|
1201 | + ); |
|
1202 | + $registrations_to_apply_payment_to = EEH_HTML::br() |
|
1203 | + . EEH_HTML::div( |
|
1204 | + '', |
|
1205 | + 'txn-admin-apply-payment-to-registrations-dv', |
|
1206 | + '', |
|
1207 | + 'clear: both; margin: 1.5em 0 0; display: none;' |
|
1208 | + ); |
|
1209 | + $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
1210 | + $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
|
1211 | + $registrations_to_apply_payment_to .= EEH_HTML::thead( |
|
1212 | + EEH_HTML::tr( |
|
1213 | + EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
1214 | + EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
1215 | + EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
1216 | + EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
1217 | + EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1218 | + EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1219 | + EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
|
1220 | + ) |
|
1221 | + ); |
|
1222 | + $registrations_to_apply_payment_to .= EEH_HTML::tbody(); |
|
1223 | + // get registrations for TXN |
|
1224 | + $registrations = $this->_transaction->registrations($query_params); |
|
1225 | + $existing_reg_payments = $this->_template_args['existing_reg_payments']; |
|
1226 | + foreach ($registrations as $registration) { |
|
1227 | + if ($registration instanceof EE_Registration) { |
|
1228 | + $attendee_name = $registration->attendee() instanceof EE_Attendee |
|
1229 | + ? $registration->attendee()->full_name() |
|
1230 | + : esc_html__('Unknown Attendee', 'event_espresso'); |
|
1231 | + $owing = $registration->final_price() - $registration->paid(); |
|
1232 | + $taxable = $registration->ticket()->taxable() |
|
1233 | + ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
1234 | + : ''; |
|
1235 | + $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments) |
|
1236 | + ? ' checked="checked"' |
|
1237 | + : ''; |
|
1238 | + $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
1239 | + $registrations_to_apply_payment_to .= EEH_HTML::tr( |
|
1240 | + EEH_HTML::td($registration->ID()) . |
|
1241 | + EEH_HTML::td($attendee_name) . |
|
1242 | + EEH_HTML::td( |
|
1243 | + $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
1244 | + ) . |
|
1245 | + EEH_HTML::td($registration->event_name()) . |
|
1246 | + EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1247 | + EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1248 | + EEH_HTML::td( |
|
1249 | + '<input type="checkbox" value="' . $registration->ID() |
|
1250 | + . '" name="txn_admin_payment[registrations]"' |
|
1251 | + . $checked . $disabled . '>', |
|
1252 | + '', |
|
1253 | + 'jst-cntr' |
|
1254 | + ), |
|
1255 | + 'apply-payment-registration-row-' . $registration->ID() |
|
1256 | + ); |
|
1257 | + } |
|
1258 | + } |
|
1259 | + $registrations_to_apply_payment_to .= EEH_HTML::tbodyx(); |
|
1260 | + $registrations_to_apply_payment_to .= EEH_HTML::tablex(); |
|
1261 | + $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1262 | + $registrations_to_apply_payment_to .= EEH_HTML::p( |
|
1263 | + esc_html__( |
|
1264 | + 'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.', |
|
1265 | + 'event_espresso' |
|
1266 | + ), |
|
1267 | + '', |
|
1268 | + 'clear description' |
|
1269 | + ); |
|
1270 | + $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1271 | + $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to; |
|
1272 | + } |
|
1273 | + |
|
1274 | + |
|
1275 | + /** |
|
1276 | + * _get_reg_status_selection |
|
1277 | + * |
|
1278 | + * @todo this will need to be adjusted either once MER comes along OR we move default reg status to tickets |
|
1279 | + * instead of events. |
|
1280 | + * @access protected |
|
1281 | + * @return void |
|
1282 | + * @throws EE_Error |
|
1283 | + */ |
|
1284 | + protected function _get_reg_status_selection() |
|
1285 | + { |
|
1286 | + //first get all possible statuses |
|
1287 | + $statuses = EEM_Registration::reg_status_array(array(), true); |
|
1288 | + //let's add a "don't change" option. |
|
1289 | + $status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso'); |
|
1290 | + $status_array = array_merge($status_array, $statuses); |
|
1291 | + $this->_template_args['status_change_select'] = EEH_Form_Fields::select_input( |
|
1292 | + 'txn_reg_status_change[reg_status]', |
|
1293 | + $status_array, |
|
1294 | + 'NAN', |
|
1295 | + 'id="txn-admin-payment-reg-status-inp"', |
|
1296 | + 'txn-reg-status-change-reg-status' |
|
1297 | + ); |
|
1298 | + $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input( |
|
1299 | + 'delete_txn_reg_status_change[reg_status]', |
|
1300 | + $status_array, |
|
1301 | + 'NAN', |
|
1302 | + 'delete-txn-admin-payment-reg-status-inp', |
|
1303 | + 'delete-txn-reg-status-change-reg-status' |
|
1304 | + ); |
|
1305 | + } |
|
1306 | + |
|
1307 | + |
|
1308 | + /** |
|
1309 | + * _get_payment_methods |
|
1310 | + * Gets all the payment methods available generally, or the ones that are already |
|
1311 | + * selected on these payments (in case their payment methods are no longer active). |
|
1312 | + * Has the side-effect of updating the template args' payment_methods item |
|
1313 | + * |
|
1314 | + * @access private |
|
1315 | + * @param EE_Payment[] to show on this page |
|
1316 | + * @return void |
|
1317 | + * @throws EE_Error |
|
1318 | + * @throws InvalidArgumentException |
|
1319 | + * @throws InvalidDataTypeException |
|
1320 | + * @throws InvalidInterfaceException |
|
1321 | + * @throws ReflectionException |
|
1322 | + */ |
|
1323 | + private function _get_payment_methods($payments = array()) |
|
1324 | + { |
|
1325 | + $payment_methods_of_payments = array(); |
|
1326 | + foreach ($payments as $payment) { |
|
1327 | + if ($payment instanceof EE_Payment) { |
|
1328 | + $payment_methods_of_payments[] = $payment->get('PMD_ID'); |
|
1329 | + } |
|
1330 | + } |
|
1331 | + if ($payment_methods_of_payments) { |
|
1332 | + $query_args = array( |
|
1333 | + array( |
|
1334 | + 'OR*payment_method_for_payment' => array( |
|
1335 | + 'PMD_ID' => array('IN', $payment_methods_of_payments), |
|
1336 | + 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
1337 | + ), |
|
1338 | + ), |
|
1339 | + ); |
|
1340 | + } else { |
|
1341 | + $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
1342 | + } |
|
1343 | + $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
|
1344 | + } |
|
1345 | + |
|
1346 | + |
|
1347 | + /** |
|
1348 | + * txn_attendees_meta_box |
|
1349 | + * generates HTML for the Attendees Transaction main meta box |
|
1350 | + * |
|
1351 | + * @access public |
|
1352 | + * @param WP_Post $post |
|
1353 | + * @param array $metabox |
|
1354 | + * @return void |
|
1355 | + * @throws DomainException |
|
1356 | + * @throws EE_Error |
|
1357 | + */ |
|
1358 | + public function txn_attendees_meta_box($post, $metabox = array('args' => array())) |
|
1359 | + { |
|
1360 | + |
|
1361 | + /** @noinspection NonSecureExtractUsageInspection */ |
|
1362 | + extract($metabox['args']); |
|
1363 | + $this->_template_args['post'] = $post; |
|
1364 | + $this->_template_args['event_attendees'] = array(); |
|
1365 | + // process items in cart |
|
1366 | + $line_items = $this->_transaction->get_many_related( |
|
1367 | + 'Line_Item', |
|
1368 | + array(array('LIN_type' => 'line-item')) |
|
1369 | + ); |
|
1370 | + if (! empty($line_items)) { |
|
1371 | + foreach ($line_items as $item) { |
|
1372 | + if ($item instanceof EE_Line_Item) { |
|
1373 | + switch ($item->OBJ_type()) { |
|
1374 | + case 'Event': |
|
1375 | + break; |
|
1376 | + case 'Ticket': |
|
1377 | + $ticket = $item->ticket(); |
|
1378 | + //right now we're only handling tickets here. |
|
1379 | + //Cause its expected that only tickets will have attendees right? |
|
1380 | + if (! $ticket instanceof EE_Ticket) { |
|
1381 | + continue; |
|
1382 | + } |
|
1383 | + try { |
|
1384 | + $event_name = $ticket->get_event_name(); |
|
1385 | + } catch (Exception $e) { |
|
1386 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1387 | + $event_name = esc_html__('Unknown Event', 'event_espresso'); |
|
1388 | + } |
|
1389 | + $event_name .= ' - ' . $item->get('LIN_name'); |
|
1390 | + $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price')); |
|
1391 | + // now get all of the registrations for this transaction that use this ticket |
|
1392 | + $registrations = $ticket->get_many_related( |
|
1393 | + 'Registration', |
|
1394 | + array(array('TXN_ID' => $this->_transaction->ID())) |
|
1395 | + ); |
|
1396 | + foreach ($registrations as $registration) { |
|
1397 | + if (! $registration instanceof EE_Registration) { |
|
1398 | + continue; |
|
1399 | + } |
|
1400 | + $this->_template_args['event_attendees'][$registration->ID()]['STS_ID'] |
|
1401 | + = $registration->status_ID(); |
|
1402 | + $this->_template_args['event_attendees'][$registration->ID()]['att_num'] |
|
1403 | + = $registration->count(); |
|
1404 | + $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name'] |
|
1405 | + = $event_name; |
|
1406 | + $this->_template_args['event_attendees'][$registration->ID()]['ticket_price'] |
|
1407 | + = $ticket_price; |
|
1408 | + // attendee info |
|
1409 | + $attendee = $registration->get_first_related('Attendee'); |
|
1410 | + if ($attendee instanceof EE_Attendee) { |
|
1411 | + $this->_template_args['event_attendees'][$registration->ID()]['att_id'] |
|
1412 | + = $attendee->ID(); |
|
1413 | + $this->_template_args['event_attendees'][$registration->ID()]['attendee'] |
|
1414 | + = $attendee->full_name(); |
|
1415 | + $this->_template_args['event_attendees'][$registration->ID()]['email'] |
|
1416 | + = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
1417 | + . esc_html__( |
|
1418 | + ' Event', |
|
1419 | + 'event_espresso' |
|
1420 | + ) |
|
1421 | + . '">' . $attendee->email() . '</a>'; |
|
1422 | + $this->_template_args['event_attendees'][$registration->ID()]['address'] |
|
1423 | + = EEH_Address::format($attendee, 'inline', false, false); |
|
1424 | + } else { |
|
1425 | + $this->_template_args['event_attendees'][$registration->ID()]['att_id'] = ''; |
|
1426 | + $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = ''; |
|
1427 | + $this->_template_args['event_attendees'][$registration->ID()]['email'] = ''; |
|
1428 | + $this->_template_args['event_attendees'][$registration->ID()]['address'] = ''; |
|
1429 | + } |
|
1430 | + } |
|
1431 | + break; |
|
1432 | + |
|
1433 | + } |
|
1434 | + } |
|
1435 | + } |
|
1436 | + |
|
1437 | + $this->_template_args['transaction_form_url'] = add_query_arg( |
|
1438 | + array( |
|
1439 | + 'action' => 'edit_transaction', |
|
1440 | + 'process' => 'attendees', |
|
1441 | + ), |
|
1442 | + TXN_ADMIN_URL |
|
1443 | + ); |
|
1444 | + echo EEH_Template::display_template( |
|
1445 | + TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
1446 | + $this->_template_args, |
|
1447 | + true |
|
1448 | + ); |
|
1449 | + |
|
1450 | + } else { |
|
1451 | + echo sprintf( |
|
1452 | + esc_html__( |
|
1453 | + '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s', |
|
1454 | + 'event_espresso' |
|
1455 | + ), |
|
1456 | + '<p class="important-notice">', |
|
1457 | + '</p>' |
|
1458 | + ); |
|
1459 | + } |
|
1460 | + } |
|
1461 | + |
|
1462 | + |
|
1463 | + /** |
|
1464 | + * txn_registrant_side_meta_box |
|
1465 | + * generates HTML for the Edit Transaction side meta box |
|
1466 | + * |
|
1467 | + * @access public |
|
1468 | + * @return void |
|
1469 | + * @throws DomainException |
|
1470 | + * @throws EE_Error |
|
1471 | + * @throws InvalidArgumentException |
|
1472 | + * @throws InvalidDataTypeException |
|
1473 | + * @throws InvalidInterfaceException |
|
1474 | + * @throws ReflectionException |
|
1475 | + */ |
|
1476 | + public function txn_registrant_side_meta_box() |
|
1477 | + { |
|
1478 | + $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
|
1479 | + ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
|
1480 | + : null; |
|
1481 | + if (! $primary_att instanceof EE_Attendee) { |
|
1482 | + $this->_template_args['no_attendee_message'] = esc_html__( |
|
1483 | + 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
|
1484 | + 'event_espresso' |
|
1485 | + ); |
|
1486 | + $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
1487 | + } |
|
1488 | + $this->_template_args['ATT_ID'] = $primary_att->ID(); |
|
1489 | + $this->_template_args['prime_reg_fname'] = $primary_att->fname(); |
|
1490 | + $this->_template_args['prime_reg_lname'] = $primary_att->lname(); |
|
1491 | + $this->_template_args['prime_reg_email'] = $primary_att->email(); |
|
1492 | + $this->_template_args['prime_reg_phone'] = $primary_att->phone(); |
|
1493 | + $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array( |
|
1494 | + 'action' => 'edit_attendee', |
|
1495 | + 'post' => $primary_att->ID(), |
|
1496 | + ), REG_ADMIN_URL); |
|
1497 | + // get formatted address for registrant |
|
1498 | + $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
|
1499 | + echo EEH_Template::display_template( |
|
1500 | + TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
1501 | + $this->_template_args, |
|
1502 | + true |
|
1503 | + ); |
|
1504 | + } |
|
1505 | + |
|
1506 | + |
|
1507 | + /** |
|
1508 | + * txn_billing_info_side_meta_box |
|
1509 | + * generates HTML for the Edit Transaction side meta box |
|
1510 | + * |
|
1511 | + * @access public |
|
1512 | + * @return void |
|
1513 | + * @throws DomainException |
|
1514 | + * @throws EE_Error |
|
1515 | + */ |
|
1516 | + public function txn_billing_info_side_meta_box() |
|
1517 | + { |
|
1518 | + |
|
1519 | + $this->_template_args['billing_form'] = $this->_transaction->billing_info(); |
|
1520 | + $this->_template_args['billing_form_url'] = add_query_arg( |
|
1521 | + array('action' => 'edit_transaction', 'process' => 'billing'), |
|
1522 | + TXN_ADMIN_URL |
|
1523 | + ); |
|
1524 | + |
|
1525 | + $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
1526 | + echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/ |
|
1527 | + } |
|
1528 | + |
|
1529 | + |
|
1530 | + /** |
|
1531 | + * apply_payments_or_refunds |
|
1532 | + * registers a payment or refund made towards a transaction |
|
1533 | + * |
|
1534 | + * @access public |
|
1535 | + * @return void |
|
1536 | + * @throws EE_Error |
|
1537 | + * @throws InvalidArgumentException |
|
1538 | + * @throws ReflectionException |
|
1539 | + * @throws RuntimeException |
|
1540 | + * @throws InvalidDataTypeException |
|
1541 | + * @throws InvalidInterfaceException |
|
1542 | + */ |
|
1543 | + public function apply_payments_or_refunds() |
|
1544 | + { |
|
1545 | + $json_response_data = array('return_data' => false); |
|
1546 | + $valid_data = $this->_validate_payment_request_data(); |
|
1547 | + $has_access = EE_Registry::instance()->CAP->current_user_can( |
|
1548 | + 'ee_edit_payments', |
|
1549 | + 'apply_payment_or_refund_from_registration_details' |
|
1550 | + ); |
|
1551 | + if (! empty($valid_data) && $has_access) { |
|
1552 | + $PAY_ID = $valid_data['PAY_ID']; |
|
1553 | + //save the new payment |
|
1554 | + $payment = $this->_create_payment_from_request_data($valid_data); |
|
1555 | + // get the TXN for this payment |
|
1556 | + $transaction = $payment->transaction(); |
|
1557 | + // verify transaction |
|
1558 | + if ($transaction instanceof EE_Transaction) { |
|
1559 | + // calculate_total_payments_and_update_status |
|
1560 | + $this->_process_transaction_payments($transaction); |
|
1561 | + $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
|
1562 | + $this->_remove_existing_registration_payments($payment, $PAY_ID); |
|
1563 | + // apply payment to registrations (if applicable) |
|
1564 | + if (! empty($REG_IDs)) { |
|
1565 | + $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
|
1566 | + $this->_maybe_send_notifications(); |
|
1567 | + // now process status changes for the same registrations |
|
1568 | + $this->_process_registration_status_change($transaction, $REG_IDs); |
|
1569 | + } |
|
1570 | + $this->_maybe_send_notifications($payment); |
|
1571 | + //prepare to render page |
|
1572 | + $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs); |
|
1573 | + do_action( |
|
1574 | + 'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording', |
|
1575 | + $transaction, |
|
1576 | + $payment |
|
1577 | + ); |
|
1578 | + } else { |
|
1579 | + EE_Error::add_error( |
|
1580 | + esc_html__( |
|
1581 | + 'A valid Transaction for this payment could not be retrieved.', |
|
1582 | + 'event_espresso' |
|
1583 | + ), |
|
1584 | + __FILE__, |
|
1585 | + __FUNCTION__, |
|
1586 | + __LINE__ |
|
1587 | + ); |
|
1588 | + } |
|
1589 | + } else { |
|
1590 | + if ($has_access) { |
|
1591 | + EE_Error::add_error( |
|
1592 | + esc_html__( |
|
1593 | + 'The payment form data could not be processed. Please try again.', |
|
1594 | + 'event_espresso' |
|
1595 | + ), |
|
1596 | + __FILE__, |
|
1597 | + __FUNCTION__, |
|
1598 | + __LINE__ |
|
1599 | + ); |
|
1600 | + } else { |
|
1601 | + EE_Error::add_error( |
|
1602 | + esc_html__( |
|
1603 | + 'You do not have access to apply payments or refunds to a registration.', |
|
1604 | + 'event_espresso' |
|
1605 | + ), |
|
1606 | + __FILE__, |
|
1607 | + __FUNCTION__, |
|
1608 | + __LINE__ |
|
1609 | + ); |
|
1610 | + } |
|
1611 | + } |
|
1612 | + $notices = EE_Error::get_notices( |
|
1613 | + false, |
|
1614 | + false, |
|
1615 | + false |
|
1616 | + ); |
|
1617 | + $this->_template_args = array( |
|
1618 | + 'data' => $json_response_data, |
|
1619 | + 'error' => $notices['errors'], |
|
1620 | + 'success' => $notices['success'], |
|
1621 | + ); |
|
1622 | + $this->_return_json(); |
|
1623 | + } |
|
1624 | + |
|
1625 | + |
|
1626 | + /** |
|
1627 | + * _validate_payment_request_data |
|
1628 | + * |
|
1629 | + * @return array |
|
1630 | + * @throws EE_Error |
|
1631 | + */ |
|
1632 | + protected function _validate_payment_request_data() |
|
1633 | + { |
|
1634 | + if (! isset($this->_req_data['txn_admin_payment'])) { |
|
1635 | + return false; |
|
1636 | + } |
|
1637 | + $payment_form = $this->_generate_payment_form_section(); |
|
1638 | + try { |
|
1639 | + if ($payment_form->was_submitted()) { |
|
1640 | + $payment_form->receive_form_submission(); |
|
1641 | + if (! $payment_form->is_valid()) { |
|
1642 | + $submission_error_messages = array(); |
|
1643 | + foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
|
1644 | + if ($validation_error instanceof EE_Validation_Error) { |
|
1645 | + $submission_error_messages[] = sprintf( |
|
1646 | + _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'), |
|
1647 | + $validation_error->get_form_section()->html_label_text(), |
|
1648 | + $validation_error->getMessage() |
|
1649 | + ); |
|
1650 | + } |
|
1651 | + } |
|
1652 | + EE_Error::add_error( |
|
1653 | + implode('<br />', $submission_error_messages), |
|
1654 | + __FILE__, |
|
1655 | + __FUNCTION__, |
|
1656 | + __LINE__ |
|
1657 | + ); |
|
1658 | + |
|
1659 | + return array(); |
|
1660 | + } |
|
1661 | + } |
|
1662 | + } catch (EE_Error $e) { |
|
1663 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1664 | + |
|
1665 | + return array(); |
|
1666 | + } |
|
1667 | + |
|
1668 | + return $payment_form->valid_data(); |
|
1669 | + } |
|
1670 | + |
|
1671 | + |
|
1672 | + /** |
|
1673 | + * _generate_payment_form_section |
|
1674 | + * |
|
1675 | + * @return EE_Form_Section_Proper |
|
1676 | + * @throws EE_Error |
|
1677 | + */ |
|
1678 | + protected function _generate_payment_form_section() |
|
1679 | + { |
|
1680 | + return new EE_Form_Section_Proper( |
|
1681 | + array( |
|
1682 | + 'name' => 'txn_admin_payment', |
|
1683 | + 'subsections' => array( |
|
1684 | + 'PAY_ID' => new EE_Text_Input( |
|
1685 | + array( |
|
1686 | + 'default' => 0, |
|
1687 | + 'required' => false, |
|
1688 | + 'html_label_text' => esc_html__('Payment ID', 'event_espresso'), |
|
1689 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1690 | + ) |
|
1691 | + ), |
|
1692 | + 'TXN_ID' => new EE_Text_Input( |
|
1693 | + array( |
|
1694 | + 'default' => 0, |
|
1695 | + 'required' => true, |
|
1696 | + 'html_label_text' => esc_html__('Transaction ID', 'event_espresso'), |
|
1697 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1698 | + ) |
|
1699 | + ), |
|
1700 | + 'type' => new EE_Text_Input( |
|
1701 | + array( |
|
1702 | + 'default' => 1, |
|
1703 | + 'required' => true, |
|
1704 | + 'html_label_text' => esc_html__('Payment or Refund', 'event_espresso'), |
|
1705 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1706 | + ) |
|
1707 | + ), |
|
1708 | + 'amount' => new EE_Text_Input( |
|
1709 | + array( |
|
1710 | + 'default' => 0, |
|
1711 | + 'required' => true, |
|
1712 | + 'html_label_text' => esc_html__('Payment amount', 'event_espresso'), |
|
1713 | + 'validation_strategies' => array(new EE_Float_Normalization()), |
|
1714 | + ) |
|
1715 | + ), |
|
1716 | + 'status' => new EE_Text_Input( |
|
1717 | + array( |
|
1718 | + 'default' => EEM_Payment::status_id_approved, |
|
1719 | + 'required' => true, |
|
1720 | + 'html_label_text' => esc_html__('Payment status', 'event_espresso'), |
|
1721 | + ) |
|
1722 | + ), |
|
1723 | + 'PMD_ID' => new EE_Text_Input( |
|
1724 | + array( |
|
1725 | + 'default' => 2, |
|
1726 | + 'required' => true, |
|
1727 | + 'html_label_text' => esc_html__('Payment Method', 'event_espresso'), |
|
1728 | + 'validation_strategies' => array(new EE_Int_Normalization()), |
|
1729 | + ) |
|
1730 | + ), |
|
1731 | + 'date' => new EE_Text_Input( |
|
1732 | + array( |
|
1733 | + 'default' => time(), |
|
1734 | + 'required' => true, |
|
1735 | + 'html_label_text' => esc_html__('Payment date', 'event_espresso'), |
|
1736 | + ) |
|
1737 | + ), |
|
1738 | + 'txn_id_chq_nmbr' => new EE_Text_Input( |
|
1739 | + array( |
|
1740 | + 'default' => '', |
|
1741 | + 'required' => false, |
|
1742 | + 'html_label_text' => esc_html__('Transaction or Cheque Number', 'event_espresso'), |
|
1743 | + 'validation_strategies' => array( |
|
1744 | + new EE_Max_Length_Validation_Strategy( |
|
1745 | + esc_html__('Input too long', 'event_espresso'), |
|
1746 | + 100 |
|
1747 | + ), |
|
1748 | + ), |
|
1749 | + ) |
|
1750 | + ), |
|
1751 | + 'po_number' => new EE_Text_Input( |
|
1752 | + array( |
|
1753 | + 'default' => '', |
|
1754 | + 'required' => false, |
|
1755 | + 'html_label_text' => esc_html__('Purchase Order Number', 'event_espresso'), |
|
1756 | + 'validation_strategies' => array( |
|
1757 | + new EE_Max_Length_Validation_Strategy( |
|
1758 | + esc_html__('Input too long', 'event_espresso'), |
|
1759 | + 100 |
|
1760 | + ), |
|
1761 | + ), |
|
1762 | + ) |
|
1763 | + ), |
|
1764 | + 'accounting' => new EE_Text_Input( |
|
1765 | + array( |
|
1766 | + 'default' => '', |
|
1767 | + 'required' => false, |
|
1768 | + 'html_label_text' => esc_html__('Extra Field for Accounting', 'event_espresso'), |
|
1769 | + 'validation_strategies' => array( |
|
1770 | + new EE_Max_Length_Validation_Strategy( |
|
1771 | + esc_html__('Input too long', 'event_espresso'), |
|
1772 | + 100 |
|
1773 | + ), |
|
1774 | + ), |
|
1775 | + ) |
|
1776 | + ), |
|
1777 | + ), |
|
1778 | + ) |
|
1779 | + ); |
|
1780 | + } |
|
1781 | + |
|
1782 | + |
|
1783 | + /** |
|
1784 | + * _create_payment_from_request_data |
|
1785 | + * |
|
1786 | + * @param array $valid_data |
|
1787 | + * @return EE_Payment |
|
1788 | + * @throws EE_Error |
|
1789 | + */ |
|
1790 | + protected function _create_payment_from_request_data($valid_data) |
|
1791 | + { |
|
1792 | + $PAY_ID = $valid_data['PAY_ID']; |
|
1793 | + // get payment amount |
|
1794 | + $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0; |
|
1795 | + // payments have a type value of 1 and refunds have a type value of -1 |
|
1796 | + // so multiplying amount by type will give a positive value for payments, and negative values for refunds |
|
1797 | + $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount; |
|
1798 | + // for some reason the date string coming in has extra spaces between the date and time. This fixes that. |
|
1799 | + $date = $valid_data['date'] |
|
1800 | + ? preg_replace('/\s+/', ' ', $valid_data['date']) |
|
1801 | + : date('Y-m-d g:i a', current_time('timestamp')); |
|
1802 | + $payment = EE_Payment::new_instance( |
|
1803 | + array( |
|
1804 | + 'TXN_ID' => $valid_data['TXN_ID'], |
|
1805 | + 'STS_ID' => $valid_data['status'], |
|
1806 | + 'PAY_timestamp' => $date, |
|
1807 | + 'PAY_source' => EEM_Payment_Method::scope_admin, |
|
1808 | + 'PMD_ID' => $valid_data['PMD_ID'], |
|
1809 | + 'PAY_amount' => $amount, |
|
1810 | + 'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'], |
|
1811 | + 'PAY_po_number' => $valid_data['po_number'], |
|
1812 | + 'PAY_extra_accntng' => $valid_data['accounting'], |
|
1813 | + 'PAY_details' => $valid_data, |
|
1814 | + 'PAY_ID' => $PAY_ID, |
|
1815 | + ), |
|
1816 | + '', |
|
1817 | + array('Y-m-d', 'g:i a') |
|
1818 | + ); |
|
1819 | + |
|
1820 | + if (! $payment->save()) { |
|
1821 | + EE_Error::add_error( |
|
1822 | + sprintf( |
|
1823 | + esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
|
1824 | + $payment->ID() |
|
1825 | + ), |
|
1826 | + __FILE__, __FUNCTION__, __LINE__ |
|
1827 | + ); |
|
1828 | + } |
|
1829 | + |
|
1830 | + return $payment; |
|
1831 | + } |
|
1832 | + |
|
1833 | + |
|
1834 | + /** |
|
1835 | + * _process_transaction_payments |
|
1836 | + * |
|
1837 | + * @param \EE_Transaction $transaction |
|
1838 | + * @return void |
|
1839 | + * @throws EE_Error |
|
1840 | + * @throws InvalidArgumentException |
|
1841 | + * @throws ReflectionException |
|
1842 | + * @throws InvalidDataTypeException |
|
1843 | + * @throws InvalidInterfaceException |
|
1844 | + */ |
|
1845 | + protected function _process_transaction_payments(EE_Transaction $transaction) |
|
1846 | + { |
|
1847 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
1848 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
1849 | + //update the transaction with this payment |
|
1850 | + if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) { |
|
1851 | + EE_Error::add_success(esc_html__( |
|
1852 | + 'The payment has been processed successfully.', 'event_espresso'), |
|
1853 | + __FILE__, |
|
1854 | + __FUNCTION__, |
|
1855 | + __LINE__ |
|
1856 | + ); |
|
1857 | + } else { |
|
1858 | + EE_Error::add_error( |
|
1859 | + esc_html__( |
|
1860 | + 'The payment was processed successfully but the amount paid for the transaction was not updated.', |
|
1861 | + 'event_espresso' |
|
1862 | + ) |
|
1863 | + , |
|
1864 | + __FILE__, |
|
1865 | + __FUNCTION__, |
|
1866 | + __LINE__ |
|
1867 | + ); |
|
1868 | + } |
|
1869 | + } |
|
1870 | + |
|
1871 | + |
|
1872 | + /** |
|
1873 | + * _get_REG_IDs_to_apply_payment_to |
|
1874 | + * returns a list of registration IDs that the payment will apply to |
|
1875 | + * |
|
1876 | + * @param \EE_Payment $payment |
|
1877 | + * @return array |
|
1878 | + * @throws EE_Error |
|
1879 | + */ |
|
1880 | + protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment) |
|
1881 | + { |
|
1882 | + $REG_IDs = array(); |
|
1883 | + // grab array of IDs for specific registrations to apply changes to |
|
1884 | + if (isset($this->_req_data['txn_admin_payment']['registrations'])) { |
|
1885 | + $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations']; |
|
1886 | + } |
|
1887 | + //nothing specified ? then get all reg IDs |
|
1888 | + if (empty($REG_IDs)) { |
|
1889 | + $registrations = $payment->transaction()->registrations(); |
|
1890 | + $REG_IDs = ! empty($registrations) |
|
1891 | + ? array_keys($registrations) |
|
1892 | + : $this->_get_existing_reg_payment_REG_IDs($payment); |
|
1893 | + } |
|
1894 | + |
|
1895 | + // ensure that REG_IDs are integers and NOT strings |
|
1896 | + return array_map('intval', $REG_IDs); |
|
1897 | + } |
|
1898 | + |
|
1899 | + |
|
1900 | + /** |
|
1901 | + * @return array |
|
1902 | + */ |
|
1903 | + public function existing_reg_payment_REG_IDs() |
|
1904 | + { |
|
1905 | + return $this->_existing_reg_payment_REG_IDs; |
|
1906 | + } |
|
1907 | + |
|
1908 | + |
|
1909 | + /** |
|
1910 | + * @param array $existing_reg_payment_REG_IDs |
|
1911 | + */ |
|
1912 | + public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null) |
|
1913 | + { |
|
1914 | + $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs; |
|
1915 | + } |
|
1916 | + |
|
1917 | + |
|
1918 | + /** |
|
1919 | + * _get_existing_reg_payment_REG_IDs |
|
1920 | + * returns a list of registration IDs that the payment is currently related to |
|
1921 | + * as recorded in the database |
|
1922 | + * |
|
1923 | + * @param \EE_Payment $payment |
|
1924 | + * @return array |
|
1925 | + * @throws EE_Error |
|
1926 | + */ |
|
1927 | + protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment) |
|
1928 | + { |
|
1929 | + if ($this->existing_reg_payment_REG_IDs() === null) { |
|
1930 | + // let's get any existing reg payment records for this payment |
|
1931 | + $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration'); |
|
1932 | + // but we only want the REG IDs, so grab the array keys |
|
1933 | + $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs) |
|
1934 | + ? array_keys($existing_reg_payment_REG_IDs) |
|
1935 | + : array(); |
|
1936 | + $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs); |
|
1937 | + } |
|
1938 | + |
|
1939 | + return $this->existing_reg_payment_REG_IDs(); |
|
1940 | + } |
|
1941 | + |
|
1942 | + |
|
1943 | + /** |
|
1944 | + * _remove_existing_registration_payments |
|
1945 | + * this calculates the difference between existing relations |
|
1946 | + * to the supplied payment and the new list registration IDs, |
|
1947 | + * removes any related registrations that no longer apply, |
|
1948 | + * and then updates the registration paid fields |
|
1949 | + * |
|
1950 | + * @param \EE_Payment $payment |
|
1951 | + * @param int $PAY_ID |
|
1952 | + * @return bool; |
|
1953 | + * @throws EE_Error |
|
1954 | + * @throws InvalidArgumentException |
|
1955 | + * @throws ReflectionException |
|
1956 | + * @throws InvalidDataTypeException |
|
1957 | + * @throws InvalidInterfaceException |
|
1958 | + */ |
|
1959 | + protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0) |
|
1960 | + { |
|
1961 | + // newly created payments will have nothing recorded for $PAY_ID |
|
1962 | + if ($PAY_ID == 0) { |
|
1963 | + return false; |
|
1964 | + } |
|
1965 | + $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
1966 | + if (empty($existing_reg_payment_REG_IDs)) { |
|
1967 | + return false; |
|
1968 | + } |
|
1969 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
1970 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
1971 | + |
|
1972 | + return $transaction_payments->delete_registration_payments_and_update_registrations( |
|
1973 | + $payment, |
|
1974 | + array( |
|
1975 | + array( |
|
1976 | + 'PAY_ID' => $payment->ID(), |
|
1977 | + 'REG_ID' => array('IN', $existing_reg_payment_REG_IDs), |
|
1978 | + ), |
|
1979 | + ) |
|
1980 | + ); |
|
1981 | + } |
|
1982 | + |
|
1983 | + |
|
1984 | + /** |
|
1985 | + * _update_registration_payments |
|
1986 | + * this applies the payments to the selected registrations |
|
1987 | + * but only if they have not already been paid for |
|
1988 | + * |
|
1989 | + * @param EE_Transaction $transaction |
|
1990 | + * @param \EE_Payment $payment |
|
1991 | + * @param array $REG_IDs |
|
1992 | + * @return void |
|
1993 | + * @throws EE_Error |
|
1994 | + * @throws InvalidArgumentException |
|
1995 | + * @throws ReflectionException |
|
1996 | + * @throws RuntimeException |
|
1997 | + * @throws InvalidDataTypeException |
|
1998 | + * @throws InvalidInterfaceException |
|
1999 | + */ |
|
2000 | + protected function _update_registration_payments( |
|
2001 | + EE_Transaction $transaction, |
|
2002 | + EE_Payment $payment, |
|
2003 | + $REG_IDs = array() |
|
2004 | + ) { |
|
2005 | + // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments() |
|
2006 | + // so let's do that using our set of REG_IDs from the form |
|
2007 | + $registration_query_where_params = array( |
|
2008 | + 'REG_ID' => array('IN', $REG_IDs), |
|
2009 | + ); |
|
2010 | + // but add in some conditions regarding payment, |
|
2011 | + // so that we don't apply payments to registrations that are free or have already been paid for |
|
2012 | + // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
|
2013 | + if (! $payment->is_a_refund()) { |
|
2014 | + $registration_query_where_params['REG_final_price'] = array('!=', 0); |
|
2015 | + $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
|
2016 | + } |
|
2017 | + $registrations = $transaction->registrations(array($registration_query_where_params)); |
|
2018 | + if (! empty($registrations)) { |
|
2019 | + /** @type EE_Payment_Processor $payment_processor */ |
|
2020 | + $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
|
2021 | + $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
|
2022 | + } |
|
2023 | + } |
|
2024 | + |
|
2025 | + |
|
2026 | + /** |
|
2027 | + * _process_registration_status_change |
|
2028 | + * This processes requested registration status changes for all the registrations |
|
2029 | + * on a given transaction and (optionally) sends out notifications for the changes. |
|
2030 | + * |
|
2031 | + * @param EE_Transaction $transaction |
|
2032 | + * @param array $REG_IDs |
|
2033 | + * @return bool |
|
2034 | + * @throws EE_Error |
|
2035 | + * @throws InvalidArgumentException |
|
2036 | + * @throws ReflectionException |
|
2037 | + * @throws InvalidDataTypeException |
|
2038 | + * @throws InvalidInterfaceException |
|
2039 | + */ |
|
2040 | + protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array()) |
|
2041 | + { |
|
2042 | + // first if there is no change in status then we get out. |
|
2043 | + if ( |
|
2044 | + ! isset($this->_req_data['txn_reg_status_change']['reg_status']) |
|
2045 | + || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN' |
|
2046 | + ) { |
|
2047 | + //no error message, no change requested, just nothing to do man. |
|
2048 | + return false; |
|
2049 | + } |
|
2050 | + /** @type EE_Transaction_Processor $transaction_processor */ |
|
2051 | + $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor'); |
|
2052 | + |
|
2053 | + // made it here dude? Oh WOW. K, let's take care of changing the statuses |
|
2054 | + return $transaction_processor->manually_update_registration_statuses( |
|
2055 | + $transaction, |
|
2056 | + sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']), |
|
2057 | + array(array('REG_ID' => array('IN', $REG_IDs))) |
|
2058 | + ); |
|
2059 | + } |
|
2060 | + |
|
2061 | + |
|
2062 | + /** |
|
2063 | + * _build_payment_json_response |
|
2064 | + * |
|
2065 | + * @access public |
|
2066 | + * @param \EE_Payment $payment |
|
2067 | + * @param array $REG_IDs |
|
2068 | + * @param bool | null $delete_txn_reg_status_change |
|
2069 | + * @return array |
|
2070 | + * @throws EE_Error |
|
2071 | + * @throws InvalidArgumentException |
|
2072 | + * @throws InvalidDataTypeException |
|
2073 | + * @throws InvalidInterfaceException |
|
2074 | + * @throws ReflectionException |
|
2075 | + */ |
|
2076 | + protected function _build_payment_json_response( |
|
2077 | + EE_Payment $payment, |
|
2078 | + $REG_IDs = array(), |
|
2079 | + $delete_txn_reg_status_change = null |
|
2080 | + ) { |
|
2081 | + // was the payment deleted ? |
|
2082 | + if (is_bool($delete_txn_reg_status_change)) { |
|
2083 | + return array( |
|
2084 | + 'PAY_ID' => $payment->ID(), |
|
2085 | + 'amount' => $payment->amount(), |
|
2086 | + 'total_paid' => $payment->transaction()->paid(), |
|
2087 | + 'txn_status' => $payment->transaction()->status_ID(), |
|
2088 | + 'pay_status' => $payment->STS_ID(), |
|
2089 | + 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
2090 | + 'delete_txn_reg_status_change' => $delete_txn_reg_status_change, |
|
2091 | + ); |
|
2092 | + } else { |
|
2093 | + $this->_get_payment_status_array(); |
|
2094 | + |
|
2095 | + return array( |
|
2096 | + 'amount' => $payment->amount(), |
|
2097 | + 'total_paid' => $payment->transaction()->paid(), |
|
2098 | + 'txn_status' => $payment->transaction()->status_ID(), |
|
2099 | + 'pay_status' => $payment->STS_ID(), |
|
2100 | + 'PAY_ID' => $payment->ID(), |
|
2101 | + 'STS_ID' => $payment->STS_ID(), |
|
2102 | + 'status' => self::$_pay_status[$payment->STS_ID()], |
|
2103 | + 'date' => $payment->timestamp('Y-m-d', 'h:i a'), |
|
2104 | + 'method' => strtoupper($payment->source()), |
|
2105 | + 'PM_ID' => $payment->payment_method() ? $payment->payment_method()->ID() : 1, |
|
2106 | + 'gateway' => $payment->payment_method() |
|
2107 | + ? $payment->payment_method()->admin_name() |
|
2108 | + : esc_html__("Unknown", 'event_espresso'), |
|
2109 | + 'gateway_response' => $payment->gateway_response(), |
|
2110 | + 'txn_id_chq_nmbr' => $payment->txn_id_chq_nmbr(), |
|
2111 | + 'po_number' => $payment->po_number(), |
|
2112 | + 'extra_accntng' => $payment->extra_accntng(), |
|
2113 | + 'registrations' => $this->_registration_payment_data_array($REG_IDs), |
|
2114 | + ); |
|
2115 | + } |
|
2116 | + } |
|
2117 | + |
|
2118 | + |
|
2119 | + /** |
|
2120 | + * delete_payment |
|
2121 | + * delete a payment or refund made towards a transaction |
|
2122 | + * |
|
2123 | + * @access public |
|
2124 | + * @return void |
|
2125 | + * @throws EE_Error |
|
2126 | + * @throws InvalidArgumentException |
|
2127 | + * @throws ReflectionException |
|
2128 | + * @throws InvalidDataTypeException |
|
2129 | + * @throws InvalidInterfaceException |
|
2130 | + */ |
|
2131 | + public function delete_payment() |
|
2132 | + { |
|
2133 | + $json_response_data = array('return_data' => false); |
|
2134 | + $PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
2135 | + ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID']) |
|
2136 | + : 0; |
|
2137 | + $can_delete = EE_Registry::instance()->CAP->current_user_can( |
|
2138 | + 'ee_delete_payments', |
|
2139 | + 'delete_payment_from_registration_details' |
|
2140 | + ); |
|
2141 | + if ($PAY_ID && $can_delete) { |
|
2142 | + $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change']) |
|
2143 | + ? $this->_req_data['delete_txn_reg_status_change'] |
|
2144 | + : false; |
|
2145 | + $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID); |
|
2146 | + if ($payment instanceof EE_Payment) { |
|
2147 | + $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment); |
|
2148 | + /** @type EE_Transaction_Payments $transaction_payments */ |
|
2149 | + $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments'); |
|
2150 | + if ($transaction_payments->delete_payment_and_update_transaction($payment)) { |
|
2151 | + $json_response_data['return_data'] = $this->_build_payment_json_response( |
|
2152 | + $payment, |
|
2153 | + $REG_IDs, |
|
2154 | + $delete_txn_reg_status_change |
|
2155 | + ); |
|
2156 | + if ($delete_txn_reg_status_change) { |
|
2157 | + $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
2158 | + //MAKE sure we also add the delete_txn_req_status_change to the |
|
2159 | + //$_REQUEST global because that's how messages will be looking for it. |
|
2160 | + $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change; |
|
2161 | + $this->_maybe_send_notifications(); |
|
2162 | + $this->_process_registration_status_change($payment->transaction(), $REG_IDs); |
|
2163 | + } |
|
2164 | + } |
|
2165 | + } else { |
|
2166 | + EE_Error::add_error( |
|
2167 | + esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'), |
|
2168 | + __FILE__, __FUNCTION__, __LINE__ |
|
2169 | + ); |
|
2170 | + } |
|
2171 | + } else { |
|
2172 | + if ($can_delete) { |
|
2173 | + EE_Error::add_error( |
|
2174 | + esc_html__( |
|
2175 | + 'A valid Payment ID was not received, therefore payment form data could not be loaded.', |
|
2176 | + 'event_espresso' |
|
2177 | + ), |
|
2178 | + __FILE__, __FUNCTION__, __LINE__ |
|
2179 | + ); |
|
2180 | + } else { |
|
2181 | + EE_Error::add_error( |
|
2182 | + esc_html__( |
|
2183 | + 'You do not have access to delete a payment.', |
|
2184 | + 'event_espresso' |
|
2185 | + ), |
|
2186 | + __FILE__, |
|
2187 | + __FUNCTION__, |
|
2188 | + __LINE__ |
|
2189 | + ); |
|
2190 | + } |
|
2191 | + } |
|
2192 | + $notices = EE_Error::get_notices(false, false, false); |
|
2193 | + $this->_template_args = array( |
|
2194 | + 'data' => $json_response_data, |
|
2195 | + 'success' => $notices['success'], |
|
2196 | + 'error' => $notices['errors'], |
|
2197 | + 'attention' => $notices['attention'], |
|
2198 | + ); |
|
2199 | + $this->_return_json(); |
|
2200 | + } |
|
2201 | + |
|
2202 | + |
|
2203 | + /** |
|
2204 | + * _registration_payment_data_array |
|
2205 | + * adds info for 'owing' and 'paid' for each registration to the json response |
|
2206 | + * |
|
2207 | + * @access protected |
|
2208 | + * @param array $REG_IDs |
|
2209 | + * @return array |
|
2210 | + * @throws EE_Error |
|
2211 | + * @throws InvalidArgumentException |
|
2212 | + * @throws InvalidDataTypeException |
|
2213 | + * @throws InvalidInterfaceException |
|
2214 | + * @throws ReflectionException |
|
2215 | + */ |
|
2216 | + protected function _registration_payment_data_array($REG_IDs) |
|
2217 | + { |
|
2218 | + $registration_payment_data = array(); |
|
2219 | + //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
|
2220 | + if (! empty($REG_IDs)) { |
|
2221 | + $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
|
2222 | + foreach ($registrations as $registration) { |
|
2223 | + if ($registration instanceof EE_Registration) { |
|
2224 | + $registration_payment_data[$registration->ID()] = array( |
|
2225 | + 'paid' => $registration->pretty_paid(), |
|
2226 | + 'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()), |
|
2227 | + ); |
|
2228 | + } |
|
2229 | + } |
|
2230 | + } |
|
2231 | + |
|
2232 | + return $registration_payment_data; |
|
2233 | + } |
|
2234 | + |
|
2235 | + |
|
2236 | + /** |
|
2237 | + * _maybe_send_notifications |
|
2238 | + * determines whether or not the admin has indicated that notifications should be sent. |
|
2239 | + * If so, will toggle a filter switch for delivering registration notices. |
|
2240 | + * If passed an EE_Payment object, then it will trigger payment notifications instead. |
|
2241 | + * |
|
2242 | + * @access protected |
|
2243 | + * @param \EE_Payment | null $payment |
|
2244 | + */ |
|
2245 | + protected function _maybe_send_notifications($payment = null) |
|
2246 | + { |
|
2247 | + switch ($payment instanceof EE_Payment) { |
|
2248 | + // payment notifications |
|
2249 | + case true : |
|
2250 | + if ( |
|
2251 | + isset( |
|
2252 | + $this->_req_data['txn_payments'], |
|
2253 | + $this->_req_data['txn_payments']['send_notifications'] |
|
2254 | + ) && |
|
2255 | + filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN) |
|
2256 | + ) { |
|
2257 | + $this->_process_payment_notification($payment); |
|
2258 | + } |
|
2259 | + break; |
|
2260 | + // registration notifications |
|
2261 | + case false : |
|
2262 | + if ( |
|
2263 | + isset( |
|
2264 | + $this->_req_data['txn_reg_status_change'], |
|
2265 | + $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
2266 | + ) && |
|
2267 | + filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN) |
|
2268 | + ) { |
|
2269 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true'); |
|
2270 | + } |
|
2271 | + break; |
|
2272 | + } |
|
2273 | + } |
|
2274 | + |
|
2275 | + |
|
2276 | + /** |
|
2277 | + * _send_payment_reminder |
|
2278 | + * generates HTML for the View Transaction Details Admin page |
|
2279 | + * |
|
2280 | + * @access protected |
|
2281 | + * @return void |
|
2282 | + * @throws EE_Error |
|
2283 | + * @throws InvalidArgumentException |
|
2284 | + * @throws InvalidDataTypeException |
|
2285 | + * @throws InvalidInterfaceException |
|
2286 | + */ |
|
2287 | + protected function _send_payment_reminder() |
|
2288 | + { |
|
2289 | + $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false; |
|
2290 | + $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID); |
|
2291 | + $query_args = isset($this->_req_data['redirect_to']) ? array( |
|
2292 | + 'action' => $this->_req_data['redirect_to'], |
|
2293 | + 'TXN_ID' => $this->_req_data['TXN_ID'], |
|
2294 | + ) : array(); |
|
2295 | + do_action( |
|
2296 | + 'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder', |
|
2297 | + $transaction |
|
2298 | + ); |
|
2299 | + $this->_redirect_after_action( |
|
2300 | + false, |
|
2301 | + esc_html__('payment reminder', 'event_espresso'), |
|
2302 | + esc_html__('sent', 'event_espresso'), |
|
2303 | + $query_args, |
|
2304 | + true |
|
2305 | + ); |
|
2306 | + } |
|
2307 | + |
|
2308 | + |
|
2309 | + /** |
|
2310 | + * get_transactions |
|
2311 | + * get transactions for given parameters (used by list table) |
|
2312 | + * |
|
2313 | + * @param int $perpage how many transactions displayed per page |
|
2314 | + * @param boolean $count return the count or objects |
|
2315 | + * @param string $view |
|
2316 | + * @return mixed int = count || array of transaction objects |
|
2317 | + * @throws EE_Error |
|
2318 | + * @throws InvalidArgumentException |
|
2319 | + * @throws InvalidDataTypeException |
|
2320 | + * @throws InvalidInterfaceException |
|
2321 | + */ |
|
2322 | + public function get_transactions($perpage, $count = false, $view = '') |
|
2323 | + { |
|
2324 | + |
|
2325 | + $TXN = EEM_Transaction::instance(); |
|
2326 | + |
|
2327 | + $start_date = isset($this->_req_data['txn-filter-start-date']) |
|
2328 | + ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) |
|
2329 | + : date( |
|
2330 | + 'm/d/Y', |
|
2331 | + strtotime('-10 year') |
|
2332 | + ); |
|
2333 | + $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
2334 | + ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
|
2335 | + : date('m/d/Y'); |
|
2336 | + |
|
2337 | + //make sure our timestamps start and end right at the boundaries for each day |
|
2338 | + $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
2339 | + $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
2340 | + |
|
2341 | + |
|
2342 | + //convert to timestamps |
|
2343 | + $start_date = strtotime($start_date); |
|
2344 | + $end_date = strtotime($end_date); |
|
2345 | + |
|
2346 | + //makes sure start date is the lowest value and vice versa |
|
2347 | + $start_date = min($start_date, $end_date); |
|
2348 | + $end_date = max($start_date, $end_date); |
|
2349 | + |
|
2350 | + //convert to correct format for query |
|
2351 | + $start_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2352 | + 'TXN_timestamp', |
|
2353 | + date('Y-m-d H:i:s', $start_date), |
|
2354 | + 'Y-m-d H:i:s' |
|
2355 | + ); |
|
2356 | + $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2357 | + 'TXN_timestamp', |
|
2358 | + date('Y-m-d H:i:s', $end_date), |
|
2359 | + 'Y-m-d H:i:s' |
|
2360 | + ); |
|
2361 | + |
|
2362 | + |
|
2363 | + //set orderby |
|
2364 | + $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
2365 | + |
|
2366 | + switch ($this->_req_data['orderby']) { |
|
2367 | + case 'TXN_ID': |
|
2368 | + $orderby = 'TXN_ID'; |
|
2369 | + break; |
|
2370 | + case 'ATT_fname': |
|
2371 | + $orderby = 'Registration.Attendee.ATT_fname'; |
|
2372 | + break; |
|
2373 | + case 'event_name': |
|
2374 | + $orderby = 'Registration.Event.EVT_name'; |
|
2375 | + break; |
|
2376 | + default: //'TXN_timestamp' |
|
2377 | + $orderby = 'TXN_timestamp'; |
|
2378 | + } |
|
2379 | + |
|
2380 | + $sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
2381 | + $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
2382 | + $per_page = ! empty($perpage) ? $perpage : 10; |
|
2383 | + $per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page; |
|
2384 | + |
|
2385 | + $offset = ($current_page - 1) * $per_page; |
|
2386 | + $limit = array($offset, $per_page); |
|
2387 | + |
|
2388 | + $_where = array( |
|
2389 | + 'TXN_timestamp' => array('BETWEEN', array($start_date, $end_date)), |
|
2390 | + 'Registration.REG_count' => 1, |
|
2391 | + ); |
|
2392 | + |
|
2393 | + if (isset($this->_req_data['EVT_ID'])) { |
|
2394 | + $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID']; |
|
2395 | + } |
|
2396 | + |
|
2397 | + if (isset($this->_req_data['s'])) { |
|
2398 | + $search_string = '%' . $this->_req_data['s'] . '%'; |
|
2399 | + $_where['OR'] = array( |
|
2400 | + 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
|
2401 | + 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
|
2402 | + 'Registration.Event.EVT_short_desc' => array('LIKE', $search_string), |
|
2403 | + 'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
2404 | + 'Registration.Attendee.ATT_fname' => array('LIKE', $search_string), |
|
2405 | + 'Registration.Attendee.ATT_lname' => array('LIKE', $search_string), |
|
2406 | + 'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
2407 | + 'Registration.Attendee.ATT_email' => array('LIKE', $search_string), |
|
2408 | + 'Registration.Attendee.ATT_address' => array('LIKE', $search_string), |
|
2409 | + 'Registration.Attendee.ATT_address2' => array('LIKE', $search_string), |
|
2410 | + 'Registration.Attendee.ATT_city' => array('LIKE', $search_string), |
|
2411 | + 'Registration.REG_final_price' => array('LIKE', $search_string), |
|
2412 | + 'Registration.REG_code' => array('LIKE', $search_string), |
|
2413 | + 'Registration.REG_count' => array('LIKE', $search_string), |
|
2414 | + 'Registration.REG_group_size' => array('LIKE', $search_string), |
|
2415 | + 'Registration.Ticket.TKT_name' => array('LIKE', $search_string), |
|
2416 | + 'Registration.Ticket.TKT_description' => array('LIKE', $search_string), |
|
2417 | + 'Payment.PAY_source' => array('LIKE', $search_string), |
|
2418 | + 'Payment.Payment_Method.PMD_name' => array('LIKE', $search_string), |
|
2419 | + 'TXN_session_data' => array('LIKE', $search_string), |
|
2420 | + 'Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
2421 | + ); |
|
2422 | + } |
|
2423 | + |
|
2424 | + //failed transactions |
|
2425 | + $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
2426 | + || ($count && $view === 'failed'); |
|
2427 | + $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
2428 | + || ($count && $view === 'abandoned'); |
|
2429 | + |
|
2430 | + if ($failed) { |
|
2431 | + $_where['STS_ID'] = EEM_Transaction::failed_status_code; |
|
2432 | + } else if ($abandoned) { |
|
2433 | + $_where['STS_ID'] = EEM_Transaction::abandoned_status_code; |
|
2434 | + } else { |
|
2435 | + $_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code); |
|
2436 | + $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code); |
|
2437 | + } |
|
2438 | + |
|
2439 | + $query_params = array( |
|
2440 | + $_where, |
|
2441 | + 'order_by' => array($orderby => $sort), |
|
2442 | + 'limit' => $limit, |
|
2443 | + 'default_where_conditions' => EEM_Base::default_where_conditions_this_only, |
|
2444 | + ); |
|
2445 | + |
|
2446 | + $transactions = $count |
|
2447 | + ? $TXN->count(array($_where), 'TXN_ID', true) |
|
2448 | + : $TXN->get_all($query_params); |
|
2449 | + |
|
2450 | + return $transactions; |
|
2451 | + } |
|
2452 | 2452 | } |
@@ -266,7 +266,7 @@ discard block |
||
266 | 266 | 'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.', |
267 | 267 | 'event_espresso' |
268 | 268 | ); |
269 | - EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
269 | + EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__( |
|
270 | 270 | 'An error occurred! Please refresh the page and try again.', |
271 | 271 | 'event_espresso' |
272 | 272 | ); |
@@ -364,13 +364,13 @@ discard block |
||
364 | 364 | //enqueue style |
365 | 365 | wp_register_style( |
366 | 366 | 'espresso_txn', |
367 | - TXN_ASSETS_URL . 'espresso_transactions_admin.css', |
|
367 | + TXN_ASSETS_URL.'espresso_transactions_admin.css', |
|
368 | 368 | array(), |
369 | 369 | EVENT_ESPRESSO_VERSION |
370 | 370 | ); |
371 | 371 | wp_enqueue_style('espresso_txn'); |
372 | 372 | //scripts |
373 | - wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array( |
|
373 | + wp_register_script('espresso_txn', TXN_ASSETS_URL.'espresso_transactions_admin.js', array( |
|
374 | 374 | 'ee_admin_js', |
375 | 375 | 'ee-datepicker', |
376 | 376 | 'jquery-ui-datepicker', |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | : null; |
468 | 468 | $this->_transaction->verify_abandoned_transaction_status(); |
469 | 469 | |
470 | - if (! $this->_transaction instanceof EE_Transaction) { |
|
470 | + if ( ! $this->_transaction instanceof EE_Transaction) { |
|
471 | 471 | $error_msg = sprintf( |
472 | 472 | esc_html__( |
473 | 473 | 'An error occurred and the details for the transaction with the ID # %d could not be retrieved.', |
@@ -565,7 +565,7 @@ discard block |
||
565 | 565 | 'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items', |
566 | 566 | array( |
567 | 567 | 'overpaid' => array( |
568 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code, |
|
568 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::overpaid_status_code, |
|
569 | 569 | 'desc' => EEH_Template::pretty_status( |
570 | 570 | EEM_Transaction::overpaid_status_code, |
571 | 571 | false, |
@@ -573,7 +573,7 @@ discard block |
||
573 | 573 | ), |
574 | 574 | ), |
575 | 575 | 'complete' => array( |
576 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code, |
|
576 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::complete_status_code, |
|
577 | 577 | 'desc' => EEH_Template::pretty_status( |
578 | 578 | EEM_Transaction::complete_status_code, |
579 | 579 | false, |
@@ -581,7 +581,7 @@ discard block |
||
581 | 581 | ), |
582 | 582 | ), |
583 | 583 | 'incomplete' => array( |
584 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code, |
|
584 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::incomplete_status_code, |
|
585 | 585 | 'desc' => EEH_Template::pretty_status( |
586 | 586 | EEM_Transaction::incomplete_status_code, |
587 | 587 | false, |
@@ -589,7 +589,7 @@ discard block |
||
589 | 589 | ), |
590 | 590 | ), |
591 | 591 | 'abandoned' => array( |
592 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code, |
|
592 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::abandoned_status_code, |
|
593 | 593 | 'desc' => EEH_Template::pretty_status( |
594 | 594 | EEM_Transaction::abandoned_status_code, |
595 | 595 | false, |
@@ -597,7 +597,7 @@ discard block |
||
597 | 597 | ), |
598 | 598 | ), |
599 | 599 | 'failed' => array( |
600 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code, |
|
600 | + 'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::failed_status_code, |
|
601 | 601 | 'desc' => EEH_Template::pretty_status( |
602 | 602 | EEM_Transaction::failed_status_code, |
603 | 603 | false, |
@@ -646,11 +646,11 @@ discard block |
||
646 | 646 | 'Click to Edit event', |
647 | 647 | 'event_espresso' |
648 | 648 | ) |
649 | - . '">' . $event->get('EVT_name') . '</a>', |
|
649 | + . '">'.$event->get('EVT_name').'</a>', |
|
650 | 650 | '</h3>' |
651 | 651 | ) |
652 | 652 | : ''; |
653 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
653 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items()); |
|
654 | 654 | $this->display_admin_list_table_page_with_no_sidebar(); |
655 | 655 | } |
656 | 656 | |
@@ -693,7 +693,7 @@ discard block |
||
693 | 693 | |
694 | 694 | $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')]; |
695 | 695 | $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso'); |
696 | - $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID'); |
|
696 | + $this->_template_args['txn_status']['class'] = 'status-'.$this->_transaction->get('STS_ID'); |
|
697 | 697 | |
698 | 698 | $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total'); |
699 | 699 | $this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid'); |
@@ -746,7 +746,7 @@ discard block |
||
746 | 746 | |
747 | 747 | |
748 | 748 | // next link |
749 | - $next_txn = $this->_transaction->next( |
|
749 | + $next_txn = $this->_transaction->next( |
|
750 | 750 | null, |
751 | 751 | array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
752 | 752 | 'TXN_ID' |
@@ -761,7 +761,7 @@ discard block |
||
761 | 761 | ) |
762 | 762 | : ''; |
763 | 763 | // previous link |
764 | - $previous_txn = $this->_transaction->previous( |
|
764 | + $previous_txn = $this->_transaction->previous( |
|
765 | 765 | null, |
766 | 766 | array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))), |
767 | 767 | 'TXN_ID' |
@@ -811,7 +811,7 @@ discard block |
||
811 | 811 | // grab messages at the last second |
812 | 812 | $this->_template_args['notices'] = EE_Error::get_notices(); |
813 | 813 | // path to template |
814 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php'; |
|
814 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php'; |
|
815 | 815 | $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
816 | 816 | $template_path, |
817 | 817 | $this->_template_args, |
@@ -893,7 +893,7 @@ discard block |
||
893 | 893 | { |
894 | 894 | $content = ''; |
895 | 895 | $actions = array(); |
896 | - if (! $transaction instanceof EE_Transaction) { |
|
896 | + if ( ! $transaction instanceof EE_Transaction) { |
|
897 | 897 | return $content; |
898 | 898 | } |
899 | 899 | /** @var EE_Registration $primary_registration */ |
@@ -954,7 +954,7 @@ discard block |
||
954 | 954 | ); |
955 | 955 | if ($actions) { |
956 | 956 | $content = '<ul>'; |
957 | - $content .= '<li>' . implode('</li><li>', $actions) . '</li>'; |
|
957 | + $content .= '<li>'.implode('</li><li>', $actions).'</li>'; |
|
958 | 958 | $content .= '</uL>'; |
959 | 959 | } |
960 | 960 | return $content; |
@@ -992,7 +992,7 @@ discard block |
||
992 | 992 | |
993 | 993 | //get line table |
994 | 994 | EEH_Autoloader::register_line_item_display_autoloaders(); |
995 | - $Line_Item_Display = new EE_Line_Item_Display( |
|
995 | + $Line_Item_Display = new EE_Line_Item_Display( |
|
996 | 996 | 'admin_table', |
997 | 997 | 'EE_Admin_Table_Line_Item_Display_Strategy' |
998 | 998 | ); |
@@ -1003,13 +1003,13 @@ discard block |
||
1003 | 1003 | ->get('REG_code'); |
1004 | 1004 | |
1005 | 1005 | // process taxes |
1006 | - $taxes = $this->_transaction->get_many_related( |
|
1006 | + $taxes = $this->_transaction->get_many_related( |
|
1007 | 1007 | 'Line_Item', |
1008 | 1008 | array(array('LIN_type' => EEM_Line_Item::type_tax)) |
1009 | 1009 | ); |
1010 | 1010 | $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false; |
1011 | 1011 | |
1012 | - $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
1012 | + $this->_template_args['grand_total'] = EEH_Template::format_currency( |
|
1013 | 1013 | $this->_transaction->get('TXN_total'), |
1014 | 1014 | false, |
1015 | 1015 | false |
@@ -1019,7 +1019,7 @@ discard block |
||
1019 | 1019 | |
1020 | 1020 | // process payment details |
1021 | 1021 | $payments = $this->_transaction->get_many_related('Payment'); |
1022 | - if (! empty($payments)) { |
|
1022 | + if ( ! empty($payments)) { |
|
1023 | 1023 | $this->_template_args['payments'] = $payments; |
1024 | 1024 | $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments); |
1025 | 1025 | } else { |
@@ -1080,7 +1080,7 @@ discard block |
||
1080 | 1080 | esc_html__('%1$s : Initiated %2$s', 'event_espresso'), |
1081 | 1081 | ucwords(str_replace('_', ' ', $reg_step)), |
1082 | 1082 | date( |
1083 | - get_option('date_format') . ' ' . get_option('time_format'), |
|
1083 | + get_option('date_format').' '.get_option('time_format'), |
|
1084 | 1084 | ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)) |
1085 | 1085 | ) |
1086 | 1086 | ) |
@@ -1094,7 +1094,7 @@ discard block |
||
1094 | 1094 | . '</li>'; |
1095 | 1095 | } |
1096 | 1096 | } |
1097 | - $reg_steps .= '</ul>'; |
|
1097 | + $reg_steps .= '</ul>'; |
|
1098 | 1098 | $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps; |
1099 | 1099 | $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__( |
1100 | 1100 | 'Registration Step Progress', |
@@ -1107,11 +1107,11 @@ discard block |
||
1107 | 1107 | $this->_get_payment_status_array(); |
1108 | 1108 | $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction. |
1109 | 1109 | |
1110 | - $this->_template_args['transaction_form_url'] = add_query_arg(array( |
|
1110 | + $this->_template_args['transaction_form_url'] = add_query_arg(array( |
|
1111 | 1111 | 'action' => 'edit_transaction', |
1112 | 1112 | 'process' => 'transaction', |
1113 | 1113 | ), TXN_ADMIN_URL); |
1114 | - $this->_template_args['apply_payment_form_url'] = add_query_arg(array( |
|
1114 | + $this->_template_args['apply_payment_form_url'] = add_query_arg(array( |
|
1115 | 1115 | 'page' => 'espresso_transactions', |
1116 | 1116 | 'action' => 'espresso_apply_payment', |
1117 | 1117 | ), WP_AJAX_URL); |
@@ -1124,7 +1124,7 @@ discard block |
||
1124 | 1124 | |
1125 | 1125 | // 'espresso_delete_payment_nonce' |
1126 | 1126 | |
1127 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
1127 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php'; |
|
1128 | 1128 | echo EEH_Template::display_template($template_path, $this->_template_args, true); |
1129 | 1129 | } |
1130 | 1130 | |
@@ -1154,11 +1154,11 @@ discard block |
||
1154 | 1154 | ), |
1155 | 1155 | ), |
1156 | 1156 | )); |
1157 | - if (! empty($reg_payments)) { |
|
1157 | + if ( ! empty($reg_payments)) { |
|
1158 | 1158 | foreach ($payments as $payment) { |
1159 | - if (! $payment instanceof EE_Payment) { |
|
1159 | + if ( ! $payment instanceof EE_Payment) { |
|
1160 | 1160 | continue; |
1161 | - } elseif (! isset($existing_reg_payments[$payment->ID()])) { |
|
1161 | + } elseif ( ! isset($existing_reg_payments[$payment->ID()])) { |
|
1162 | 1162 | $existing_reg_payments[$payment->ID()] = array(); |
1163 | 1163 | } |
1164 | 1164 | foreach ($reg_payments as $reg_payment) { |
@@ -1187,7 +1187,7 @@ discard block |
||
1187 | 1187 | protected function _get_registrations_to_apply_payment_to() |
1188 | 1188 | { |
1189 | 1189 | // we want any registration with an active status (ie: not deleted or cancelled) |
1190 | - $query_params = array( |
|
1190 | + $query_params = array( |
|
1191 | 1191 | array( |
1192 | 1192 | 'STS_ID' => array( |
1193 | 1193 | 'IN', |
@@ -1206,16 +1206,16 @@ discard block |
||
1206 | 1206 | '', |
1207 | 1207 | 'clear: both; margin: 1.5em 0 0; display: none;' |
1208 | 1208 | ); |
1209 | - $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
1209 | + $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap'); |
|
1210 | 1210 | $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl'); |
1211 | 1211 | $registrations_to_apply_payment_to .= EEH_HTML::thead( |
1212 | 1212 | EEH_HTML::tr( |
1213 | - EEH_HTML::th(esc_html__('ID', 'event_espresso')) . |
|
1214 | - EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) . |
|
1215 | - EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) . |
|
1216 | - EEH_HTML::th(esc_html__('Event', 'event_espresso')) . |
|
1217 | - EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1218 | - EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1213 | + EEH_HTML::th(esc_html__('ID', 'event_espresso')). |
|
1214 | + EEH_HTML::th(esc_html__('Registrant', 'event_espresso')). |
|
1215 | + EEH_HTML::th(esc_html__('Ticket', 'event_espresso')). |
|
1216 | + EEH_HTML::th(esc_html__('Event', 'event_espresso')). |
|
1217 | + EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr'). |
|
1218 | + EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr'). |
|
1219 | 1219 | EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr') |
1220 | 1220 | ) |
1221 | 1221 | ); |
@@ -1230,29 +1230,29 @@ discard block |
||
1230 | 1230 | : esc_html__('Unknown Attendee', 'event_espresso'); |
1231 | 1231 | $owing = $registration->final_price() - $registration->paid(); |
1232 | 1232 | $taxable = $registration->ticket()->taxable() |
1233 | - ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>' |
|
1233 | + ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>' |
|
1234 | 1234 | : ''; |
1235 | 1235 | $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments) |
1236 | 1236 | ? ' checked="checked"' |
1237 | 1237 | : ''; |
1238 | - $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
1238 | + $disabled = $registration->final_price() > 0 ? '' : ' disabled'; |
|
1239 | 1239 | $registrations_to_apply_payment_to .= EEH_HTML::tr( |
1240 | - EEH_HTML::td($registration->ID()) . |
|
1241 | - EEH_HTML::td($attendee_name) . |
|
1240 | + EEH_HTML::td($registration->ID()). |
|
1241 | + EEH_HTML::td($attendee_name). |
|
1242 | 1242 | EEH_HTML::td( |
1243 | - $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable |
|
1244 | - ) . |
|
1245 | - EEH_HTML::td($registration->event_name()) . |
|
1246 | - EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') . |
|
1247 | - EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') . |
|
1243 | + $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable |
|
1244 | + ). |
|
1245 | + EEH_HTML::td($registration->event_name()). |
|
1246 | + EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr'). |
|
1247 | + EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr'). |
|
1248 | 1248 | EEH_HTML::td( |
1249 | - '<input type="checkbox" value="' . $registration->ID() |
|
1249 | + '<input type="checkbox" value="'.$registration->ID() |
|
1250 | 1250 | . '" name="txn_admin_payment[registrations]"' |
1251 | - . $checked . $disabled . '>', |
|
1251 | + . $checked.$disabled.'>', |
|
1252 | 1252 | '', |
1253 | 1253 | 'jst-cntr' |
1254 | 1254 | ), |
1255 | - 'apply-payment-registration-row-' . $registration->ID() |
|
1255 | + 'apply-payment-registration-row-'.$registration->ID() |
|
1256 | 1256 | ); |
1257 | 1257 | } |
1258 | 1258 | } |
@@ -1267,7 +1267,7 @@ discard block |
||
1267 | 1267 | '', |
1268 | 1268 | 'clear description' |
1269 | 1269 | ); |
1270 | - $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1270 | + $registrations_to_apply_payment_to .= EEH_HTML::divx(); |
|
1271 | 1271 | $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to; |
1272 | 1272 | } |
1273 | 1273 | |
@@ -1333,12 +1333,12 @@ discard block |
||
1333 | 1333 | array( |
1334 | 1334 | 'OR*payment_method_for_payment' => array( |
1335 | 1335 | 'PMD_ID' => array('IN', $payment_methods_of_payments), |
1336 | - 'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'), |
|
1336 | + 'PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'), |
|
1337 | 1337 | ), |
1338 | 1338 | ), |
1339 | 1339 | ); |
1340 | 1340 | } else { |
1341 | - $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'))); |
|
1341 | + $query_args = array(array('PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'))); |
|
1342 | 1342 | } |
1343 | 1343 | $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args); |
1344 | 1344 | } |
@@ -1367,7 +1367,7 @@ discard block |
||
1367 | 1367 | 'Line_Item', |
1368 | 1368 | array(array('LIN_type' => 'line-item')) |
1369 | 1369 | ); |
1370 | - if (! empty($line_items)) { |
|
1370 | + if ( ! empty($line_items)) { |
|
1371 | 1371 | foreach ($line_items as $item) { |
1372 | 1372 | if ($item instanceof EE_Line_Item) { |
1373 | 1373 | switch ($item->OBJ_type()) { |
@@ -1377,7 +1377,7 @@ discard block |
||
1377 | 1377 | $ticket = $item->ticket(); |
1378 | 1378 | //right now we're only handling tickets here. |
1379 | 1379 | //Cause its expected that only tickets will have attendees right? |
1380 | - if (! $ticket instanceof EE_Ticket) { |
|
1380 | + if ( ! $ticket instanceof EE_Ticket) { |
|
1381 | 1381 | continue; |
1382 | 1382 | } |
1383 | 1383 | try { |
@@ -1386,7 +1386,7 @@ discard block |
||
1386 | 1386 | EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
1387 | 1387 | $event_name = esc_html__('Unknown Event', 'event_espresso'); |
1388 | 1388 | } |
1389 | - $event_name .= ' - ' . $item->get('LIN_name'); |
|
1389 | + $event_name .= ' - '.$item->get('LIN_name'); |
|
1390 | 1390 | $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price')); |
1391 | 1391 | // now get all of the registrations for this transaction that use this ticket |
1392 | 1392 | $registrations = $ticket->get_many_related( |
@@ -1394,7 +1394,7 @@ discard block |
||
1394 | 1394 | array(array('TXN_ID' => $this->_transaction->ID())) |
1395 | 1395 | ); |
1396 | 1396 | foreach ($registrations as $registration) { |
1397 | - if (! $registration instanceof EE_Registration) { |
|
1397 | + if ( ! $registration instanceof EE_Registration) { |
|
1398 | 1398 | continue; |
1399 | 1399 | } |
1400 | 1400 | $this->_template_args['event_attendees'][$registration->ID()]['STS_ID'] |
@@ -1413,12 +1413,12 @@ discard block |
||
1413 | 1413 | $this->_template_args['event_attendees'][$registration->ID()]['attendee'] |
1414 | 1414 | = $attendee->full_name(); |
1415 | 1415 | $this->_template_args['event_attendees'][$registration->ID()]['email'] |
1416 | - = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name |
|
1416 | + = '<a href="mailto:'.$attendee->email().'?subject='.$event_name |
|
1417 | 1417 | . esc_html__( |
1418 | 1418 | ' Event', |
1419 | 1419 | 'event_espresso' |
1420 | 1420 | ) |
1421 | - . '">' . $attendee->email() . '</a>'; |
|
1421 | + . '">'.$attendee->email().'</a>'; |
|
1422 | 1422 | $this->_template_args['event_attendees'][$registration->ID()]['address'] |
1423 | 1423 | = EEH_Address::format($attendee, 'inline', false, false); |
1424 | 1424 | } else { |
@@ -1442,7 +1442,7 @@ discard block |
||
1442 | 1442 | TXN_ADMIN_URL |
1443 | 1443 | ); |
1444 | 1444 | echo EEH_Template::display_template( |
1445 | - TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php', |
|
1445 | + TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php', |
|
1446 | 1446 | $this->_template_args, |
1447 | 1447 | true |
1448 | 1448 | ); |
@@ -1478,12 +1478,12 @@ discard block |
||
1478 | 1478 | $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration |
1479 | 1479 | ? $this->_transaction->primary_registration()->get_first_related('Attendee') |
1480 | 1480 | : null; |
1481 | - if (! $primary_att instanceof EE_Attendee) { |
|
1481 | + if ( ! $primary_att instanceof EE_Attendee) { |
|
1482 | 1482 | $this->_template_args['no_attendee_message'] = esc_html__( |
1483 | 1483 | 'There is no attached contact for this transaction. The transaction either failed due to an error or was abandoned.', |
1484 | 1484 | 'event_espresso' |
1485 | 1485 | ); |
1486 | - $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
1486 | + $primary_att = EEM_Attendee::instance()->create_default_object(); |
|
1487 | 1487 | } |
1488 | 1488 | $this->_template_args['ATT_ID'] = $primary_att->ID(); |
1489 | 1489 | $this->_template_args['prime_reg_fname'] = $primary_att->fname(); |
@@ -1497,7 +1497,7 @@ discard block |
||
1497 | 1497 | // get formatted address for registrant |
1498 | 1498 | $this->_template_args['formatted_address'] = EEH_Address::format($primary_att); |
1499 | 1499 | echo EEH_Template::display_template( |
1500 | - TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php', |
|
1500 | + TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php', |
|
1501 | 1501 | $this->_template_args, |
1502 | 1502 | true |
1503 | 1503 | ); |
@@ -1522,8 +1522,8 @@ discard block |
||
1522 | 1522 | TXN_ADMIN_URL |
1523 | 1523 | ); |
1524 | 1524 | |
1525 | - $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
1526 | - echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/ |
|
1525 | + $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php'; |
|
1526 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); /**/ |
|
1527 | 1527 | } |
1528 | 1528 | |
1529 | 1529 | |
@@ -1548,7 +1548,7 @@ discard block |
||
1548 | 1548 | 'ee_edit_payments', |
1549 | 1549 | 'apply_payment_or_refund_from_registration_details' |
1550 | 1550 | ); |
1551 | - if (! empty($valid_data) && $has_access) { |
|
1551 | + if ( ! empty($valid_data) && $has_access) { |
|
1552 | 1552 | $PAY_ID = $valid_data['PAY_ID']; |
1553 | 1553 | //save the new payment |
1554 | 1554 | $payment = $this->_create_payment_from_request_data($valid_data); |
@@ -1561,7 +1561,7 @@ discard block |
||
1561 | 1561 | $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment); |
1562 | 1562 | $this->_remove_existing_registration_payments($payment, $PAY_ID); |
1563 | 1563 | // apply payment to registrations (if applicable) |
1564 | - if (! empty($REG_IDs)) { |
|
1564 | + if ( ! empty($REG_IDs)) { |
|
1565 | 1565 | $this->_update_registration_payments($transaction, $payment, $REG_IDs); |
1566 | 1566 | $this->_maybe_send_notifications(); |
1567 | 1567 | // now process status changes for the same registrations |
@@ -1609,7 +1609,7 @@ discard block |
||
1609 | 1609 | ); |
1610 | 1610 | } |
1611 | 1611 | } |
1612 | - $notices = EE_Error::get_notices( |
|
1612 | + $notices = EE_Error::get_notices( |
|
1613 | 1613 | false, |
1614 | 1614 | false, |
1615 | 1615 | false |
@@ -1631,14 +1631,14 @@ discard block |
||
1631 | 1631 | */ |
1632 | 1632 | protected function _validate_payment_request_data() |
1633 | 1633 | { |
1634 | - if (! isset($this->_req_data['txn_admin_payment'])) { |
|
1634 | + if ( ! isset($this->_req_data['txn_admin_payment'])) { |
|
1635 | 1635 | return false; |
1636 | 1636 | } |
1637 | 1637 | $payment_form = $this->_generate_payment_form_section(); |
1638 | 1638 | try { |
1639 | 1639 | if ($payment_form->was_submitted()) { |
1640 | 1640 | $payment_form->receive_form_submission(); |
1641 | - if (! $payment_form->is_valid()) { |
|
1641 | + if ( ! $payment_form->is_valid()) { |
|
1642 | 1642 | $submission_error_messages = array(); |
1643 | 1643 | foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) { |
1644 | 1644 | if ($validation_error instanceof EE_Validation_Error) { |
@@ -1817,7 +1817,7 @@ discard block |
||
1817 | 1817 | array('Y-m-d', 'g:i a') |
1818 | 1818 | ); |
1819 | 1819 | |
1820 | - if (! $payment->save()) { |
|
1820 | + if ( ! $payment->save()) { |
|
1821 | 1821 | EE_Error::add_error( |
1822 | 1822 | sprintf( |
1823 | 1823 | esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'), |
@@ -1882,7 +1882,7 @@ discard block |
||
1882 | 1882 | $REG_IDs = array(); |
1883 | 1883 | // grab array of IDs for specific registrations to apply changes to |
1884 | 1884 | if (isset($this->_req_data['txn_admin_payment']['registrations'])) { |
1885 | - $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations']; |
|
1885 | + $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations']; |
|
1886 | 1886 | } |
1887 | 1887 | //nothing specified ? then get all reg IDs |
1888 | 1888 | if (empty($REG_IDs)) { |
@@ -2010,12 +2010,12 @@ discard block |
||
2010 | 2010 | // but add in some conditions regarding payment, |
2011 | 2011 | // so that we don't apply payments to registrations that are free or have already been paid for |
2012 | 2012 | // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative ) |
2013 | - if (! $payment->is_a_refund()) { |
|
2013 | + if ( ! $payment->is_a_refund()) { |
|
2014 | 2014 | $registration_query_where_params['REG_final_price'] = array('!=', 0); |
2015 | 2015 | $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true); |
2016 | 2016 | } |
2017 | 2017 | $registrations = $transaction->registrations(array($registration_query_where_params)); |
2018 | - if (! empty($registrations)) { |
|
2018 | + if ( ! empty($registrations)) { |
|
2019 | 2019 | /** @type EE_Payment_Processor $payment_processor */ |
2020 | 2020 | $payment_processor = EE_Registry::instance()->load_core('Payment_Processor'); |
2021 | 2021 | $payment_processor->process_registration_payments($transaction, $payment, $registrations); |
@@ -2217,7 +2217,7 @@ discard block |
||
2217 | 2217 | { |
2218 | 2218 | $registration_payment_data = array(); |
2219 | 2219 | //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows. |
2220 | - if (! empty($REG_IDs)) { |
|
2220 | + if ( ! empty($REG_IDs)) { |
|
2221 | 2221 | $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs)))); |
2222 | 2222 | foreach ($registrations as $registration) { |
2223 | 2223 | if ($registration instanceof EE_Registration) { |
@@ -2330,13 +2330,13 @@ discard block |
||
2330 | 2330 | 'm/d/Y', |
2331 | 2331 | strtotime('-10 year') |
2332 | 2332 | ); |
2333 | - $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
2333 | + $end_date = isset($this->_req_data['txn-filter-end-date']) |
|
2334 | 2334 | ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) |
2335 | 2335 | : date('m/d/Y'); |
2336 | 2336 | |
2337 | 2337 | //make sure our timestamps start and end right at the boundaries for each day |
2338 | - $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
2339 | - $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
2338 | + $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00'; |
|
2339 | + $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59'; |
|
2340 | 2340 | |
2341 | 2341 | |
2342 | 2342 | //convert to timestamps |
@@ -2353,7 +2353,7 @@ discard block |
||
2353 | 2353 | date('Y-m-d H:i:s', $start_date), |
2354 | 2354 | 'Y-m-d H:i:s' |
2355 | 2355 | ); |
2356 | - $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2356 | + $end_date = EEM_Transaction::instance()->convert_datetime_for_query( |
|
2357 | 2357 | 'TXN_timestamp', |
2358 | 2358 | date('Y-m-d H:i:s', $end_date), |
2359 | 2359 | 'Y-m-d H:i:s' |
@@ -2395,7 +2395,7 @@ discard block |
||
2395 | 2395 | } |
2396 | 2396 | |
2397 | 2397 | if (isset($this->_req_data['s'])) { |
2398 | - $search_string = '%' . $this->_req_data['s'] . '%'; |
|
2398 | + $search_string = '%'.$this->_req_data['s'].'%'; |
|
2399 | 2399 | $_where['OR'] = array( |
2400 | 2400 | 'Registration.Event.EVT_name' => array('LIKE', $search_string), |
2401 | 2401 | 'Registration.Event.EVT_desc' => array('LIKE', $search_string), |
@@ -2422,9 +2422,9 @@ discard block |
||
2422 | 2422 | } |
2423 | 2423 | |
2424 | 2424 | //failed transactions |
2425 | - $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
2425 | + $failed = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count) |
|
2426 | 2426 | || ($count && $view === 'failed'); |
2427 | - $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
2427 | + $abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count) |
|
2428 | 2428 | || ($count && $view === 'abandoned'); |
2429 | 2429 | |
2430 | 2430 | if ($failed) { |
@@ -24,1256 +24,1256 @@ |
||
24 | 24 | { |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
29 | - * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
30 | - */ |
|
31 | - const req_type_normal = 0; |
|
32 | - |
|
33 | - /** |
|
34 | - * Indicates this is a brand new installation of EE so we should install |
|
35 | - * tables and default data etc |
|
36 | - */ |
|
37 | - const req_type_new_activation = 1; |
|
38 | - |
|
39 | - /** |
|
40 | - * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
41 | - * and we just exited maintenance mode). We MUST check the database is setup properly |
|
42 | - * and that default data is setup too |
|
43 | - */ |
|
44 | - const req_type_reactivation = 2; |
|
45 | - |
|
46 | - /** |
|
47 | - * indicates that EE has been upgraded since its previous request. |
|
48 | - * We may have data migration scripts to call and will want to trigger maintenance mode |
|
49 | - */ |
|
50 | - const req_type_upgrade = 3; |
|
51 | - |
|
52 | - /** |
|
53 | - * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
54 | - */ |
|
55 | - const req_type_downgrade = 4; |
|
56 | - |
|
57 | - /** |
|
58 | - * @deprecated since version 4.6.0.dev.006 |
|
59 | - * Now whenever a new_activation is detected the request type is still just |
|
60 | - * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
61 | - * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
62 | - * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
63 | - * (Specifically, when the migration manager indicates migrations are finished |
|
64 | - * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
65 | - */ |
|
66 | - const req_type_activation_but_not_installed = 5; |
|
67 | - |
|
68 | - /** |
|
69 | - * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
70 | - */ |
|
71 | - const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
72 | - |
|
73 | - |
|
74 | - /** |
|
75 | - * @var EE_System $_instance |
|
76 | - */ |
|
77 | - private static $_instance; |
|
78 | - |
|
79 | - /** |
|
80 | - * @var EE_Registry $registry |
|
81 | - */ |
|
82 | - private $registry; |
|
83 | - |
|
84 | - /** |
|
85 | - * @var LoaderInterface $loader |
|
86 | - */ |
|
87 | - private $loader; |
|
88 | - |
|
89 | - /** |
|
90 | - * @var EE_Capabilities $capabilities |
|
91 | - */ |
|
92 | - private $capabilities; |
|
93 | - |
|
94 | - /** |
|
95 | - * @var RequestInterface $request |
|
96 | - */ |
|
97 | - private $request; |
|
98 | - |
|
99 | - /** |
|
100 | - * @var EE_Maintenance_Mode $maintenance_mode |
|
101 | - */ |
|
102 | - private $maintenance_mode; |
|
103 | - |
|
104 | - /** |
|
105 | - * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
106 | - * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
107 | - * |
|
108 | - * @var int $_req_type |
|
109 | - */ |
|
110 | - private $_req_type; |
|
111 | - |
|
112 | - /** |
|
113 | - * Whether or not there was a non-micro version change in EE core version during this request |
|
114 | - * |
|
115 | - * @var boolean $_major_version_change |
|
116 | - */ |
|
117 | - private $_major_version_change = false; |
|
118 | - |
|
119 | - /** |
|
120 | - * A Context DTO dedicated solely to identifying the current request type. |
|
121 | - * |
|
122 | - * @var RequestTypeContextCheckerInterface $request_type |
|
123 | - */ |
|
124 | - private $request_type; |
|
125 | - |
|
126 | - |
|
127 | - |
|
128 | - /** |
|
129 | - * @singleton method used to instantiate class object |
|
130 | - * @param EE_Registry|null $registry |
|
131 | - * @param LoaderInterface|null $loader |
|
132 | - * @param RequestInterface|null $request |
|
133 | - * @param EE_Maintenance_Mode|null $maintenance_mode |
|
134 | - * @return EE_System |
|
135 | - */ |
|
136 | - public static function instance( |
|
137 | - EE_Registry $registry = null, |
|
138 | - LoaderInterface $loader = null, |
|
139 | - RequestInterface $request = null, |
|
140 | - EE_Maintenance_Mode $maintenance_mode = null |
|
141 | - ) { |
|
142 | - // check if class object is instantiated |
|
143 | - if (! self::$_instance instanceof EE_System) { |
|
144 | - self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
145 | - } |
|
146 | - return self::$_instance; |
|
147 | - } |
|
148 | - |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * resets the instance and returns it |
|
153 | - * |
|
154 | - * @return EE_System |
|
155 | - */ |
|
156 | - public static function reset() |
|
157 | - { |
|
158 | - self::$_instance->_req_type = null; |
|
159 | - //make sure none of the old hooks are left hanging around |
|
160 | - remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
161 | - //we need to reset the migration manager in order for it to detect DMSs properly |
|
162 | - EE_Data_Migration_Manager::reset(); |
|
163 | - self::instance()->detect_activations_or_upgrades(); |
|
164 | - self::instance()->perform_activations_upgrades_and_migrations(); |
|
165 | - return self::instance(); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - |
|
170 | - /** |
|
171 | - * sets hooks for running rest of system |
|
172 | - * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
173 | - * starting EE Addons from any other point may lead to problems |
|
174 | - * |
|
175 | - * @param EE_Registry $registry |
|
176 | - * @param LoaderInterface $loader |
|
177 | - * @param RequestInterface $request |
|
178 | - * @param EE_Maintenance_Mode $maintenance_mode |
|
179 | - */ |
|
180 | - private function __construct( |
|
181 | - EE_Registry $registry, |
|
182 | - LoaderInterface $loader, |
|
183 | - RequestInterface $request, |
|
184 | - EE_Maintenance_Mode $maintenance_mode |
|
185 | - ) { |
|
186 | - $this->registry = $registry; |
|
187 | - $this->loader = $loader; |
|
188 | - $this->request = $request; |
|
189 | - $this->maintenance_mode = $maintenance_mode; |
|
190 | - do_action('AHEE__EE_System__construct__begin', $this); |
|
191 | - add_action( |
|
192 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
193 | - array($this, 'loadCapabilities'), |
|
194 | - 5 |
|
195 | - ); |
|
196 | - add_action( |
|
197 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
198 | - array($this, 'loadCommandBus'), |
|
199 | - 7 |
|
200 | - ); |
|
201 | - add_action( |
|
202 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
203 | - array($this, 'loadPluginApi'), |
|
204 | - 9 |
|
205 | - ); |
|
206 | - // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
207 | - add_action( |
|
208 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
209 | - array($this, 'load_espresso_addons') |
|
210 | - ); |
|
211 | - // when an ee addon is activated, we want to call the core hook(s) again |
|
212 | - // because the newly-activated addon didn't get a chance to run at all |
|
213 | - add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
214 | - // detect whether install or upgrade |
|
215 | - add_action( |
|
216 | - 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
217 | - array($this, 'detect_activations_or_upgrades'), |
|
218 | - 3 |
|
219 | - ); |
|
220 | - // load EE_Config, EE_Textdomain, etc |
|
221 | - add_action( |
|
222 | - 'AHEE__EE_Bootstrap__load_core_configuration', |
|
223 | - array($this, 'load_core_configuration'), |
|
224 | - 5 |
|
225 | - ); |
|
226 | - // load EE_Config, EE_Textdomain, etc |
|
227 | - add_action( |
|
228 | - 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
229 | - array($this, 'register_shortcodes_modules_and_widgets'), |
|
230 | - 7 |
|
231 | - ); |
|
232 | - // you wanna get going? I wanna get going... let's get going! |
|
233 | - add_action( |
|
234 | - 'AHEE__EE_Bootstrap__brew_espresso', |
|
235 | - array($this, 'brew_espresso'), |
|
236 | - 9 |
|
237 | - ); |
|
238 | - //other housekeeping |
|
239 | - //exclude EE critical pages from wp_list_pages |
|
240 | - add_filter( |
|
241 | - 'wp_list_pages_excludes', |
|
242 | - array($this, 'remove_pages_from_wp_list_pages'), |
|
243 | - 10 |
|
244 | - ); |
|
245 | - // ALL EE Addons should use the following hook point to attach their initial setup too |
|
246 | - // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
247 | - do_action('AHEE__EE_System__construct__complete', $this); |
|
248 | - } |
|
249 | - |
|
250 | - |
|
251 | - /** |
|
252 | - * load and setup EE_Capabilities |
|
253 | - * |
|
254 | - * @return void |
|
255 | - * @throws EE_Error |
|
256 | - */ |
|
257 | - public function loadCapabilities() |
|
258 | - { |
|
259 | - $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
260 | - add_action( |
|
261 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
262 | - function () |
|
263 | - { |
|
264 | - LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
265 | - } |
|
266 | - ); |
|
267 | - } |
|
268 | - |
|
269 | - |
|
270 | - |
|
271 | - /** |
|
272 | - * create and cache the CommandBus, and also add middleware |
|
273 | - * The CapChecker middleware requires the use of EE_Capabilities |
|
274 | - * which is why we need to load the CommandBus after Caps are set up |
|
275 | - * |
|
276 | - * @return void |
|
277 | - * @throws EE_Error |
|
278 | - */ |
|
279 | - public function loadCommandBus() |
|
280 | - { |
|
281 | - $this->loader->getShared( |
|
282 | - 'CommandBusInterface', |
|
283 | - array( |
|
284 | - null, |
|
285 | - apply_filters( |
|
286 | - 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
287 | - array( |
|
288 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
289 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
290 | - ) |
|
291 | - ), |
|
292 | - ) |
|
293 | - ); |
|
294 | - } |
|
295 | - |
|
296 | - |
|
297 | - |
|
298 | - /** |
|
299 | - * @return void |
|
300 | - * @throws EE_Error |
|
301 | - */ |
|
302 | - public function loadPluginApi() |
|
303 | - { |
|
304 | - // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
305 | - // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
306 | - EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
307 | - $this->loader->getShared('EE_Request_Handler'); |
|
308 | - } |
|
309 | - |
|
310 | - |
|
311 | - /** |
|
312 | - * @param string $addon_name |
|
313 | - * @param string $version_constant |
|
314 | - * @param string $min_version_required |
|
315 | - * @param string $load_callback |
|
316 | - * @param string $plugin_file_constant |
|
317 | - * @return void |
|
318 | - */ |
|
319 | - private function deactivateIncompatibleAddon( |
|
320 | - $addon_name, |
|
321 | - $version_constant, |
|
322 | - $min_version_required, |
|
323 | - $load_callback, |
|
324 | - $plugin_file_constant |
|
325 | - ) { |
|
326 | - if (! defined($version_constant)) { |
|
327 | - return; |
|
328 | - } |
|
329 | - $addon_version = constant($version_constant); |
|
330 | - if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
331 | - remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
332 | - if (! function_exists('deactivate_plugins')) { |
|
333 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
334 | - } |
|
335 | - deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
336 | - unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
337 | - EE_Error::add_error( |
|
338 | - sprintf( |
|
339 | - esc_html__( |
|
340 | - 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
341 | - 'event_espresso' |
|
342 | - ), |
|
343 | - $addon_name, |
|
344 | - $min_version_required |
|
345 | - ), |
|
346 | - __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__ |
|
347 | - ); |
|
348 | - EE_Error::get_notices(false, true); |
|
349 | - } |
|
350 | - } |
|
351 | - |
|
352 | - |
|
353 | - /** |
|
354 | - * load_espresso_addons |
|
355 | - * allow addons to load first so that they can set hooks for running DMS's, etc |
|
356 | - * this is hooked into both: |
|
357 | - * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
358 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
359 | - * and the WP 'activate_plugin' hook point |
|
360 | - * |
|
361 | - * @access public |
|
362 | - * @return void |
|
363 | - */ |
|
364 | - public function load_espresso_addons() |
|
365 | - { |
|
366 | - $this->deactivateIncompatibleAddon( |
|
367 | - 'Wait Lists', |
|
368 | - 'EE_WAIT_LISTS_VERSION', |
|
369 | - '1.0.0.beta.074', |
|
370 | - 'load_espresso_wait_lists', |
|
371 | - 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
372 | - ); |
|
373 | - $this->deactivateIncompatibleAddon( |
|
374 | - 'Automated Upcoming Event Notifications', |
|
375 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
376 | - '1.0.0.beta.091', |
|
377 | - 'load_espresso_automated_upcoming_event_notification', |
|
378 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
379 | - ); |
|
380 | - do_action('AHEE__EE_System__load_espresso_addons'); |
|
381 | - //if the WP API basic auth plugin isn't already loaded, load it now. |
|
382 | - //We want it for mobile apps. Just include the entire plugin |
|
383 | - //also, don't load the basic auth when a plugin is getting activated, because |
|
384 | - //it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
385 | - //and causes a fatal error |
|
386 | - if ( |
|
387 | - $this->request->getRequestParam('activate') !== 'true' |
|
388 | - && ! function_exists('json_basic_auth_handler') |
|
389 | - && ! function_exists('json_basic_auth_error') |
|
390 | - && ! in_array( |
|
391 | - $this->request->getRequestParam('action'), |
|
392 | - array('activate', 'activate-selected'), |
|
393 | - true |
|
394 | - ) |
|
395 | - ) { |
|
396 | - include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
397 | - } |
|
398 | - do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
399 | - } |
|
400 | - |
|
401 | - |
|
402 | - |
|
403 | - /** |
|
404 | - * detect_activations_or_upgrades |
|
405 | - * Checks for activation or upgrade of core first; |
|
406 | - * then also checks if any registered addons have been activated or upgraded |
|
407 | - * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
408 | - * which runs during the WP 'plugins_loaded' action at priority 3 |
|
409 | - * |
|
410 | - * @access public |
|
411 | - * @return void |
|
412 | - */ |
|
413 | - public function detect_activations_or_upgrades() |
|
414 | - { |
|
415 | - //first off: let's make sure to handle core |
|
416 | - $this->detect_if_activation_or_upgrade(); |
|
417 | - foreach ($this->registry->addons as $addon) { |
|
418 | - if ($addon instanceof EE_Addon) { |
|
419 | - //detect teh request type for that addon |
|
420 | - $addon->detect_activation_or_upgrade(); |
|
421 | - } |
|
422 | - } |
|
423 | - } |
|
424 | - |
|
425 | - |
|
426 | - |
|
427 | - /** |
|
428 | - * detect_if_activation_or_upgrade |
|
429 | - * Takes care of detecting whether this is a brand new install or code upgrade, |
|
430 | - * and either setting up the DB or setting up maintenance mode etc. |
|
431 | - * |
|
432 | - * @access public |
|
433 | - * @return void |
|
434 | - */ |
|
435 | - public function detect_if_activation_or_upgrade() |
|
436 | - { |
|
437 | - do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
438 | - // check if db has been updated, or if its a brand-new installation |
|
439 | - $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
440 | - $request_type = $this->detect_req_type($espresso_db_update); |
|
441 | - //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
442 | - switch ($request_type) { |
|
443 | - case EE_System::req_type_new_activation: |
|
444 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
445 | - $this->_handle_core_version_change($espresso_db_update); |
|
446 | - break; |
|
447 | - case EE_System::req_type_reactivation: |
|
448 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
449 | - $this->_handle_core_version_change($espresso_db_update); |
|
450 | - break; |
|
451 | - case EE_System::req_type_upgrade: |
|
452 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
453 | - //migrations may be required now that we've upgraded |
|
454 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
455 | - $this->_handle_core_version_change($espresso_db_update); |
|
456 | - // echo "done upgrade";die; |
|
457 | - break; |
|
458 | - case EE_System::req_type_downgrade: |
|
459 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
460 | - //its possible migrations are no longer required |
|
461 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
462 | - $this->_handle_core_version_change($espresso_db_update); |
|
463 | - break; |
|
464 | - case EE_System::req_type_normal: |
|
465 | - default: |
|
466 | - break; |
|
467 | - } |
|
468 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
469 | - } |
|
470 | - |
|
471 | - |
|
472 | - |
|
473 | - /** |
|
474 | - * Updates the list of installed versions and sets hooks for |
|
475 | - * initializing the database later during the request |
|
476 | - * |
|
477 | - * @param array $espresso_db_update |
|
478 | - */ |
|
479 | - private function _handle_core_version_change($espresso_db_update) |
|
480 | - { |
|
481 | - $this->update_list_of_installed_versions($espresso_db_update); |
|
482 | - //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
483 | - add_action( |
|
484 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
485 | - array($this, 'initialize_db_if_no_migrations_required') |
|
486 | - ); |
|
487 | - } |
|
488 | - |
|
489 | - |
|
490 | - |
|
491 | - /** |
|
492 | - * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
493 | - * information about what versions of EE have been installed and activated, |
|
494 | - * NOT necessarily the state of the database |
|
495 | - * |
|
496 | - * @param mixed $espresso_db_update the value of the WordPress option. |
|
497 | - * If not supplied, fetches it from the options table |
|
498 | - * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
499 | - */ |
|
500 | - private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
501 | - { |
|
502 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
503 | - if (! $espresso_db_update) { |
|
504 | - $espresso_db_update = get_option('espresso_db_update'); |
|
505 | - } |
|
506 | - // check that option is an array |
|
507 | - if (! is_array($espresso_db_update)) { |
|
508 | - // if option is FALSE, then it never existed |
|
509 | - if ($espresso_db_update === false) { |
|
510 | - // make $espresso_db_update an array and save option with autoload OFF |
|
511 | - $espresso_db_update = array(); |
|
512 | - add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
513 | - } else { |
|
514 | - // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
515 | - $espresso_db_update = array($espresso_db_update => array()); |
|
516 | - update_option('espresso_db_update', $espresso_db_update); |
|
517 | - } |
|
518 | - } else { |
|
519 | - $corrected_db_update = array(); |
|
520 | - //if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
521 | - foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
522 | - if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
523 | - //the key is an int, and the value IS NOT an array |
|
524 | - //so it must be numerically-indexed, where values are versions installed... |
|
525 | - //fix it! |
|
526 | - $version_string = $should_be_array; |
|
527 | - $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
528 | - } else { |
|
529 | - //ok it checks out |
|
530 | - $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
531 | - } |
|
532 | - } |
|
533 | - $espresso_db_update = $corrected_db_update; |
|
534 | - update_option('espresso_db_update', $espresso_db_update); |
|
535 | - } |
|
536 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
537 | - return $espresso_db_update; |
|
538 | - } |
|
539 | - |
|
540 | - |
|
541 | - |
|
542 | - /** |
|
543 | - * Does the traditional work of setting up the plugin's database and adding default data. |
|
544 | - * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
545 | - * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
546 | - * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
547 | - * so that it will be done when migrations are finished |
|
548 | - * |
|
549 | - * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
550 | - * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
551 | - * This is a resource-intensive job |
|
552 | - * so we prefer to only do it when necessary |
|
553 | - * @return void |
|
554 | - * @throws EE_Error |
|
555 | - */ |
|
556 | - public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
557 | - { |
|
558 | - $request_type = $this->detect_req_type(); |
|
559 | - //only initialize system if we're not in maintenance mode. |
|
560 | - if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
561 | - update_option('ee_flush_rewrite_rules', true); |
|
562 | - if ($verify_schema) { |
|
563 | - EEH_Activation::initialize_db_and_folders(); |
|
564 | - } |
|
565 | - EEH_Activation::initialize_db_content(); |
|
566 | - EEH_Activation::system_initialization(); |
|
567 | - if ($initialize_addons_too) { |
|
568 | - $this->initialize_addons(); |
|
569 | - } |
|
570 | - } else { |
|
571 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
572 | - } |
|
573 | - if ($request_type === EE_System::req_type_new_activation |
|
574 | - || $request_type === EE_System::req_type_reactivation |
|
575 | - || ( |
|
576 | - $request_type === EE_System::req_type_upgrade |
|
577 | - && $this->is_major_version_change() |
|
578 | - ) |
|
579 | - ) { |
|
580 | - add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
581 | - } |
|
582 | - } |
|
583 | - |
|
584 | - |
|
585 | - |
|
586 | - /** |
|
587 | - * Initializes the db for all registered addons |
|
588 | - * |
|
589 | - * @throws EE_Error |
|
590 | - */ |
|
591 | - public function initialize_addons() |
|
592 | - { |
|
593 | - //foreach registered addon, make sure its db is up-to-date too |
|
594 | - foreach ($this->registry->addons as $addon) { |
|
595 | - if ($addon instanceof EE_Addon) { |
|
596 | - $addon->initialize_db_if_no_migrations_required(); |
|
597 | - } |
|
598 | - } |
|
599 | - } |
|
600 | - |
|
601 | - |
|
602 | - |
|
603 | - /** |
|
604 | - * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
605 | - * |
|
606 | - * @param array $version_history |
|
607 | - * @param string $current_version_to_add version to be added to the version history |
|
608 | - * @return boolean success as to whether or not this option was changed |
|
609 | - */ |
|
610 | - public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
611 | - { |
|
612 | - if (! $version_history) { |
|
613 | - $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
614 | - } |
|
615 | - if ($current_version_to_add === null) { |
|
616 | - $current_version_to_add = espresso_version(); |
|
617 | - } |
|
618 | - $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
619 | - // re-save |
|
620 | - return update_option('espresso_db_update', $version_history); |
|
621 | - } |
|
622 | - |
|
623 | - |
|
624 | - |
|
625 | - /** |
|
626 | - * Detects if the current version indicated in the has existed in the list of |
|
627 | - * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
628 | - * |
|
629 | - * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
630 | - * If not supplied, fetches it from the options table. |
|
631 | - * Also, caches its result so later parts of the code can also know whether |
|
632 | - * there's been an update or not. This way we can add the current version to |
|
633 | - * espresso_db_update, but still know if this is a new install or not |
|
634 | - * @return int one of the constants on EE_System::req_type_ |
|
635 | - */ |
|
636 | - public function detect_req_type($espresso_db_update = null) |
|
637 | - { |
|
638 | - if ($this->_req_type === null) { |
|
639 | - $espresso_db_update = ! empty($espresso_db_update) |
|
640 | - ? $espresso_db_update |
|
641 | - : $this->fix_espresso_db_upgrade_option(); |
|
642 | - $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
643 | - $espresso_db_update, |
|
644 | - 'ee_espresso_activation', espresso_version() |
|
645 | - ); |
|
646 | - $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
647 | - $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
648 | - } |
|
649 | - return $this->_req_type; |
|
650 | - } |
|
651 | - |
|
652 | - |
|
653 | - |
|
654 | - /** |
|
655 | - * Returns whether or not there was a non-micro version change (ie, change in either |
|
656 | - * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
657 | - * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
658 | - * |
|
659 | - * @param $activation_history |
|
660 | - * @return bool |
|
661 | - */ |
|
662 | - private function _detect_major_version_change($activation_history) |
|
663 | - { |
|
664 | - $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
665 | - $previous_version_parts = explode('.', $previous_version); |
|
666 | - $current_version_parts = explode('.', espresso_version()); |
|
667 | - return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
668 | - && ($previous_version_parts[0] !== $current_version_parts[0] |
|
669 | - || $previous_version_parts[1] !== $current_version_parts[1] |
|
670 | - ); |
|
671 | - } |
|
672 | - |
|
673 | - |
|
674 | - |
|
675 | - /** |
|
676 | - * Returns true if either the major or minor version of EE changed during this request. |
|
677 | - * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
678 | - * |
|
679 | - * @return bool |
|
680 | - */ |
|
681 | - public function is_major_version_change() |
|
682 | - { |
|
683 | - return $this->_major_version_change; |
|
684 | - } |
|
685 | - |
|
686 | - |
|
687 | - |
|
688 | - /** |
|
689 | - * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
690 | - * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
691 | - * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
692 | - * just activated to (for core that will always be espresso_version()) |
|
693 | - * |
|
694 | - * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
695 | - * ee plugin. for core that's 'espresso_db_update' |
|
696 | - * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
697 | - * indicate that this plugin was just activated |
|
698 | - * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
699 | - * espresso_version()) |
|
700 | - * @return int one of the constants on EE_System::req_type_* |
|
701 | - */ |
|
702 | - public static function detect_req_type_given_activation_history( |
|
703 | - $activation_history_for_addon, |
|
704 | - $activation_indicator_option_name, |
|
705 | - $version_to_upgrade_to |
|
706 | - ) { |
|
707 | - $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
708 | - if ($activation_history_for_addon) { |
|
709 | - //it exists, so this isn't a completely new install |
|
710 | - //check if this version already in that list of previously installed versions |
|
711 | - if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
712 | - //it a version we haven't seen before |
|
713 | - if ($version_is_higher === 1) { |
|
714 | - $req_type = EE_System::req_type_upgrade; |
|
715 | - } else { |
|
716 | - $req_type = EE_System::req_type_downgrade; |
|
717 | - } |
|
718 | - delete_option($activation_indicator_option_name); |
|
719 | - } else { |
|
720 | - // its not an update. maybe a reactivation? |
|
721 | - if (get_option($activation_indicator_option_name, false)) { |
|
722 | - if ($version_is_higher === -1) { |
|
723 | - $req_type = EE_System::req_type_downgrade; |
|
724 | - } elseif ($version_is_higher === 0) { |
|
725 | - //we've seen this version before, but it's an activation. must be a reactivation |
|
726 | - $req_type = EE_System::req_type_reactivation; |
|
727 | - } else {//$version_is_higher === 1 |
|
728 | - $req_type = EE_System::req_type_upgrade; |
|
729 | - } |
|
730 | - delete_option($activation_indicator_option_name); |
|
731 | - } else { |
|
732 | - //we've seen this version before and the activation indicate doesn't show it was just activated |
|
733 | - if ($version_is_higher === -1) { |
|
734 | - $req_type = EE_System::req_type_downgrade; |
|
735 | - } elseif ($version_is_higher === 0) { |
|
736 | - //we've seen this version before and it's not an activation. its normal request |
|
737 | - $req_type = EE_System::req_type_normal; |
|
738 | - } else {//$version_is_higher === 1 |
|
739 | - $req_type = EE_System::req_type_upgrade; |
|
740 | - } |
|
741 | - } |
|
742 | - } |
|
743 | - } else { |
|
744 | - //brand new install |
|
745 | - $req_type = EE_System::req_type_new_activation; |
|
746 | - delete_option($activation_indicator_option_name); |
|
747 | - } |
|
748 | - return $req_type; |
|
749 | - } |
|
750 | - |
|
751 | - |
|
752 | - |
|
753 | - /** |
|
754 | - * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
755 | - * the $activation_history_for_addon |
|
756 | - * |
|
757 | - * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
758 | - * sometimes containing 'unknown-date' |
|
759 | - * @param string $version_to_upgrade_to (current version) |
|
760 | - * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
761 | - * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
762 | - * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
763 | - * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
764 | - */ |
|
765 | - private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
766 | - { |
|
767 | - //find the most recently-activated version |
|
768 | - $most_recently_active_version = |
|
769 | - EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
770 | - return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
771 | - } |
|
772 | - |
|
773 | - |
|
774 | - |
|
775 | - /** |
|
776 | - * Gets the most recently active version listed in the activation history, |
|
777 | - * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
778 | - * |
|
779 | - * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
780 | - * sometimes containing 'unknown-date' |
|
781 | - * @return string |
|
782 | - */ |
|
783 | - private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
784 | - { |
|
785 | - $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
786 | - $most_recently_active_version = '0.0.0.dev.000'; |
|
787 | - if (is_array($activation_history)) { |
|
788 | - foreach ($activation_history as $version => $times_activated) { |
|
789 | - //check there is a record of when this version was activated. Otherwise, |
|
790 | - //mark it as unknown |
|
791 | - if (! $times_activated) { |
|
792 | - $times_activated = array('unknown-date'); |
|
793 | - } |
|
794 | - if (is_string($times_activated)) { |
|
795 | - $times_activated = array($times_activated); |
|
796 | - } |
|
797 | - foreach ($times_activated as $an_activation) { |
|
798 | - if ($an_activation !== 'unknown-date' |
|
799 | - && $an_activation |
|
800 | - > $most_recently_active_version_activation) { |
|
801 | - $most_recently_active_version = $version; |
|
802 | - $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
803 | - ? '1970-01-01 00:00:00' |
|
804 | - : $an_activation; |
|
805 | - } |
|
806 | - } |
|
807 | - } |
|
808 | - } |
|
809 | - return $most_recently_active_version; |
|
810 | - } |
|
811 | - |
|
812 | - |
|
813 | - |
|
814 | - /** |
|
815 | - * This redirects to the about EE page after activation |
|
816 | - * |
|
817 | - * @return void |
|
818 | - */ |
|
819 | - public function redirect_to_about_ee() |
|
820 | - { |
|
821 | - $notices = EE_Error::get_notices(false); |
|
822 | - //if current user is an admin and it's not an ajax or rest request |
|
823 | - if ( |
|
824 | - ! isset($notices['errors']) |
|
825 | - && $this->request->isAdmin() |
|
826 | - && apply_filters( |
|
827 | - 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
828 | - $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
829 | - ) |
|
830 | - ) { |
|
831 | - $query_params = array('page' => 'espresso_about'); |
|
832 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
833 | - $query_params['new_activation'] = true; |
|
834 | - } |
|
835 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
836 | - $query_params['reactivation'] = true; |
|
837 | - } |
|
838 | - $url = add_query_arg($query_params, admin_url('admin.php')); |
|
839 | - wp_safe_redirect($url); |
|
840 | - exit(); |
|
841 | - } |
|
842 | - } |
|
843 | - |
|
844 | - |
|
845 | - |
|
846 | - /** |
|
847 | - * load_core_configuration |
|
848 | - * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
849 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
850 | - * |
|
851 | - * @return void |
|
852 | - * @throws ReflectionException |
|
853 | - */ |
|
854 | - public function load_core_configuration() |
|
855 | - { |
|
856 | - do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
857 | - $this->loader->getShared('EE_Load_Textdomain'); |
|
858 | - //load textdomain |
|
859 | - EE_Load_Textdomain::load_textdomain(); |
|
860 | - // load and setup EE_Config and EE_Network_Config |
|
861 | - $config = $this->loader->getShared('EE_Config'); |
|
862 | - $this->loader->getShared('EE_Network_Config'); |
|
863 | - // setup autoloaders |
|
864 | - // enable logging? |
|
865 | - if ($config->admin->use_full_logging) { |
|
866 | - $this->loader->getShared('EE_Log'); |
|
867 | - } |
|
868 | - // check for activation errors |
|
869 | - $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
870 | - if ($activation_errors) { |
|
871 | - EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
872 | - update_option('ee_plugin_activation_errors', false); |
|
873 | - } |
|
874 | - // get model names |
|
875 | - $this->_parse_model_names(); |
|
876 | - //load caf stuff a chance to play during the activation process too. |
|
877 | - $this->_maybe_brew_regular(); |
|
878 | - do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
879 | - } |
|
880 | - |
|
881 | - |
|
882 | - |
|
883 | - /** |
|
884 | - * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
885 | - * |
|
886 | - * @return void |
|
887 | - * @throws ReflectionException |
|
888 | - */ |
|
889 | - private function _parse_model_names() |
|
890 | - { |
|
891 | - //get all the files in the EE_MODELS folder that end in .model.php |
|
892 | - $models = glob(EE_MODELS . '*.model.php'); |
|
893 | - $model_names = array(); |
|
894 | - $non_abstract_db_models = array(); |
|
895 | - foreach ($models as $model) { |
|
896 | - // get model classname |
|
897 | - $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
898 | - $short_name = str_replace('EEM_', '', $classname); |
|
899 | - $reflectionClass = new ReflectionClass($classname); |
|
900 | - if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
901 | - $non_abstract_db_models[ $short_name ] = $classname; |
|
902 | - } |
|
903 | - $model_names[ $short_name ] = $classname; |
|
904 | - } |
|
905 | - $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
906 | - $this->registry->non_abstract_db_models = apply_filters( |
|
907 | - 'FHEE__EE_System__parse_implemented_model_names', |
|
908 | - $non_abstract_db_models |
|
909 | - ); |
|
910 | - } |
|
911 | - |
|
912 | - |
|
913 | - |
|
914 | - /** |
|
915 | - * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
916 | - * that need to be setup before our EE_System launches. |
|
917 | - * |
|
918 | - * @return void |
|
919 | - */ |
|
920 | - private function _maybe_brew_regular() |
|
921 | - { |
|
922 | - if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) { |
|
923 | - require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
924 | - } |
|
925 | - } |
|
926 | - |
|
927 | - |
|
928 | - |
|
929 | - /** |
|
930 | - * register_shortcodes_modules_and_widgets |
|
931 | - * generate lists of shortcodes and modules, then verify paths and classes |
|
932 | - * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
933 | - * which runs during the WP 'plugins_loaded' action at priority 7 |
|
934 | - * |
|
935 | - * @access public |
|
936 | - * @return void |
|
937 | - * @throws Exception |
|
938 | - */ |
|
939 | - public function register_shortcodes_modules_and_widgets() |
|
940 | - { |
|
941 | - if ($this->request->isFrontend() || $this->request->isIframe()) { |
|
942 | - try { |
|
943 | - // load, register, and add shortcodes the new way |
|
944 | - $this->loader->getShared( |
|
945 | - 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
946 | - array( |
|
947 | - // and the old way, but we'll put it under control of the new system |
|
948 | - EE_Config::getLegacyShortcodesManager(), |
|
949 | - ) |
|
950 | - ); |
|
951 | - } catch (Exception $exception) { |
|
952 | - new ExceptionStackTraceDisplay($exception); |
|
953 | - } |
|
954 | - } |
|
955 | - do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
956 | - // check for addons using old hook point |
|
957 | - if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
958 | - $this->_incompatible_addon_error(); |
|
959 | - } |
|
960 | - } |
|
961 | - |
|
962 | - |
|
963 | - |
|
964 | - /** |
|
965 | - * _incompatible_addon_error |
|
966 | - * |
|
967 | - * @access public |
|
968 | - * @return void |
|
969 | - */ |
|
970 | - private function _incompatible_addon_error() |
|
971 | - { |
|
972 | - // get array of classes hooking into here |
|
973 | - $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
974 | - 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
975 | - ); |
|
976 | - if (! empty($class_names)) { |
|
977 | - $msg = __( |
|
978 | - 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
979 | - 'event_espresso' |
|
980 | - ); |
|
981 | - $msg .= '<ul>'; |
|
982 | - foreach ($class_names as $class_name) { |
|
983 | - $msg .= '<li><b>Event Espresso - ' . str_replace( |
|
984 | - array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '', |
|
985 | - $class_name |
|
986 | - ) . '</b></li>'; |
|
987 | - } |
|
988 | - $msg .= '</ul>'; |
|
989 | - $msg .= __( |
|
990 | - 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
991 | - 'event_espresso' |
|
992 | - ); |
|
993 | - // save list of incompatible addons to wp-options for later use |
|
994 | - add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
995 | - if (is_admin()) { |
|
996 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
997 | - } |
|
998 | - } |
|
999 | - } |
|
1000 | - |
|
1001 | - |
|
1002 | - |
|
1003 | - /** |
|
1004 | - * brew_espresso |
|
1005 | - * begins the process of setting hooks for initializing EE in the correct order |
|
1006 | - * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1007 | - * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1008 | - * |
|
1009 | - * @return void |
|
1010 | - */ |
|
1011 | - public function brew_espresso() |
|
1012 | - { |
|
1013 | - do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1014 | - // load some final core systems |
|
1015 | - add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1016 | - add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1017 | - add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1018 | - add_action('init', array($this, 'load_controllers'), 7); |
|
1019 | - add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1020 | - add_action('init', array($this, 'initialize'), 10); |
|
1021 | - add_action('init', array($this, 'initialize_last'), 100); |
|
1022 | - if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1023 | - // pew pew pew |
|
1024 | - $this->loader->getShared('EE_PUE'); |
|
1025 | - do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1026 | - } |
|
1027 | - do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1028 | - } |
|
1029 | - |
|
1030 | - |
|
1031 | - |
|
1032 | - /** |
|
1033 | - * set_hooks_for_core |
|
1034 | - * |
|
1035 | - * @access public |
|
1036 | - * @return void |
|
1037 | - * @throws EE_Error |
|
1038 | - */ |
|
1039 | - public function set_hooks_for_core() |
|
1040 | - { |
|
1041 | - $this->_deactivate_incompatible_addons(); |
|
1042 | - do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1043 | - $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1044 | - //caps need to be initialized on every request so that capability maps are set. |
|
1045 | - //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1046 | - $this->registry->CAP->init_caps(); |
|
1047 | - } |
|
1048 | - |
|
1049 | - |
|
1050 | - |
|
1051 | - /** |
|
1052 | - * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1053 | - * deactivates any addons considered incompatible with the current version of EE |
|
1054 | - */ |
|
1055 | - private function _deactivate_incompatible_addons() |
|
1056 | - { |
|
1057 | - $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1058 | - if (! empty($incompatible_addons)) { |
|
1059 | - $active_plugins = get_option('active_plugins', array()); |
|
1060 | - foreach ($active_plugins as $active_plugin) { |
|
1061 | - foreach ($incompatible_addons as $incompatible_addon) { |
|
1062 | - if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1063 | - unset($_GET['activate']); |
|
1064 | - espresso_deactivate_plugin($active_plugin); |
|
1065 | - } |
|
1066 | - } |
|
1067 | - } |
|
1068 | - } |
|
1069 | - } |
|
1070 | - |
|
1071 | - |
|
1072 | - |
|
1073 | - /** |
|
1074 | - * perform_activations_upgrades_and_migrations |
|
1075 | - * |
|
1076 | - * @access public |
|
1077 | - * @return void |
|
1078 | - */ |
|
1079 | - public function perform_activations_upgrades_and_migrations() |
|
1080 | - { |
|
1081 | - do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1082 | - } |
|
1083 | - |
|
1084 | - |
|
1085 | - |
|
1086 | - /** |
|
1087 | - * load_CPTs_and_session |
|
1088 | - * |
|
1089 | - * @access public |
|
1090 | - * @return void |
|
1091 | - */ |
|
1092 | - public function load_CPTs_and_session() |
|
1093 | - { |
|
1094 | - do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1095 | - // register Custom Post Types |
|
1096 | - $this->loader->getShared('EE_Register_CPTs'); |
|
1097 | - do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1098 | - } |
|
1099 | - |
|
1100 | - |
|
1101 | - |
|
1102 | - /** |
|
1103 | - * load_controllers |
|
1104 | - * this is the best place to load any additional controllers that needs access to EE core. |
|
1105 | - * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1106 | - * time |
|
1107 | - * |
|
1108 | - * @access public |
|
1109 | - * @return void |
|
1110 | - */ |
|
1111 | - public function load_controllers() |
|
1112 | - { |
|
1113 | - do_action('AHEE__EE_System__load_controllers__start'); |
|
1114 | - // let's get it started |
|
1115 | - if ( |
|
1116 | - ! $this->maintenance_mode->level() |
|
1117 | - && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1118 | - ) { |
|
1119 | - do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1120 | - $this->loader->getShared('EE_Front_Controller'); |
|
1121 | - } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1122 | - do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1123 | - $this->loader->getShared('EE_Admin'); |
|
1124 | - } |
|
1125 | - do_action('AHEE__EE_System__load_controllers__complete'); |
|
1126 | - } |
|
1127 | - |
|
1128 | - |
|
1129 | - |
|
1130 | - /** |
|
1131 | - * core_loaded_and_ready |
|
1132 | - * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1133 | - * |
|
1134 | - * @access public |
|
1135 | - * @return void |
|
1136 | - */ |
|
1137 | - public function core_loaded_and_ready() |
|
1138 | - { |
|
1139 | - if ( |
|
1140 | - $this->request->isAdmin() |
|
1141 | - || $this->request->isEeAjax() |
|
1142 | - || $this->request->isFrontend() |
|
1143 | - ) { |
|
1144 | - $this->loader->getShared('EE_Session'); |
|
1145 | - } |
|
1146 | - do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1147 | - // load_espresso_template_tags |
|
1148 | - if ( |
|
1149 | - is_readable(EE_PUBLIC . 'template_tags.php') |
|
1150 | - && ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed()) |
|
1151 | - ) { |
|
1152 | - require_once EE_PUBLIC . 'template_tags.php'; |
|
1153 | - } |
|
1154 | - do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1155 | - if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1156 | - $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1157 | - } |
|
1158 | - } |
|
1159 | - |
|
1160 | - |
|
1161 | - |
|
1162 | - /** |
|
1163 | - * initialize |
|
1164 | - * this is the best place to begin initializing client code |
|
1165 | - * |
|
1166 | - * @access public |
|
1167 | - * @return void |
|
1168 | - */ |
|
1169 | - public function initialize() |
|
1170 | - { |
|
1171 | - do_action('AHEE__EE_System__initialize'); |
|
1172 | - } |
|
1173 | - |
|
1174 | - |
|
1175 | - |
|
1176 | - /** |
|
1177 | - * initialize_last |
|
1178 | - * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1179 | - * initialize has done so |
|
1180 | - * |
|
1181 | - * @access public |
|
1182 | - * @return void |
|
1183 | - */ |
|
1184 | - public function initialize_last() |
|
1185 | - { |
|
1186 | - do_action('AHEE__EE_System__initialize_last'); |
|
1187 | - add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1188 | - } |
|
1189 | - |
|
1190 | - |
|
1191 | - |
|
1192 | - /** |
|
1193 | - * @return void |
|
1194 | - * @throws EE_Error |
|
1195 | - */ |
|
1196 | - public function addEspressoToolbar() |
|
1197 | - { |
|
1198 | - $this->loader->getShared( |
|
1199 | - 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1200 | - array($this->registry->CAP) |
|
1201 | - ); |
|
1202 | - } |
|
1203 | - |
|
1204 | - |
|
1205 | - |
|
1206 | - /** |
|
1207 | - * do_not_cache |
|
1208 | - * sets no cache headers and defines no cache constants for WP plugins |
|
1209 | - * |
|
1210 | - * @access public |
|
1211 | - * @return void |
|
1212 | - */ |
|
1213 | - public static function do_not_cache() |
|
1214 | - { |
|
1215 | - // set no cache constants |
|
1216 | - if (! defined('DONOTCACHEPAGE')) { |
|
1217 | - define('DONOTCACHEPAGE', true); |
|
1218 | - } |
|
1219 | - if (! defined('DONOTCACHCEOBJECT')) { |
|
1220 | - define('DONOTCACHCEOBJECT', true); |
|
1221 | - } |
|
1222 | - if (! defined('DONOTCACHEDB')) { |
|
1223 | - define('DONOTCACHEDB', true); |
|
1224 | - } |
|
1225 | - // add no cache headers |
|
1226 | - add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1227 | - // plus a little extra for nginx and Google Chrome |
|
1228 | - add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1229 | - // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1230 | - remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1231 | - } |
|
1232 | - |
|
1233 | - |
|
1234 | - |
|
1235 | - /** |
|
1236 | - * extra_nocache_headers |
|
1237 | - * |
|
1238 | - * @access public |
|
1239 | - * @param $headers |
|
1240 | - * @return array |
|
1241 | - */ |
|
1242 | - public static function extra_nocache_headers($headers) |
|
1243 | - { |
|
1244 | - // for NGINX |
|
1245 | - $headers['X-Accel-Expires'] = 0; |
|
1246 | - // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1247 | - $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1248 | - return $headers; |
|
1249 | - } |
|
1250 | - |
|
1251 | - |
|
1252 | - |
|
1253 | - /** |
|
1254 | - * nocache_headers |
|
1255 | - * |
|
1256 | - * @access public |
|
1257 | - * @return void |
|
1258 | - */ |
|
1259 | - public static function nocache_headers() |
|
1260 | - { |
|
1261 | - nocache_headers(); |
|
1262 | - } |
|
1263 | - |
|
1264 | - |
|
1265 | - |
|
1266 | - /** |
|
1267 | - * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1268 | - * never returned with the function. |
|
1269 | - * |
|
1270 | - * @param array $exclude_array any existing pages being excluded are in this array. |
|
1271 | - * @return array |
|
1272 | - */ |
|
1273 | - public function remove_pages_from_wp_list_pages($exclude_array) |
|
1274 | - { |
|
1275 | - return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1276 | - } |
|
27 | + /** |
|
28 | + * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
29 | + * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
30 | + */ |
|
31 | + const req_type_normal = 0; |
|
32 | + |
|
33 | + /** |
|
34 | + * Indicates this is a brand new installation of EE so we should install |
|
35 | + * tables and default data etc |
|
36 | + */ |
|
37 | + const req_type_new_activation = 1; |
|
38 | + |
|
39 | + /** |
|
40 | + * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
41 | + * and we just exited maintenance mode). We MUST check the database is setup properly |
|
42 | + * and that default data is setup too |
|
43 | + */ |
|
44 | + const req_type_reactivation = 2; |
|
45 | + |
|
46 | + /** |
|
47 | + * indicates that EE has been upgraded since its previous request. |
|
48 | + * We may have data migration scripts to call and will want to trigger maintenance mode |
|
49 | + */ |
|
50 | + const req_type_upgrade = 3; |
|
51 | + |
|
52 | + /** |
|
53 | + * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
54 | + */ |
|
55 | + const req_type_downgrade = 4; |
|
56 | + |
|
57 | + /** |
|
58 | + * @deprecated since version 4.6.0.dev.006 |
|
59 | + * Now whenever a new_activation is detected the request type is still just |
|
60 | + * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
61 | + * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
62 | + * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
63 | + * (Specifically, when the migration manager indicates migrations are finished |
|
64 | + * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
65 | + */ |
|
66 | + const req_type_activation_but_not_installed = 5; |
|
67 | + |
|
68 | + /** |
|
69 | + * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
70 | + */ |
|
71 | + const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
72 | + |
|
73 | + |
|
74 | + /** |
|
75 | + * @var EE_System $_instance |
|
76 | + */ |
|
77 | + private static $_instance; |
|
78 | + |
|
79 | + /** |
|
80 | + * @var EE_Registry $registry |
|
81 | + */ |
|
82 | + private $registry; |
|
83 | + |
|
84 | + /** |
|
85 | + * @var LoaderInterface $loader |
|
86 | + */ |
|
87 | + private $loader; |
|
88 | + |
|
89 | + /** |
|
90 | + * @var EE_Capabilities $capabilities |
|
91 | + */ |
|
92 | + private $capabilities; |
|
93 | + |
|
94 | + /** |
|
95 | + * @var RequestInterface $request |
|
96 | + */ |
|
97 | + private $request; |
|
98 | + |
|
99 | + /** |
|
100 | + * @var EE_Maintenance_Mode $maintenance_mode |
|
101 | + */ |
|
102 | + private $maintenance_mode; |
|
103 | + |
|
104 | + /** |
|
105 | + * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
106 | + * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
107 | + * |
|
108 | + * @var int $_req_type |
|
109 | + */ |
|
110 | + private $_req_type; |
|
111 | + |
|
112 | + /** |
|
113 | + * Whether or not there was a non-micro version change in EE core version during this request |
|
114 | + * |
|
115 | + * @var boolean $_major_version_change |
|
116 | + */ |
|
117 | + private $_major_version_change = false; |
|
118 | + |
|
119 | + /** |
|
120 | + * A Context DTO dedicated solely to identifying the current request type. |
|
121 | + * |
|
122 | + * @var RequestTypeContextCheckerInterface $request_type |
|
123 | + */ |
|
124 | + private $request_type; |
|
125 | + |
|
126 | + |
|
127 | + |
|
128 | + /** |
|
129 | + * @singleton method used to instantiate class object |
|
130 | + * @param EE_Registry|null $registry |
|
131 | + * @param LoaderInterface|null $loader |
|
132 | + * @param RequestInterface|null $request |
|
133 | + * @param EE_Maintenance_Mode|null $maintenance_mode |
|
134 | + * @return EE_System |
|
135 | + */ |
|
136 | + public static function instance( |
|
137 | + EE_Registry $registry = null, |
|
138 | + LoaderInterface $loader = null, |
|
139 | + RequestInterface $request = null, |
|
140 | + EE_Maintenance_Mode $maintenance_mode = null |
|
141 | + ) { |
|
142 | + // check if class object is instantiated |
|
143 | + if (! self::$_instance instanceof EE_System) { |
|
144 | + self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
145 | + } |
|
146 | + return self::$_instance; |
|
147 | + } |
|
148 | + |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * resets the instance and returns it |
|
153 | + * |
|
154 | + * @return EE_System |
|
155 | + */ |
|
156 | + public static function reset() |
|
157 | + { |
|
158 | + self::$_instance->_req_type = null; |
|
159 | + //make sure none of the old hooks are left hanging around |
|
160 | + remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
161 | + //we need to reset the migration manager in order for it to detect DMSs properly |
|
162 | + EE_Data_Migration_Manager::reset(); |
|
163 | + self::instance()->detect_activations_or_upgrades(); |
|
164 | + self::instance()->perform_activations_upgrades_and_migrations(); |
|
165 | + return self::instance(); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + |
|
170 | + /** |
|
171 | + * sets hooks for running rest of system |
|
172 | + * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
173 | + * starting EE Addons from any other point may lead to problems |
|
174 | + * |
|
175 | + * @param EE_Registry $registry |
|
176 | + * @param LoaderInterface $loader |
|
177 | + * @param RequestInterface $request |
|
178 | + * @param EE_Maintenance_Mode $maintenance_mode |
|
179 | + */ |
|
180 | + private function __construct( |
|
181 | + EE_Registry $registry, |
|
182 | + LoaderInterface $loader, |
|
183 | + RequestInterface $request, |
|
184 | + EE_Maintenance_Mode $maintenance_mode |
|
185 | + ) { |
|
186 | + $this->registry = $registry; |
|
187 | + $this->loader = $loader; |
|
188 | + $this->request = $request; |
|
189 | + $this->maintenance_mode = $maintenance_mode; |
|
190 | + do_action('AHEE__EE_System__construct__begin', $this); |
|
191 | + add_action( |
|
192 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
193 | + array($this, 'loadCapabilities'), |
|
194 | + 5 |
|
195 | + ); |
|
196 | + add_action( |
|
197 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
198 | + array($this, 'loadCommandBus'), |
|
199 | + 7 |
|
200 | + ); |
|
201 | + add_action( |
|
202 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
203 | + array($this, 'loadPluginApi'), |
|
204 | + 9 |
|
205 | + ); |
|
206 | + // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
207 | + add_action( |
|
208 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
209 | + array($this, 'load_espresso_addons') |
|
210 | + ); |
|
211 | + // when an ee addon is activated, we want to call the core hook(s) again |
|
212 | + // because the newly-activated addon didn't get a chance to run at all |
|
213 | + add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
214 | + // detect whether install or upgrade |
|
215 | + add_action( |
|
216 | + 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
217 | + array($this, 'detect_activations_or_upgrades'), |
|
218 | + 3 |
|
219 | + ); |
|
220 | + // load EE_Config, EE_Textdomain, etc |
|
221 | + add_action( |
|
222 | + 'AHEE__EE_Bootstrap__load_core_configuration', |
|
223 | + array($this, 'load_core_configuration'), |
|
224 | + 5 |
|
225 | + ); |
|
226 | + // load EE_Config, EE_Textdomain, etc |
|
227 | + add_action( |
|
228 | + 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
229 | + array($this, 'register_shortcodes_modules_and_widgets'), |
|
230 | + 7 |
|
231 | + ); |
|
232 | + // you wanna get going? I wanna get going... let's get going! |
|
233 | + add_action( |
|
234 | + 'AHEE__EE_Bootstrap__brew_espresso', |
|
235 | + array($this, 'brew_espresso'), |
|
236 | + 9 |
|
237 | + ); |
|
238 | + //other housekeeping |
|
239 | + //exclude EE critical pages from wp_list_pages |
|
240 | + add_filter( |
|
241 | + 'wp_list_pages_excludes', |
|
242 | + array($this, 'remove_pages_from_wp_list_pages'), |
|
243 | + 10 |
|
244 | + ); |
|
245 | + // ALL EE Addons should use the following hook point to attach their initial setup too |
|
246 | + // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
247 | + do_action('AHEE__EE_System__construct__complete', $this); |
|
248 | + } |
|
249 | + |
|
250 | + |
|
251 | + /** |
|
252 | + * load and setup EE_Capabilities |
|
253 | + * |
|
254 | + * @return void |
|
255 | + * @throws EE_Error |
|
256 | + */ |
|
257 | + public function loadCapabilities() |
|
258 | + { |
|
259 | + $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
260 | + add_action( |
|
261 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
262 | + function () |
|
263 | + { |
|
264 | + LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
265 | + } |
|
266 | + ); |
|
267 | + } |
|
268 | + |
|
269 | + |
|
270 | + |
|
271 | + /** |
|
272 | + * create and cache the CommandBus, and also add middleware |
|
273 | + * The CapChecker middleware requires the use of EE_Capabilities |
|
274 | + * which is why we need to load the CommandBus after Caps are set up |
|
275 | + * |
|
276 | + * @return void |
|
277 | + * @throws EE_Error |
|
278 | + */ |
|
279 | + public function loadCommandBus() |
|
280 | + { |
|
281 | + $this->loader->getShared( |
|
282 | + 'CommandBusInterface', |
|
283 | + array( |
|
284 | + null, |
|
285 | + apply_filters( |
|
286 | + 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
287 | + array( |
|
288 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
289 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
290 | + ) |
|
291 | + ), |
|
292 | + ) |
|
293 | + ); |
|
294 | + } |
|
295 | + |
|
296 | + |
|
297 | + |
|
298 | + /** |
|
299 | + * @return void |
|
300 | + * @throws EE_Error |
|
301 | + */ |
|
302 | + public function loadPluginApi() |
|
303 | + { |
|
304 | + // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
305 | + // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
306 | + EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
307 | + $this->loader->getShared('EE_Request_Handler'); |
|
308 | + } |
|
309 | + |
|
310 | + |
|
311 | + /** |
|
312 | + * @param string $addon_name |
|
313 | + * @param string $version_constant |
|
314 | + * @param string $min_version_required |
|
315 | + * @param string $load_callback |
|
316 | + * @param string $plugin_file_constant |
|
317 | + * @return void |
|
318 | + */ |
|
319 | + private function deactivateIncompatibleAddon( |
|
320 | + $addon_name, |
|
321 | + $version_constant, |
|
322 | + $min_version_required, |
|
323 | + $load_callback, |
|
324 | + $plugin_file_constant |
|
325 | + ) { |
|
326 | + if (! defined($version_constant)) { |
|
327 | + return; |
|
328 | + } |
|
329 | + $addon_version = constant($version_constant); |
|
330 | + if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
331 | + remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
332 | + if (! function_exists('deactivate_plugins')) { |
|
333 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
334 | + } |
|
335 | + deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
336 | + unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
337 | + EE_Error::add_error( |
|
338 | + sprintf( |
|
339 | + esc_html__( |
|
340 | + 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
341 | + 'event_espresso' |
|
342 | + ), |
|
343 | + $addon_name, |
|
344 | + $min_version_required |
|
345 | + ), |
|
346 | + __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__ |
|
347 | + ); |
|
348 | + EE_Error::get_notices(false, true); |
|
349 | + } |
|
350 | + } |
|
351 | + |
|
352 | + |
|
353 | + /** |
|
354 | + * load_espresso_addons |
|
355 | + * allow addons to load first so that they can set hooks for running DMS's, etc |
|
356 | + * this is hooked into both: |
|
357 | + * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
358 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
359 | + * and the WP 'activate_plugin' hook point |
|
360 | + * |
|
361 | + * @access public |
|
362 | + * @return void |
|
363 | + */ |
|
364 | + public function load_espresso_addons() |
|
365 | + { |
|
366 | + $this->deactivateIncompatibleAddon( |
|
367 | + 'Wait Lists', |
|
368 | + 'EE_WAIT_LISTS_VERSION', |
|
369 | + '1.0.0.beta.074', |
|
370 | + 'load_espresso_wait_lists', |
|
371 | + 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
372 | + ); |
|
373 | + $this->deactivateIncompatibleAddon( |
|
374 | + 'Automated Upcoming Event Notifications', |
|
375 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
376 | + '1.0.0.beta.091', |
|
377 | + 'load_espresso_automated_upcoming_event_notification', |
|
378 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
379 | + ); |
|
380 | + do_action('AHEE__EE_System__load_espresso_addons'); |
|
381 | + //if the WP API basic auth plugin isn't already loaded, load it now. |
|
382 | + //We want it for mobile apps. Just include the entire plugin |
|
383 | + //also, don't load the basic auth when a plugin is getting activated, because |
|
384 | + //it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
385 | + //and causes a fatal error |
|
386 | + if ( |
|
387 | + $this->request->getRequestParam('activate') !== 'true' |
|
388 | + && ! function_exists('json_basic_auth_handler') |
|
389 | + && ! function_exists('json_basic_auth_error') |
|
390 | + && ! in_array( |
|
391 | + $this->request->getRequestParam('action'), |
|
392 | + array('activate', 'activate-selected'), |
|
393 | + true |
|
394 | + ) |
|
395 | + ) { |
|
396 | + include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
397 | + } |
|
398 | + do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
399 | + } |
|
400 | + |
|
401 | + |
|
402 | + |
|
403 | + /** |
|
404 | + * detect_activations_or_upgrades |
|
405 | + * Checks for activation or upgrade of core first; |
|
406 | + * then also checks if any registered addons have been activated or upgraded |
|
407 | + * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
408 | + * which runs during the WP 'plugins_loaded' action at priority 3 |
|
409 | + * |
|
410 | + * @access public |
|
411 | + * @return void |
|
412 | + */ |
|
413 | + public function detect_activations_or_upgrades() |
|
414 | + { |
|
415 | + //first off: let's make sure to handle core |
|
416 | + $this->detect_if_activation_or_upgrade(); |
|
417 | + foreach ($this->registry->addons as $addon) { |
|
418 | + if ($addon instanceof EE_Addon) { |
|
419 | + //detect teh request type for that addon |
|
420 | + $addon->detect_activation_or_upgrade(); |
|
421 | + } |
|
422 | + } |
|
423 | + } |
|
424 | + |
|
425 | + |
|
426 | + |
|
427 | + /** |
|
428 | + * detect_if_activation_or_upgrade |
|
429 | + * Takes care of detecting whether this is a brand new install or code upgrade, |
|
430 | + * and either setting up the DB or setting up maintenance mode etc. |
|
431 | + * |
|
432 | + * @access public |
|
433 | + * @return void |
|
434 | + */ |
|
435 | + public function detect_if_activation_or_upgrade() |
|
436 | + { |
|
437 | + do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
438 | + // check if db has been updated, or if its a brand-new installation |
|
439 | + $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
440 | + $request_type = $this->detect_req_type($espresso_db_update); |
|
441 | + //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
442 | + switch ($request_type) { |
|
443 | + case EE_System::req_type_new_activation: |
|
444 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
445 | + $this->_handle_core_version_change($espresso_db_update); |
|
446 | + break; |
|
447 | + case EE_System::req_type_reactivation: |
|
448 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
449 | + $this->_handle_core_version_change($espresso_db_update); |
|
450 | + break; |
|
451 | + case EE_System::req_type_upgrade: |
|
452 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
453 | + //migrations may be required now that we've upgraded |
|
454 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
455 | + $this->_handle_core_version_change($espresso_db_update); |
|
456 | + // echo "done upgrade";die; |
|
457 | + break; |
|
458 | + case EE_System::req_type_downgrade: |
|
459 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
460 | + //its possible migrations are no longer required |
|
461 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
462 | + $this->_handle_core_version_change($espresso_db_update); |
|
463 | + break; |
|
464 | + case EE_System::req_type_normal: |
|
465 | + default: |
|
466 | + break; |
|
467 | + } |
|
468 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
469 | + } |
|
470 | + |
|
471 | + |
|
472 | + |
|
473 | + /** |
|
474 | + * Updates the list of installed versions and sets hooks for |
|
475 | + * initializing the database later during the request |
|
476 | + * |
|
477 | + * @param array $espresso_db_update |
|
478 | + */ |
|
479 | + private function _handle_core_version_change($espresso_db_update) |
|
480 | + { |
|
481 | + $this->update_list_of_installed_versions($espresso_db_update); |
|
482 | + //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
483 | + add_action( |
|
484 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
485 | + array($this, 'initialize_db_if_no_migrations_required') |
|
486 | + ); |
|
487 | + } |
|
488 | + |
|
489 | + |
|
490 | + |
|
491 | + /** |
|
492 | + * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
493 | + * information about what versions of EE have been installed and activated, |
|
494 | + * NOT necessarily the state of the database |
|
495 | + * |
|
496 | + * @param mixed $espresso_db_update the value of the WordPress option. |
|
497 | + * If not supplied, fetches it from the options table |
|
498 | + * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
499 | + */ |
|
500 | + private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
501 | + { |
|
502 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
503 | + if (! $espresso_db_update) { |
|
504 | + $espresso_db_update = get_option('espresso_db_update'); |
|
505 | + } |
|
506 | + // check that option is an array |
|
507 | + if (! is_array($espresso_db_update)) { |
|
508 | + // if option is FALSE, then it never existed |
|
509 | + if ($espresso_db_update === false) { |
|
510 | + // make $espresso_db_update an array and save option with autoload OFF |
|
511 | + $espresso_db_update = array(); |
|
512 | + add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
513 | + } else { |
|
514 | + // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
515 | + $espresso_db_update = array($espresso_db_update => array()); |
|
516 | + update_option('espresso_db_update', $espresso_db_update); |
|
517 | + } |
|
518 | + } else { |
|
519 | + $corrected_db_update = array(); |
|
520 | + //if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
521 | + foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
522 | + if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
523 | + //the key is an int, and the value IS NOT an array |
|
524 | + //so it must be numerically-indexed, where values are versions installed... |
|
525 | + //fix it! |
|
526 | + $version_string = $should_be_array; |
|
527 | + $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
528 | + } else { |
|
529 | + //ok it checks out |
|
530 | + $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
531 | + } |
|
532 | + } |
|
533 | + $espresso_db_update = $corrected_db_update; |
|
534 | + update_option('espresso_db_update', $espresso_db_update); |
|
535 | + } |
|
536 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
537 | + return $espresso_db_update; |
|
538 | + } |
|
539 | + |
|
540 | + |
|
541 | + |
|
542 | + /** |
|
543 | + * Does the traditional work of setting up the plugin's database and adding default data. |
|
544 | + * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
545 | + * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
546 | + * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
547 | + * so that it will be done when migrations are finished |
|
548 | + * |
|
549 | + * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
550 | + * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
551 | + * This is a resource-intensive job |
|
552 | + * so we prefer to only do it when necessary |
|
553 | + * @return void |
|
554 | + * @throws EE_Error |
|
555 | + */ |
|
556 | + public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
557 | + { |
|
558 | + $request_type = $this->detect_req_type(); |
|
559 | + //only initialize system if we're not in maintenance mode. |
|
560 | + if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
561 | + update_option('ee_flush_rewrite_rules', true); |
|
562 | + if ($verify_schema) { |
|
563 | + EEH_Activation::initialize_db_and_folders(); |
|
564 | + } |
|
565 | + EEH_Activation::initialize_db_content(); |
|
566 | + EEH_Activation::system_initialization(); |
|
567 | + if ($initialize_addons_too) { |
|
568 | + $this->initialize_addons(); |
|
569 | + } |
|
570 | + } else { |
|
571 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
572 | + } |
|
573 | + if ($request_type === EE_System::req_type_new_activation |
|
574 | + || $request_type === EE_System::req_type_reactivation |
|
575 | + || ( |
|
576 | + $request_type === EE_System::req_type_upgrade |
|
577 | + && $this->is_major_version_change() |
|
578 | + ) |
|
579 | + ) { |
|
580 | + add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
581 | + } |
|
582 | + } |
|
583 | + |
|
584 | + |
|
585 | + |
|
586 | + /** |
|
587 | + * Initializes the db for all registered addons |
|
588 | + * |
|
589 | + * @throws EE_Error |
|
590 | + */ |
|
591 | + public function initialize_addons() |
|
592 | + { |
|
593 | + //foreach registered addon, make sure its db is up-to-date too |
|
594 | + foreach ($this->registry->addons as $addon) { |
|
595 | + if ($addon instanceof EE_Addon) { |
|
596 | + $addon->initialize_db_if_no_migrations_required(); |
|
597 | + } |
|
598 | + } |
|
599 | + } |
|
600 | + |
|
601 | + |
|
602 | + |
|
603 | + /** |
|
604 | + * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
605 | + * |
|
606 | + * @param array $version_history |
|
607 | + * @param string $current_version_to_add version to be added to the version history |
|
608 | + * @return boolean success as to whether or not this option was changed |
|
609 | + */ |
|
610 | + public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
611 | + { |
|
612 | + if (! $version_history) { |
|
613 | + $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
614 | + } |
|
615 | + if ($current_version_to_add === null) { |
|
616 | + $current_version_to_add = espresso_version(); |
|
617 | + } |
|
618 | + $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
619 | + // re-save |
|
620 | + return update_option('espresso_db_update', $version_history); |
|
621 | + } |
|
622 | + |
|
623 | + |
|
624 | + |
|
625 | + /** |
|
626 | + * Detects if the current version indicated in the has existed in the list of |
|
627 | + * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
628 | + * |
|
629 | + * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
630 | + * If not supplied, fetches it from the options table. |
|
631 | + * Also, caches its result so later parts of the code can also know whether |
|
632 | + * there's been an update or not. This way we can add the current version to |
|
633 | + * espresso_db_update, but still know if this is a new install or not |
|
634 | + * @return int one of the constants on EE_System::req_type_ |
|
635 | + */ |
|
636 | + public function detect_req_type($espresso_db_update = null) |
|
637 | + { |
|
638 | + if ($this->_req_type === null) { |
|
639 | + $espresso_db_update = ! empty($espresso_db_update) |
|
640 | + ? $espresso_db_update |
|
641 | + : $this->fix_espresso_db_upgrade_option(); |
|
642 | + $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
643 | + $espresso_db_update, |
|
644 | + 'ee_espresso_activation', espresso_version() |
|
645 | + ); |
|
646 | + $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
647 | + $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
648 | + } |
|
649 | + return $this->_req_type; |
|
650 | + } |
|
651 | + |
|
652 | + |
|
653 | + |
|
654 | + /** |
|
655 | + * Returns whether or not there was a non-micro version change (ie, change in either |
|
656 | + * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
657 | + * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
658 | + * |
|
659 | + * @param $activation_history |
|
660 | + * @return bool |
|
661 | + */ |
|
662 | + private function _detect_major_version_change($activation_history) |
|
663 | + { |
|
664 | + $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
665 | + $previous_version_parts = explode('.', $previous_version); |
|
666 | + $current_version_parts = explode('.', espresso_version()); |
|
667 | + return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
668 | + && ($previous_version_parts[0] !== $current_version_parts[0] |
|
669 | + || $previous_version_parts[1] !== $current_version_parts[1] |
|
670 | + ); |
|
671 | + } |
|
672 | + |
|
673 | + |
|
674 | + |
|
675 | + /** |
|
676 | + * Returns true if either the major or minor version of EE changed during this request. |
|
677 | + * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
678 | + * |
|
679 | + * @return bool |
|
680 | + */ |
|
681 | + public function is_major_version_change() |
|
682 | + { |
|
683 | + return $this->_major_version_change; |
|
684 | + } |
|
685 | + |
|
686 | + |
|
687 | + |
|
688 | + /** |
|
689 | + * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
690 | + * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
691 | + * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
692 | + * just activated to (for core that will always be espresso_version()) |
|
693 | + * |
|
694 | + * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
695 | + * ee plugin. for core that's 'espresso_db_update' |
|
696 | + * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
697 | + * indicate that this plugin was just activated |
|
698 | + * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
699 | + * espresso_version()) |
|
700 | + * @return int one of the constants on EE_System::req_type_* |
|
701 | + */ |
|
702 | + public static function detect_req_type_given_activation_history( |
|
703 | + $activation_history_for_addon, |
|
704 | + $activation_indicator_option_name, |
|
705 | + $version_to_upgrade_to |
|
706 | + ) { |
|
707 | + $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
708 | + if ($activation_history_for_addon) { |
|
709 | + //it exists, so this isn't a completely new install |
|
710 | + //check if this version already in that list of previously installed versions |
|
711 | + if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
712 | + //it a version we haven't seen before |
|
713 | + if ($version_is_higher === 1) { |
|
714 | + $req_type = EE_System::req_type_upgrade; |
|
715 | + } else { |
|
716 | + $req_type = EE_System::req_type_downgrade; |
|
717 | + } |
|
718 | + delete_option($activation_indicator_option_name); |
|
719 | + } else { |
|
720 | + // its not an update. maybe a reactivation? |
|
721 | + if (get_option($activation_indicator_option_name, false)) { |
|
722 | + if ($version_is_higher === -1) { |
|
723 | + $req_type = EE_System::req_type_downgrade; |
|
724 | + } elseif ($version_is_higher === 0) { |
|
725 | + //we've seen this version before, but it's an activation. must be a reactivation |
|
726 | + $req_type = EE_System::req_type_reactivation; |
|
727 | + } else {//$version_is_higher === 1 |
|
728 | + $req_type = EE_System::req_type_upgrade; |
|
729 | + } |
|
730 | + delete_option($activation_indicator_option_name); |
|
731 | + } else { |
|
732 | + //we've seen this version before and the activation indicate doesn't show it was just activated |
|
733 | + if ($version_is_higher === -1) { |
|
734 | + $req_type = EE_System::req_type_downgrade; |
|
735 | + } elseif ($version_is_higher === 0) { |
|
736 | + //we've seen this version before and it's not an activation. its normal request |
|
737 | + $req_type = EE_System::req_type_normal; |
|
738 | + } else {//$version_is_higher === 1 |
|
739 | + $req_type = EE_System::req_type_upgrade; |
|
740 | + } |
|
741 | + } |
|
742 | + } |
|
743 | + } else { |
|
744 | + //brand new install |
|
745 | + $req_type = EE_System::req_type_new_activation; |
|
746 | + delete_option($activation_indicator_option_name); |
|
747 | + } |
|
748 | + return $req_type; |
|
749 | + } |
|
750 | + |
|
751 | + |
|
752 | + |
|
753 | + /** |
|
754 | + * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
755 | + * the $activation_history_for_addon |
|
756 | + * |
|
757 | + * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
758 | + * sometimes containing 'unknown-date' |
|
759 | + * @param string $version_to_upgrade_to (current version) |
|
760 | + * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
761 | + * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
762 | + * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
763 | + * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
764 | + */ |
|
765 | + private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
766 | + { |
|
767 | + //find the most recently-activated version |
|
768 | + $most_recently_active_version = |
|
769 | + EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
770 | + return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
771 | + } |
|
772 | + |
|
773 | + |
|
774 | + |
|
775 | + /** |
|
776 | + * Gets the most recently active version listed in the activation history, |
|
777 | + * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
778 | + * |
|
779 | + * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
780 | + * sometimes containing 'unknown-date' |
|
781 | + * @return string |
|
782 | + */ |
|
783 | + private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
784 | + { |
|
785 | + $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
786 | + $most_recently_active_version = '0.0.0.dev.000'; |
|
787 | + if (is_array($activation_history)) { |
|
788 | + foreach ($activation_history as $version => $times_activated) { |
|
789 | + //check there is a record of when this version was activated. Otherwise, |
|
790 | + //mark it as unknown |
|
791 | + if (! $times_activated) { |
|
792 | + $times_activated = array('unknown-date'); |
|
793 | + } |
|
794 | + if (is_string($times_activated)) { |
|
795 | + $times_activated = array($times_activated); |
|
796 | + } |
|
797 | + foreach ($times_activated as $an_activation) { |
|
798 | + if ($an_activation !== 'unknown-date' |
|
799 | + && $an_activation |
|
800 | + > $most_recently_active_version_activation) { |
|
801 | + $most_recently_active_version = $version; |
|
802 | + $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
803 | + ? '1970-01-01 00:00:00' |
|
804 | + : $an_activation; |
|
805 | + } |
|
806 | + } |
|
807 | + } |
|
808 | + } |
|
809 | + return $most_recently_active_version; |
|
810 | + } |
|
811 | + |
|
812 | + |
|
813 | + |
|
814 | + /** |
|
815 | + * This redirects to the about EE page after activation |
|
816 | + * |
|
817 | + * @return void |
|
818 | + */ |
|
819 | + public function redirect_to_about_ee() |
|
820 | + { |
|
821 | + $notices = EE_Error::get_notices(false); |
|
822 | + //if current user is an admin and it's not an ajax or rest request |
|
823 | + if ( |
|
824 | + ! isset($notices['errors']) |
|
825 | + && $this->request->isAdmin() |
|
826 | + && apply_filters( |
|
827 | + 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
828 | + $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
829 | + ) |
|
830 | + ) { |
|
831 | + $query_params = array('page' => 'espresso_about'); |
|
832 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
833 | + $query_params['new_activation'] = true; |
|
834 | + } |
|
835 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
836 | + $query_params['reactivation'] = true; |
|
837 | + } |
|
838 | + $url = add_query_arg($query_params, admin_url('admin.php')); |
|
839 | + wp_safe_redirect($url); |
|
840 | + exit(); |
|
841 | + } |
|
842 | + } |
|
843 | + |
|
844 | + |
|
845 | + |
|
846 | + /** |
|
847 | + * load_core_configuration |
|
848 | + * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
849 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
850 | + * |
|
851 | + * @return void |
|
852 | + * @throws ReflectionException |
|
853 | + */ |
|
854 | + public function load_core_configuration() |
|
855 | + { |
|
856 | + do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
857 | + $this->loader->getShared('EE_Load_Textdomain'); |
|
858 | + //load textdomain |
|
859 | + EE_Load_Textdomain::load_textdomain(); |
|
860 | + // load and setup EE_Config and EE_Network_Config |
|
861 | + $config = $this->loader->getShared('EE_Config'); |
|
862 | + $this->loader->getShared('EE_Network_Config'); |
|
863 | + // setup autoloaders |
|
864 | + // enable logging? |
|
865 | + if ($config->admin->use_full_logging) { |
|
866 | + $this->loader->getShared('EE_Log'); |
|
867 | + } |
|
868 | + // check for activation errors |
|
869 | + $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
870 | + if ($activation_errors) { |
|
871 | + EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
872 | + update_option('ee_plugin_activation_errors', false); |
|
873 | + } |
|
874 | + // get model names |
|
875 | + $this->_parse_model_names(); |
|
876 | + //load caf stuff a chance to play during the activation process too. |
|
877 | + $this->_maybe_brew_regular(); |
|
878 | + do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
879 | + } |
|
880 | + |
|
881 | + |
|
882 | + |
|
883 | + /** |
|
884 | + * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
885 | + * |
|
886 | + * @return void |
|
887 | + * @throws ReflectionException |
|
888 | + */ |
|
889 | + private function _parse_model_names() |
|
890 | + { |
|
891 | + //get all the files in the EE_MODELS folder that end in .model.php |
|
892 | + $models = glob(EE_MODELS . '*.model.php'); |
|
893 | + $model_names = array(); |
|
894 | + $non_abstract_db_models = array(); |
|
895 | + foreach ($models as $model) { |
|
896 | + // get model classname |
|
897 | + $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
898 | + $short_name = str_replace('EEM_', '', $classname); |
|
899 | + $reflectionClass = new ReflectionClass($classname); |
|
900 | + if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
901 | + $non_abstract_db_models[ $short_name ] = $classname; |
|
902 | + } |
|
903 | + $model_names[ $short_name ] = $classname; |
|
904 | + } |
|
905 | + $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
906 | + $this->registry->non_abstract_db_models = apply_filters( |
|
907 | + 'FHEE__EE_System__parse_implemented_model_names', |
|
908 | + $non_abstract_db_models |
|
909 | + ); |
|
910 | + } |
|
911 | + |
|
912 | + |
|
913 | + |
|
914 | + /** |
|
915 | + * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
916 | + * that need to be setup before our EE_System launches. |
|
917 | + * |
|
918 | + * @return void |
|
919 | + */ |
|
920 | + private function _maybe_brew_regular() |
|
921 | + { |
|
922 | + if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) { |
|
923 | + require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
924 | + } |
|
925 | + } |
|
926 | + |
|
927 | + |
|
928 | + |
|
929 | + /** |
|
930 | + * register_shortcodes_modules_and_widgets |
|
931 | + * generate lists of shortcodes and modules, then verify paths and classes |
|
932 | + * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
933 | + * which runs during the WP 'plugins_loaded' action at priority 7 |
|
934 | + * |
|
935 | + * @access public |
|
936 | + * @return void |
|
937 | + * @throws Exception |
|
938 | + */ |
|
939 | + public function register_shortcodes_modules_and_widgets() |
|
940 | + { |
|
941 | + if ($this->request->isFrontend() || $this->request->isIframe()) { |
|
942 | + try { |
|
943 | + // load, register, and add shortcodes the new way |
|
944 | + $this->loader->getShared( |
|
945 | + 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
946 | + array( |
|
947 | + // and the old way, but we'll put it under control of the new system |
|
948 | + EE_Config::getLegacyShortcodesManager(), |
|
949 | + ) |
|
950 | + ); |
|
951 | + } catch (Exception $exception) { |
|
952 | + new ExceptionStackTraceDisplay($exception); |
|
953 | + } |
|
954 | + } |
|
955 | + do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
956 | + // check for addons using old hook point |
|
957 | + if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
958 | + $this->_incompatible_addon_error(); |
|
959 | + } |
|
960 | + } |
|
961 | + |
|
962 | + |
|
963 | + |
|
964 | + /** |
|
965 | + * _incompatible_addon_error |
|
966 | + * |
|
967 | + * @access public |
|
968 | + * @return void |
|
969 | + */ |
|
970 | + private function _incompatible_addon_error() |
|
971 | + { |
|
972 | + // get array of classes hooking into here |
|
973 | + $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
974 | + 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
975 | + ); |
|
976 | + if (! empty($class_names)) { |
|
977 | + $msg = __( |
|
978 | + 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
979 | + 'event_espresso' |
|
980 | + ); |
|
981 | + $msg .= '<ul>'; |
|
982 | + foreach ($class_names as $class_name) { |
|
983 | + $msg .= '<li><b>Event Espresso - ' . str_replace( |
|
984 | + array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '', |
|
985 | + $class_name |
|
986 | + ) . '</b></li>'; |
|
987 | + } |
|
988 | + $msg .= '</ul>'; |
|
989 | + $msg .= __( |
|
990 | + 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
991 | + 'event_espresso' |
|
992 | + ); |
|
993 | + // save list of incompatible addons to wp-options for later use |
|
994 | + add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
995 | + if (is_admin()) { |
|
996 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
997 | + } |
|
998 | + } |
|
999 | + } |
|
1000 | + |
|
1001 | + |
|
1002 | + |
|
1003 | + /** |
|
1004 | + * brew_espresso |
|
1005 | + * begins the process of setting hooks for initializing EE in the correct order |
|
1006 | + * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1007 | + * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1008 | + * |
|
1009 | + * @return void |
|
1010 | + */ |
|
1011 | + public function brew_espresso() |
|
1012 | + { |
|
1013 | + do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1014 | + // load some final core systems |
|
1015 | + add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1016 | + add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1017 | + add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1018 | + add_action('init', array($this, 'load_controllers'), 7); |
|
1019 | + add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1020 | + add_action('init', array($this, 'initialize'), 10); |
|
1021 | + add_action('init', array($this, 'initialize_last'), 100); |
|
1022 | + if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1023 | + // pew pew pew |
|
1024 | + $this->loader->getShared('EE_PUE'); |
|
1025 | + do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1026 | + } |
|
1027 | + do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1028 | + } |
|
1029 | + |
|
1030 | + |
|
1031 | + |
|
1032 | + /** |
|
1033 | + * set_hooks_for_core |
|
1034 | + * |
|
1035 | + * @access public |
|
1036 | + * @return void |
|
1037 | + * @throws EE_Error |
|
1038 | + */ |
|
1039 | + public function set_hooks_for_core() |
|
1040 | + { |
|
1041 | + $this->_deactivate_incompatible_addons(); |
|
1042 | + do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1043 | + $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1044 | + //caps need to be initialized on every request so that capability maps are set. |
|
1045 | + //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1046 | + $this->registry->CAP->init_caps(); |
|
1047 | + } |
|
1048 | + |
|
1049 | + |
|
1050 | + |
|
1051 | + /** |
|
1052 | + * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1053 | + * deactivates any addons considered incompatible with the current version of EE |
|
1054 | + */ |
|
1055 | + private function _deactivate_incompatible_addons() |
|
1056 | + { |
|
1057 | + $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1058 | + if (! empty($incompatible_addons)) { |
|
1059 | + $active_plugins = get_option('active_plugins', array()); |
|
1060 | + foreach ($active_plugins as $active_plugin) { |
|
1061 | + foreach ($incompatible_addons as $incompatible_addon) { |
|
1062 | + if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1063 | + unset($_GET['activate']); |
|
1064 | + espresso_deactivate_plugin($active_plugin); |
|
1065 | + } |
|
1066 | + } |
|
1067 | + } |
|
1068 | + } |
|
1069 | + } |
|
1070 | + |
|
1071 | + |
|
1072 | + |
|
1073 | + /** |
|
1074 | + * perform_activations_upgrades_and_migrations |
|
1075 | + * |
|
1076 | + * @access public |
|
1077 | + * @return void |
|
1078 | + */ |
|
1079 | + public function perform_activations_upgrades_and_migrations() |
|
1080 | + { |
|
1081 | + do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1082 | + } |
|
1083 | + |
|
1084 | + |
|
1085 | + |
|
1086 | + /** |
|
1087 | + * load_CPTs_and_session |
|
1088 | + * |
|
1089 | + * @access public |
|
1090 | + * @return void |
|
1091 | + */ |
|
1092 | + public function load_CPTs_and_session() |
|
1093 | + { |
|
1094 | + do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1095 | + // register Custom Post Types |
|
1096 | + $this->loader->getShared('EE_Register_CPTs'); |
|
1097 | + do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1098 | + } |
|
1099 | + |
|
1100 | + |
|
1101 | + |
|
1102 | + /** |
|
1103 | + * load_controllers |
|
1104 | + * this is the best place to load any additional controllers that needs access to EE core. |
|
1105 | + * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1106 | + * time |
|
1107 | + * |
|
1108 | + * @access public |
|
1109 | + * @return void |
|
1110 | + */ |
|
1111 | + public function load_controllers() |
|
1112 | + { |
|
1113 | + do_action('AHEE__EE_System__load_controllers__start'); |
|
1114 | + // let's get it started |
|
1115 | + if ( |
|
1116 | + ! $this->maintenance_mode->level() |
|
1117 | + && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1118 | + ) { |
|
1119 | + do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1120 | + $this->loader->getShared('EE_Front_Controller'); |
|
1121 | + } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1122 | + do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1123 | + $this->loader->getShared('EE_Admin'); |
|
1124 | + } |
|
1125 | + do_action('AHEE__EE_System__load_controllers__complete'); |
|
1126 | + } |
|
1127 | + |
|
1128 | + |
|
1129 | + |
|
1130 | + /** |
|
1131 | + * core_loaded_and_ready |
|
1132 | + * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1133 | + * |
|
1134 | + * @access public |
|
1135 | + * @return void |
|
1136 | + */ |
|
1137 | + public function core_loaded_and_ready() |
|
1138 | + { |
|
1139 | + if ( |
|
1140 | + $this->request->isAdmin() |
|
1141 | + || $this->request->isEeAjax() |
|
1142 | + || $this->request->isFrontend() |
|
1143 | + ) { |
|
1144 | + $this->loader->getShared('EE_Session'); |
|
1145 | + } |
|
1146 | + do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1147 | + // load_espresso_template_tags |
|
1148 | + if ( |
|
1149 | + is_readable(EE_PUBLIC . 'template_tags.php') |
|
1150 | + && ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed()) |
|
1151 | + ) { |
|
1152 | + require_once EE_PUBLIC . 'template_tags.php'; |
|
1153 | + } |
|
1154 | + do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1155 | + if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1156 | + $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1157 | + } |
|
1158 | + } |
|
1159 | + |
|
1160 | + |
|
1161 | + |
|
1162 | + /** |
|
1163 | + * initialize |
|
1164 | + * this is the best place to begin initializing client code |
|
1165 | + * |
|
1166 | + * @access public |
|
1167 | + * @return void |
|
1168 | + */ |
|
1169 | + public function initialize() |
|
1170 | + { |
|
1171 | + do_action('AHEE__EE_System__initialize'); |
|
1172 | + } |
|
1173 | + |
|
1174 | + |
|
1175 | + |
|
1176 | + /** |
|
1177 | + * initialize_last |
|
1178 | + * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1179 | + * initialize has done so |
|
1180 | + * |
|
1181 | + * @access public |
|
1182 | + * @return void |
|
1183 | + */ |
|
1184 | + public function initialize_last() |
|
1185 | + { |
|
1186 | + do_action('AHEE__EE_System__initialize_last'); |
|
1187 | + add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1188 | + } |
|
1189 | + |
|
1190 | + |
|
1191 | + |
|
1192 | + /** |
|
1193 | + * @return void |
|
1194 | + * @throws EE_Error |
|
1195 | + */ |
|
1196 | + public function addEspressoToolbar() |
|
1197 | + { |
|
1198 | + $this->loader->getShared( |
|
1199 | + 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1200 | + array($this->registry->CAP) |
|
1201 | + ); |
|
1202 | + } |
|
1203 | + |
|
1204 | + |
|
1205 | + |
|
1206 | + /** |
|
1207 | + * do_not_cache |
|
1208 | + * sets no cache headers and defines no cache constants for WP plugins |
|
1209 | + * |
|
1210 | + * @access public |
|
1211 | + * @return void |
|
1212 | + */ |
|
1213 | + public static function do_not_cache() |
|
1214 | + { |
|
1215 | + // set no cache constants |
|
1216 | + if (! defined('DONOTCACHEPAGE')) { |
|
1217 | + define('DONOTCACHEPAGE', true); |
|
1218 | + } |
|
1219 | + if (! defined('DONOTCACHCEOBJECT')) { |
|
1220 | + define('DONOTCACHCEOBJECT', true); |
|
1221 | + } |
|
1222 | + if (! defined('DONOTCACHEDB')) { |
|
1223 | + define('DONOTCACHEDB', true); |
|
1224 | + } |
|
1225 | + // add no cache headers |
|
1226 | + add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1227 | + // plus a little extra for nginx and Google Chrome |
|
1228 | + add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1229 | + // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1230 | + remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1231 | + } |
|
1232 | + |
|
1233 | + |
|
1234 | + |
|
1235 | + /** |
|
1236 | + * extra_nocache_headers |
|
1237 | + * |
|
1238 | + * @access public |
|
1239 | + * @param $headers |
|
1240 | + * @return array |
|
1241 | + */ |
|
1242 | + public static function extra_nocache_headers($headers) |
|
1243 | + { |
|
1244 | + // for NGINX |
|
1245 | + $headers['X-Accel-Expires'] = 0; |
|
1246 | + // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1247 | + $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1248 | + return $headers; |
|
1249 | + } |
|
1250 | + |
|
1251 | + |
|
1252 | + |
|
1253 | + /** |
|
1254 | + * nocache_headers |
|
1255 | + * |
|
1256 | + * @access public |
|
1257 | + * @return void |
|
1258 | + */ |
|
1259 | + public static function nocache_headers() |
|
1260 | + { |
|
1261 | + nocache_headers(); |
|
1262 | + } |
|
1263 | + |
|
1264 | + |
|
1265 | + |
|
1266 | + /** |
|
1267 | + * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1268 | + * never returned with the function. |
|
1269 | + * |
|
1270 | + * @param array $exclude_array any existing pages being excluded are in this array. |
|
1271 | + * @return array |
|
1272 | + */ |
|
1273 | + public function remove_pages_from_wp_list_pages($exclude_array) |
|
1274 | + { |
|
1275 | + return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1276 | + } |
|
1277 | 1277 | |
1278 | 1278 | |
1279 | 1279 |
@@ -38,103 +38,103 @@ |
||
38 | 38 | * @since 4.0 |
39 | 39 | */ |
40 | 40 | if (function_exists('espresso_version')) { |
41 | - if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | - /** |
|
43 | - * espresso_duplicate_plugin_error |
|
44 | - * displays if more than one version of EE is activated at the same time |
|
45 | - */ |
|
46 | - function espresso_duplicate_plugin_error() |
|
47 | - { |
|
48 | - ?> |
|
41 | + if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | + /** |
|
43 | + * espresso_duplicate_plugin_error |
|
44 | + * displays if more than one version of EE is activated at the same time |
|
45 | + */ |
|
46 | + function espresso_duplicate_plugin_error() |
|
47 | + { |
|
48 | + ?> |
|
49 | 49 | <div class="error"> |
50 | 50 | <p> |
51 | 51 | <?php |
52 | - echo esc_html__( |
|
53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | - 'event_espresso' |
|
55 | - ); ?> |
|
52 | + echo esc_html__( |
|
53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | + 'event_espresso' |
|
55 | + ); ?> |
|
56 | 56 | </p> |
57 | 57 | </div> |
58 | 58 | <?php |
59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | - } |
|
61 | - } |
|
62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | + } |
|
61 | + } |
|
62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
63 | 63 | |
64 | 64 | } else { |
65 | - define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
66 | - if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
67 | - /** |
|
68 | - * espresso_minimum_php_version_error |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - function espresso_minimum_php_version_error() |
|
72 | - { |
|
73 | - ?> |
|
65 | + define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
66 | + if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
67 | + /** |
|
68 | + * espresso_minimum_php_version_error |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + function espresso_minimum_php_version_error() |
|
72 | + { |
|
73 | + ?> |
|
74 | 74 | <div class="error"> |
75 | 75 | <p> |
76 | 76 | <?php |
77 | - printf( |
|
78 | - esc_html__( |
|
79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | - 'event_espresso' |
|
81 | - ), |
|
82 | - EE_MIN_PHP_VER_REQUIRED, |
|
83 | - PHP_VERSION, |
|
84 | - '<br/>', |
|
85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | - ); |
|
87 | - ?> |
|
77 | + printf( |
|
78 | + esc_html__( |
|
79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | + 'event_espresso' |
|
81 | + ), |
|
82 | + EE_MIN_PHP_VER_REQUIRED, |
|
83 | + PHP_VERSION, |
|
84 | + '<br/>', |
|
85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | + ); |
|
87 | + ?> |
|
88 | 88 | </p> |
89 | 89 | </div> |
90 | 90 | <?php |
91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | - } |
|
91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | + } |
|
93 | 93 | |
94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | - } else { |
|
96 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | - /** |
|
98 | - * espresso_version |
|
99 | - * Returns the plugin version |
|
100 | - * |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - function espresso_version() |
|
104 | - { |
|
105 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.59.rc.053'); |
|
106 | - } |
|
94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | + } else { |
|
96 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | + /** |
|
98 | + * espresso_version |
|
99 | + * Returns the plugin version |
|
100 | + * |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + function espresso_version() |
|
104 | + { |
|
105 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.59.rc.053'); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * espresso_plugin_activation |
|
110 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | - */ |
|
112 | - function espresso_plugin_activation() |
|
113 | - { |
|
114 | - update_option('ee_espresso_activation', true); |
|
115 | - } |
|
108 | + /** |
|
109 | + * espresso_plugin_activation |
|
110 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | + */ |
|
112 | + function espresso_plugin_activation() |
|
113 | + { |
|
114 | + update_option('ee_espresso_activation', true); |
|
115 | + } |
|
116 | 116 | |
117 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
117 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
118 | 118 | |
119 | - require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | - bootstrap_espresso(); |
|
121 | - } |
|
119 | + require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | + bootstrap_espresso(); |
|
121 | + } |
|
122 | 122 | } |
123 | 123 | if (! function_exists('espresso_deactivate_plugin')) { |
124 | - /** |
|
125 | - * deactivate_plugin |
|
126 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | - * |
|
128 | - * @access public |
|
129 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | - { |
|
134 | - if (! function_exists('deactivate_plugins')) { |
|
135 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | - } |
|
137 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | - deactivate_plugins($plugin_basename); |
|
139 | - } |
|
124 | + /** |
|
125 | + * deactivate_plugin |
|
126 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | + * |
|
128 | + * @access public |
|
129 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | + { |
|
134 | + if (! function_exists('deactivate_plugins')) { |
|
135 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | + } |
|
137 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | + deactivate_plugins($plugin_basename); |
|
139 | + } |
|
140 | 140 | } |
@@ -18,76 +18,76 @@ |
||
18 | 18 | class ExitModal |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @var Registry |
|
23 | - */ |
|
24 | - private $assets_registry; |
|
21 | + /** |
|
22 | + * @var Registry |
|
23 | + */ |
|
24 | + private $assets_registry; |
|
25 | 25 | |
26 | - /** |
|
27 | - * ExitModal constructor. |
|
28 | - * |
|
29 | - * @param Registry $assets_registry |
|
30 | - */ |
|
31 | - public function __construct(Registry $assets_registry) |
|
32 | - { |
|
33 | - $this->assets_registry = $assets_registry; |
|
34 | - add_action('in_admin_footer', array($this, 'modalContainer')); |
|
35 | - add_action('admin_enqueue_scripts', array($this, 'enqueues')); |
|
36 | - } |
|
26 | + /** |
|
27 | + * ExitModal constructor. |
|
28 | + * |
|
29 | + * @param Registry $assets_registry |
|
30 | + */ |
|
31 | + public function __construct(Registry $assets_registry) |
|
32 | + { |
|
33 | + $this->assets_registry = $assets_registry; |
|
34 | + add_action('in_admin_footer', array($this, 'modalContainer')); |
|
35 | + add_action('admin_enqueue_scripts', array($this, 'enqueues')); |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * Callback on in_admin_footer that is used to output the exit modal container. |
|
41 | - */ |
|
42 | - public function modalContainer() |
|
43 | - { |
|
44 | - echo '<div id="ee-exit-survey-modal"></div>'; |
|
45 | - } |
|
39 | + /** |
|
40 | + * Callback on in_admin_footer that is used to output the exit modal container. |
|
41 | + */ |
|
42 | + public function modalContainer() |
|
43 | + { |
|
44 | + echo '<div id="ee-exit-survey-modal"></div>'; |
|
45 | + } |
|
46 | 46 | |
47 | 47 | |
48 | - /** |
|
49 | - * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal. |
|
50 | - * |
|
51 | - * @throws InvalidArgumentException |
|
52 | - */ |
|
53 | - public function enqueues() |
|
54 | - { |
|
55 | - $current_user = new WP_User(get_current_user_id()); |
|
56 | - $this->assets_registry->addData( |
|
57 | - 'exitModali18n', |
|
58 | - array( |
|
59 | - 'introText' => htmlspecialchars( |
|
60 | - __( |
|
61 | - 'Do you have a moment to share why you are deactivating Event Espresso?', |
|
62 | - 'event_espresso' |
|
63 | - ), |
|
64 | - ENT_NOQUOTES |
|
65 | - ), |
|
66 | - 'doSurveyButtonText' => htmlspecialchars( |
|
67 | - __( |
|
68 | - 'Sure I\'ll help', |
|
69 | - 'event_espresso' |
|
70 | - ), |
|
71 | - ENT_NOQUOTES |
|
72 | - ), |
|
73 | - 'skipButtonText' => htmlspecialchars( |
|
74 | - __( |
|
75 | - 'Skip', |
|
76 | - 'event_espresso' |
|
77 | - ), |
|
78 | - ENT_NOQUOTES |
|
79 | - ) |
|
80 | - ) |
|
81 | - ); |
|
82 | - $this->assets_registry->addData( |
|
83 | - 'exitModalInfo', |
|
84 | - array( |
|
85 | - 'firstname' => htmlspecialchars($current_user->user_firstname), |
|
86 | - 'emailaddress' => htmlspecialchars($current_user->user_email), |
|
87 | - 'website' => htmlspecialchars(site_url()) |
|
88 | - ) |
|
89 | - ); |
|
90 | - wp_enqueue_script('ee-exit-modal-survey'); |
|
91 | - wp_enqueue_style('ee-exit-modal-survey'); |
|
92 | - } |
|
48 | + /** |
|
49 | + * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal. |
|
50 | + * |
|
51 | + * @throws InvalidArgumentException |
|
52 | + */ |
|
53 | + public function enqueues() |
|
54 | + { |
|
55 | + $current_user = new WP_User(get_current_user_id()); |
|
56 | + $this->assets_registry->addData( |
|
57 | + 'exitModali18n', |
|
58 | + array( |
|
59 | + 'introText' => htmlspecialchars( |
|
60 | + __( |
|
61 | + 'Do you have a moment to share why you are deactivating Event Espresso?', |
|
62 | + 'event_espresso' |
|
63 | + ), |
|
64 | + ENT_NOQUOTES |
|
65 | + ), |
|
66 | + 'doSurveyButtonText' => htmlspecialchars( |
|
67 | + __( |
|
68 | + 'Sure I\'ll help', |
|
69 | + 'event_espresso' |
|
70 | + ), |
|
71 | + ENT_NOQUOTES |
|
72 | + ), |
|
73 | + 'skipButtonText' => htmlspecialchars( |
|
74 | + __( |
|
75 | + 'Skip', |
|
76 | + 'event_espresso' |
|
77 | + ), |
|
78 | + ENT_NOQUOTES |
|
79 | + ) |
|
80 | + ) |
|
81 | + ); |
|
82 | + $this->assets_registry->addData( |
|
83 | + 'exitModalInfo', |
|
84 | + array( |
|
85 | + 'firstname' => htmlspecialchars($current_user->user_firstname), |
|
86 | + 'emailaddress' => htmlspecialchars($current_user->user_email), |
|
87 | + 'website' => htmlspecialchars(site_url()) |
|
88 | + ) |
|
89 | + ); |
|
90 | + wp_enqueue_script('ee-exit-modal-survey'); |
|
91 | + wp_enqueue_style('ee-exit-modal-survey'); |
|
92 | + } |
|
93 | 93 | } |
94 | 94 | \ No newline at end of file |
@@ -8,7 +8,7 @@ discard block |
||
8 | 8 | use EventEspresso\core\services\request\ResponseInterface; |
9 | 9 | |
10 | 10 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
11 | - exit('No direct script access allowed'); |
|
11 | + exit('No direct script access allowed'); |
|
12 | 12 | } |
13 | 13 | |
14 | 14 | |
@@ -25,844 +25,844 @@ discard block |
||
25 | 25 | class EE_Dependency_Map |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * This means that the requested class dependency is not present in the dependency map |
|
30 | - */ |
|
31 | - const not_registered = 0; |
|
32 | - |
|
33 | - /** |
|
34 | - * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
35 | - */ |
|
36 | - const load_new_object = 1; |
|
37 | - |
|
38 | - /** |
|
39 | - * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
40 | - * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
41 | - */ |
|
42 | - const load_from_cache = 2; |
|
43 | - |
|
44 | - /** |
|
45 | - * When registering a dependency, |
|
46 | - * this indicates to keep any existing dependencies that already exist, |
|
47 | - * and simply discard any new dependencies declared in the incoming data |
|
48 | - */ |
|
49 | - const KEEP_EXISTING_DEPENDENCIES = 0; |
|
50 | - |
|
51 | - /** |
|
52 | - * When registering a dependency, |
|
53 | - * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
54 | - */ |
|
55 | - const OVERWRITE_DEPENDENCIES = 1; |
|
56 | - |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * @type EE_Dependency_Map $_instance |
|
61 | - */ |
|
62 | - protected static $_instance; |
|
63 | - |
|
64 | - /** |
|
65 | - * @type RequestInterface $request |
|
66 | - */ |
|
67 | - protected $request; |
|
68 | - |
|
69 | - /** |
|
70 | - * @type LegacyRequestInterface $legacy_request |
|
71 | - */ |
|
72 | - protected $legacy_request; |
|
73 | - |
|
74 | - /** |
|
75 | - * @type ResponseInterface $response |
|
76 | - */ |
|
77 | - protected $response; |
|
78 | - |
|
79 | - /** |
|
80 | - * @type LoaderInterface $loader |
|
81 | - */ |
|
82 | - protected $loader; |
|
83 | - |
|
84 | - /** |
|
85 | - * @type array $_dependency_map |
|
86 | - */ |
|
87 | - protected $_dependency_map = array(); |
|
88 | - |
|
89 | - /** |
|
90 | - * @type array $_class_loaders |
|
91 | - */ |
|
92 | - protected $_class_loaders = array(); |
|
93 | - |
|
94 | - /** |
|
95 | - * @type array $_aliases |
|
96 | - */ |
|
97 | - protected $_aliases = array(); |
|
98 | - |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * EE_Dependency_Map constructor. |
|
103 | - */ |
|
104 | - protected function __construct() |
|
105 | - { |
|
106 | - // add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
107 | - do_action('EE_Dependency_Map____construct'); |
|
108 | - } |
|
109 | - |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @throws InvalidDataTypeException |
|
114 | - * @throws InvalidInterfaceException |
|
115 | - * @throws InvalidArgumentException |
|
116 | - */ |
|
117 | - public function initialize() |
|
118 | - { |
|
119 | - $this->_register_core_dependencies(); |
|
120 | - $this->_register_core_class_loaders(); |
|
121 | - $this->_register_core_aliases(); |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @singleton method used to instantiate class object |
|
128 | - * @return EE_Dependency_Map |
|
129 | - */ |
|
130 | - public static function instance() { |
|
131 | - // check if class object is instantiated, and instantiated properly |
|
132 | - if (! self::$_instance instanceof EE_Dependency_Map) { |
|
133 | - self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/); |
|
134 | - } |
|
135 | - return self::$_instance; |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param RequestInterface $request |
|
141 | - */ |
|
142 | - public function setRequest(RequestInterface $request) |
|
143 | - { |
|
144 | - $this->request = $request; |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * @param LegacyRequestInterface $legacy_request |
|
150 | - */ |
|
151 | - public function setLegacyRequest(LegacyRequestInterface $legacy_request) |
|
152 | - { |
|
153 | - $this->legacy_request = $legacy_request; |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @param ResponseInterface $response |
|
159 | - */ |
|
160 | - public function setResponse(ResponseInterface $response) |
|
161 | - { |
|
162 | - $this->response = $response; |
|
163 | - } |
|
164 | - |
|
165 | - |
|
166 | - |
|
167 | - /** |
|
168 | - * @param LoaderInterface $loader |
|
169 | - */ |
|
170 | - public function setLoader(LoaderInterface $loader) |
|
171 | - { |
|
172 | - $this->loader = $loader; |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - |
|
177 | - /** |
|
178 | - * @param string $class |
|
179 | - * @param array $dependencies |
|
180 | - * @param int $overwrite |
|
181 | - * @return bool |
|
182 | - */ |
|
183 | - public static function register_dependencies( |
|
184 | - $class, |
|
185 | - array $dependencies, |
|
186 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
187 | - ) { |
|
188 | - return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
189 | - } |
|
190 | - |
|
191 | - |
|
192 | - |
|
193 | - /** |
|
194 | - * Assigns an array of class names and corresponding load sources (new or cached) |
|
195 | - * to the class specified by the first parameter. |
|
196 | - * IMPORTANT !!! |
|
197 | - * The order of elements in the incoming $dependencies array MUST match |
|
198 | - * the order of the constructor parameters for the class in question. |
|
199 | - * This is especially important when overriding any existing dependencies that are registered. |
|
200 | - * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
201 | - * |
|
202 | - * @param string $class |
|
203 | - * @param array $dependencies |
|
204 | - * @param int $overwrite |
|
205 | - * @return bool |
|
206 | - */ |
|
207 | - public function registerDependencies( |
|
208 | - $class, |
|
209 | - array $dependencies, |
|
210 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
211 | - ) { |
|
212 | - $class = trim($class, '\\'); |
|
213 | - $registered = false; |
|
214 | - if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
215 | - self::$_instance->_dependency_map[ $class ] = array(); |
|
216 | - } |
|
217 | - // we need to make sure that any aliases used when registering a dependency |
|
218 | - // get resolved to the correct class name |
|
219 | - foreach ($dependencies as $dependency => $load_source) { |
|
220 | - $alias = self::$_instance->get_alias($dependency); |
|
221 | - if ( |
|
222 | - $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
223 | - || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
224 | - ) { |
|
225 | - unset($dependencies[$dependency]); |
|
226 | - $dependencies[$alias] = $load_source; |
|
227 | - $registered = true; |
|
228 | - } |
|
229 | - } |
|
230 | - // now add our two lists of dependencies together. |
|
231 | - // using Union (+=) favours the arrays in precedence from left to right, |
|
232 | - // so $dependencies is NOT overwritten because it is listed first |
|
233 | - // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
234 | - // Union is way faster than array_merge() but should be used with caution... |
|
235 | - // especially with numerically indexed arrays |
|
236 | - $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
237 | - // now we need to ensure that the resulting dependencies |
|
238 | - // array only has the entries that are required for the class |
|
239 | - // so first count how many dependencies were originally registered for the class |
|
240 | - $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
241 | - // if that count is non-zero (meaning dependencies were already registered) |
|
242 | - self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
243 | - // then truncate the final array to match that count |
|
244 | - ? array_slice($dependencies, 0, $dependency_count) |
|
245 | - // otherwise just take the incoming array because nothing previously existed |
|
246 | - : $dependencies; |
|
247 | - return $registered; |
|
248 | - } |
|
249 | - |
|
250 | - |
|
251 | - |
|
252 | - /** |
|
253 | - * @param string $class_name |
|
254 | - * @param string $loader |
|
255 | - * @return bool |
|
256 | - * @throws DomainException |
|
257 | - */ |
|
258 | - public static function register_class_loader($class_name, $loader = 'load_core') |
|
259 | - { |
|
260 | - if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
261 | - throw new DomainException( |
|
262 | - esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
263 | - ); |
|
264 | - } |
|
265 | - // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
266 | - if ( |
|
267 | - ! is_callable($loader) |
|
268 | - && ( |
|
269 | - strpos($loader, 'load_') !== 0 |
|
270 | - || ! method_exists('EE_Registry', $loader) |
|
271 | - ) |
|
272 | - ) { |
|
273 | - throw new DomainException( |
|
274 | - sprintf( |
|
275 | - esc_html__( |
|
276 | - '"%1$s" is not a valid loader method on EE_Registry.', |
|
277 | - 'event_espresso' |
|
278 | - ), |
|
279 | - $loader |
|
280 | - ) |
|
281 | - ); |
|
282 | - } |
|
283 | - $class_name = self::$_instance->get_alias($class_name); |
|
284 | - if (! isset(self::$_instance->_class_loaders[$class_name])) { |
|
285 | - self::$_instance->_class_loaders[$class_name] = $loader; |
|
286 | - return true; |
|
287 | - } |
|
288 | - return false; |
|
289 | - } |
|
290 | - |
|
291 | - |
|
292 | - |
|
293 | - /** |
|
294 | - * @return array |
|
295 | - */ |
|
296 | - public function dependency_map() |
|
297 | - { |
|
298 | - return $this->_dependency_map; |
|
299 | - } |
|
300 | - |
|
301 | - |
|
302 | - |
|
303 | - /** |
|
304 | - * returns TRUE if dependency map contains a listing for the provided class name |
|
305 | - * |
|
306 | - * @param string $class_name |
|
307 | - * @return boolean |
|
308 | - */ |
|
309 | - public function has($class_name = '') |
|
310 | - { |
|
311 | - // all legacy models have the same dependencies |
|
312 | - if (strpos($class_name, 'EEM_') === 0) { |
|
313 | - $class_name = 'LEGACY_MODELS'; |
|
314 | - } |
|
315 | - return isset($this->_dependency_map[$class_name]) ? true : false; |
|
316 | - } |
|
317 | - |
|
318 | - |
|
319 | - |
|
320 | - /** |
|
321 | - * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
322 | - * |
|
323 | - * @param string $class_name |
|
324 | - * @param string $dependency |
|
325 | - * @return bool |
|
326 | - */ |
|
327 | - public function has_dependency_for_class($class_name = '', $dependency = '') |
|
328 | - { |
|
329 | - // all legacy models have the same dependencies |
|
330 | - if (strpos($class_name, 'EEM_') === 0) { |
|
331 | - $class_name = 'LEGACY_MODELS'; |
|
332 | - } |
|
333 | - $dependency = $this->get_alias($dependency); |
|
334 | - return isset($this->_dependency_map[$class_name][$dependency]) |
|
335 | - ? true |
|
336 | - : false; |
|
337 | - } |
|
338 | - |
|
339 | - |
|
340 | - |
|
341 | - /** |
|
342 | - * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
343 | - * |
|
344 | - * @param string $class_name |
|
345 | - * @param string $dependency |
|
346 | - * @return int |
|
347 | - */ |
|
348 | - public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
349 | - { |
|
350 | - // all legacy models have the same dependencies |
|
351 | - if (strpos($class_name, 'EEM_') === 0) { |
|
352 | - $class_name = 'LEGACY_MODELS'; |
|
353 | - } |
|
354 | - $dependency = $this->get_alias($dependency); |
|
355 | - return $this->has_dependency_for_class($class_name, $dependency) |
|
356 | - ? $this->_dependency_map[$class_name][$dependency] |
|
357 | - : EE_Dependency_Map::not_registered; |
|
358 | - } |
|
359 | - |
|
360 | - |
|
361 | - |
|
362 | - /** |
|
363 | - * @param string $class_name |
|
364 | - * @return string | Closure |
|
365 | - */ |
|
366 | - public function class_loader($class_name) |
|
367 | - { |
|
368 | - // all legacy models use load_model() |
|
369 | - if(strpos($class_name, 'EEM_') === 0){ |
|
370 | - return 'load_model'; |
|
371 | - } |
|
372 | - $class_name = $this->get_alias($class_name); |
|
373 | - return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : ''; |
|
374 | - } |
|
375 | - |
|
376 | - |
|
377 | - |
|
378 | - /** |
|
379 | - * @return array |
|
380 | - */ |
|
381 | - public function class_loaders() |
|
382 | - { |
|
383 | - return $this->_class_loaders; |
|
384 | - } |
|
385 | - |
|
386 | - |
|
387 | - |
|
388 | - /** |
|
389 | - * adds an alias for a classname |
|
390 | - * |
|
391 | - * @param string $class_name the class name that should be used (concrete class to replace interface) |
|
392 | - * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
393 | - * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
394 | - */ |
|
395 | - public function add_alias($class_name, $alias, $for_class = '') |
|
396 | - { |
|
397 | - if ($for_class !== '') { |
|
398 | - if (! isset($this->_aliases[$for_class])) { |
|
399 | - $this->_aliases[$for_class] = array(); |
|
400 | - } |
|
401 | - $this->_aliases[$for_class][$class_name] = $alias; |
|
402 | - } |
|
403 | - $this->_aliases[$class_name] = $alias; |
|
404 | - } |
|
405 | - |
|
406 | - |
|
407 | - |
|
408 | - /** |
|
409 | - * returns TRUE if the provided class name has an alias |
|
410 | - * |
|
411 | - * @param string $class_name |
|
412 | - * @param string $for_class |
|
413 | - * @return bool |
|
414 | - */ |
|
415 | - public function has_alias($class_name = '', $for_class = '') |
|
416 | - { |
|
417 | - return isset($this->_aliases[$for_class][$class_name]) |
|
418 | - || ( |
|
419 | - isset($this->_aliases[$class_name]) |
|
420 | - && ! is_array($this->_aliases[$class_name]) |
|
421 | - ); |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - |
|
426 | - /** |
|
427 | - * returns alias for class name if one exists, otherwise returns the original classname |
|
428 | - * functions recursively, so that multiple aliases can be used to drill down to a classname |
|
429 | - * for example: |
|
430 | - * if the following two entries were added to the _aliases array: |
|
431 | - * array( |
|
432 | - * 'interface_alias' => 'some\namespace\interface' |
|
433 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
434 | - * ) |
|
435 | - * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
436 | - * to load an instance of 'some\namespace\classname' |
|
437 | - * |
|
438 | - * @param string $class_name |
|
439 | - * @param string $for_class |
|
440 | - * @return string |
|
441 | - */ |
|
442 | - public function get_alias($class_name = '', $for_class = '') |
|
443 | - { |
|
444 | - if (! $this->has_alias($class_name, $for_class)) { |
|
445 | - return $class_name; |
|
446 | - } |
|
447 | - if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) { |
|
448 | - return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class); |
|
449 | - } |
|
450 | - return $this->get_alias($this->_aliases[$class_name]); |
|
451 | - } |
|
452 | - |
|
453 | - |
|
454 | - |
|
455 | - /** |
|
456 | - * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
457 | - * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
458 | - * This is done by using the following class constants: |
|
459 | - * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
460 | - * EE_Dependency_Map::load_new_object - generates a new object every time |
|
461 | - */ |
|
462 | - protected function _register_core_dependencies() |
|
463 | - { |
|
464 | - $this->_dependency_map = array( |
|
465 | - 'EE_Request_Handler' => array( |
|
466 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
467 | - ), |
|
468 | - 'EE_System' => array( |
|
469 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
470 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
471 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
472 | - 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
473 | - ), |
|
474 | - 'EE_Session' => array( |
|
475 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
476 | - 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
477 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
478 | - 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
479 | - ), |
|
480 | - 'EE_Cart' => array( |
|
481 | - 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
482 | - ), |
|
483 | - 'EE_Front_Controller' => array( |
|
484 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
485 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
486 | - 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
487 | - ), |
|
488 | - 'EE_Messenger_Collection_Loader' => array( |
|
489 | - 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
490 | - ), |
|
491 | - 'EE_Message_Type_Collection_Loader' => array( |
|
492 | - 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
493 | - ), |
|
494 | - 'EE_Message_Resource_Manager' => array( |
|
495 | - 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
496 | - 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
497 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
498 | - ), |
|
499 | - 'EE_Message_Factory' => array( |
|
500 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
501 | - ), |
|
502 | - 'EE_messages' => array( |
|
503 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
504 | - ), |
|
505 | - 'EE_Messages_Generator' => array( |
|
506 | - 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
507 | - 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
508 | - 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
509 | - 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
510 | - ), |
|
511 | - 'EE_Messages_Processor' => array( |
|
512 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
513 | - ), |
|
514 | - 'EE_Messages_Queue' => array( |
|
515 | - 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
516 | - ), |
|
517 | - 'EE_Messages_Template_Defaults' => array( |
|
518 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
519 | - 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
520 | - ), |
|
521 | - 'EE_Message_To_Generate_From_Request' => array( |
|
522 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
523 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
524 | - ), |
|
525 | - 'EventEspresso\core\services\commands\CommandBus' => array( |
|
526 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
527 | - ), |
|
528 | - 'EventEspresso\services\commands\CommandHandler' => array( |
|
529 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
530 | - 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
531 | - ), |
|
532 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
533 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
534 | - ), |
|
535 | - 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
536 | - 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
537 | - 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
538 | - ), |
|
539 | - 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
540 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
541 | - ), |
|
542 | - 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
543 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
544 | - ), |
|
545 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
546 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
547 | - ), |
|
548 | - 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
549 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
550 | - ), |
|
551 | - 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
552 | - 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
553 | - ), |
|
554 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
555 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
556 | - ), |
|
557 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
558 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
559 | - ), |
|
560 | - 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
561 | - 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
562 | - ), |
|
563 | - 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
564 | - 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
565 | - ), |
|
566 | - 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
567 | - 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
568 | - ), |
|
569 | - 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
570 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
571 | - ), |
|
572 | - 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
573 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
574 | - ), |
|
575 | - 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
576 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
577 | - ), |
|
578 | - 'EventEspresso\core\services\database\TableManager' => array( |
|
579 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
580 | - ), |
|
581 | - 'EE_Data_Migration_Class_Base' => array( |
|
582 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
583 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
584 | - ), |
|
585 | - 'EE_DMS_Core_4_1_0' => array( |
|
586 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
587 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
588 | - ), |
|
589 | - 'EE_DMS_Core_4_2_0' => array( |
|
590 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
591 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
592 | - ), |
|
593 | - 'EE_DMS_Core_4_3_0' => array( |
|
594 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
595 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
596 | - ), |
|
597 | - 'EE_DMS_Core_4_4_0' => array( |
|
598 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
599 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
600 | - ), |
|
601 | - 'EE_DMS_Core_4_5_0' => array( |
|
602 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
603 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
604 | - ), |
|
605 | - 'EE_DMS_Core_4_6_0' => array( |
|
606 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
607 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
608 | - ), |
|
609 | - 'EE_DMS_Core_4_7_0' => array( |
|
610 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
611 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
612 | - ), |
|
613 | - 'EE_DMS_Core_4_8_0' => array( |
|
614 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
615 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
616 | - ), |
|
617 | - 'EE_DMS_Core_4_9_0' => array( |
|
618 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
619 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
620 | - ), |
|
621 | - 'EventEspresso\core\services\assets\Registry' => array( |
|
622 | - 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
623 | - 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
624 | - 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache |
|
625 | - ), |
|
626 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
627 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
628 | - ), |
|
629 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
630 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
631 | - ), |
|
632 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
633 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
634 | - ), |
|
635 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
636 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
637 | - ), |
|
638 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
639 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
640 | - ), |
|
641 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
642 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
643 | - ), |
|
644 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
645 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
646 | - ), |
|
647 | - 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
648 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
649 | - ), |
|
650 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
651 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
652 | - ), |
|
653 | - 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array( |
|
654 | - 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
655 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
656 | - ), |
|
657 | - 'EventEspresso\core\domain\values\EmailAddress' => array( |
|
658 | - null, |
|
659 | - 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache, |
|
660 | - ), |
|
661 | - 'EventEspresso\core\services\orm\ModelFieldFactory' => array( |
|
662 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
663 | - ), |
|
664 | - 'LEGACY_MODELS' => array( |
|
665 | - null, |
|
666 | - 'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache, |
|
667 | - ), |
|
668 | - 'EE_Module_Request_Router' => array( |
|
669 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
670 | - ), |
|
671 | - 'EE_Registration_Processor' => array( |
|
672 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
673 | - ), |
|
674 | - 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array( |
|
675 | - null, |
|
676 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
677 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
678 | - ), |
|
679 | - 'EE_Admin_Transactions_List_Table' => array( |
|
680 | - null, |
|
681 | - 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
682 | - ), |
|
683 | - 'EventEspresso\core\domain\services\admin\ExitModal' => array( |
|
684 | - 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache |
|
685 | - ) |
|
686 | - ); |
|
687 | - } |
|
688 | - |
|
689 | - |
|
690 | - |
|
691 | - /** |
|
692 | - * Registers how core classes are loaded. |
|
693 | - * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
694 | - * 'EE_Request_Handler' => 'load_core' |
|
695 | - * 'EE_Messages_Queue' => 'load_lib' |
|
696 | - * 'EEH_Debug_Tools' => 'load_helper' |
|
697 | - * or, if greater control is required, by providing a custom closure. For example: |
|
698 | - * 'Some_Class' => function () { |
|
699 | - * return new Some_Class(); |
|
700 | - * }, |
|
701 | - * This is required for instantiating dependencies |
|
702 | - * where an interface has been type hinted in a class constructor. For example: |
|
703 | - * 'Required_Interface' => function () { |
|
704 | - * return new A_Class_That_Implements_Required_Interface(); |
|
705 | - * }, |
|
706 | - * |
|
707 | - * @throws InvalidInterfaceException |
|
708 | - * @throws InvalidDataTypeException |
|
709 | - * @throws InvalidArgumentException |
|
710 | - */ |
|
711 | - protected function _register_core_class_loaders() |
|
712 | - { |
|
713 | - //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
714 | - //be used in a closure. |
|
715 | - $request = &$this->request; |
|
716 | - $response = &$this->response; |
|
717 | - $legacy_request = &$this->legacy_request; |
|
718 | - // $loader = &$this->loader; |
|
719 | - $this->_class_loaders = array( |
|
720 | - //load_core |
|
721 | - 'EE_Capabilities' => 'load_core', |
|
722 | - 'EE_Encryption' => 'load_core', |
|
723 | - 'EE_Front_Controller' => 'load_core', |
|
724 | - 'EE_Module_Request_Router' => 'load_core', |
|
725 | - 'EE_Registry' => 'load_core', |
|
726 | - 'EE_Request' => function () use (&$legacy_request) { |
|
727 | - return $legacy_request; |
|
728 | - }, |
|
729 | - 'EventEspresso\core\services\request\Request' => function () use (&$request) { |
|
730 | - return $request; |
|
731 | - }, |
|
732 | - 'EventEspresso\core\services\request\Response' => function () use (&$response) { |
|
733 | - return $response; |
|
734 | - }, |
|
735 | - 'EE_Request_Handler' => 'load_core', |
|
736 | - 'EE_Session' => 'load_core', |
|
737 | - 'EE_Cron_Tasks' => 'load_core', |
|
738 | - 'EE_System' => 'load_core', |
|
739 | - 'EE_Maintenance_Mode' => 'load_core', |
|
740 | - 'EE_Register_CPTs' => 'load_core', |
|
741 | - 'EE_Admin' => 'load_core', |
|
742 | - //load_lib |
|
743 | - 'EE_Message_Resource_Manager' => 'load_lib', |
|
744 | - 'EE_Message_Type_Collection' => 'load_lib', |
|
745 | - 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
746 | - 'EE_Messenger_Collection' => 'load_lib', |
|
747 | - 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
748 | - 'EE_Messages_Processor' => 'load_lib', |
|
749 | - 'EE_Message_Repository' => 'load_lib', |
|
750 | - 'EE_Messages_Queue' => 'load_lib', |
|
751 | - 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
752 | - 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
753 | - 'EE_Payment_Method_Manager' => 'load_lib', |
|
754 | - 'EE_Messages_Generator' => function () { |
|
755 | - return EE_Registry::instance()->load_lib( |
|
756 | - 'Messages_Generator', |
|
757 | - array(), |
|
758 | - false, |
|
759 | - false |
|
760 | - ); |
|
761 | - }, |
|
762 | - 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
763 | - return EE_Registry::instance()->load_lib( |
|
764 | - 'Messages_Template_Defaults', |
|
765 | - $arguments, |
|
766 | - false, |
|
767 | - false |
|
768 | - ); |
|
769 | - }, |
|
770 | - //load_model |
|
771 | - // 'EEM_Attendee' => 'load_model', |
|
772 | - // 'EEM_Message_Template_Group' => 'load_model', |
|
773 | - // 'EEM_Message_Template' => 'load_model', |
|
774 | - //load_helper |
|
775 | - 'EEH_Parse_Shortcodes' => function () { |
|
776 | - if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
777 | - return new EEH_Parse_Shortcodes(); |
|
778 | - } |
|
779 | - return null; |
|
780 | - }, |
|
781 | - 'EE_Template_Config' => function () { |
|
782 | - return EE_Config::instance()->template_settings; |
|
783 | - }, |
|
784 | - 'EE_Currency_Config' => function () { |
|
785 | - return EE_Config::instance()->currency; |
|
786 | - }, |
|
787 | - 'EE_Registration_Config' => function () { |
|
788 | - return EE_Config::instance()->registration; |
|
789 | - }, |
|
790 | - 'EventEspresso\core\services\loaders\Loader' => function () { |
|
791 | - return LoaderFactory::getLoader(); |
|
792 | - }, |
|
793 | - ); |
|
794 | - } |
|
795 | - |
|
796 | - |
|
797 | - |
|
798 | - /** |
|
799 | - * can be used for supplying alternate names for classes, |
|
800 | - * or for connecting interface names to instantiable classes |
|
801 | - */ |
|
802 | - protected function _register_core_aliases() |
|
803 | - { |
|
804 | - $this->_aliases = array( |
|
805 | - 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
806 | - 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
807 | - 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
808 | - 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
809 | - 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
810 | - 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
811 | - 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
812 | - 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
813 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
814 | - 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
815 | - 'CreateRegCodeCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand', |
|
816 | - 'CreateRegUrlLinkCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand', |
|
817 | - 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
818 | - 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
819 | - 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
820 | - 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
821 | - 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
822 | - 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
823 | - 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
824 | - 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
825 | - 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
826 | - 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
827 | - 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
828 | - 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
829 | - 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
830 | - 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
831 | - 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
832 | - 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
833 | - 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
834 | - 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
835 | - 'EventEspresso\core\domain\services\session\SessionIdentifierInterface' => 'EE_Session', |
|
836 | - 'EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface', |
|
837 | - 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService', |
|
838 | - 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
839 | - 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
840 | - 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
841 | - 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
842 | - 'EventEspresso\core\services\request\RequestInterface' => 'EventEspresso\core\services\request\Request', |
|
843 | - 'EventEspresso\core\services\request\ResponseInterface' => 'EventEspresso\core\services\request\Response', |
|
844 | - 'EventEspresso\core\domain\DomainInterface' => 'EventEspresso\core\domain\Domain', |
|
845 | - ); |
|
846 | - if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
847 | - $this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices'; |
|
848 | - } |
|
849 | - } |
|
850 | - |
|
851 | - |
|
852 | - |
|
853 | - /** |
|
854 | - * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
855 | - * request Primarily used by unit tests. |
|
856 | - * |
|
857 | - * @throws InvalidDataTypeException |
|
858 | - * @throws InvalidInterfaceException |
|
859 | - * @throws InvalidArgumentException |
|
860 | - */ |
|
861 | - public function reset() |
|
862 | - { |
|
863 | - $this->_register_core_class_loaders(); |
|
864 | - $this->_register_core_dependencies(); |
|
865 | - } |
|
28 | + /** |
|
29 | + * This means that the requested class dependency is not present in the dependency map |
|
30 | + */ |
|
31 | + const not_registered = 0; |
|
32 | + |
|
33 | + /** |
|
34 | + * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
35 | + */ |
|
36 | + const load_new_object = 1; |
|
37 | + |
|
38 | + /** |
|
39 | + * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
40 | + * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
41 | + */ |
|
42 | + const load_from_cache = 2; |
|
43 | + |
|
44 | + /** |
|
45 | + * When registering a dependency, |
|
46 | + * this indicates to keep any existing dependencies that already exist, |
|
47 | + * and simply discard any new dependencies declared in the incoming data |
|
48 | + */ |
|
49 | + const KEEP_EXISTING_DEPENDENCIES = 0; |
|
50 | + |
|
51 | + /** |
|
52 | + * When registering a dependency, |
|
53 | + * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
54 | + */ |
|
55 | + const OVERWRITE_DEPENDENCIES = 1; |
|
56 | + |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * @type EE_Dependency_Map $_instance |
|
61 | + */ |
|
62 | + protected static $_instance; |
|
63 | + |
|
64 | + /** |
|
65 | + * @type RequestInterface $request |
|
66 | + */ |
|
67 | + protected $request; |
|
68 | + |
|
69 | + /** |
|
70 | + * @type LegacyRequestInterface $legacy_request |
|
71 | + */ |
|
72 | + protected $legacy_request; |
|
73 | + |
|
74 | + /** |
|
75 | + * @type ResponseInterface $response |
|
76 | + */ |
|
77 | + protected $response; |
|
78 | + |
|
79 | + /** |
|
80 | + * @type LoaderInterface $loader |
|
81 | + */ |
|
82 | + protected $loader; |
|
83 | + |
|
84 | + /** |
|
85 | + * @type array $_dependency_map |
|
86 | + */ |
|
87 | + protected $_dependency_map = array(); |
|
88 | + |
|
89 | + /** |
|
90 | + * @type array $_class_loaders |
|
91 | + */ |
|
92 | + protected $_class_loaders = array(); |
|
93 | + |
|
94 | + /** |
|
95 | + * @type array $_aliases |
|
96 | + */ |
|
97 | + protected $_aliases = array(); |
|
98 | + |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * EE_Dependency_Map constructor. |
|
103 | + */ |
|
104 | + protected function __construct() |
|
105 | + { |
|
106 | + // add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
107 | + do_action('EE_Dependency_Map____construct'); |
|
108 | + } |
|
109 | + |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @throws InvalidDataTypeException |
|
114 | + * @throws InvalidInterfaceException |
|
115 | + * @throws InvalidArgumentException |
|
116 | + */ |
|
117 | + public function initialize() |
|
118 | + { |
|
119 | + $this->_register_core_dependencies(); |
|
120 | + $this->_register_core_class_loaders(); |
|
121 | + $this->_register_core_aliases(); |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @singleton method used to instantiate class object |
|
128 | + * @return EE_Dependency_Map |
|
129 | + */ |
|
130 | + public static function instance() { |
|
131 | + // check if class object is instantiated, and instantiated properly |
|
132 | + if (! self::$_instance instanceof EE_Dependency_Map) { |
|
133 | + self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/); |
|
134 | + } |
|
135 | + return self::$_instance; |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param RequestInterface $request |
|
141 | + */ |
|
142 | + public function setRequest(RequestInterface $request) |
|
143 | + { |
|
144 | + $this->request = $request; |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * @param LegacyRequestInterface $legacy_request |
|
150 | + */ |
|
151 | + public function setLegacyRequest(LegacyRequestInterface $legacy_request) |
|
152 | + { |
|
153 | + $this->legacy_request = $legacy_request; |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @param ResponseInterface $response |
|
159 | + */ |
|
160 | + public function setResponse(ResponseInterface $response) |
|
161 | + { |
|
162 | + $this->response = $response; |
|
163 | + } |
|
164 | + |
|
165 | + |
|
166 | + |
|
167 | + /** |
|
168 | + * @param LoaderInterface $loader |
|
169 | + */ |
|
170 | + public function setLoader(LoaderInterface $loader) |
|
171 | + { |
|
172 | + $this->loader = $loader; |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + |
|
177 | + /** |
|
178 | + * @param string $class |
|
179 | + * @param array $dependencies |
|
180 | + * @param int $overwrite |
|
181 | + * @return bool |
|
182 | + */ |
|
183 | + public static function register_dependencies( |
|
184 | + $class, |
|
185 | + array $dependencies, |
|
186 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
187 | + ) { |
|
188 | + return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
189 | + } |
|
190 | + |
|
191 | + |
|
192 | + |
|
193 | + /** |
|
194 | + * Assigns an array of class names and corresponding load sources (new or cached) |
|
195 | + * to the class specified by the first parameter. |
|
196 | + * IMPORTANT !!! |
|
197 | + * The order of elements in the incoming $dependencies array MUST match |
|
198 | + * the order of the constructor parameters for the class in question. |
|
199 | + * This is especially important when overriding any existing dependencies that are registered. |
|
200 | + * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
201 | + * |
|
202 | + * @param string $class |
|
203 | + * @param array $dependencies |
|
204 | + * @param int $overwrite |
|
205 | + * @return bool |
|
206 | + */ |
|
207 | + public function registerDependencies( |
|
208 | + $class, |
|
209 | + array $dependencies, |
|
210 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
211 | + ) { |
|
212 | + $class = trim($class, '\\'); |
|
213 | + $registered = false; |
|
214 | + if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
215 | + self::$_instance->_dependency_map[ $class ] = array(); |
|
216 | + } |
|
217 | + // we need to make sure that any aliases used when registering a dependency |
|
218 | + // get resolved to the correct class name |
|
219 | + foreach ($dependencies as $dependency => $load_source) { |
|
220 | + $alias = self::$_instance->get_alias($dependency); |
|
221 | + if ( |
|
222 | + $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
223 | + || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
224 | + ) { |
|
225 | + unset($dependencies[$dependency]); |
|
226 | + $dependencies[$alias] = $load_source; |
|
227 | + $registered = true; |
|
228 | + } |
|
229 | + } |
|
230 | + // now add our two lists of dependencies together. |
|
231 | + // using Union (+=) favours the arrays in precedence from left to right, |
|
232 | + // so $dependencies is NOT overwritten because it is listed first |
|
233 | + // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
234 | + // Union is way faster than array_merge() but should be used with caution... |
|
235 | + // especially with numerically indexed arrays |
|
236 | + $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
237 | + // now we need to ensure that the resulting dependencies |
|
238 | + // array only has the entries that are required for the class |
|
239 | + // so first count how many dependencies were originally registered for the class |
|
240 | + $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
241 | + // if that count is non-zero (meaning dependencies were already registered) |
|
242 | + self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
243 | + // then truncate the final array to match that count |
|
244 | + ? array_slice($dependencies, 0, $dependency_count) |
|
245 | + // otherwise just take the incoming array because nothing previously existed |
|
246 | + : $dependencies; |
|
247 | + return $registered; |
|
248 | + } |
|
249 | + |
|
250 | + |
|
251 | + |
|
252 | + /** |
|
253 | + * @param string $class_name |
|
254 | + * @param string $loader |
|
255 | + * @return bool |
|
256 | + * @throws DomainException |
|
257 | + */ |
|
258 | + public static function register_class_loader($class_name, $loader = 'load_core') |
|
259 | + { |
|
260 | + if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
261 | + throw new DomainException( |
|
262 | + esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
263 | + ); |
|
264 | + } |
|
265 | + // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
266 | + if ( |
|
267 | + ! is_callable($loader) |
|
268 | + && ( |
|
269 | + strpos($loader, 'load_') !== 0 |
|
270 | + || ! method_exists('EE_Registry', $loader) |
|
271 | + ) |
|
272 | + ) { |
|
273 | + throw new DomainException( |
|
274 | + sprintf( |
|
275 | + esc_html__( |
|
276 | + '"%1$s" is not a valid loader method on EE_Registry.', |
|
277 | + 'event_espresso' |
|
278 | + ), |
|
279 | + $loader |
|
280 | + ) |
|
281 | + ); |
|
282 | + } |
|
283 | + $class_name = self::$_instance->get_alias($class_name); |
|
284 | + if (! isset(self::$_instance->_class_loaders[$class_name])) { |
|
285 | + self::$_instance->_class_loaders[$class_name] = $loader; |
|
286 | + return true; |
|
287 | + } |
|
288 | + return false; |
|
289 | + } |
|
290 | + |
|
291 | + |
|
292 | + |
|
293 | + /** |
|
294 | + * @return array |
|
295 | + */ |
|
296 | + public function dependency_map() |
|
297 | + { |
|
298 | + return $this->_dependency_map; |
|
299 | + } |
|
300 | + |
|
301 | + |
|
302 | + |
|
303 | + /** |
|
304 | + * returns TRUE if dependency map contains a listing for the provided class name |
|
305 | + * |
|
306 | + * @param string $class_name |
|
307 | + * @return boolean |
|
308 | + */ |
|
309 | + public function has($class_name = '') |
|
310 | + { |
|
311 | + // all legacy models have the same dependencies |
|
312 | + if (strpos($class_name, 'EEM_') === 0) { |
|
313 | + $class_name = 'LEGACY_MODELS'; |
|
314 | + } |
|
315 | + return isset($this->_dependency_map[$class_name]) ? true : false; |
|
316 | + } |
|
317 | + |
|
318 | + |
|
319 | + |
|
320 | + /** |
|
321 | + * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
322 | + * |
|
323 | + * @param string $class_name |
|
324 | + * @param string $dependency |
|
325 | + * @return bool |
|
326 | + */ |
|
327 | + public function has_dependency_for_class($class_name = '', $dependency = '') |
|
328 | + { |
|
329 | + // all legacy models have the same dependencies |
|
330 | + if (strpos($class_name, 'EEM_') === 0) { |
|
331 | + $class_name = 'LEGACY_MODELS'; |
|
332 | + } |
|
333 | + $dependency = $this->get_alias($dependency); |
|
334 | + return isset($this->_dependency_map[$class_name][$dependency]) |
|
335 | + ? true |
|
336 | + : false; |
|
337 | + } |
|
338 | + |
|
339 | + |
|
340 | + |
|
341 | + /** |
|
342 | + * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
343 | + * |
|
344 | + * @param string $class_name |
|
345 | + * @param string $dependency |
|
346 | + * @return int |
|
347 | + */ |
|
348 | + public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
349 | + { |
|
350 | + // all legacy models have the same dependencies |
|
351 | + if (strpos($class_name, 'EEM_') === 0) { |
|
352 | + $class_name = 'LEGACY_MODELS'; |
|
353 | + } |
|
354 | + $dependency = $this->get_alias($dependency); |
|
355 | + return $this->has_dependency_for_class($class_name, $dependency) |
|
356 | + ? $this->_dependency_map[$class_name][$dependency] |
|
357 | + : EE_Dependency_Map::not_registered; |
|
358 | + } |
|
359 | + |
|
360 | + |
|
361 | + |
|
362 | + /** |
|
363 | + * @param string $class_name |
|
364 | + * @return string | Closure |
|
365 | + */ |
|
366 | + public function class_loader($class_name) |
|
367 | + { |
|
368 | + // all legacy models use load_model() |
|
369 | + if(strpos($class_name, 'EEM_') === 0){ |
|
370 | + return 'load_model'; |
|
371 | + } |
|
372 | + $class_name = $this->get_alias($class_name); |
|
373 | + return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : ''; |
|
374 | + } |
|
375 | + |
|
376 | + |
|
377 | + |
|
378 | + /** |
|
379 | + * @return array |
|
380 | + */ |
|
381 | + public function class_loaders() |
|
382 | + { |
|
383 | + return $this->_class_loaders; |
|
384 | + } |
|
385 | + |
|
386 | + |
|
387 | + |
|
388 | + /** |
|
389 | + * adds an alias for a classname |
|
390 | + * |
|
391 | + * @param string $class_name the class name that should be used (concrete class to replace interface) |
|
392 | + * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
393 | + * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
394 | + */ |
|
395 | + public function add_alias($class_name, $alias, $for_class = '') |
|
396 | + { |
|
397 | + if ($for_class !== '') { |
|
398 | + if (! isset($this->_aliases[$for_class])) { |
|
399 | + $this->_aliases[$for_class] = array(); |
|
400 | + } |
|
401 | + $this->_aliases[$for_class][$class_name] = $alias; |
|
402 | + } |
|
403 | + $this->_aliases[$class_name] = $alias; |
|
404 | + } |
|
405 | + |
|
406 | + |
|
407 | + |
|
408 | + /** |
|
409 | + * returns TRUE if the provided class name has an alias |
|
410 | + * |
|
411 | + * @param string $class_name |
|
412 | + * @param string $for_class |
|
413 | + * @return bool |
|
414 | + */ |
|
415 | + public function has_alias($class_name = '', $for_class = '') |
|
416 | + { |
|
417 | + return isset($this->_aliases[$for_class][$class_name]) |
|
418 | + || ( |
|
419 | + isset($this->_aliases[$class_name]) |
|
420 | + && ! is_array($this->_aliases[$class_name]) |
|
421 | + ); |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + |
|
426 | + /** |
|
427 | + * returns alias for class name if one exists, otherwise returns the original classname |
|
428 | + * functions recursively, so that multiple aliases can be used to drill down to a classname |
|
429 | + * for example: |
|
430 | + * if the following two entries were added to the _aliases array: |
|
431 | + * array( |
|
432 | + * 'interface_alias' => 'some\namespace\interface' |
|
433 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
434 | + * ) |
|
435 | + * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
436 | + * to load an instance of 'some\namespace\classname' |
|
437 | + * |
|
438 | + * @param string $class_name |
|
439 | + * @param string $for_class |
|
440 | + * @return string |
|
441 | + */ |
|
442 | + public function get_alias($class_name = '', $for_class = '') |
|
443 | + { |
|
444 | + if (! $this->has_alias($class_name, $for_class)) { |
|
445 | + return $class_name; |
|
446 | + } |
|
447 | + if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) { |
|
448 | + return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class); |
|
449 | + } |
|
450 | + return $this->get_alias($this->_aliases[$class_name]); |
|
451 | + } |
|
452 | + |
|
453 | + |
|
454 | + |
|
455 | + /** |
|
456 | + * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
457 | + * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
458 | + * This is done by using the following class constants: |
|
459 | + * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
460 | + * EE_Dependency_Map::load_new_object - generates a new object every time |
|
461 | + */ |
|
462 | + protected function _register_core_dependencies() |
|
463 | + { |
|
464 | + $this->_dependency_map = array( |
|
465 | + 'EE_Request_Handler' => array( |
|
466 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
467 | + ), |
|
468 | + 'EE_System' => array( |
|
469 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
470 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
471 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
472 | + 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
473 | + ), |
|
474 | + 'EE_Session' => array( |
|
475 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
476 | + 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
477 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
478 | + 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
479 | + ), |
|
480 | + 'EE_Cart' => array( |
|
481 | + 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
482 | + ), |
|
483 | + 'EE_Front_Controller' => array( |
|
484 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
485 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
486 | + 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
487 | + ), |
|
488 | + 'EE_Messenger_Collection_Loader' => array( |
|
489 | + 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
490 | + ), |
|
491 | + 'EE_Message_Type_Collection_Loader' => array( |
|
492 | + 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
493 | + ), |
|
494 | + 'EE_Message_Resource_Manager' => array( |
|
495 | + 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
496 | + 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
497 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
498 | + ), |
|
499 | + 'EE_Message_Factory' => array( |
|
500 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
501 | + ), |
|
502 | + 'EE_messages' => array( |
|
503 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
504 | + ), |
|
505 | + 'EE_Messages_Generator' => array( |
|
506 | + 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
507 | + 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
508 | + 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
509 | + 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
510 | + ), |
|
511 | + 'EE_Messages_Processor' => array( |
|
512 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
513 | + ), |
|
514 | + 'EE_Messages_Queue' => array( |
|
515 | + 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
516 | + ), |
|
517 | + 'EE_Messages_Template_Defaults' => array( |
|
518 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
519 | + 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
520 | + ), |
|
521 | + 'EE_Message_To_Generate_From_Request' => array( |
|
522 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
523 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
524 | + ), |
|
525 | + 'EventEspresso\core\services\commands\CommandBus' => array( |
|
526 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
527 | + ), |
|
528 | + 'EventEspresso\services\commands\CommandHandler' => array( |
|
529 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
530 | + 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
531 | + ), |
|
532 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
533 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
534 | + ), |
|
535 | + 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
536 | + 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
537 | + 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
538 | + ), |
|
539 | + 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
540 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
541 | + ), |
|
542 | + 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
543 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
544 | + ), |
|
545 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
546 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
547 | + ), |
|
548 | + 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
549 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
550 | + ), |
|
551 | + 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
552 | + 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
553 | + ), |
|
554 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
555 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
556 | + ), |
|
557 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
558 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
559 | + ), |
|
560 | + 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
561 | + 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
562 | + ), |
|
563 | + 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
564 | + 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
565 | + ), |
|
566 | + 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
567 | + 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
568 | + ), |
|
569 | + 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
570 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
571 | + ), |
|
572 | + 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
573 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
574 | + ), |
|
575 | + 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
576 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
577 | + ), |
|
578 | + 'EventEspresso\core\services\database\TableManager' => array( |
|
579 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
580 | + ), |
|
581 | + 'EE_Data_Migration_Class_Base' => array( |
|
582 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
583 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
584 | + ), |
|
585 | + 'EE_DMS_Core_4_1_0' => array( |
|
586 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
587 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
588 | + ), |
|
589 | + 'EE_DMS_Core_4_2_0' => array( |
|
590 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
591 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
592 | + ), |
|
593 | + 'EE_DMS_Core_4_3_0' => array( |
|
594 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
595 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
596 | + ), |
|
597 | + 'EE_DMS_Core_4_4_0' => array( |
|
598 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
599 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
600 | + ), |
|
601 | + 'EE_DMS_Core_4_5_0' => array( |
|
602 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
603 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
604 | + ), |
|
605 | + 'EE_DMS_Core_4_6_0' => array( |
|
606 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
607 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
608 | + ), |
|
609 | + 'EE_DMS_Core_4_7_0' => array( |
|
610 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
611 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
612 | + ), |
|
613 | + 'EE_DMS_Core_4_8_0' => array( |
|
614 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
615 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
616 | + ), |
|
617 | + 'EE_DMS_Core_4_9_0' => array( |
|
618 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
619 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
620 | + ), |
|
621 | + 'EventEspresso\core\services\assets\Registry' => array( |
|
622 | + 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
623 | + 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
624 | + 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache |
|
625 | + ), |
|
626 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
627 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
628 | + ), |
|
629 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
630 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
631 | + ), |
|
632 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
633 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
634 | + ), |
|
635 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
636 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
637 | + ), |
|
638 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
639 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
640 | + ), |
|
641 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
642 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
643 | + ), |
|
644 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
645 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
646 | + ), |
|
647 | + 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
648 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
649 | + ), |
|
650 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
651 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
652 | + ), |
|
653 | + 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array( |
|
654 | + 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
655 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
656 | + ), |
|
657 | + 'EventEspresso\core\domain\values\EmailAddress' => array( |
|
658 | + null, |
|
659 | + 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache, |
|
660 | + ), |
|
661 | + 'EventEspresso\core\services\orm\ModelFieldFactory' => array( |
|
662 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
663 | + ), |
|
664 | + 'LEGACY_MODELS' => array( |
|
665 | + null, |
|
666 | + 'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache, |
|
667 | + ), |
|
668 | + 'EE_Module_Request_Router' => array( |
|
669 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
670 | + ), |
|
671 | + 'EE_Registration_Processor' => array( |
|
672 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
673 | + ), |
|
674 | + 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array( |
|
675 | + null, |
|
676 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
677 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
678 | + ), |
|
679 | + 'EE_Admin_Transactions_List_Table' => array( |
|
680 | + null, |
|
681 | + 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
682 | + ), |
|
683 | + 'EventEspresso\core\domain\services\admin\ExitModal' => array( |
|
684 | + 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache |
|
685 | + ) |
|
686 | + ); |
|
687 | + } |
|
688 | + |
|
689 | + |
|
690 | + |
|
691 | + /** |
|
692 | + * Registers how core classes are loaded. |
|
693 | + * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
694 | + * 'EE_Request_Handler' => 'load_core' |
|
695 | + * 'EE_Messages_Queue' => 'load_lib' |
|
696 | + * 'EEH_Debug_Tools' => 'load_helper' |
|
697 | + * or, if greater control is required, by providing a custom closure. For example: |
|
698 | + * 'Some_Class' => function () { |
|
699 | + * return new Some_Class(); |
|
700 | + * }, |
|
701 | + * This is required for instantiating dependencies |
|
702 | + * where an interface has been type hinted in a class constructor. For example: |
|
703 | + * 'Required_Interface' => function () { |
|
704 | + * return new A_Class_That_Implements_Required_Interface(); |
|
705 | + * }, |
|
706 | + * |
|
707 | + * @throws InvalidInterfaceException |
|
708 | + * @throws InvalidDataTypeException |
|
709 | + * @throws InvalidArgumentException |
|
710 | + */ |
|
711 | + protected function _register_core_class_loaders() |
|
712 | + { |
|
713 | + //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
714 | + //be used in a closure. |
|
715 | + $request = &$this->request; |
|
716 | + $response = &$this->response; |
|
717 | + $legacy_request = &$this->legacy_request; |
|
718 | + // $loader = &$this->loader; |
|
719 | + $this->_class_loaders = array( |
|
720 | + //load_core |
|
721 | + 'EE_Capabilities' => 'load_core', |
|
722 | + 'EE_Encryption' => 'load_core', |
|
723 | + 'EE_Front_Controller' => 'load_core', |
|
724 | + 'EE_Module_Request_Router' => 'load_core', |
|
725 | + 'EE_Registry' => 'load_core', |
|
726 | + 'EE_Request' => function () use (&$legacy_request) { |
|
727 | + return $legacy_request; |
|
728 | + }, |
|
729 | + 'EventEspresso\core\services\request\Request' => function () use (&$request) { |
|
730 | + return $request; |
|
731 | + }, |
|
732 | + 'EventEspresso\core\services\request\Response' => function () use (&$response) { |
|
733 | + return $response; |
|
734 | + }, |
|
735 | + 'EE_Request_Handler' => 'load_core', |
|
736 | + 'EE_Session' => 'load_core', |
|
737 | + 'EE_Cron_Tasks' => 'load_core', |
|
738 | + 'EE_System' => 'load_core', |
|
739 | + 'EE_Maintenance_Mode' => 'load_core', |
|
740 | + 'EE_Register_CPTs' => 'load_core', |
|
741 | + 'EE_Admin' => 'load_core', |
|
742 | + //load_lib |
|
743 | + 'EE_Message_Resource_Manager' => 'load_lib', |
|
744 | + 'EE_Message_Type_Collection' => 'load_lib', |
|
745 | + 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
746 | + 'EE_Messenger_Collection' => 'load_lib', |
|
747 | + 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
748 | + 'EE_Messages_Processor' => 'load_lib', |
|
749 | + 'EE_Message_Repository' => 'load_lib', |
|
750 | + 'EE_Messages_Queue' => 'load_lib', |
|
751 | + 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
752 | + 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
753 | + 'EE_Payment_Method_Manager' => 'load_lib', |
|
754 | + 'EE_Messages_Generator' => function () { |
|
755 | + return EE_Registry::instance()->load_lib( |
|
756 | + 'Messages_Generator', |
|
757 | + array(), |
|
758 | + false, |
|
759 | + false |
|
760 | + ); |
|
761 | + }, |
|
762 | + 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
763 | + return EE_Registry::instance()->load_lib( |
|
764 | + 'Messages_Template_Defaults', |
|
765 | + $arguments, |
|
766 | + false, |
|
767 | + false |
|
768 | + ); |
|
769 | + }, |
|
770 | + //load_model |
|
771 | + // 'EEM_Attendee' => 'load_model', |
|
772 | + // 'EEM_Message_Template_Group' => 'load_model', |
|
773 | + // 'EEM_Message_Template' => 'load_model', |
|
774 | + //load_helper |
|
775 | + 'EEH_Parse_Shortcodes' => function () { |
|
776 | + if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
777 | + return new EEH_Parse_Shortcodes(); |
|
778 | + } |
|
779 | + return null; |
|
780 | + }, |
|
781 | + 'EE_Template_Config' => function () { |
|
782 | + return EE_Config::instance()->template_settings; |
|
783 | + }, |
|
784 | + 'EE_Currency_Config' => function () { |
|
785 | + return EE_Config::instance()->currency; |
|
786 | + }, |
|
787 | + 'EE_Registration_Config' => function () { |
|
788 | + return EE_Config::instance()->registration; |
|
789 | + }, |
|
790 | + 'EventEspresso\core\services\loaders\Loader' => function () { |
|
791 | + return LoaderFactory::getLoader(); |
|
792 | + }, |
|
793 | + ); |
|
794 | + } |
|
795 | + |
|
796 | + |
|
797 | + |
|
798 | + /** |
|
799 | + * can be used for supplying alternate names for classes, |
|
800 | + * or for connecting interface names to instantiable classes |
|
801 | + */ |
|
802 | + protected function _register_core_aliases() |
|
803 | + { |
|
804 | + $this->_aliases = array( |
|
805 | + 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
806 | + 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
807 | + 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
808 | + 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
809 | + 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
810 | + 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
811 | + 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
812 | + 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
813 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
814 | + 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
815 | + 'CreateRegCodeCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand', |
|
816 | + 'CreateRegUrlLinkCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand', |
|
817 | + 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
818 | + 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
819 | + 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
820 | + 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
821 | + 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
822 | + 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
823 | + 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
824 | + 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
825 | + 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
826 | + 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
827 | + 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
828 | + 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
829 | + 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
830 | + 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
831 | + 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
832 | + 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
833 | + 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
834 | + 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
835 | + 'EventEspresso\core\domain\services\session\SessionIdentifierInterface' => 'EE_Session', |
|
836 | + 'EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface', |
|
837 | + 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService', |
|
838 | + 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
839 | + 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
840 | + 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
841 | + 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
842 | + 'EventEspresso\core\services\request\RequestInterface' => 'EventEspresso\core\services\request\Request', |
|
843 | + 'EventEspresso\core\services\request\ResponseInterface' => 'EventEspresso\core\services\request\Response', |
|
844 | + 'EventEspresso\core\domain\DomainInterface' => 'EventEspresso\core\domain\Domain', |
|
845 | + ); |
|
846 | + if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
847 | + $this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices'; |
|
848 | + } |
|
849 | + } |
|
850 | + |
|
851 | + |
|
852 | + |
|
853 | + /** |
|
854 | + * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
855 | + * request Primarily used by unit tests. |
|
856 | + * |
|
857 | + * @throws InvalidDataTypeException |
|
858 | + * @throws InvalidInterfaceException |
|
859 | + * @throws InvalidArgumentException |
|
860 | + */ |
|
861 | + public function reset() |
|
862 | + { |
|
863 | + $this->_register_core_class_loaders(); |
|
864 | + $this->_register_core_dependencies(); |
|
865 | + } |
|
866 | 866 | |
867 | 867 | |
868 | 868 | } |