@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
3 | - exit( 'NO direct script access allowed' ); |
|
2 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | + exit('NO direct script access allowed'); |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | |
@@ -43,16 +43,16 @@ discard block |
||
43 | 43 | public function __construct() { |
44 | 44 | //set properties |
45 | 45 | $this->name = 'html'; |
46 | - $this->description = __( 'This messenger outputs a message to a browser for display.', 'event_espresso' ); |
|
46 | + $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso'); |
|
47 | 47 | $this->label = array( |
48 | - 'singular' => __( 'html', 'event_espresso' ), |
|
49 | - 'plural' => __( 'html', 'event_espresso' ), |
|
48 | + 'singular' => __('html', 'event_espresso'), |
|
49 | + 'plural' => __('html', 'event_espresso'), |
|
50 | 50 | ); |
51 | 51 | $this->activate_on_install = true; |
52 | 52 | // add the "powered by EE" credit link to the HTML receipt and invoice |
53 | 53 | add_filter( |
54 | 54 | 'FHEE__EE_Html_messenger___send_message__main_body', |
55 | - array( $this, 'add_powered_by_credit_link_to_receipt_and_invoice' ), |
|
55 | + array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'), |
|
56 | 56 | 10, |
57 | 57 | 3 |
58 | 58 | ); |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | * @see abstract declaration in EE_messenger for details. |
92 | 92 | */ |
93 | 93 | protected function _set_admin_pages() { |
94 | - $this->admin_registered_pages = array( 'events_edit' => true ); |
|
94 | + $this->admin_registered_pages = array('events_edit' => true); |
|
95 | 95 | } |
96 | 96 | |
97 | 97 | |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | protected function _set_validator_config() { |
112 | 112 | $this->_validator_config = array( |
113 | 113 | 'subject' => array( |
114 | - 'shortcodes' => array( 'organization', 'primary_registration_details', 'email', 'transaction' ), |
|
114 | + 'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'), |
|
115 | 115 | ), |
116 | 116 | 'content' => array( |
117 | 117 | 'shortcodes' => array( |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | 'primary_registration_list', |
138 | 138 | 'event_author', |
139 | 139 | ), |
140 | - 'required' => array( '[EVENT_LIST]' ), |
|
140 | + 'required' => array('[EVENT_LIST]'), |
|
141 | 141 | ), |
142 | 142 | 'ticket_list' => array( |
143 | 143 | 'shortcodes' => array( |
@@ -148,39 +148,39 @@ discard block |
||
148 | 148 | 'line_item_list', |
149 | 149 | 'venue', |
150 | 150 | ), |
151 | - 'required' => array( '[TICKET_LIST]' ), |
|
151 | + 'required' => array('[TICKET_LIST]'), |
|
152 | 152 | ), |
153 | 153 | 'ticket_line_item_no_pms' => array( |
154 | - 'shortcodes' => array( 'line_item', 'ticket' ), |
|
155 | - 'required' => array( '[TICKET_LINE_ITEM_LIST]' ), |
|
154 | + 'shortcodes' => array('line_item', 'ticket'), |
|
155 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
156 | 156 | ), |
157 | 157 | 'ticket_line_item_pms' => array( |
158 | - 'shortcodes' => array( 'line_item', 'ticket', 'line_item_list' ), |
|
159 | - 'required' => array( '[TICKET_LINE_ITEM_LIST]' ), |
|
158 | + 'shortcodes' => array('line_item', 'ticket', 'line_item_list'), |
|
159 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
160 | 160 | ), |
161 | 161 | 'price_modifier_line_item_list' => array( |
162 | - 'shortcodes' => array( 'line_item' ), |
|
163 | - 'required' => array( '[PRICE_MODIFIER_LINE_ITEM_LIST]' ), |
|
162 | + 'shortcodes' => array('line_item'), |
|
163 | + 'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
164 | 164 | ), |
165 | 165 | 'datetime_list' => array( |
166 | - 'shortcodes' => array( 'datetime' ), |
|
167 | - 'required' => array( '[DATETIME_LIST]' ), |
|
166 | + 'shortcodes' => array('datetime'), |
|
167 | + 'required' => array('[DATETIME_LIST]'), |
|
168 | 168 | ), |
169 | 169 | 'attendee_list' => array( |
170 | - 'shortcodes' => array( 'attendee' ), |
|
171 | - 'required' => array( '[ATTENDEE_LIST]' ), |
|
170 | + 'shortcodes' => array('attendee'), |
|
171 | + 'required' => array('[ATTENDEE_LIST]'), |
|
172 | 172 | ), |
173 | 173 | 'tax_line_item_list' => array( |
174 | - 'shortcodes' => array( 'line_item' ), |
|
175 | - 'required' => array( '[TAX_LINE_ITEM_LIST]' ), |
|
174 | + 'shortcodes' => array('line_item'), |
|
175 | + 'required' => array('[TAX_LINE_ITEM_LIST]'), |
|
176 | 176 | ), |
177 | 177 | 'additional_line_item_list' => array( |
178 | - 'shortcodes' => array( 'line_item' ), |
|
179 | - 'required' => array( '[ADDITIONAL_LINE_ITEM_LIST]' ), |
|
178 | + 'shortcodes' => array('line_item'), |
|
179 | + 'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
180 | 180 | ), |
181 | 181 | 'payment_list' => array( |
182 | - 'shortcodes' => array( 'payment' ), |
|
183 | - 'required' => array( '[PAYMENT_LIST_*]' ), |
|
182 | + 'shortcodes' => array('payment'), |
|
183 | + 'required' => array('[PAYMENT_LIST_*]'), |
|
184 | 184 | ), |
185 | 185 | ); |
186 | 186 | } |
@@ -196,9 +196,9 @@ discard block |
||
196 | 196 | * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed. |
197 | 197 | * @return void |
198 | 198 | */ |
199 | - public function do_secondary_messenger_hooks( $sending_messenger_name ) { |
|
200 | - if ( $sending_messenger_name = 'pdf' ) { |
|
201 | - add_filter( 'EE_messenger__get_variation__variation', array( $this, 'add_html_css' ), 10, 8 ); |
|
199 | + public function do_secondary_messenger_hooks($sending_messenger_name) { |
|
200 | + if ($sending_messenger_name = 'pdf') { |
|
201 | + add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8); |
|
202 | 202 | } |
203 | 203 | } |
204 | 204 | |
@@ -247,7 +247,7 @@ discard block |
||
247 | 247 | */ |
248 | 248 | public function enqueue_scripts_styles() { |
249 | 249 | parent::enqueue_scripts_styles(); |
250 | - do_action( 'AHEE__EE_Html_messenger__enqueue_scripts_styles' ); |
|
250 | + do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles'); |
|
251 | 251 | } |
252 | 252 | |
253 | 253 | |
@@ -275,7 +275,7 @@ discard block |
||
275 | 275 | $this->_template_fields = array( |
276 | 276 | 'subject' => array( |
277 | 277 | 'input' => 'text', |
278 | - 'label' => __( 'Page Title', 'event_espresso' ), |
|
278 | + 'label' => __('Page Title', 'event_espresso'), |
|
279 | 279 | 'type' => 'string', |
280 | 280 | 'required' => true, |
281 | 281 | 'validation' => true, |
@@ -288,7 +288,7 @@ discard block |
||
288 | 288 | 'content' => array( |
289 | 289 | 'main' => array( |
290 | 290 | 'input' => 'wp_editor', |
291 | - 'label' => __( 'Main Content', 'event_espresso' ), |
|
291 | + 'label' => __('Main Content', 'event_espresso'), |
|
292 | 292 | 'type' => 'string', |
293 | 293 | 'required' => true, |
294 | 294 | 'validation' => true, |
@@ -303,7 +303,7 @@ discard block |
||
303 | 303 | 'validation' => true, |
304 | 304 | 'format' => '%s', |
305 | 305 | 'rows' => '15', |
306 | - 'shortcodes_required' => array( '[EVENT_LIST]' ), |
|
306 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
307 | 307 | ), |
308 | 308 | 'ticket_list' => array( |
309 | 309 | 'input' => 'textarea', |
@@ -314,11 +314,11 @@ discard block |
||
314 | 314 | 'format' => '%s', |
315 | 315 | 'css_class' => 'large-text', |
316 | 316 | 'rows' => '10', |
317 | - 'shortcodes_required' => array( '[TICKET_LIST]' ), |
|
317 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
318 | 318 | ), |
319 | 319 | 'ticket_line_item_no_pms' => array( |
320 | 320 | 'input' => 'textarea', |
321 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
321 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
322 | 322 | 'Ticket Line Item List with no Price Modifiers', |
323 | 323 | 'event_espresso' |
324 | 324 | ), |
@@ -328,11 +328,11 @@ discard block |
||
328 | 328 | 'format' => '%s', |
329 | 329 | 'css_class' => 'large-text', |
330 | 330 | 'rows' => '5', |
331 | - 'shortcodes_required' => array( '[TICKET_LINE_ITEM_LIST]' ), |
|
331 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
332 | 332 | ), |
333 | 333 | 'ticket_line_item_pms' => array( |
334 | 334 | 'input' => 'textarea', |
335 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
335 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
336 | 336 | 'Ticket Line Item List with Price Modifiers', |
337 | 337 | 'event_espresso' |
338 | 338 | ), |
@@ -342,7 +342,7 @@ discard block |
||
342 | 342 | 'format' => '%s', |
343 | 343 | 'css_class' => 'large-text', |
344 | 344 | 'rows' => '5', |
345 | - 'shortcodes_required' => array( '[TICKET_LINE_ITEM_LIST]' ), |
|
345 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
346 | 346 | ), |
347 | 347 | 'price_modifier_line_item_list' => array( |
348 | 348 | 'input' => 'textarea', |
@@ -353,7 +353,7 @@ discard block |
||
353 | 353 | 'format' => '%s', |
354 | 354 | 'css_class' => 'large-text', |
355 | 355 | 'rows' => '5', |
356 | - 'shortcodes_required' => array( '[PRICE_MODIFIER_LINE_ITEM_LIST]' ), |
|
356 | + 'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
357 | 357 | ), |
358 | 358 | 'datetime_list' => array( |
359 | 359 | 'input' => 'textarea', |
@@ -364,7 +364,7 @@ discard block |
||
364 | 364 | 'format' => '%s', |
365 | 365 | 'css_class' => 'large-text', |
366 | 366 | 'rows' => '5', |
367 | - 'shortcodes_required' => array( '[DATETIME_LIST]' ), |
|
367 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
368 | 368 | ), |
369 | 369 | 'attendee_list' => array( |
370 | 370 | 'input' => 'textarea', |
@@ -375,7 +375,7 @@ discard block |
||
375 | 375 | 'format' => '%s', |
376 | 376 | 'css_class' => 'large-text', |
377 | 377 | 'rows' => '5', |
378 | - 'shortcodes_required' => array( '[ATTENDEE_LIST]' ), |
|
378 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
379 | 379 | ), |
380 | 380 | 'tax_line_item_list' => array( |
381 | 381 | 'input' => 'textarea', |
@@ -386,7 +386,7 @@ discard block |
||
386 | 386 | 'format' => '%s', |
387 | 387 | 'css_class' => 'large-text', |
388 | 388 | 'rows' => '5', |
389 | - 'shortcodes_required' => array( '[TAX_LINE_ITEM_LIST]' ), |
|
389 | + 'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'), |
|
390 | 390 | ), |
391 | 391 | 'additional_line_item_list' => array( |
392 | 392 | 'input' => 'textarea', |
@@ -397,7 +397,7 @@ discard block |
||
397 | 397 | 'format' => '%s', |
398 | 398 | 'css_class' => 'large-text', |
399 | 399 | 'rows' => '5', |
400 | - 'shortcodes_required' => array( '[ADDITIONAL_LINE_ITEM_LIST]' ), |
|
400 | + 'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
401 | 401 | ), |
402 | 402 | 'payment_list' => array( |
403 | 403 | 'input' => 'textarea', |
@@ -408,7 +408,7 @@ discard block |
||
408 | 408 | 'format' => '%s', |
409 | 409 | 'css_class' => 'large-text', |
410 | 410 | 'rows' => '5', |
411 | - 'shortcodes_required' => array( '[PAYMENT_LIST_*]' ), |
|
411 | + 'shortcodes_required' => array('[PAYMENT_LIST_*]'), |
|
412 | 412 | ), |
413 | 413 | ), |
414 | 414 | ), |
@@ -422,7 +422,7 @@ discard block |
||
422 | 422 | * @since 4.5.0 |
423 | 423 | */ |
424 | 424 | protected function _set_default_message_types() { |
425 | - $this->_default_message_types = array( 'receipt', 'invoice' ); |
|
425 | + $this->_default_message_types = array('receipt', 'invoice'); |
|
426 | 426 | } |
427 | 427 | |
428 | 428 | |
@@ -432,7 +432,7 @@ discard block |
||
432 | 432 | * @since 4.5.0 |
433 | 433 | */ |
434 | 434 | protected function _set_valid_message_types() { |
435 | - $this->_valid_message_types = array( 'receipt', 'invoice' ); |
|
435 | + $this->_valid_message_types = array('receipt', 'invoice'); |
|
436 | 436 | } |
437 | 437 | |
438 | 438 | |
@@ -445,7 +445,7 @@ discard block |
||
445 | 445 | */ |
446 | 446 | protected function _send_message() { |
447 | 447 | $this->_template_args = array( |
448 | - 'page_title' => html_entity_decode( stripslashes( $this->_subject ), ENT_QUOTES, "UTF-8" ), |
|
448 | + 'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"), |
|
449 | 449 | 'base_css' => $this->get_variation( |
450 | 450 | $this->_tmp_pack, |
451 | 451 | $this->_incoming_message_type->name, |
@@ -483,7 +483,7 @@ discard block |
||
483 | 483 | ), |
484 | 484 | ); |
485 | 485 | $this->_deregister_wp_hooks(); |
486 | - add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) ); |
|
486 | + add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
487 | 487 | echo $this->_get_main_template(); |
488 | 488 | exit(); |
489 | 489 | } |
@@ -499,16 +499,16 @@ discard block |
||
499 | 499 | * @return void |
500 | 500 | */ |
501 | 501 | protected function _deregister_wp_hooks() { |
502 | - remove_all_actions( 'wp_head' ); |
|
503 | - remove_all_actions( 'wp_footer' ); |
|
504 | - remove_all_actions( 'wp_print_footer_scripts' ); |
|
505 | - remove_all_actions( 'wp_enqueue_scripts' ); |
|
502 | + remove_all_actions('wp_head'); |
|
503 | + remove_all_actions('wp_footer'); |
|
504 | + remove_all_actions('wp_print_footer_scripts'); |
|
505 | + remove_all_actions('wp_enqueue_scripts'); |
|
506 | 506 | global $wp_scripts, $wp_styles; |
507 | 507 | $wp_scripts = $wp_styles = array(); |
508 | 508 | //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
509 | - add_action( 'wp_footer', 'wp_print_footer_scripts' ); |
|
510 | - add_action( 'wp_print_footer_scripts', '_wp_footer_scripts' ); |
|
511 | - add_action( 'wp_head', 'wp_enqueue_scripts' ); |
|
509 | + add_action('wp_footer', 'wp_print_footer_scripts'); |
|
510 | + add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
511 | + add_action('wp_head', 'wp_enqueue_scripts'); |
|
512 | 512 | } |
513 | 513 | |
514 | 514 | |
@@ -520,11 +520,11 @@ discard block |
||
520 | 520 | * @param bool $preview |
521 | 521 | * @return string |
522 | 522 | */ |
523 | - protected function _get_main_template( $preview = false ) { |
|
524 | - $wrapper_template = $this->_tmp_pack->get_wrapper( $this->name, 'main' ); |
|
523 | + protected function _get_main_template($preview = false) { |
|
524 | + $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main'); |
|
525 | 525 | //include message type as a template arg |
526 | 526 | $this->_template_args['message_type'] = $this->_incoming_message_type; |
527 | - return EEH_Template::display_template( $wrapper_template, $this->_template_args, true ); |
|
527 | + return EEH_Template::display_template($wrapper_template, $this->_template_args, true); |
|
528 | 528 | } |
529 | 529 | |
530 | 530 | |
@@ -557,10 +557,10 @@ discard block |
||
557 | 557 | EE_message_type $incoming_message_type |
558 | 558 | ) { |
559 | 559 | if ( |
560 | - ( $incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt' ) |
|
561 | - && apply_filters( 'FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true ) |
|
560 | + ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt') |
|
561 | + && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true) |
|
562 | 562 | ) { |
563 | - $content .= \EEH_Template::powered_by_event_espresso( 'aln-cntr' ) . EEH_HTML::div( EEH_HTML::p(' ') ); |
|
563 | + $content .= \EEH_Template::powered_by_event_espresso('aln-cntr').EEH_HTML::div(EEH_HTML::p(' ')); |
|
564 | 564 | } |
565 | 565 | return $content; |
566 | 566 | } |
@@ -8,9 +8,9 @@ discard block |
||
8 | 8 | * @param $class_file |
9 | 9 | * @return array |
10 | 10 | */ |
11 | -function espresso_invoice_template_files( $class_file) { |
|
11 | +function espresso_invoice_template_files($class_file) { |
|
12 | 12 | // read our template dir and build an array of files |
13 | - $dhandle = opendir(dirname($class_file) . '/lib/templates/css/'); //If the template files have been moved to the uploads folder |
|
13 | + $dhandle = opendir(dirname($class_file).'/lib/templates/css/'); //If the template files have been moved to the uploads folder |
|
14 | 14 | //} else return FALSE; |
15 | 15 | |
16 | 16 | $files = array(); |
@@ -50,8 +50,8 @@ discard block |
||
50 | 50 | * @param string $selected |
51 | 51 | * @return string |
52 | 52 | */ |
53 | -function espresso_invoice_is_selected( $input_item, $selected='') { |
|
54 | - if ( $input_item === $selected ) { |
|
53 | +function espresso_invoice_is_selected($input_item, $selected = '') { |
|
54 | + if ($input_item === $selected) { |
|
55 | 55 | return 'selected="selected"'; |
56 | 56 | } else { |
57 | 57 | return ''; |
@@ -2,7 +2,7 @@ discard block |
||
2 | 2 | use EventEspresso\core\services\database\TableAnalysis; |
3 | 3 | use EventEspresso\core\services\database\TableManager; |
4 | 4 | |
5 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION')) { |
|
5 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
6 | 6 | exit('No direct script access allowed'); |
7 | 7 | } |
8 | 8 | |
@@ -20,7 +20,7 @@ discard block |
||
20 | 20 | */ |
21 | 21 | /** |
22 | 22 | */ |
23 | -class EE_DMS_Unknown_1_0_0 extends EE_Data_Migration_Script_Base{ |
|
23 | +class EE_DMS_Unknown_1_0_0 extends EE_Data_Migration_Script_Base { |
|
24 | 24 | |
25 | 25 | /** |
26 | 26 | * Returns whether or not this data migration script can operate on the given version of the database. |
@@ -47,11 +47,11 @@ discard block |
||
47 | 47 | * @param TableManager $table_manager |
48 | 48 | * @param TableAnalysis $table_analysis |
49 | 49 | */ |
50 | - public function __construct( TableManager $table_manager = null, TableAnalysis $table_analysis = null ) { |
|
50 | + public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null) { |
|
51 | 51 | $this->_migration_stages = array(); |
52 | 52 | $this->_pretty_name = __("Fatal Uncatchable Error Occurred", "event_espresso"); |
53 | 53 | // dd($this); |
54 | - parent::__construct( $table_manager, $table_analysis ); |
|
54 | + parent::__construct($table_manager, $table_analysis); |
|
55 | 55 | } |
56 | 56 | public function migration_page_hooks() { |
57 | 57 |
@@ -35,12 +35,12 @@ |
||
35 | 35 | |
36 | 36 | |
37 | 37 | /** |
38 | - * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
39 | - * @param string $column_name |
|
40 | - * @param string $column_info |
|
41 | - * @return bool|false|int |
|
42 | - */ |
|
43 | - public function addColumn( $table_name, $column_name, $column_info='INT UNSIGNED NOT NULL' ) |
|
38 | + * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
39 | + * @param string $column_name |
|
40 | + * @param string $column_info |
|
41 | + * @return bool|false|int |
|
42 | + */ |
|
43 | + public function addColumn( $table_name, $column_name, $column_info='INT UNSIGNED NOT NULL' ) |
|
44 | 44 | { |
45 | 45 | if( apply_filters( 'FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', FALSE ) ){ |
46 | 46 | return FALSE; |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | namespace EventEspresso\core\services\database; |
3 | 3 | |
4 | -defined( 'EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed'); |
|
4 | +defined('EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed'); |
|
5 | 5 | /** |
6 | 6 | * |
7 | 7 | * Class TableManager |
@@ -28,7 +28,7 @@ discard block |
||
28 | 28 | * |
29 | 29 | * @param TableAnalysis $TableAnalysis |
30 | 30 | */ |
31 | - public function __construct( TableAnalysis $TableAnalysis ) { |
|
31 | + public function __construct(TableAnalysis $TableAnalysis) { |
|
32 | 32 | $this->table_analysis = $TableAnalysis; |
33 | 33 | } |
34 | 34 | |
@@ -38,13 +38,13 @@ discard block |
||
38 | 38 | * @throws \EE_Error |
39 | 39 | */ |
40 | 40 | protected function getTableAnalysis() { |
41 | - if( $this->table_analysis instanceof TableAnalysis ) { |
|
41 | + if ($this->table_analysis instanceof TableAnalysis) { |
|
42 | 42 | return $this->table_analysis; |
43 | 43 | } else { |
44 | 44 | throw new \EE_Error( |
45 | 45 | sprintf( |
46 | - __( 'Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
47 | - get_class( $this ) |
|
46 | + __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
47 | + get_class($this) |
|
48 | 48 | ) |
49 | 49 | ); |
50 | 50 | } |
@@ -58,16 +58,16 @@ discard block |
||
58 | 58 | * @param string $column_info |
59 | 59 | * @return bool|false|int |
60 | 60 | */ |
61 | - public function addColumn( $table_name, $column_name, $column_info='INT UNSIGNED NOT NULL' ) |
|
61 | + public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL') |
|
62 | 62 | { |
63 | - if( apply_filters( 'FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', FALSE ) ){ |
|
63 | + if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', FALSE)) { |
|
64 | 64 | return FALSE; |
65 | 65 | } |
66 | 66 | global $wpdb; |
67 | - $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
67 | + $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
68 | 68 | $columns = $this->getTableColumns($table_name); |
69 | - if( !in_array( $column_name, $columns)){ |
|
70 | - $alter_query="ALTER TABLE $full_table_name ADD $column_name $column_info"; |
|
69 | + if ( ! in_array($column_name, $columns)) { |
|
70 | + $alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info"; |
|
71 | 71 | return $wpdb->query($alter_query); |
72 | 72 | } |
73 | 73 | return TRUE; |
@@ -80,15 +80,15 @@ discard block |
||
80 | 80 | * @param string $table_name |
81 | 81 | * @return array |
82 | 82 | */ |
83 | - public function getTableColumns( $table_name ) |
|
83 | + public function getTableColumns($table_name) |
|
84 | 84 | { |
85 | 85 | global $wpdb; |
86 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
86 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
87 | 87 | $fieldArray = array(); |
88 | - if ( ! empty( $table_name )) { |
|
88 | + if ( ! empty($table_name)) { |
|
89 | 89 | $columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name "); |
90 | 90 | if ($columns !== FALSE) { |
91 | - foreach( $columns as $column ){ |
|
91 | + foreach ($columns as $column) { |
|
92 | 92 | $fieldArray[] = $column->Field; |
93 | 93 | } |
94 | 94 | } |
@@ -104,12 +104,12 @@ discard block |
||
104 | 104 | * @param string $table_name |
105 | 105 | * @return int |
106 | 106 | */ |
107 | - public function dropTable( $table_name ) |
|
107 | + public function dropTable($table_name) |
|
108 | 108 | { |
109 | 109 | global $wpdb; |
110 | - if ( $this->getTableAnalysis()->tableExists( $table_name ) ) { |
|
111 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
112 | - return $wpdb->query( "DROP TABLE IF EXISTS $table_name" ); |
|
110 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
111 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
112 | + return $wpdb->query("DROP TABLE IF EXISTS $table_name"); |
|
113 | 113 | } |
114 | 114 | return 0; |
115 | 115 | } |
@@ -122,17 +122,17 @@ discard block |
||
122 | 122 | * @param array $table_names |
123 | 123 | * @return array of table names which we deleted |
124 | 124 | */ |
125 | - public function dropTables( $table_names ) |
|
125 | + public function dropTables($table_names) |
|
126 | 126 | { |
127 | 127 | $tables_to_delete = array(); |
128 | - foreach( $table_names as $table_name ) { |
|
129 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
130 | - if( $this->getTableAnalysis()->tableExists( $table_name ) ) { |
|
128 | + foreach ($table_names as $table_name) { |
|
129 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
130 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
131 | 131 | $tables_to_delete[] = $table_name; |
132 | 132 | } |
133 | 133 | } |
134 | 134 | global $wpdb; |
135 | - $wpdb->query( 'DROP TABLE ' . implode( ', ', $tables_to_delete ) ); |
|
135 | + $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete)); |
|
136 | 136 | return $tables_to_delete; |
137 | 137 | } |
138 | 138 | |
@@ -145,19 +145,19 @@ discard block |
||
145 | 145 | * @param string $indexName |
146 | 146 | * @return int |
147 | 147 | */ |
148 | - public function dropIndex( $table_name, $indexName ) |
|
148 | + public function dropIndex($table_name, $indexName) |
|
149 | 149 | { |
150 | - if( apply_filters( 'FHEE__EEH_Activation__drop_index__short_circuit', FALSE ) ){ |
|
150 | + if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', FALSE)) { |
|
151 | 151 | return FALSE; |
152 | 152 | } |
153 | 153 | global $wpdb; |
154 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
154 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
155 | 155 | $index_exists_query = "SHOW INDEX FROM $table_name WHERE Key_name = '$indexName'"; |
156 | 156 | if ( |
157 | - $this->getTableAnalysis()->tableExists( $table_name ) |
|
158 | - && $wpdb->get_var( $index_exists_query ) === $table_name //using get_var with the $index_exists_query returns the table's name |
|
157 | + $this->getTableAnalysis()->tableExists($table_name) |
|
158 | + && $wpdb->get_var($index_exists_query) === $table_name //using get_var with the $index_exists_query returns the table's name |
|
159 | 159 | ) { |
160 | - return $wpdb->query( "ALTER TABLE $table_name DROP INDEX $indexName" ); |
|
160 | + return $wpdb->query("ALTER TABLE $table_name DROP INDEX $indexName"); |
|
161 | 161 | } |
162 | 162 | return 0; |
163 | 163 | } |
@@ -171,31 +171,31 @@ discard block |
||
171 | 171 | * @return void |
172 | 172 | * @throws \EE_Error |
173 | 173 | */ |
174 | - public function createTable( $table_name, $createSql, $engine = 'MyISAM' ) |
|
174 | + public function createTable($table_name, $createSql, $engine = 'MyISAM') |
|
175 | 175 | { |
176 | 176 | // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns ) |
177 | - if ( preg_match( '((((.*?))(,\s))+)', $createSql, $valid_column_data ) ) { |
|
178 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix( $table_name ); |
|
177 | + if (preg_match('((((.*?))(,\s))+)', $createSql, $valid_column_data)) { |
|
178 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
179 | 179 | $SQL = "CREATE TABLE $table_name ( $createSql ) ENGINE=$engine DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;"; |
180 | 180 | /** @var \wpdb $wpdb */ |
181 | 181 | global $wpdb; |
182 | 182 | //get $wpdb to echo errors, but buffer them. This way at least WE know an error |
183 | 183 | //happened. And then we can choose to tell the end user |
184 | - $old_show_errors_policy = $wpdb->show_errors( TRUE ); |
|
185 | - $old_error_suppression_policy = $wpdb->suppress_errors( FALSE ); |
|
184 | + $old_show_errors_policy = $wpdb->show_errors(TRUE); |
|
185 | + $old_error_suppression_policy = $wpdb->suppress_errors(FALSE); |
|
186 | 186 | ob_start(); |
187 | - dbDelta( $SQL ); |
|
187 | + dbDelta($SQL); |
|
188 | 188 | $output = ob_get_contents(); |
189 | 189 | ob_end_clean(); |
190 | - $wpdb->show_errors( $old_show_errors_policy ); |
|
191 | - $wpdb->suppress_errors( $old_error_suppression_policy ); |
|
192 | - if( ! empty( $output ) ){ |
|
193 | - throw new \EE_Error( $output ); |
|
190 | + $wpdb->show_errors($old_show_errors_policy); |
|
191 | + $wpdb->suppress_errors($old_error_suppression_policy); |
|
192 | + if ( ! empty($output)) { |
|
193 | + throw new \EE_Error($output); |
|
194 | 194 | } |
195 | 195 | } else { |
196 | 196 | throw new \EE_Error( |
197 | 197 | sprintf( |
198 | - __( 'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s', 'event_espresso' ), |
|
198 | + __('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s', 'event_espresso'), |
|
199 | 199 | '<br />', |
200 | 200 | $createSql |
201 | 201 | ) |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * before the hook wp_enqueue_scripts is called (so that the form section can enqueue its needed scripts). |
8 | 8 | * However, you may output the form (usually by calling get_html) anywhere you like. |
9 | 9 | */ |
10 | -class EE_Form_Section_Proper extends EE_Form_Section_Validatable{ |
|
10 | +class EE_Form_Section_Proper extends EE_Form_Section_Validatable { |
|
11 | 11 | |
12 | 12 | const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data'; |
13 | 13 | |
@@ -71,52 +71,52 @@ discard block |
||
71 | 71 | * } @see EE_Form_Section_Validatable::__construct() |
72 | 72 | * @throws \EE_Error |
73 | 73 | */ |
74 | - public function __construct( $options_array = array() ){ |
|
75 | - $options_array = (array) apply_filters( 'FHEE__EE_Form_Section_Proper___construct__options_array', $options_array, $this ); |
|
74 | + public function __construct($options_array = array()) { |
|
75 | + $options_array = (array) apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array, $this); |
|
76 | 76 | //call parent first, as it may be setting the name |
77 | 77 | parent::__construct($options_array); |
78 | 78 | //if they've included subsections in the constructor, add them now |
79 | - if( isset( $options_array['include'] )){ |
|
79 | + if (isset($options_array['include'])) { |
|
80 | 80 | //we are going to make sure we ONLY have those subsections to include |
81 | 81 | //AND we are going to make sure they're in that specified order |
82 | 82 | $reordered_subsections = array(); |
83 | - foreach($options_array['include'] as $input_name){ |
|
84 | - if(isset($this->_subsections[$input_name])){ |
|
83 | + foreach ($options_array['include'] as $input_name) { |
|
84 | + if (isset($this->_subsections[$input_name])) { |
|
85 | 85 | $reordered_subsections[$input_name] = $this->_subsections[$input_name]; |
86 | 86 | } |
87 | 87 | } |
88 | 88 | $this->_subsections = $reordered_subsections; |
89 | 89 | } |
90 | - if(isset($options_array['exclude'])){ |
|
90 | + if (isset($options_array['exclude'])) { |
|
91 | 91 | $exclude = $options_array['exclude']; |
92 | 92 | $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude)); |
93 | 93 | } |
94 | - if(isset($options_array['layout_strategy'])){ |
|
94 | + if (isset($options_array['layout_strategy'])) { |
|
95 | 95 | $this->_layout_strategy = $options_array['layout_strategy']; |
96 | 96 | } |
97 | - if( ! $this->_layout_strategy){ |
|
97 | + if ( ! $this->_layout_strategy) { |
|
98 | 98 | $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
99 | 99 | } |
100 | 100 | $this->_layout_strategy->_construct_finalize($this); |
101 | 101 | |
102 | 102 | //ok so we are definitely going to want the forms JS, |
103 | 103 | //so enqueue it or remember to enqueue it during wp_enqueue_scripts |
104 | - if( did_action( 'wp_enqueue_scripts' ) |
|
105 | - || did_action( 'admin_enqueue_scripts' ) ) { |
|
104 | + if (did_action('wp_enqueue_scripts') |
|
105 | + || did_action('admin_enqueue_scripts')) { |
|
106 | 106 | //ok so they've constructed this object after when they should have. |
107 | 107 | //just enqueue the generic form scripts and initialize the form immediately in the JS |
108 | - \EE_Form_Section_Proper::wp_enqueue_scripts( true ); |
|
108 | + \EE_Form_Section_Proper::wp_enqueue_scripts(true); |
|
109 | 109 | \EE_Form_Section_Proper::wp_deregister_conflicting_scripts(); |
110 | 110 | } else { |
111 | - add_action( 'wp_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_enqueue_scripts' )); |
|
112 | - add_action( 'admin_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_enqueue_scripts' )); |
|
113 | - add_action( 'wp_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_deregister_conflicting_scripts' ), 100 ); |
|
114 | - add_action( 'admin_enqueue_scripts', array( 'EE_Form_Section_Proper', 'wp_deregister_conflicting_scripts' ), 100 ); |
|
111 | + add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
112 | + add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
113 | + add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_deregister_conflicting_scripts'), 100); |
|
114 | + add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_deregister_conflicting_scripts'), 100); |
|
115 | 115 | } |
116 | - add_action( 'wp_footer', array( $this, 'ensure_scripts_localized' ), 1 ); |
|
116 | + add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1); |
|
117 | 117 | |
118 | - if( isset( $options_array[ 'name' ] ) ) { |
|
119 | - $this->_construct_finalize( null, $options_array[ 'name' ] ); |
|
118 | + if (isset($options_array['name'])) { |
|
119 | + $this->_construct_finalize(null, $options_array['name']); |
|
120 | 120 | } |
121 | 121 | } |
122 | 122 | |
@@ -129,25 +129,25 @@ discard block |
||
129 | 129 | * @param string $name |
130 | 130 | * @throws \EE_Error |
131 | 131 | */ |
132 | - public function _construct_finalize( $parent_form_section, $name ) { |
|
132 | + public function _construct_finalize($parent_form_section, $name) { |
|
133 | 133 | parent::_construct_finalize($parent_form_section, $name); |
134 | 134 | $this->_set_default_name_if_empty(); |
135 | 135 | $this->_set_default_html_id_if_empty(); |
136 | - foreach( $this->_subsections as $subsection_name => $subsection ){ |
|
137 | - if ( $subsection instanceof EE_Form_Section_Base ) { |
|
138 | - $subsection->_construct_finalize( $this, $subsection_name ); |
|
136 | + foreach ($this->_subsections as $subsection_name => $subsection) { |
|
137 | + if ($subsection instanceof EE_Form_Section_Base) { |
|
138 | + $subsection->_construct_finalize($this, $subsection_name); |
|
139 | 139 | } else { |
140 | 140 | throw new EE_Error( |
141 | 141 | sprintf( |
142 | - __( 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', 'event_espresso' ), |
|
142 | + __('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', 'event_espresso'), |
|
143 | 143 | $subsection_name, |
144 | 144 | get_class($this), |
145 | - $subsection ? get_class($subsection) : __( 'NULL', 'event_espresso' ) |
|
145 | + $subsection ? get_class($subsection) : __('NULL', 'event_espresso') |
|
146 | 146 | ) |
147 | 147 | ); |
148 | 148 | } |
149 | 149 | } |
150 | - do_action( 'AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name ); |
|
150 | + do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | * Gets the layout strategy for this form section |
157 | 157 | * @return EE_Form_Section_Layout_Base |
158 | 158 | */ |
159 | - public function get_layout_strategy(){ |
|
159 | + public function get_layout_strategy() { |
|
160 | 160 | return $this->_layout_strategy; |
161 | 161 | } |
162 | 162 | |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | * @param EE_Form_Input_Base $input |
169 | 169 | * @return string |
170 | 170 | */ |
171 | - public function get_html_for_input($input){ |
|
171 | + public function get_html_for_input($input) { |
|
172 | 172 | return $this->_layout_strategy->layout_input($input); |
173 | 173 | } |
174 | 174 | |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | * @param null $form_data |
182 | 182 | * @return boolean |
183 | 183 | */ |
184 | - public function was_submitted($form_data = NULL){ |
|
184 | + public function was_submitted($form_data = NULL) { |
|
185 | 185 | return $this->form_data_present_in($form_data); |
186 | 186 | } |
187 | 187 | |
@@ -206,21 +206,21 @@ discard block |
||
206 | 206 | * (eg you validated the data then stored it in the DB) |
207 | 207 | * you may want to skip this step. |
208 | 208 | */ |
209 | - public function receive_form_submission( $req_data = null, $validate = true ){ |
|
210 | - $req_data = apply_filters( 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this, $validate ); |
|
211 | - if( $req_data === null ){ |
|
212 | - $req_data = array_merge( $_GET, $_POST ); |
|
209 | + public function receive_form_submission($req_data = null, $validate = true) { |
|
210 | + $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this, $validate); |
|
211 | + if ($req_data === null) { |
|
212 | + $req_data = array_merge($_GET, $_POST); |
|
213 | 213 | } |
214 | - $req_data = apply_filters( 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data, $this ); |
|
215 | - $this->_normalize( $req_data ); |
|
216 | - if( $validate ){ |
|
214 | + $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data, $this); |
|
215 | + $this->_normalize($req_data); |
|
216 | + if ($validate) { |
|
217 | 217 | $this->_validate(); |
218 | 218 | //if it's invalid, we're going to want to re-display so remember what they submitted |
219 | - if ( ! $this->is_valid() ) { |
|
219 | + if ( ! $this->is_valid()) { |
|
220 | 220 | $this->store_submitted_form_data_in_session(); |
221 | 221 | } |
222 | 222 | } |
223 | - do_action( 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate ); |
|
223 | + do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate); |
|
224 | 224 | } |
225 | 225 | |
226 | 226 | |
@@ -234,7 +234,7 @@ discard block |
||
234 | 234 | protected function store_submitted_form_data_in_session() { |
235 | 235 | return EE_Registry::instance()->SSN->set_session_data( |
236 | 236 | array( |
237 | - \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values( true ) |
|
237 | + \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true) |
|
238 | 238 | ) |
239 | 239 | ); |
240 | 240 | } |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | */ |
250 | 250 | protected function get_submitted_form_data_from_session() { |
251 | 251 | $session = EE_Registry::instance()->SSN; |
252 | - if( $session instanceof EE_Session ) { |
|
252 | + if ($session instanceof EE_Session) { |
|
253 | 253 | return $session->get_session_data( |
254 | 254 | \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY |
255 | 255 | ); |
@@ -267,7 +267,7 @@ discard block |
||
267 | 267 | */ |
268 | 268 | protected function flush_submitted_form_data_from_session() { |
269 | 269 | return EE_Registry::instance()->SSN->reset_data( |
270 | - array( \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY ) |
|
270 | + array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY) |
|
271 | 271 | ); |
272 | 272 | } |
273 | 273 | |
@@ -283,12 +283,12 @@ discard block |
||
283 | 283 | */ |
284 | 284 | public function populate_from_session() { |
285 | 285 | $form_data_in_session = $this->get_submitted_form_data_from_session(); |
286 | - if ( empty( $form_data_in_session ) ) { |
|
286 | + if (empty($form_data_in_session)) { |
|
287 | 287 | return false; |
288 | 288 | } |
289 | - $this->receive_form_submission( $form_data_in_session ); |
|
289 | + $this->receive_form_submission($form_data_in_session); |
|
290 | 290 | $this->flush_submitted_form_data_from_session(); |
291 | - if ( $this->form_data_present_in( $form_data_in_session ) ) { |
|
291 | + if ($this->form_data_present_in($form_data_in_session)) { |
|
292 | 292 | return true; |
293 | 293 | } else { |
294 | 294 | return false; |
@@ -305,12 +305,12 @@ discard block |
||
305 | 305 | * the value being an array formatted in teh same way |
306 | 306 | * @param array $default_data |
307 | 307 | */ |
308 | - public function populate_defaults($default_data){ |
|
309 | - foreach($this->subsections() as $subsection_name => $subsection){ |
|
310 | - if(isset($default_data[$subsection_name])){ |
|
311 | - if($subsection instanceof EE_Form_Input_Base){ |
|
308 | + public function populate_defaults($default_data) { |
|
309 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
310 | + if (isset($default_data[$subsection_name])) { |
|
311 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
312 | 312 | $subsection->set_default($default_data[$subsection_name]); |
313 | - }elseif($subsection instanceof EE_Form_Section_Proper){ |
|
313 | + }elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
314 | 314 | $subsection->populate_defaults($default_data[$subsection_name]); |
315 | 315 | } |
316 | 316 | } |
@@ -325,8 +325,8 @@ discard block |
||
325 | 325 | * @param string $name |
326 | 326 | * @return boolean |
327 | 327 | */ |
328 | - public function subsection_exists( $name ){ |
|
329 | - return isset( $this->_subsections[ $name ] ) ? true : false; |
|
328 | + public function subsection_exists($name) { |
|
329 | + return isset($this->_subsections[$name]) ? true : false; |
|
330 | 330 | } |
331 | 331 | |
332 | 332 | |
@@ -344,11 +344,11 @@ discard block |
||
344 | 344 | * @return EE_Form_Section_Base |
345 | 345 | * @throws \EE_Error |
346 | 346 | */ |
347 | - public function get_subsection($name, $require_construction_to_be_finalized = TRUE ){ |
|
348 | - if( $require_construction_to_be_finalized ){ |
|
347 | + public function get_subsection($name, $require_construction_to_be_finalized = TRUE) { |
|
348 | + if ($require_construction_to_be_finalized) { |
|
349 | 349 | $this->ensure_construct_finalized_called(); |
350 | 350 | } |
351 | - return $this->subsection_exists( $name ) ? $this->_subsections[$name] : NULL; |
|
351 | + return $this->subsection_exists($name) ? $this->_subsections[$name] : NULL; |
|
352 | 352 | } |
353 | 353 | |
354 | 354 | |
@@ -357,10 +357,10 @@ discard block |
||
357 | 357 | * Gets all the validatable subsections of this form section |
358 | 358 | * @return EE_Form_Section_Validatable[] |
359 | 359 | */ |
360 | - public function get_validatable_subsections(){ |
|
360 | + public function get_validatable_subsections() { |
|
361 | 361 | $validatable_subsections = array(); |
362 | - foreach($this->subsections() as $name=>$obj){ |
|
363 | - if($obj instanceof EE_Form_Section_Validatable){ |
|
362 | + foreach ($this->subsections() as $name=>$obj) { |
|
363 | + if ($obj instanceof EE_Form_Section_Validatable) { |
|
364 | 364 | $validatable_subsections[$name] = $obj; |
365 | 365 | } |
366 | 366 | } |
@@ -380,9 +380,9 @@ discard block |
||
380 | 380 | * @return EE_Form_Input_Base |
381 | 381 | * @throws EE_Error |
382 | 382 | */ |
383 | - public function get_input($name, $require_construction_to_be_finalized = TRUE ){ |
|
383 | + public function get_input($name, $require_construction_to_be_finalized = TRUE) { |
|
384 | 384 | $subsection = $this->get_subsection($name, $require_construction_to_be_finalized); |
385 | - if( ! $subsection instanceof EE_Form_Input_Base){ |
|
385 | + if ( ! $subsection instanceof EE_Form_Input_Base) { |
|
386 | 386 | throw new EE_Error( |
387 | 387 | sprintf( |
388 | 388 | __( |
@@ -390,8 +390,8 @@ discard block |
||
390 | 390 | 'event_espresso' |
391 | 391 | ), |
392 | 392 | $name, |
393 | - get_class( $this ), |
|
394 | - $subsection ? get_class( $subsection ) : __( "NULL", 'event_espresso' ) |
|
393 | + get_class($this), |
|
394 | + $subsection ? get_class($subsection) : __("NULL", 'event_espresso') |
|
395 | 395 | ) |
396 | 396 | ); |
397 | 397 | } |
@@ -411,14 +411,14 @@ discard block |
||
411 | 411 | * @return EE_Form_Section_Proper |
412 | 412 | * @throws EE_Error |
413 | 413 | */ |
414 | - public function get_proper_subsection($name, $require_construction_to_be_finalized = TRUE ){ |
|
415 | - $subsection = $this->get_subsection( $name, $require_construction_to_be_finalized ); |
|
416 | - if( ! $subsection instanceof EE_Form_Section_Proper){ |
|
414 | + public function get_proper_subsection($name, $require_construction_to_be_finalized = TRUE) { |
|
415 | + $subsection = $this->get_subsection($name, $require_construction_to_be_finalized); |
|
416 | + if ( ! $subsection instanceof EE_Form_Section_Proper) { |
|
417 | 417 | throw new EE_Error( |
418 | 418 | sprintf( |
419 | - __( "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso' ), |
|
419 | + __("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'), |
|
420 | 420 | $name, |
421 | - get_class( $this ) |
|
421 | + get_class($this) |
|
422 | 422 | ) |
423 | 423 | ); |
424 | 424 | } |
@@ -435,7 +435,7 @@ discard block |
||
435 | 435 | * @return mixed depending on the input's type and its normalization strategy |
436 | 436 | * @throws \EE_Error |
437 | 437 | */ |
438 | - public function get_input_value($name){ |
|
438 | + public function get_input_value($name) { |
|
439 | 439 | $input = $this->get_input($name); |
440 | 440 | return $input->normalized_value(); |
441 | 441 | } |
@@ -448,7 +448,7 @@ discard block |
||
448 | 448 | * @return boolean |
449 | 449 | */ |
450 | 450 | public function is_valid() { |
451 | - if( ! $this->has_received_submission()){ |
|
451 | + if ( ! $this->has_received_submission()) { |
|
452 | 452 | throw new EE_Error( |
453 | 453 | sprintf( |
454 | 454 | __( |
@@ -458,16 +458,16 @@ discard block |
||
458 | 458 | ) |
459 | 459 | ); |
460 | 460 | } |
461 | - if( ! parent::is_valid() ) { |
|
461 | + if ( ! parent::is_valid()) { |
|
462 | 462 | return false; |
463 | 463 | } |
464 | 464 | // ok so no general errors to this entire form section. |
465 | 465 | // so let's check the subsections, but only set errors if that hasn't been done yet |
466 | 466 | $set_submission_errors = $this->submission_error_message() === '' ? true : false; |
467 | - foreach( $this->get_validatable_subsections() as $subsection ){ |
|
468 | - if( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '' ){ |
|
469 | - if ( $set_submission_errors ) { |
|
470 | - $this->set_submission_error_message( $subsection->get_validation_error_string() ); |
|
467 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
468 | + if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') { |
|
469 | + if ($set_submission_errors) { |
|
470 | + $this->set_submission_error_message($subsection->get_validation_error_string()); |
|
471 | 471 | } |
472 | 472 | return false; |
473 | 473 | } |
@@ -481,11 +481,11 @@ discard block |
||
481 | 481 | * gets teh default name of this form section if none is specified |
482 | 482 | * @return string |
483 | 483 | */ |
484 | - protected function _set_default_name_if_empty(){ |
|
485 | - if( ! $this->_name ){ |
|
484 | + protected function _set_default_name_if_empty() { |
|
485 | + if ( ! $this->_name) { |
|
486 | 486 | $classname = get_class($this); |
487 | 487 | $default_name = str_replace("EE_", "", $classname); |
488 | - $this->_name = $default_name; |
|
488 | + $this->_name = $default_name; |
|
489 | 489 | } |
490 | 490 | } |
491 | 491 | |
@@ -501,7 +501,7 @@ discard block |
||
501 | 501 | * and get_html when you are about to display the form. |
502 | 502 | * @throws \EE_Error |
503 | 503 | */ |
504 | - public function get_html_and_js(){ |
|
504 | + public function get_html_and_js() { |
|
505 | 505 | //no doing_it_wrong yet because we ourselves are still doing it wrong... |
506 | 506 | //and theoretically this CAN be used properly, provided its used during "wp_enqueue_scripts" |
507 | 507 | $this->enqueue_js(); |
@@ -516,9 +516,9 @@ discard block |
||
516 | 516 | * @param bool $display_previously_submitted_data |
517 | 517 | * @return string |
518 | 518 | */ |
519 | - public function get_html( $display_previously_submitted_data = true ){ |
|
519 | + public function get_html($display_previously_submitted_data = true) { |
|
520 | 520 | $this->ensure_construct_finalized_called(); |
521 | - if ( $display_previously_submitted_data ) { |
|
521 | + if ($display_previously_submitted_data) { |
|
522 | 522 | $this->populate_from_session(); |
523 | 523 | } |
524 | 524 | return $this->_layout_strategy->layout_form(); |
@@ -532,9 +532,9 @@ discard block |
||
532 | 532 | * @return string |
533 | 533 | * @throws \EE_Error |
534 | 534 | */ |
535 | - public function enqueue_js(){ |
|
535 | + public function enqueue_js() { |
|
536 | 536 | $this->_enqueue_and_localize_form_js(); |
537 | - foreach( $this->subsections() as $subsection ) { |
|
537 | + foreach ($this->subsections() as $subsection) { |
|
538 | 538 | $subsection->enqueue_js(); |
539 | 539 | } |
540 | 540 | } |
@@ -553,19 +553,19 @@ discard block |
||
553 | 553 | * to be triggered automatically or not |
554 | 554 | * @return void |
555 | 555 | */ |
556 | - public static function wp_enqueue_scripts( $init_form_validation_automatically = true ){ |
|
557 | - add_filter( 'FHEE_load_jquery_validate', '__return_true' ); |
|
556 | + public static function wp_enqueue_scripts($init_form_validation_automatically = true) { |
|
557 | + add_filter('FHEE_load_jquery_validate', '__return_true'); |
|
558 | 558 | wp_register_script( |
559 | 559 | 'ee_form_section_validation', |
560 | - EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js', |
|
561 | - array( 'jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods' ), |
|
560 | + EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js', |
|
561 | + array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
|
562 | 562 | EVENT_ESPRESSO_VERSION, |
563 | 563 | true |
564 | 564 | ); |
565 | 565 | wp_localize_script( |
566 | 566 | 'ee_form_section_validation', |
567 | 567 | 'ee_form_section_validation_init', |
568 | - array( 'init' => $init_form_validation_automatically ? true : false ) |
|
568 | + array('init' => $init_form_validation_automatically ? true : false) |
|
569 | 569 | ); |
570 | 570 | } |
571 | 571 | |
@@ -576,7 +576,7 @@ discard block |
||
576 | 576 | public static function wp_deregister_conflicting_scripts() { |
577 | 577 | //jquery-form (included in WP core, but deprecated) also declares some of the same methods |
578 | 578 | //as jquery validate |
579 | - wp_deregister_script( 'jquery-form' ); |
|
579 | + wp_deregister_script('jquery-form'); |
|
580 | 580 | } |
581 | 581 | |
582 | 582 | |
@@ -588,14 +588,14 @@ discard block |
||
588 | 588 | * |
589 | 589 | * @throws \EE_Error |
590 | 590 | */ |
591 | - public function _enqueue_and_localize_form_js(){ |
|
591 | + public function _enqueue_and_localize_form_js() { |
|
592 | 592 | $this->ensure_construct_finalized_called(); |
593 | 593 | //actually, we don't want to localize just yet. There may be other forms on the page. |
594 | 594 | //so we need to add our form section data to a static variable accessible by all form sections |
595 | 595 | //and localize it just before the footer |
596 | 596 | $this->localize_validation_rules(); |
597 | - add_action( 'wp_footer', array( 'EE_Form_Section_Proper', 'localize_script_for_all_forms' ), 2 ); |
|
598 | - add_action( 'admin_footer', array( 'EE_Form_Section_Proper', 'localize_script_for_all_forms' ) ); |
|
597 | + add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2); |
|
598 | + add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms')); |
|
599 | 599 | } |
600 | 600 | |
601 | 601 | |
@@ -607,12 +607,12 @@ discard block |
||
607 | 607 | * @return void |
608 | 608 | * @throws \EE_Error |
609 | 609 | */ |
610 | - public function localize_validation_rules( $return_for_subsection = FALSE ){ |
|
610 | + public function localize_validation_rules($return_for_subsection = FALSE) { |
|
611 | 611 | // we only want to localize vars ONCE for the entire form, |
612 | 612 | // so if the form section doesn't have a parent, then it must be the top dog |
613 | - if ( $return_for_subsection || ! $this->parent_section() ) { |
|
614 | - EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
615 | - 'form_section_id'=> $this->html_id( TRUE ), |
|
613 | + if ($return_for_subsection || ! $this->parent_section()) { |
|
614 | + EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array( |
|
615 | + 'form_section_id'=> $this->html_id(TRUE), |
|
616 | 616 | 'validation_rules'=> $this->get_jquery_validation_rules(), |
617 | 617 | 'other_data' => $this->get_other_js_data(), |
618 | 618 | 'errors'=> $this->subsection_validation_errors_by_html_name() |
@@ -628,9 +628,9 @@ discard block |
||
628 | 628 | * @param array $form_other_js_data |
629 | 629 | * @return array |
630 | 630 | */ |
631 | - public function get_other_js_data( $form_other_js_data = array() ) { |
|
632 | - foreach( $this->subsections() as $subsection ) { |
|
633 | - $form_other_js_data = $subsection->get_other_js_data( $form_other_js_data ); |
|
631 | + public function get_other_js_data($form_other_js_data = array()) { |
|
632 | + foreach ($this->subsections() as $subsection) { |
|
633 | + $form_other_js_data = $subsection->get_other_js_data($form_other_js_data); |
|
634 | 634 | } |
635 | 635 | return $form_other_js_data; |
636 | 636 | } |
@@ -641,12 +641,12 @@ discard block |
||
641 | 641 | * Keys are their form names, and values are the inputs themselves |
642 | 642 | * @return EE_Form_Input_Base |
643 | 643 | */ |
644 | - public function inputs_in_subsections(){ |
|
644 | + public function inputs_in_subsections() { |
|
645 | 645 | $inputs = array(); |
646 | - foreach($this->subsections() as $subsection){ |
|
647 | - if( $subsection instanceof EE_Form_Input_Base ){ |
|
648 | - $inputs[ $subsection->html_name() ] = $subsection; |
|
649 | - }elseif($subsection instanceof EE_Form_Section_Proper ){ |
|
646 | + foreach ($this->subsections() as $subsection) { |
|
647 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
648 | + $inputs[$subsection->html_name()] = $subsection; |
|
649 | + }elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
650 | 650 | $inputs += $subsection->inputs_in_subsections(); |
651 | 651 | } |
652 | 652 | } |
@@ -659,12 +659,12 @@ discard block |
||
659 | 659 | * and values are a string of all their validation errors |
660 | 660 | * @return string[] |
661 | 661 | */ |
662 | - public function subsection_validation_errors_by_html_name(){ |
|
662 | + public function subsection_validation_errors_by_html_name() { |
|
663 | 663 | $inputs = $this->inputs(); |
664 | 664 | $errors = array(); |
665 | - foreach( $inputs as $form_input ){ |
|
666 | - if ( $form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors() ){ |
|
667 | - $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
665 | + foreach ($inputs as $form_input) { |
|
666 | + if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
|
667 | + $errors[$form_input->html_name()] = $form_input->get_validation_error_string(); |
|
668 | 668 | } |
669 | 669 | } |
670 | 670 | return $errors; |
@@ -676,15 +676,15 @@ discard block |
||
676 | 676 | * passes all the form data required by the JS to the JS, and enqueues the few required JS files. |
677 | 677 | * Should be setup by each form during the _enqueues_and_localize_form_js |
678 | 678 | */ |
679 | - public static function localize_script_for_all_forms(){ |
|
679 | + public static function localize_script_for_all_forms() { |
|
680 | 680 | //allow inputs and stuff to hook in their JS and stuff here |
681 | - do_action( 'AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin' ); |
|
681 | + do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin'); |
|
682 | 682 | EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages(); |
683 | - $email_validation_level = isset( EE_Registry::instance()->CFG->registration->email_validation_level ) |
|
683 | + $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
|
684 | 684 | ? EE_Registry::instance()->CFG->registration->email_validation_level |
685 | 685 | : 'wp_default'; |
686 | 686 | EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
687 | - wp_enqueue_script( 'ee_form_section_validation' ); |
|
687 | + wp_enqueue_script('ee_form_section_validation'); |
|
688 | 688 | wp_localize_script( |
689 | 689 | 'ee_form_section_validation', |
690 | 690 | 'ee_form_section_vars', |
@@ -697,8 +697,8 @@ discard block |
||
697 | 697 | /** |
698 | 698 | * ensure_scripts_localized |
699 | 699 | */ |
700 | - public function ensure_scripts_localized(){ |
|
701 | - if ( ! EE_Form_Section_Proper::$_scripts_localized ) { |
|
700 | + public function ensure_scripts_localized() { |
|
701 | + if ( ! EE_Form_Section_Proper::$_scripts_localized) { |
|
702 | 702 | $this->_enqueue_and_localize_form_js(); |
703 | 703 | } |
704 | 704 | } |
@@ -710,10 +710,10 @@ discard block |
||
710 | 710 | * is that the key here should be the same as the custom validation rule put in the JS file |
711 | 711 | * @return array keys are custom validation rules, and values are internationalized strings |
712 | 712 | */ |
713 | - private static function _get_localized_error_messages(){ |
|
713 | + private static function _get_localized_error_messages() { |
|
714 | 714 | return array( |
715 | 715 | 'validUrl'=> __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"), |
716 | - 'regex' => __( 'Please check your input', 'event_espresso' ), |
|
716 | + 'regex' => __('Please check your input', 'event_espresso'), |
|
717 | 717 | ); |
718 | 718 | } |
719 | 719 | |
@@ -743,9 +743,9 @@ discard block |
||
743 | 743 | * |
744 | 744 | * @return array |
745 | 745 | */ |
746 | - public function get_jquery_validation_rules(){ |
|
746 | + public function get_jquery_validation_rules() { |
|
747 | 747 | $jquery_validation_rules = array(); |
748 | - foreach($this->get_validatable_subsections() as $subsection){ |
|
748 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
749 | 749 | $jquery_validation_rules = array_merge( |
750 | 750 | $jquery_validation_rules, |
751 | 751 | $subsection->get_jquery_validation_rules() |
@@ -762,14 +762,14 @@ discard block |
||
762 | 762 | * @param array $req_data like $_POST |
763 | 763 | * @return void |
764 | 764 | */ |
765 | - protected function _normalize( $req_data ) { |
|
765 | + protected function _normalize($req_data) { |
|
766 | 766 | $this->_received_submission = true; |
767 | 767 | $this->_validation_errors = array(); |
768 | - foreach ( $this->get_validatable_subsections() as $subsection ) { |
|
768 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
769 | 769 | try { |
770 | - $subsection->_normalize( $req_data ); |
|
771 | - } catch ( EE_Validation_Error $e ) { |
|
772 | - $subsection->add_validation_error( $e ); |
|
770 | + $subsection->_normalize($req_data); |
|
771 | + } catch (EE_Validation_Error $e) { |
|
772 | + $subsection->add_validation_error($e); |
|
773 | 773 | } |
774 | 774 | } |
775 | 775 | } |
@@ -786,9 +786,9 @@ discard block |
||
786 | 786 | * calling parent::_validate() first. |
787 | 787 | */ |
788 | 788 | protected function _validate() { |
789 | - foreach($this->get_validatable_subsections() as $subsection_name => $subsection){ |
|
790 | - if(method_exists($this,'_validate_'.$subsection_name)){ |
|
791 | - call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection)); |
|
789 | + foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
|
790 | + if (method_exists($this, '_validate_'.$subsection_name)) { |
|
791 | + call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection)); |
|
792 | 792 | } |
793 | 793 | $subsection->_validate(); |
794 | 794 | } |
@@ -800,13 +800,13 @@ discard block |
||
800 | 800 | * Gets all the validated inputs for the form section |
801 | 801 | * @return array |
802 | 802 | */ |
803 | - public function valid_data(){ |
|
803 | + public function valid_data() { |
|
804 | 804 | $inputs = array(); |
805 | - foreach( $this->subsections() as $subsection_name =>$subsection ){ |
|
806 | - if ( $subsection instanceof EE_Form_Section_Proper ) { |
|
807 | - $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
808 | - } else if ( $subsection instanceof EE_Form_Input_Base ){ |
|
809 | - $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
805 | + foreach ($this->subsections() as $subsection_name =>$subsection) { |
|
806 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
807 | + $inputs[$subsection_name] = $subsection->valid_data(); |
|
808 | + } else if ($subsection instanceof EE_Form_Input_Base) { |
|
809 | + $inputs[$subsection_name] = $subsection->normalized_value(); |
|
810 | 810 | } |
811 | 811 | } |
812 | 812 | return $inputs; |
@@ -818,11 +818,11 @@ discard block |
||
818 | 818 | * Gets all the inputs on this form section |
819 | 819 | * @return EE_Form_Input_Base[] |
820 | 820 | */ |
821 | - public function inputs(){ |
|
821 | + public function inputs() { |
|
822 | 822 | $inputs = array(); |
823 | - foreach( $this->subsections() as $subsection_name =>$subsection ){ |
|
824 | - if ( $subsection instanceof EE_Form_Input_Base ){ |
|
825 | - $inputs[ $subsection_name ] = $subsection; |
|
823 | + foreach ($this->subsections() as $subsection_name =>$subsection) { |
|
824 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
825 | + $inputs[$subsection_name] = $subsection; |
|
826 | 826 | } |
827 | 827 | } |
828 | 828 | return $inputs; |
@@ -834,10 +834,10 @@ discard block |
||
834 | 834 | * Gets all the subsections which are a proper form |
835 | 835 | * @return EE_Form_Section_Proper[] |
836 | 836 | */ |
837 | - public function subforms(){ |
|
837 | + public function subforms() { |
|
838 | 838 | $form_sections = array(); |
839 | - foreach($this->subsections() as $name=>$obj){ |
|
840 | - if($obj instanceof EE_Form_Section_Proper){ |
|
839 | + foreach ($this->subsections() as $name=>$obj) { |
|
840 | + if ($obj instanceof EE_Form_Section_Proper) { |
|
841 | 841 | $form_sections[$name] = $obj; |
842 | 842 | } |
843 | 843 | } |
@@ -852,7 +852,7 @@ discard block |
||
852 | 852 | * if you only want form inputs or proper form sections. |
853 | 853 | * @return EE_Form_Section_Proper[] |
854 | 854 | */ |
855 | - public function subsections(){ |
|
855 | + public function subsections() { |
|
856 | 856 | $this->ensure_construct_finalized_called(); |
857 | 857 | return $this->_subsections; |
858 | 858 | } |
@@ -874,8 +874,8 @@ discard block |
||
874 | 874 | * where keys are always subsection names and values are either |
875 | 875 | * the input's normalized value, or an array like the top-level array |
876 | 876 | */ |
877 | - public function input_values( $include_subform_inputs = false, $flatten = false ){ |
|
878 | - return $this->_input_values( false, $include_subform_inputs, $flatten ); |
|
877 | + public function input_values($include_subform_inputs = false, $flatten = false) { |
|
878 | + return $this->_input_values(false, $include_subform_inputs, $flatten); |
|
879 | 879 | } |
880 | 880 | |
881 | 881 | /** |
@@ -895,8 +895,8 @@ discard block |
||
895 | 895 | * where keys are always subsection names and values are either |
896 | 896 | * the input's normalized value, or an array like the top-level array |
897 | 897 | */ |
898 | - public function input_pretty_values( $include_subform_inputs = false, $flatten = false ){ |
|
899 | - return $this->_input_values( true, $include_subform_inputs, $flatten ); |
|
898 | + public function input_pretty_values($include_subform_inputs = false, $flatten = false) { |
|
899 | + return $this->_input_values(true, $include_subform_inputs, $flatten); |
|
900 | 900 | } |
901 | 901 | |
902 | 902 | /** |
@@ -914,19 +914,19 @@ discard block |
||
914 | 914 | * where keys are always subsection names and values are either |
915 | 915 | * the input's normalized value, or an array like the top-level array |
916 | 916 | */ |
917 | - public function _input_values( $pretty = false, $include_subform_inputs = false, $flatten = false ) { |
|
917 | + public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) { |
|
918 | 918 | $input_values = array(); |
919 | - foreach( $this->subsections() as $subsection_name => $subsection ) { |
|
920 | - if( $subsection instanceof EE_Form_Input_Base ) { |
|
921 | - $input_values[ $subsection_name ] = $pretty |
|
919 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
920 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
921 | + $input_values[$subsection_name] = $pretty |
|
922 | 922 | ? $subsection->pretty_value() |
923 | 923 | : $subsection->normalized_value(); |
924 | - } else if( $subsection instanceof EE_Form_Section_Proper && $include_subform_inputs ) { |
|
925 | - $subform_input_values = $subsection->_input_values( $pretty, $include_subform_inputs, $flatten ); |
|
926 | - if( $flatten ) { |
|
927 | - $input_values = array_merge( $input_values, $subform_input_values ); |
|
924 | + } else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
|
925 | + $subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten); |
|
926 | + if ($flatten) { |
|
927 | + $input_values = array_merge($input_values, $subform_input_values); |
|
928 | 928 | } else { |
929 | - $input_values[ $subsection_name ] = $subform_input_values; |
|
929 | + $input_values[$subsection_name] = $subform_input_values; |
|
930 | 930 | } |
931 | 931 | } |
932 | 932 | } |
@@ -947,23 +947,23 @@ discard block |
||
947 | 947 | * where keys are always subsection names and values are either |
948 | 948 | * the input's normalized value, or an array like the top-level array |
949 | 949 | */ |
950 | - public function submitted_values( $include_subforms = false ) { |
|
950 | + public function submitted_values($include_subforms = false) { |
|
951 | 951 | $submitted_values = array(); |
952 | - foreach( $this->subsections() as $subsection ) { |
|
953 | - if( $subsection instanceof EE_Form_Input_Base ) { |
|
952 | + foreach ($this->subsections() as $subsection) { |
|
953 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
954 | 954 | // is this input part of an array of inputs? |
955 | - if ( strpos( $subsection->html_name(), '[' ) !== false ) { |
|
955 | + if (strpos($subsection->html_name(), '[') !== false) { |
|
956 | 956 | $full_input_name = \EEH_Array::convert_array_values_to_keys( |
957 | - explode( '[', str_replace( ']', '', $subsection->html_name() ) ), |
|
957 | + explode('[', str_replace(']', '', $subsection->html_name())), |
|
958 | 958 | $subsection->raw_value() |
959 | 959 | ); |
960 | - $submitted_values = array_replace_recursive( $submitted_values, $full_input_name ); |
|
960 | + $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
|
961 | 961 | } else { |
962 | - $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
962 | + $submitted_values[$subsection->html_name()] = $subsection->raw_value(); |
|
963 | 963 | } |
964 | - } else if( $subsection instanceof EE_Form_Section_Proper && $include_subforms ) { |
|
965 | - $subform_input_values = $subsection->submitted_values( $include_subforms ); |
|
966 | - $submitted_values = array_replace_recursive( $submitted_values, $subform_input_values ); |
|
964 | + } else if ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
|
965 | + $subform_input_values = $subsection->submitted_values($include_subforms); |
|
966 | + $submitted_values = array_replace_recursive($submitted_values, $subform_input_values); |
|
967 | 967 | } |
968 | 968 | } |
969 | 969 | return $submitted_values; |
@@ -978,7 +978,7 @@ discard block |
||
978 | 978 | * @return boolean |
979 | 979 | * @throws \EE_Error |
980 | 980 | */ |
981 | - public function has_received_submission(){ |
|
981 | + public function has_received_submission() { |
|
982 | 982 | $this->ensure_construct_finalized_called(); |
983 | 983 | return $this->_received_submission; |
984 | 984 | } |
@@ -991,8 +991,8 @@ discard block |
||
991 | 991 | * @param array $inputs_to_exclude values are the input names |
992 | 992 | * @return void |
993 | 993 | */ |
994 | - public function exclude($inputs_to_exclude = array()){ |
|
995 | - foreach($inputs_to_exclude as $input_to_exclude_name){ |
|
994 | + public function exclude($inputs_to_exclude = array()) { |
|
995 | + foreach ($inputs_to_exclude as $input_to_exclude_name) { |
|
996 | 996 | unset($this->_subsections[$input_to_exclude_name]); |
997 | 997 | } |
998 | 998 | } |
@@ -1003,8 +1003,8 @@ discard block |
||
1003 | 1003 | * @param array $inputs_to_hide |
1004 | 1004 | * @throws \EE_Error |
1005 | 1005 | */ |
1006 | - public function hide($inputs_to_hide= array()){ |
|
1007 | - foreach($inputs_to_hide as $input_to_hide){ |
|
1006 | + public function hide($inputs_to_hide = array()) { |
|
1007 | + foreach ($inputs_to_hide as $input_to_hide) { |
|
1008 | 1008 | $input = $this->get_input($input_to_hide); |
1009 | 1009 | |
1010 | 1010 | $input->set_display_strategy(new EE_Hidden_Display_Strategy()); |
@@ -1034,21 +1034,21 @@ discard block |
||
1034 | 1034 | * @return void |
1035 | 1035 | * @throws \EE_Error |
1036 | 1036 | */ |
1037 | - public function add_subsections( $new_subsections, $subsection_name_to_target = NULL, $add_before = true ){ |
|
1038 | - foreach( $new_subsections as $subsection_name => $subsection ){ |
|
1039 | - if( ! $subsection instanceof EE_Form_Section_Base ){ |
|
1037 | + public function add_subsections($new_subsections, $subsection_name_to_target = NULL, $add_before = true) { |
|
1038 | + foreach ($new_subsections as $subsection_name => $subsection) { |
|
1039 | + if ( ! $subsection instanceof EE_Form_Section_Base) { |
|
1040 | 1040 | EE_Error::add_error( |
1041 | 1041 | sprintf( |
1042 | 1042 | __( |
1043 | 1043 | "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", |
1044 | 1044 | "event_espresso" |
1045 | 1045 | ), |
1046 | - get_class( $subsection ), |
|
1046 | + get_class($subsection), |
|
1047 | 1047 | $subsection_name, |
1048 | 1048 | $this->name() |
1049 | 1049 | ) |
1050 | 1050 | ); |
1051 | - unset( $new_subsections[ $subsection_name ] ); |
|
1051 | + unset($new_subsections[$subsection_name]); |
|
1052 | 1052 | } |
1053 | 1053 | } |
1054 | 1054 | $this->_subsections = EEH_Array::insert_into_array( |
@@ -1059,8 +1059,8 @@ discard block |
||
1059 | 1059 | ); |
1060 | 1060 | |
1061 | 1061 | |
1062 | - if( $this->_construction_finalized ){ |
|
1063 | - foreach($this->_subsections as $name => $subsection){ |
|
1062 | + if ($this->_construction_finalized) { |
|
1063 | + foreach ($this->_subsections as $name => $subsection) { |
|
1064 | 1064 | $subsection->_construct_finalize($this, $name); |
1065 | 1065 | } |
1066 | 1066 | } |
@@ -1071,8 +1071,8 @@ discard block |
||
1071 | 1071 | /** |
1072 | 1072 | * Just gets all validatable subsections to clean their sensitive data |
1073 | 1073 | */ |
1074 | - public function clean_sensitive_data(){ |
|
1075 | - foreach($this->get_validatable_subsections() as $subsection){ |
|
1074 | + public function clean_sensitive_data() { |
|
1075 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1076 | 1076 | $subsection->clean_sensitive_data(); |
1077 | 1077 | } |
1078 | 1078 | } |
@@ -1082,10 +1082,10 @@ discard block |
||
1082 | 1082 | /** |
1083 | 1083 | * @param string $form_submission_error_message |
1084 | 1084 | */ |
1085 | - public function set_submission_error_message( $form_submission_error_message = '' ) { |
|
1086 | - $this->_form_submission_error_message .= ! empty( $form_submission_error_message ) |
|
1085 | + public function set_submission_error_message($form_submission_error_message = '') { |
|
1086 | + $this->_form_submission_error_message .= ! empty($form_submission_error_message) |
|
1087 | 1087 | ? $form_submission_error_message |
1088 | - : __( 'Form submission failed due to errors', 'event_espresso' ); |
|
1088 | + : __('Form submission failed due to errors', 'event_espresso'); |
|
1089 | 1089 | } |
1090 | 1090 | |
1091 | 1091 | |
@@ -1102,10 +1102,10 @@ discard block |
||
1102 | 1102 | /** |
1103 | 1103 | * @param string $form_submission_success_message |
1104 | 1104 | */ |
1105 | - public function set_submission_success_message( $form_submission_success_message ) { |
|
1106 | - $this->_form_submission_success_message .= ! empty( $form_submission_success_message ) |
|
1105 | + public function set_submission_success_message($form_submission_success_message) { |
|
1106 | + $this->_form_submission_success_message .= ! empty($form_submission_success_message) |
|
1107 | 1107 | ? $form_submission_success_message |
1108 | - : __( 'Form submitted successfully', 'event_espresso' ); |
|
1108 | + : __('Form submitted successfully', 'event_espresso'); |
|
1109 | 1109 | } |
1110 | 1110 | |
1111 | 1111 | |
@@ -1128,10 +1128,10 @@ discard block |
||
1128 | 1128 | * @return string |
1129 | 1129 | * @throws \EE_Error |
1130 | 1130 | */ |
1131 | - public function html_name_prefix(){ |
|
1132 | - if( $this->parent_section() instanceof EE_Form_Section_Proper ){ |
|
1133 | - return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1134 | - }else{ |
|
1131 | + public function html_name_prefix() { |
|
1132 | + if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
|
1133 | + return $this->parent_section()->html_name_prefix().'['.$this->name().']'; |
|
1134 | + } else { |
|
1135 | 1135 | return $this->name(); |
1136 | 1136 | } |
1137 | 1137 | } |
@@ -1146,7 +1146,7 @@ discard block |
||
1146 | 1146 | * @return string |
1147 | 1147 | * @throws \EE_Error |
1148 | 1148 | */ |
1149 | - public function name(){ |
|
1149 | + public function name() { |
|
1150 | 1150 | $this->ensure_construct_finalized_called(); |
1151 | 1151 | return parent::name(); |
1152 | 1152 | } |
@@ -1157,7 +1157,7 @@ discard block |
||
1157 | 1157 | * @return EE_Form_Section_Proper |
1158 | 1158 | * @throws \EE_Error |
1159 | 1159 | */ |
1160 | - public function parent_section(){ |
|
1160 | + public function parent_section() { |
|
1161 | 1161 | $this->ensure_construct_finalized_called(); |
1162 | 1162 | return parent::parent_section(); |
1163 | 1163 | } |
@@ -1170,9 +1170,9 @@ discard block |
||
1170 | 1170 | * @return void |
1171 | 1171 | * @throws \EE_Error |
1172 | 1172 | */ |
1173 | - public function ensure_construct_finalized_called(){ |
|
1174 | - if( ! $this->_construction_finalized ){ |
|
1175 | - $this->_construct_finalize($this->_parent_section, $this->_name ); |
|
1173 | + public function ensure_construct_finalized_called() { |
|
1174 | + if ( ! $this->_construction_finalized) { |
|
1175 | + $this->_construct_finalize($this->_parent_section, $this->_name); |
|
1176 | 1176 | } |
1177 | 1177 | } |
1178 | 1178 | |
@@ -1184,17 +1184,17 @@ discard block |
||
1184 | 1184 | * @param array $req_data |
1185 | 1185 | * @return boolean |
1186 | 1186 | */ |
1187 | - public function form_data_present_in( $req_data = NULL ) { |
|
1188 | - if( $req_data === NULL){ |
|
1187 | + public function form_data_present_in($req_data = NULL) { |
|
1188 | + if ($req_data === NULL) { |
|
1189 | 1189 | $req_data = $_POST; |
1190 | 1190 | } |
1191 | - foreach( $this->subsections() as $subsection ) { |
|
1192 | - if($subsection instanceof EE_Form_Input_Base ) { |
|
1193 | - if( $subsection->form_data_present_in( $req_data ) ) { |
|
1191 | + foreach ($this->subsections() as $subsection) { |
|
1192 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1193 | + if ($subsection->form_data_present_in($req_data)) { |
|
1194 | 1194 | return TRUE; |
1195 | 1195 | } |
1196 | - }elseif( $subsection instanceof EE_Form_Section_Proper ) { |
|
1197 | - if( $subsection->form_data_present_in( $req_data ) ) { |
|
1196 | + }elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
1197 | + if ($subsection->form_data_present_in($req_data)) { |
|
1198 | 1198 | return TRUE; |
1199 | 1199 | } |
1200 | 1200 | } |
@@ -1211,14 +1211,14 @@ discard block |
||
1211 | 1211 | */ |
1212 | 1212 | public function get_validation_errors_accumulated() { |
1213 | 1213 | $validation_errors = $this->get_validation_errors(); |
1214 | - foreach($this->get_validatable_subsections() as $subsection ) { |
|
1215 | - if( $subsection instanceof EE_Form_Section_Proper ) { |
|
1214 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1215 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
1216 | 1216 | $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated(); |
1217 | 1217 | } else { |
1218 | - $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1218 | + $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1219 | 1219 | } |
1220 | - if( $validation_errors_on_this_subsection ){ |
|
1221 | - $validation_errors = array_merge( $validation_errors, $validation_errors_on_this_subsection ); |
|
1220 | + if ($validation_errors_on_this_subsection) { |
|
1221 | + $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection); |
|
1222 | 1222 | } |
1223 | 1223 | } |
1224 | 1224 | return $validation_errors; |
@@ -1240,24 +1240,24 @@ discard block |
||
1240 | 1240 | * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false |
1241 | 1241 | * @return EE_Form_Section_Base |
1242 | 1242 | */ |
1243 | - public function find_section_from_path( $form_section_path ) { |
|
1243 | + public function find_section_from_path($form_section_path) { |
|
1244 | 1244 | //check if we can find the input from purely going straight up the tree |
1245 | - $input = parent::find_section_from_path( $form_section_path ); |
|
1246 | - if( $input instanceof EE_Form_Section_Base ) { |
|
1245 | + $input = parent::find_section_from_path($form_section_path); |
|
1246 | + if ($input instanceof EE_Form_Section_Base) { |
|
1247 | 1247 | return $input; |
1248 | 1248 | } |
1249 | 1249 | |
1250 | - $next_slash_pos = strpos( $form_section_path, '/' ); |
|
1251 | - if( $next_slash_pos !== false ) { |
|
1252 | - $child_section_name = substr( $form_section_path, 0, $next_slash_pos ); |
|
1253 | - $subpath = substr( $form_section_path, $next_slash_pos + 1 ); |
|
1250 | + $next_slash_pos = strpos($form_section_path, '/'); |
|
1251 | + if ($next_slash_pos !== false) { |
|
1252 | + $child_section_name = substr($form_section_path, 0, $next_slash_pos); |
|
1253 | + $subpath = substr($form_section_path, $next_slash_pos + 1); |
|
1254 | 1254 | } else { |
1255 | 1255 | $child_section_name = $form_section_path; |
1256 | 1256 | $subpath = ''; |
1257 | 1257 | } |
1258 | - $child_section = $this->get_subsection( $child_section_name ); |
|
1259 | - if ( $child_section instanceof EE_Form_Section_Base ) { |
|
1260 | - return $child_section->find_section_from_path( $subpath ); |
|
1258 | + $child_section = $this->get_subsection($child_section_name); |
|
1259 | + if ($child_section instanceof EE_Form_Section_Base) { |
|
1260 | + return $child_section->find_section_from_path($subpath); |
|
1261 | 1261 | } else { |
1262 | 1262 | return null; |
1263 | 1263 | } |
@@ -248,7 +248,7 @@ |
||
248 | 248 | * with construction finalize being called later |
249 | 249 | * (realizing that the subsections' html names |
250 | 250 | * might not be set yet, etc.) |
251 | - * @return EE_Form_Section_Base |
|
251 | + * @return EE_Form_Section_Validatable|null |
|
252 | 252 | * @throws \EE_Error |
253 | 253 | */ |
254 | 254 | public function get_subsection($name, $require_construction_to_be_finalized = TRUE ){ |
@@ -15,7 +15,7 @@ discard block |
||
15 | 15 | |
16 | 16 | |
17 | 17 | |
18 | -if ( ! function_exists( 'espresso_get_template_part' )) { |
|
18 | +if ( ! function_exists('espresso_get_template_part')) { |
|
19 | 19 | /** |
20 | 20 | * espresso_get_template_part |
21 | 21 | * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files |
@@ -25,14 +25,14 @@ discard block |
||
25 | 25 | * @param string $name The name of the specialised template. |
26 | 26 | * @return string the html output for the formatted money value |
27 | 27 | */ |
28 | - function espresso_get_template_part( $slug = NULL, $name = NULL ) { |
|
29 | - EEH_Template::get_template_part( $slug, $name ); |
|
28 | + function espresso_get_template_part($slug = NULL, $name = NULL) { |
|
29 | + EEH_Template::get_template_part($slug, $name); |
|
30 | 30 | } |
31 | 31 | } |
32 | 32 | |
33 | 33 | |
34 | 34 | |
35 | -if ( ! function_exists( 'espresso_get_object_css_class' )) { |
|
35 | +if ( ! function_exists('espresso_get_object_css_class')) { |
|
36 | 36 | /** |
37 | 37 | * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed |
38 | 38 | * |
@@ -42,8 +42,8 @@ discard block |
||
42 | 42 | * @param string $suffix added to the end of the generated class |
43 | 43 | * @return string |
44 | 44 | */ |
45 | - function espresso_get_object_css_class( $object = NULL, $prefix = '', $suffix = '' ) { |
|
46 | - return EEH_Template::get_object_css_class( $object, $prefix, $suffix ); |
|
45 | + function espresso_get_object_css_class($object = NULL, $prefix = '', $suffix = '') { |
|
46 | + return EEH_Template::get_object_css_class($object, $prefix, $suffix); |
|
47 | 47 | } |
48 | 48 | } |
49 | 49 | |
@@ -70,7 +70,7 @@ discard block |
||
70 | 70 | * @return boolean |
71 | 71 | */ |
72 | 72 | public static function is_espresso_theme() { |
73 | - return wp_get_theme()->get( 'TextDomain' ) == 'event_espresso' ? TRUE : FALSE; |
|
73 | + return wp_get_theme()->get('TextDomain') == 'event_espresso' ? TRUE : FALSE; |
|
74 | 74 | } |
75 | 75 | |
76 | 76 | /** |
@@ -79,9 +79,9 @@ discard block |
||
79 | 79 | * @return void |
80 | 80 | */ |
81 | 81 | public static function load_espresso_theme_functions() { |
82 | - if ( ! defined( 'EE_THEME_FUNCTIONS_LOADED' )) { |
|
83 | - if ( is_readable( EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php' )) { |
|
84 | - require_once( EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php' ); |
|
82 | + if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) { |
|
83 | + if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php')) { |
|
84 | + require_once(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php'); |
|
85 | 85 | } |
86 | 86 | } |
87 | 87 | } |
@@ -93,17 +93,17 @@ discard block |
||
93 | 93 | * @return array |
94 | 94 | */ |
95 | 95 | public static function get_espresso_themes() { |
96 | - if ( empty( EEH_Template::$_espresso_themes )) { |
|
97 | - $espresso_themes = glob( EE_PUBLIC . '*', GLOB_ONLYDIR ); |
|
98 | - if ( empty( $espresso_themes ) ) { |
|
96 | + if (empty(EEH_Template::$_espresso_themes)) { |
|
97 | + $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR); |
|
98 | + if (empty($espresso_themes)) { |
|
99 | 99 | return array(); |
100 | 100 | } |
101 | - if (( $key = array_search( 'global_assets', $espresso_themes )) !== FALSE ) { |
|
102 | - unset( $espresso_themes[ $key ] ); |
|
101 | + if (($key = array_search('global_assets', $espresso_themes)) !== FALSE) { |
|
102 | + unset($espresso_themes[$key]); |
|
103 | 103 | } |
104 | 104 | EEH_Template::$_espresso_themes = array(); |
105 | - foreach ( $espresso_themes as $espresso_theme ) { |
|
106 | - EEH_Template::$_espresso_themes[ basename( $espresso_theme ) ] = $espresso_theme; |
|
105 | + foreach ($espresso_themes as $espresso_theme) { |
|
106 | + EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme; |
|
107 | 107 | } |
108 | 108 | } |
109 | 109 | return EEH_Template::$_espresso_themes; |
@@ -122,16 +122,16 @@ discard block |
||
122 | 122 | * @param bool $return_string |
123 | 123 | * @return string the html output for the formatted money value |
124 | 124 | */ |
125 | - public static function get_template_part( $slug = NULL, $name = NULL, $template_args = array(), $return_string = FALSE ) { |
|
126 | - do_action( "get_template_part_{$slug}-{$name}", $slug, $name ); |
|
125 | + public static function get_template_part($slug = NULL, $name = NULL, $template_args = array(), $return_string = FALSE) { |
|
126 | + do_action("get_template_part_{$slug}-{$name}", $slug, $name); |
|
127 | 127 | $templates = array(); |
128 | 128 | $name = (string) $name; |
129 | - if ( $name != '' ) { |
|
129 | + if ($name != '') { |
|
130 | 130 | $templates[] = "{$slug}-{$name}.php"; |
131 | 131 | } |
132 | 132 | // allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' ); |
133 | - if ( apply_filters( "FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", TRUE )) { |
|
134 | - EEH_Template::locate_template( $templates, $template_args, TRUE, $return_string ); |
|
133 | + if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", TRUE)) { |
|
134 | + EEH_Template::locate_template($templates, $template_args, TRUE, $return_string); |
|
135 | 135 | } |
136 | 136 | } |
137 | 137 | |
@@ -182,26 +182,26 @@ discard block |
||
182 | 182 | * Used in places where you don't actually load the template, you just want to know if there's a custom version of it. |
183 | 183 | * @return mixed |
184 | 184 | */ |
185 | - public static function locate_template( $templates = array(), $template_args = array(), $load = TRUE, $return_string = TRUE, $check_if_custom = FALSE ) { |
|
185 | + public static function locate_template($templates = array(), $template_args = array(), $load = TRUE, $return_string = TRUE, $check_if_custom = FALSE) { |
|
186 | 186 | // first use WP locate_template to check for template in the current theme folder |
187 | - $template_path = locate_template( $templates ); |
|
187 | + $template_path = locate_template($templates); |
|
188 | 188 | |
189 | - if ( $check_if_custom && !empty( $template_path ) ) |
|
189 | + if ($check_if_custom && ! empty($template_path)) |
|
190 | 190 | return TRUE; |
191 | 191 | |
192 | 192 | // not in the theme |
193 | - if ( empty( $template_path )) { |
|
193 | + if (empty($template_path)) { |
|
194 | 194 | // not even a template to look for ? |
195 | - if ( empty( $templates )) { |
|
195 | + if (empty($templates)) { |
|
196 | 196 | // get post_type |
197 | - $post_type = EE_Registry::instance()->REQ->get( 'post_type' ); |
|
197 | + $post_type = EE_Registry::instance()->REQ->get('post_type'); |
|
198 | 198 | // get array of EE Custom Post Types |
199 | 199 | $EE_CPTs = EE_Register_CPTs::get_CPTs(); |
200 | 200 | // build template name based on request |
201 | - if ( isset( $EE_CPTs[ $post_type ] )) { |
|
202 | - $archive_or_single = is_archive() ? 'archive' : ''; |
|
203 | - $archive_or_single = is_single() ? 'single' : $archive_or_single; |
|
204 | - $templates = $archive_or_single . '-' . $post_type . '.php'; |
|
201 | + if (isset($EE_CPTs[$post_type])) { |
|
202 | + $archive_or_single = is_archive() ? 'archive' : ''; |
|
203 | + $archive_or_single = is_single() ? 'single' : $archive_or_single; |
|
204 | + $templates = $archive_or_single.'-'.$post_type.'.php'; |
|
205 | 205 | } |
206 | 206 | } |
207 | 207 | // currently active EE template theme |
@@ -210,81 +210,81 @@ discard block |
||
210 | 210 | // array of paths to folders that may contain templates |
211 | 211 | $template_folder_paths = array( |
212 | 212 | // first check the /wp-content/uploads/espresso/templates/(current EE theme)/ folder for an EE theme template file |
213 | - EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme, |
|
213 | + EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme, |
|
214 | 214 | // then in the root of the /wp-content/uploads/espresso/templates/ folder |
215 | 215 | EVENT_ESPRESSO_TEMPLATE_DIR |
216 | 216 | ); |
217 | 217 | |
218 | 218 | //add core plugin folders for checking only if we're not $check_if_custom |
219 | - if ( ! $check_if_custom ) { |
|
219 | + if ( ! $check_if_custom) { |
|
220 | 220 | $core_paths = array( |
221 | 221 | // in the /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin |
222 | - EE_PUBLIC . $current_theme, |
|
222 | + EE_PUBLIC.$current_theme, |
|
223 | 223 | // in the /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin |
224 | - EE_TEMPLATES . $current_theme, |
|
224 | + EE_TEMPLATES.$current_theme, |
|
225 | 225 | // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/ |
226 | 226 | EE_PLUGIN_DIR_PATH |
227 | 227 | ); |
228 | - $template_folder_paths = array_merge( $template_folder_paths, $core_paths ); |
|
228 | + $template_folder_paths = array_merge($template_folder_paths, $core_paths); |
|
229 | 229 | } |
230 | 230 | |
231 | 231 | // now filter that array |
232 | - $template_folder_paths = apply_filters( 'FHEE__EEH_Template__locate_template__template_folder_paths', $template_folder_paths ); |
|
233 | - $templates = is_array( $templates ) ? $templates : array( $templates ); |
|
234 | - $template_folder_paths = is_array( $template_folder_paths ) ? $template_folder_paths : array( $template_folder_paths ); |
|
232 | + $template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths', $template_folder_paths); |
|
233 | + $templates = is_array($templates) ? $templates : array($templates); |
|
234 | + $template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths); |
|
235 | 235 | // array to hold all possible template paths |
236 | 236 | $full_template_paths = array(); |
237 | 237 | |
238 | 238 | // loop through $templates |
239 | - foreach ( $templates as $template ) { |
|
239 | + foreach ($templates as $template) { |
|
240 | 240 | // normalize directory separators |
241 | - $template = EEH_File::standardise_directory_separators( $template ); |
|
242 | - $file_name = basename( $template ); |
|
243 | - $template_path_minus_file_name = substr( $template, 0, ( strlen( $file_name ) * -1 ) ); |
|
241 | + $template = EEH_File::standardise_directory_separators($template); |
|
242 | + $file_name = basename($template); |
|
243 | + $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1)); |
|
244 | 244 | // while looping through all template folder paths |
245 | - foreach ( $template_folder_paths as $template_folder_path ) { |
|
245 | + foreach ($template_folder_paths as $template_folder_path) { |
|
246 | 246 | // normalize directory separators |
247 | - $template_folder_path = EEH_File::standardise_directory_separators( $template_folder_path ); |
|
247 | + $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path); |
|
248 | 248 | // determine if any common base path exists between the two paths |
249 | 249 | $common_base_path = EEH_Template::_find_common_base_path( |
250 | - array( $template_folder_path, $template_path_minus_file_name ) |
|
250 | + array($template_folder_path, $template_path_minus_file_name) |
|
251 | 251 | ); |
252 | - if ( $common_base_path !== '' ) { |
|
252 | + if ($common_base_path !== '') { |
|
253 | 253 | // both paths have a common base, so just tack the filename onto our search path |
254 | - $resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $file_name; |
|
254 | + $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name; |
|
255 | 255 | } else { |
256 | 256 | // no common base path, so let's just concatenate |
257 | - $resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $template; |
|
257 | + $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template; |
|
258 | 258 | } |
259 | 259 | // build up our template locations array by adding our resolved paths |
260 | 260 | $full_template_paths[] = $resolved_path; |
261 | 261 | } |
262 | 262 | // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first |
263 | - array_unshift( $full_template_paths, $template ); |
|
263 | + array_unshift($full_template_paths, $template); |
|
264 | 264 | // path to the directory of the current theme: /wp-content/themes/(current WP theme)/ |
265 | - array_unshift( $full_template_paths, get_stylesheet_directory() . DS . $file_name ); |
|
265 | + array_unshift($full_template_paths, get_stylesheet_directory().DS.$file_name); |
|
266 | 266 | } |
267 | 267 | // filter final array of full template paths |
268 | - $full_template_paths = apply_filters( 'FHEE__EEH_Template__locate_template__full_template_paths', $full_template_paths, $file_name ); |
|
268 | + $full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths', $full_template_paths, $file_name); |
|
269 | 269 | // now loop through our final array of template location paths and check each location |
270 | - foreach ( (array)$full_template_paths as $full_template_path ) { |
|
271 | - if ( is_readable( $full_template_path )) { |
|
272 | - $template_path = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $full_template_path ); |
|
270 | + foreach ((array) $full_template_paths as $full_template_path) { |
|
271 | + if (is_readable($full_template_path)) { |
|
272 | + $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path); |
|
273 | 273 | // hook that can be used to display the full template path that will be used |
274 | - do_action( 'AHEE__EEH_Template__locate_template__full_template_path', $template_path ); |
|
274 | + do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path); |
|
275 | 275 | break; |
276 | 276 | } |
277 | 277 | } |
278 | 278 | } |
279 | 279 | // if we got it and you want to see it... |
280 | - if ( $template_path && $load && ! $check_if_custom ) { |
|
281 | - if ( $return_string ) { |
|
282 | - return EEH_Template::display_template( $template_path, $template_args, TRUE ); |
|
280 | + if ($template_path && $load && ! $check_if_custom) { |
|
281 | + if ($return_string) { |
|
282 | + return EEH_Template::display_template($template_path, $template_args, TRUE); |
|
283 | 283 | } else { |
284 | - EEH_Template::display_template( $template_path, $template_args, FALSE ); |
|
284 | + EEH_Template::display_template($template_path, $template_args, FALSE); |
|
285 | 285 | } |
286 | 286 | } |
287 | - return $check_if_custom && ! empty( $template_path ) ? TRUE : $template_path; |
|
287 | + return $check_if_custom && ! empty($template_path) ? TRUE : $template_path; |
|
288 | 288 | } |
289 | 289 | |
290 | 290 | |
@@ -297,21 +297,21 @@ discard block |
||
297 | 297 | * @param array $paths |
298 | 298 | * @return string |
299 | 299 | */ |
300 | - protected static function _find_common_base_path( $paths ) { |
|
300 | + protected static function _find_common_base_path($paths) { |
|
301 | 301 | $last_offset = 0; |
302 | 302 | $common_base_path = ''; |
303 | - while ( ( $index = strpos( $paths[ 0 ], DS, $last_offset ) ) !== false ) { |
|
303 | + while (($index = strpos($paths[0], DS, $last_offset)) !== false) { |
|
304 | 304 | $dir_length = $index - $last_offset + 1; |
305 | - $directory = substr( $paths[ 0 ], $last_offset, $dir_length ); |
|
306 | - foreach ( $paths as $path ) { |
|
307 | - if ( substr( $path, $last_offset, $dir_length ) != $directory ) { |
|
305 | + $directory = substr($paths[0], $last_offset, $dir_length); |
|
306 | + foreach ($paths as $path) { |
|
307 | + if (substr($path, $last_offset, $dir_length) != $directory) { |
|
308 | 308 | return $common_base_path; |
309 | 309 | } |
310 | 310 | } |
311 | 311 | $common_base_path .= $directory; |
312 | 312 | $last_offset = $index + 1; |
313 | 313 | } |
314 | - return substr( $common_base_path, 0, -1 ); |
|
314 | + return substr($common_base_path, 0, -1); |
|
315 | 315 | } |
316 | 316 | |
317 | 317 | |
@@ -323,7 +323,7 @@ discard block |
||
323 | 323 | * @param boolean $return_string whether to send output immediately to screen, or capture and return as a string |
324 | 324 | * @return mixed string |
325 | 325 | */ |
326 | - public static function display_template( $template_path = FALSE, $template_args = array(), $return_string = FALSE ) { |
|
326 | + public static function display_template($template_path = FALSE, $template_args = array(), $return_string = FALSE) { |
|
327 | 327 | |
328 | 328 | /** |
329 | 329 | * These two filters are intended for last minute changes to templates being loaded and/or template arg |
@@ -334,26 +334,26 @@ discard block |
||
334 | 334 | * |
335 | 335 | * @since 4.6.0 |
336 | 336 | */ |
337 | - $template_path = apply_filters( 'FHEE__EEH_Template__display_template__template_path', $template_path ); |
|
338 | - $template_args = apply_filters( 'FHEE__EEH_Template__display_template__template_args', $template_args ); |
|
337 | + $template_path = apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path); |
|
338 | + $template_args = apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args); |
|
339 | 339 | |
340 | 340 | // you gimme nuttin - YOU GET NUTTIN !! |
341 | - if ( ! $template_path || ! is_readable( $template_path )) { |
|
341 | + if ( ! $template_path || ! is_readable($template_path)) { |
|
342 | 342 | return ''; |
343 | 343 | } |
344 | 344 | // if $template_args are not in an array, then make it so |
345 | - if ( ! is_array( $template_args ) && ! is_object( $template_args )) { |
|
346 | - $template_args = array( $template_args ); |
|
345 | + if ( ! is_array($template_args) && ! is_object($template_args)) { |
|
346 | + $template_args = array($template_args); |
|
347 | 347 | } |
348 | - extract( (array) $template_args); |
|
348 | + extract((array) $template_args); |
|
349 | 349 | |
350 | - if ( $return_string ) { |
|
350 | + if ($return_string) { |
|
351 | 351 | // because we want to return a string, we are going to capture the output |
352 | 352 | ob_start(); |
353 | - include( $template_path ); |
|
353 | + include($template_path); |
|
354 | 354 | return ob_get_clean(); |
355 | 355 | } else { |
356 | - include( $template_path ); |
|
356 | + include($template_path); |
|
357 | 357 | } |
358 | 358 | return ''; |
359 | 359 | } |
@@ -371,27 +371,27 @@ discard block |
||
371 | 371 | * @param string $suffix added to the end of the generated class |
372 | 372 | * @return string |
373 | 373 | */ |
374 | - public static function get_object_css_class( $object = NULL, $prefix = '', $suffix = '' ) { |
|
374 | + public static function get_object_css_class($object = NULL, $prefix = '', $suffix = '') { |
|
375 | 375 | // in the beginning... |
376 | - $prefix = ! empty( $prefix ) ? rtrim( $prefix, '-' ) . '-' : ''; |
|
376 | + $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : ''; |
|
377 | 377 | // da muddle |
378 | 378 | $class = ''; |
379 | 379 | // the end |
380 | - $suffix = ! empty( $suffix ) ? '-' . ltrim( $suffix, '-' ) : ''; |
|
380 | + $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : ''; |
|
381 | 381 | // is the passed object an EE object ? |
382 | - if ( $object instanceof EE_Base_Class ) { |
|
382 | + if ($object instanceof EE_Base_Class) { |
|
383 | 383 | // grab the exact type of object |
384 | - $obj_class = get_class( $object ); |
|
384 | + $obj_class = get_class($object); |
|
385 | 385 | // depending on the type of object... |
386 | - switch ( $obj_class ) { |
|
386 | + switch ($obj_class) { |
|
387 | 387 | // no specifics just yet... |
388 | 388 | default : |
389 | - $class = strtolower( str_replace( '_', '-', $obj_class )); |
|
390 | - $class .= method_exists( $obj_class, 'name' ) ? '-' . sanitize_title( $object->name() ) : ''; |
|
389 | + $class = strtolower(str_replace('_', '-', $obj_class)); |
|
390 | + $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : ''; |
|
391 | 391 | |
392 | 392 | } |
393 | 393 | } |
394 | - return $prefix . $class . $suffix; |
|
394 | + return $prefix.$class.$suffix; |
|
395 | 395 | } |
396 | 396 | |
397 | 397 | |
@@ -407,54 +407,54 @@ discard block |
||
407 | 407 | * @param string $cur_code_span_class |
408 | 408 | * @return string the html output for the formatted money value |
409 | 409 | */ |
410 | - public static function format_currency( $amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code' ) { |
|
410 | + public static function format_currency($amount = NULL, $return_raw = FALSE, $display_code = TRUE, $CNT_ISO = '', $cur_code_span_class = 'currency-code') { |
|
411 | 411 | // ensure amount was received |
412 | - if ( is_null( $amount ) ) { |
|
413 | - $msg = __( 'In order to format currency, an amount needs to be passed.', 'event_espresso' ); |
|
414 | - EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ ); |
|
412 | + if (is_null($amount)) { |
|
413 | + $msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso'); |
|
414 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
415 | 415 | return ''; |
416 | 416 | } |
417 | 417 | //ensure amount is float |
418 | - $amount = apply_filters( 'FHEE__EEH_Template__format_currency__raw_amount', (float) $amount ); |
|
419 | - $CNT_ISO = apply_filters( 'FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount ); |
|
418 | + $amount = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount); |
|
419 | + $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount); |
|
420 | 420 | // filter raw amount (allows 0.00 to be changed to "free" for example) |
421 | - $amount_formatted = apply_filters( 'FHEE__EEH_Template__format_currency__amount', $amount, $return_raw ); |
|
421 | + $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw); |
|
422 | 422 | // still a number or was amount converted to a string like "free" ? |
423 | - if ( is_float( $amount_formatted )) { |
|
423 | + if (is_float($amount_formatted)) { |
|
424 | 424 | // was a country ISO code passed ? if so generate currency config object for that country |
425 | - $mny = $CNT_ISO !== '' ? new EE_Currency_Config( $CNT_ISO ) : NULL; |
|
425 | + $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : NULL; |
|
426 | 426 | // verify results |
427 | - if ( ! $mny instanceof EE_Currency_Config ) { |
|
427 | + if ( ! $mny instanceof EE_Currency_Config) { |
|
428 | 428 | // set default config country currency settings |
429 | 429 | $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config ? EE_Registry::instance()->CFG->currency : new EE_Currency_Config(); |
430 | 430 | } |
431 | 431 | // format float |
432 | - $amount_formatted = number_format( $amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds ); |
|
432 | + $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds); |
|
433 | 433 | // add formatting ? |
434 | - if ( ! $return_raw ) { |
|
434 | + if ( ! $return_raw) { |
|
435 | 435 | // add currency sign |
436 | - if( $mny->sign_b4 ){ |
|
437 | - if( $amount >= 0 ){ |
|
438 | - $amount_formatted = $mny->sign . $amount_formatted; |
|
439 | - }else{ |
|
440 | - $amount_formatted = '-' . $mny->sign . str_replace( '-', '', $amount_formatted ); |
|
436 | + if ($mny->sign_b4) { |
|
437 | + if ($amount >= 0) { |
|
438 | + $amount_formatted = $mny->sign.$amount_formatted; |
|
439 | + } else { |
|
440 | + $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted); |
|
441 | 441 | } |
442 | 442 | |
443 | - }else{ |
|
444 | - $amount_formatted = $amount_formatted . $mny->sign; |
|
443 | + } else { |
|
444 | + $amount_formatted = $amount_formatted.$mny->sign; |
|
445 | 445 | } |
446 | 446 | |
447 | 447 | // filter to allow global setting of display_code |
448 | - $display_code = apply_filters( 'FHEE__EEH_Template__format_currency__display_code', $display_code ); |
|
448 | + $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code); |
|
449 | 449 | |
450 | 450 | // add currency code ? |
451 | - $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted; |
|
451 | + $amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted; |
|
452 | 452 | } |
453 | 453 | // filter results |
454 | - $amount_formatted = apply_filters( 'FHEE__EEH_Template__format_currency__amount_formatted', $amount_formatted, $mny, $return_raw ); |
|
454 | + $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted', $amount_formatted, $mny, $return_raw); |
|
455 | 455 | } |
456 | 456 | // clean up vars |
457 | - unset( $mny ); |
|
457 | + unset($mny); |
|
458 | 458 | // return formatted currency amount |
459 | 459 | return $amount_formatted; |
460 | 460 | } |
@@ -469,11 +469,11 @@ discard block |
||
469 | 469 | * @param string $schema 'UPPER', 'lower', or 'Sentence' |
470 | 470 | * @return string The localized label for the status id. |
471 | 471 | */ |
472 | - public static function pretty_status( $status_id, $plural = FALSE, $schema = 'upper' ) { |
|
472 | + public static function pretty_status($status_id, $plural = FALSE, $schema = 'upper') { |
|
473 | 473 | /** @type EEM_Status $EEM_Status */ |
474 | - $EEM_Status = EE_Registry::instance()->load_model( 'Status' ); |
|
475 | - $status = $EEM_Status->localized_status( array( $status_id => __( 'unknown', 'event_espresso' )), $plural, $schema ); |
|
476 | - return $status[ $status_id ]; |
|
474 | + $EEM_Status = EE_Registry::instance()->load_model('Status'); |
|
475 | + $status = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural, $schema); |
|
476 | + return $status[$status_id]; |
|
477 | 477 | } |
478 | 478 | |
479 | 479 | |
@@ -488,21 +488,21 @@ discard block |
||
488 | 488 | * @param string $title |
489 | 489 | * @return string the html output for the button |
490 | 490 | */ |
491 | - public static function get_button_or_link( $url, $label, $class = 'button-primary', $icon = '', $title = '' ) { |
|
491 | + public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '') { |
|
492 | 492 | $icon_html = ''; |
493 | - if ( ! empty( $icon ) ) { |
|
494 | - $dashicons = preg_split( "(ee-icon |dashicons )", $icon ); |
|
495 | - $dashicons = array_filter( $dashicons ); |
|
496 | - $count = count( $dashicons ); |
|
493 | + if ( ! empty($icon)) { |
|
494 | + $dashicons = preg_split("(ee-icon |dashicons )", $icon); |
|
495 | + $dashicons = array_filter($dashicons); |
|
496 | + $count = count($dashicons); |
|
497 | 497 | $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : ''; |
498 | - foreach ( $dashicons as $dashicon ) { |
|
499 | - $type = strpos( $dashicon, 'ee-icon' ) !== false ? 'ee-icon ' : 'dashicons '; |
|
500 | - $icon_html .= '<span class="' . $type . $dashicon . '"></span>'; |
|
498 | + foreach ($dashicons as $dashicon) { |
|
499 | + $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons '; |
|
500 | + $icon_html .= '<span class="'.$type.$dashicon.'"></span>'; |
|
501 | 501 | } |
502 | 502 | $icon_html .= $count > 1 ? '</span>' : ''; |
503 | 503 | } |
504 | - $label = ! empty( $icon ) ? $icon_html . $label : $label; |
|
505 | - $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . $url . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>'; |
|
504 | + $label = ! empty($icon) ? $icon_html.$label : $label; |
|
505 | + $button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.$url.'" class="'.$class.'" title="'.$title.'">'.$label.'</a>'; |
|
506 | 506 | return $button; |
507 | 507 | } |
508 | 508 | |
@@ -519,21 +519,21 @@ discard block |
||
519 | 519 | * @param bool|string $help_text (optional) send help text you want to use for the link if default not to be used |
520 | 520 | * @return string generated link |
521 | 521 | */ |
522 | - public static function get_help_tab_link( $help_tab_id, $page = FALSE, $action = FALSE, $icon_style = FALSE, $help_text = FALSE ) { |
|
522 | + public static function get_help_tab_link($help_tab_id, $page = FALSE, $action = FALSE, $icon_style = FALSE, $help_text = FALSE) { |
|
523 | 523 | |
524 | - if ( ! $page ) |
|
525 | - $page = isset( $_REQUEST['page'] ) && ! empty( $_REQUEST['page'] ) ? sanitize_key( $_REQUEST['page'] ) : $page; |
|
524 | + if ( ! $page) |
|
525 | + $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page; |
|
526 | 526 | |
527 | - if ( ! $action ) |
|
528 | - $action = isset( $_REQUEST['action'] ) && ! empty( $_REQUEST['action'] ) ? sanitize_key( $_REQUEST['action'] ) : $action; |
|
527 | + if ( ! $action) |
|
528 | + $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action; |
|
529 | 529 | |
530 | 530 | $action = empty($action) ? 'default' : $action; |
531 | 531 | |
532 | 532 | |
533 | - $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id; |
|
534 | - $icon = !$icon_style ? ' dashicons-editor-help' : $icon_style; |
|
535 | - $help_text = !$help_text ? '' : $help_text; |
|
536 | - return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.', 'event_espresso') . '" > ' . $help_text . ' </a>'; |
|
533 | + $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id; |
|
534 | + $icon = ! $icon_style ? ' dashicons-editor-help' : $icon_style; |
|
535 | + $help_text = ! $help_text ? '' : $help_text; |
|
536 | + return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__('Click to open the \'Help\' tab for more information about this feature.', 'event_espresso').'" > '.$help_text.' </a>'; |
|
537 | 537 | } |
538 | 538 | |
539 | 539 | |
@@ -545,31 +545,31 @@ discard block |
||
545 | 545 | * @param EE_Help_Tour |
546 | 546 | * @return string html |
547 | 547 | */ |
548 | - public static function help_tour_stops_generator( EE_Help_Tour $tour ) { |
|
548 | + public static function help_tour_stops_generator(EE_Help_Tour $tour) { |
|
549 | 549 | $id = $tour->get_slug(); |
550 | 550 | $stops = $tour->get_stops(); |
551 | 551 | |
552 | - $content = '<ol style="display:none" id="' . $id . '">'; |
|
552 | + $content = '<ol style="display:none" id="'.$id.'">'; |
|
553 | 553 | |
554 | - foreach ( $stops as $stop ) { |
|
555 | - $data_id = !empty( $stop['id'] ) ? ' data-id="' . $stop['id'] . '"' : ''; |
|
556 | - $data_class = empty( $data_id ) && !empty( $stop['class'] ) ? ' data-class="' . $stop['class'] . '"' : ''; |
|
554 | + foreach ($stops as $stop) { |
|
555 | + $data_id = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : ''; |
|
556 | + $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : ''; |
|
557 | 557 | |
558 | 558 | //if container is set to modal then let's make sure we set the options accordingly |
559 | - if ( empty( $data_id ) && empty( $data_class ) ) { |
|
559 | + if (empty($data_id) && empty($data_class)) { |
|
560 | 560 | $stop['options']['modal'] = true; |
561 | 561 | $stop['options']['expose'] = true; |
562 | 562 | } |
563 | 563 | |
564 | - $custom_class = !empty( $stop['custom_class'] ) ? ' class="' . $stop['custom_class'] . '"' : ''; |
|
565 | - $button_text = !empty( $stop['button_text'] ) ? ' data-button="' . $stop['button_text'] . '"' : ''; |
|
564 | + $custom_class = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : ''; |
|
565 | + $button_text = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : ''; |
|
566 | 566 | $inner_content = isset($stop['content']) ? $stop['content'] : ''; |
567 | 567 | |
568 | 568 | //options |
569 | - if ( isset( $stop['options'] ) && is_array( $stop['options'] ) ) { |
|
569 | + if (isset($stop['options']) && is_array($stop['options'])) { |
|
570 | 570 | $options = ' data-options="'; |
571 | - foreach ( $stop['options'] as $option => $value ) { |
|
572 | - $options .= $option . ':' . $value . ';'; |
|
571 | + foreach ($stop['options'] as $option => $value) { |
|
572 | + $options .= $option.':'.$value.';'; |
|
573 | 573 | } |
574 | 574 | $options .= '"'; |
575 | 575 | } else { |
@@ -577,7 +577,7 @@ discard block |
||
577 | 577 | } |
578 | 578 | |
579 | 579 | //let's put all together |
580 | - $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>'; |
|
580 | + $content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>'; |
|
581 | 581 | } |
582 | 582 | |
583 | 583 | $content .= '</ol>'; |
@@ -598,31 +598,31 @@ discard block |
||
598 | 598 | * @throws EE_Error |
599 | 599 | * @return string html structure for status. |
600 | 600 | */ |
601 | - public static function status_legend( $status_array, $active_status = '' ) { |
|
602 | - if ( !is_array( $status_array ) ) |
|
603 | - throw new EE_Error( __('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!', 'event_espresso') ); |
|
601 | + public static function status_legend($status_array, $active_status = '') { |
|
602 | + if ( ! is_array($status_array)) |
|
603 | + throw new EE_Error(__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!', 'event_espresso')); |
|
604 | 604 | |
605 | 605 | $setup_array = array(); |
606 | - foreach ( $status_array as $item => $status ) { |
|
606 | + foreach ($status_array as $item => $status) { |
|
607 | 607 | $setup_array[$item] = array( |
608 | - 'class' => 'ee-status-legend ee-status-legend-' . $status, |
|
609 | - 'desc' => EEH_Template::pretty_status( $status, FALSE, 'sentence' ), |
|
608 | + 'class' => 'ee-status-legend ee-status-legend-'.$status, |
|
609 | + 'desc' => EEH_Template::pretty_status($status, FALSE, 'sentence'), |
|
610 | 610 | 'status' => $status |
611 | 611 | ); |
612 | 612 | } |
613 | 613 | |
614 | - $content = '<div class="ee-list-table-legend-container">' . "\n"; |
|
615 | - $content .= '<h3>' . __('Status Legend', 'event_espresso') . '</h3>' . "\n"; |
|
616 | - $content .= '<dl class="ee-list-table-legend">' . "\n\t"; |
|
617 | - foreach ( $setup_array as $item => $details ) { |
|
614 | + $content = '<div class="ee-list-table-legend-container">'."\n"; |
|
615 | + $content .= '<h3>'.__('Status Legend', 'event_espresso').'</h3>'."\n"; |
|
616 | + $content .= '<dl class="ee-list-table-legend">'."\n\t"; |
|
617 | + foreach ($setup_array as $item => $details) { |
|
618 | 618 | $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : ''; |
619 | - $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t"; |
|
620 | - $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t"; |
|
621 | - $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t"; |
|
622 | - $content .= '</dt>' . "\n"; |
|
619 | + $content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t"; |
|
620 | + $content .= '<span class="'.$details['class'].'"></span>'."\n\t\t"; |
|
621 | + $content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t"; |
|
622 | + $content .= '</dt>'."\n"; |
|
623 | 623 | } |
624 | - $content .= '</dl>' . "\n"; |
|
625 | - $content .= '</div>' . "\n"; |
|
624 | + $content .= '</dl>'."\n"; |
|
625 | + $content .= '</div>'."\n"; |
|
626 | 626 | return $content; |
627 | 627 | } |
628 | 628 | |
@@ -635,8 +635,8 @@ discard block |
||
635 | 635 | * @return string |
636 | 636 | */ |
637 | 637 | public static function layout_array_as_table($data) { |
638 | - if (is_object($data) || $data instanceof __PHP_Incomplete_Class ) { |
|
639 | - $data = (array)$data; |
|
638 | + if (is_object($data) || $data instanceof __PHP_Incomplete_Class) { |
|
639 | + $data = (array) $data; |
|
640 | 640 | } |
641 | 641 | ob_start(); |
642 | 642 | if (is_array($data)) { |
@@ -649,10 +649,10 @@ discard block |
||
649 | 649 | ?> |
650 | 650 | <tr> |
651 | 651 | <td> |
652 | - <?php echo $data_key;?> |
|
652 | + <?php echo $data_key; ?> |
|
653 | 653 | </td> |
654 | 654 | <td> |
655 | - <?php echo self::layout_array_as_table($data_values);?> |
|
655 | + <?php echo self::layout_array_as_table($data_values); ?> |
|
656 | 656 | </td> |
657 | 657 | </tr> |
658 | 658 | <?php |
@@ -666,7 +666,7 @@ discard block |
||
666 | 666 | <ul> |
667 | 667 | <?php |
668 | 668 | foreach ($data as $datum) { |
669 | - echo "<li>"; echo self::layout_array_as_table($datum);echo "</li>"; |
|
669 | + echo "<li>"; echo self::layout_array_as_table($datum); echo "</li>"; |
|
670 | 670 | }?> |
671 | 671 | </ul> |
672 | 672 | <?php |
@@ -696,8 +696,8 @@ discard block |
||
696 | 696 | * |
697 | 697 | * @return string |
698 | 698 | */ |
699 | - public static function paging_html( $total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array() ) { |
|
700 | - echo self::get_paging_html( $total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name, $items_label ); |
|
699 | + public static function paging_html($total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array()) { |
|
700 | + echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name, $items_label); |
|
701 | 701 | } |
702 | 702 | |
703 | 703 | |
@@ -721,13 +721,13 @@ discard block |
||
721 | 721 | * ) |
722 | 722 | * @return string |
723 | 723 | */ |
724 | - public static function get_paging_html( $total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array() ) { |
|
724 | + public static function get_paging_html($total_items, $current, $per_page, $url, $show_num_field = TRUE, $paged_arg_name = 'paged', $items_label = array()) { |
|
725 | 725 | $page_links = array(); |
726 | 726 | $disable_first = $disable_last = ''; |
727 | 727 | $total_items = (int) $total_items; |
728 | 728 | $per_page = (int) $per_page; |
729 | 729 | $current = (int) $current; |
730 | - $paged_arg_name = empty( $paged_arg_name ) ? 'paged' : sanitize_key( $paged_arg_name ); |
|
730 | + $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name); |
|
731 | 731 | |
732 | 732 | //filter items_label |
733 | 733 | $items_label = apply_filters( |
@@ -735,68 +735,68 @@ discard block |
||
735 | 735 | $items_label |
736 | 736 | ); |
737 | 737 | |
738 | - if ( empty( $items_label ) |
|
739 | - || ! is_array( $items_label ) |
|
740 | - || ! isset( $items_label['single'] ) |
|
741 | - || ! isset( $items_label['plural'] ) ) { |
|
738 | + if (empty($items_label) |
|
739 | + || ! is_array($items_label) |
|
740 | + || ! isset($items_label['single']) |
|
741 | + || ! isset($items_label['plural'])) { |
|
742 | 742 | $items_label = array( |
743 | - 'single' => __( '1 item', 'event_espresso' ), |
|
744 | - 'plural' => __( '%s items', 'event_espresso' ) |
|
743 | + 'single' => __('1 item', 'event_espresso'), |
|
744 | + 'plural' => __('%s items', 'event_espresso') |
|
745 | 745 | ); |
746 | 746 | } else { |
747 | 747 | $items_label = array( |
748 | - 'single' => '1 ' . esc_html( $items_label['single'] ), |
|
749 | - 'plural' => '%s ' . esc_html( $items_label['plural'] ) |
|
748 | + 'single' => '1 '.esc_html($items_label['single']), |
|
749 | + 'plural' => '%s '.esc_html($items_label['plural']) |
|
750 | 750 | ); |
751 | 751 | } |
752 | 752 | |
753 | - $total_pages = ceil( $total_items / $per_page ); |
|
753 | + $total_pages = ceil($total_items / $per_page); |
|
754 | 754 | |
755 | - if ( $total_pages <= 1 ) |
|
755 | + if ($total_pages <= 1) |
|
756 | 756 | return ''; |
757 | 757 | |
758 | - $item_label = $total_items > 1 ? sprintf( $items_label['plural'], $total_items ) : $items_label['single']; |
|
758 | + $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single']; |
|
759 | 759 | |
760 | - $output = '<span class="displaying-num">' . $item_label . '</span>'; |
|
760 | + $output = '<span class="displaying-num">'.$item_label.'</span>'; |
|
761 | 761 | |
762 | - if ( $current === 1 ) { |
|
762 | + if ($current === 1) { |
|
763 | 763 | $disable_first = ' disabled'; |
764 | 764 | } |
765 | - if ( $current == $total_pages ) { |
|
765 | + if ($current == $total_pages) { |
|
766 | 766 | $disable_last = ' disabled'; |
767 | 767 | } |
768 | 768 | |
769 | - $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>", |
|
770 | - 'first-page' . $disable_first, |
|
771 | - esc_attr__( 'Go to the first page' ), |
|
772 | - esc_url( remove_query_arg( $paged_arg_name, $url ) ), |
|
769 | + $page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>", |
|
770 | + 'first-page'.$disable_first, |
|
771 | + esc_attr__('Go to the first page'), |
|
772 | + esc_url(remove_query_arg($paged_arg_name, $url)), |
|
773 | 773 | '«' |
774 | 774 | ); |
775 | 775 | |
776 | 776 | $page_links[] = sprintf( |
777 | 777 | '<a class="%s" title="%s" href="%s">%s</a>', |
778 | - 'prev-page' . $disable_first, |
|
779 | - esc_attr__( 'Go to the previous page' ), |
|
780 | - esc_url( add_query_arg( $paged_arg_name, max( 1, $current-1 ), $url ) ), |
|
778 | + 'prev-page'.$disable_first, |
|
779 | + esc_attr__('Go to the previous page'), |
|
780 | + esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)), |
|
781 | 781 | '‹' |
782 | 782 | ); |
783 | 783 | |
784 | - if ( ! $show_num_field ) { |
|
784 | + if ( ! $show_num_field) { |
|
785 | 785 | $html_current_page = $current; |
786 | 786 | } else { |
787 | - $html_current_page = sprintf( "<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />", |
|
788 | - esc_attr__( 'Current page' ), |
|
787 | + $html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />", |
|
788 | + esc_attr__('Current page'), |
|
789 | 789 | $current, |
790 | - strlen( $total_pages ) |
|
790 | + strlen($total_pages) |
|
791 | 791 | ); |
792 | 792 | } |
793 | 793 | |
794 | 794 | $html_total_pages = sprintf( |
795 | 795 | '<span class="total-pages">%s</span>', |
796 | - number_format_i18n( $total_pages ) |
|
796 | + number_format_i18n($total_pages) |
|
797 | 797 | ); |
798 | 798 | $page_links[] = sprintf( |
799 | - _x( '%3$s%1$s of %2$s%4$s', 'paging' ), |
|
799 | + _x('%3$s%1$s of %2$s%4$s', 'paging'), |
|
800 | 800 | $html_current_page, |
801 | 801 | $html_total_pages, |
802 | 802 | '<span class="paging-input">', |
@@ -805,29 +805,29 @@ discard block |
||
805 | 805 | |
806 | 806 | $page_links[] = sprintf( |
807 | 807 | '<a class="%s" title="%s" href="%s">%s</a>', |
808 | - 'next-page' . $disable_last, |
|
809 | - esc_attr__( 'Go to the next page' ), |
|
810 | - esc_url( add_query_arg( $paged_arg_name, min( $total_pages, $current+1 ), $url ) ), |
|
808 | + 'next-page'.$disable_last, |
|
809 | + esc_attr__('Go to the next page'), |
|
810 | + esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)), |
|
811 | 811 | '›' |
812 | 812 | ); |
813 | 813 | |
814 | 814 | $page_links[] = sprintf( |
815 | 815 | '<a class="%s" title="%s" href="%s">%s</a>', |
816 | - 'last-page' . $disable_last, |
|
817 | - esc_attr__( 'Go to the last page' ), |
|
818 | - esc_url( add_query_arg( $paged_arg_name, $total_pages, $url ) ), |
|
816 | + 'last-page'.$disable_last, |
|
817 | + esc_attr__('Go to the last page'), |
|
818 | + esc_url(add_query_arg($paged_arg_name, $total_pages, $url)), |
|
819 | 819 | '»' |
820 | 820 | ); |
821 | 821 | |
822 | - $output .= "\n" . '<span class="pagination-links">' . join( "\n", $page_links ) . '</span>'; |
|
822 | + $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>'; |
|
823 | 823 | // set page class |
824 | - if ( $total_pages ) { |
|
824 | + if ($total_pages) { |
|
825 | 825 | $page_class = $total_pages < 2 ? ' one-page' : ''; |
826 | 826 | } else { |
827 | 827 | $page_class = ' no-pages'; |
828 | 828 | } |
829 | 829 | |
830 | - return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>'; |
|
830 | + return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>'; |
|
831 | 831 | } |
832 | 832 | |
833 | 833 | |
@@ -837,8 +837,8 @@ discard block |
||
837 | 837 | * @param string $wrap_id |
838 | 838 | * @return string |
839 | 839 | */ |
840 | - public static function powered_by_event_espresso( $wrap_class = '', $wrap_id = '' ) { |
|
841 | - $admin = is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ); |
|
840 | + public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '') { |
|
841 | + $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX); |
|
842 | 842 | if ( |
843 | 843 | ! $admin && |
844 | 844 | ! apply_filters( |
@@ -848,17 +848,17 @@ discard block |
||
848 | 848 | ) { |
849 | 849 | return ''; |
850 | 850 | } |
851 | - $attributes = ! empty( $wrap_id ) ? " id=\"{$wrap_id}\"" : ''; |
|
851 | + $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : ''; |
|
852 | 852 | $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class; |
853 | - $attributes .= ! empty( $wrap_class ) |
|
853 | + $attributes .= ! empty($wrap_class) |
|
854 | 854 | ? " class=\"{$wrap_class} powered-by-event-espresso-credit\"" |
855 | 855 | : ' class="powered-by-event-espresso-credit"'; |
856 | 856 | $powered_by = $admin ? EVENT_ESPRESSO_POWERED_BY : 'Event Espresso'; |
857 | 857 | $url = add_query_arg( |
858 | - array( 'ap_id' => EE_Registry::instance()->CFG->admin->affiliate_id() ), |
|
858 | + array('ap_id' => EE_Registry::instance()->CFG->admin->affiliate_id()), |
|
859 | 859 | 'https://eventespresso.com/' |
860 | 860 | ); |
861 | - $url = apply_filters( 'FHEE__EEH_Template__powered_by_event_espresso__url', $url ); |
|
861 | + $url = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url); |
|
862 | 862 | return (string) apply_filters( |
863 | 863 | 'FHEE__EEH_Template__powered_by_event_espresso__html', |
864 | 864 | sprintf( |
@@ -888,7 +888,7 @@ discard block |
||
888 | 888 | //add_filter( 'FHEE__EEH_Template__format_currency__amount', 'convert_zero_to_free', 10, 2 ); |
889 | 889 | |
890 | 890 | |
891 | -if ( ! function_exists( 'espresso_pagination' ) ) { |
|
891 | +if ( ! function_exists('espresso_pagination')) { |
|
892 | 892 | /** |
893 | 893 | * espresso_pagination |
894 | 894 | * |
@@ -900,21 +900,21 @@ discard block |
||
900 | 900 | $big = 999999999; // need an unlikely integer |
901 | 901 | $pagination = paginate_links( |
902 | 902 | array( |
903 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
903 | + 'base' => str_replace($big, '%#%', esc_url(get_pagenum_link($big))), |
|
904 | 904 | 'format' => '?paged=%#%', |
905 | - 'current' => max( 1, get_query_var( 'paged' ) ), |
|
905 | + 'current' => max(1, get_query_var('paged')), |
|
906 | 906 | 'total' => $wp_query->max_num_pages, |
907 | 907 | 'show_all' => true, |
908 | 908 | 'end_size' => 10, |
909 | 909 | 'mid_size' => 6, |
910 | 910 | 'prev_next' => true, |
911 | - 'prev_text' => __( '‹ PREV', 'event_espresso' ), |
|
912 | - 'next_text' => __( 'NEXT ›', 'event_espresso' ), |
|
911 | + 'prev_text' => __('‹ PREV', 'event_espresso'), |
|
912 | + 'next_text' => __('NEXT ›', 'event_espresso'), |
|
913 | 913 | 'type' => 'plain', |
914 | 914 | 'add_args' => false, |
915 | 915 | 'add_fragment' => '' |
916 | 916 | ) |
917 | 917 | ); |
918 | - echo ! empty( $pagination ) ? '<div class="ee-pagination-dv clear">' . $pagination . '</div>' : ''; |
|
918 | + echo ! empty($pagination) ? '<div class="ee-pagination-dv clear">'.$pagination.'</div>' : ''; |
|
919 | 919 | } |
920 | 920 | } |
921 | 921 | \ No newline at end of file |
@@ -294,7 +294,7 @@ discard block |
||
294 | 294 | * |
295 | 295 | * given two paths, this determines if there is a common base path between the two |
296 | 296 | * |
297 | - * @param array $paths |
|
297 | + * @param string[] $paths |
|
298 | 298 | * @return string |
299 | 299 | */ |
300 | 300 | protected static function _find_common_base_path( $paths ) { |
@@ -321,7 +321,7 @@ discard block |
||
321 | 321 | * @param bool|string $template_path server path to the file to be loaded, including file name and extension |
322 | 322 | * @param array $template_args an array of arguments to be extracted for use in the template |
323 | 323 | * @param boolean $return_string whether to send output immediately to screen, or capture and return as a string |
324 | - * @return mixed string |
|
324 | + * @return string string |
|
325 | 325 | */ |
326 | 326 | public static function display_template( $template_path = FALSE, $template_args = array(), $return_string = FALSE ) { |
327 | 327 |
@@ -24,7 +24,7 @@ discard block |
||
24 | 24 | * to indicate it successfully migrate some data, and has nothing left to do; or EE_Data_Migration_Manager::status_fatal_error to indicate |
25 | 25 | * an error occurred which means the ajax script should probably stop executing. |
26 | 26 | */ |
27 | -class EE_Data_Migration_Manager{ |
|
27 | +class EE_Data_Migration_Manager { |
|
28 | 28 | |
29 | 29 | /** |
30 | 30 | * |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | * of this EE installation. Keys should be the name of the version the script upgraded to |
82 | 82 | * @var EE_Data_Migration_Script_Base[] |
83 | 83 | */ |
84 | - private $_data_migrations_ran =null; |
|
84 | + private $_data_migrations_ran = null; |
|
85 | 85 | /** |
86 | 86 | * The last ran script. It's nice to store this somewhere accessible, as its easiest |
87 | 87 | * to know which was the last run by which is the newest wp option; but in most of the code |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | */ |
142 | 142 | public static function instance() { |
143 | 143 | // check if class object is instantiated |
144 | - if ( ! self::$_instance instanceof EE_Data_Migration_Manager ) { |
|
144 | + if ( ! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
145 | 145 | self::$_instance = new self(); |
146 | 146 | } |
147 | 147 | return self::$_instance; |
@@ -151,7 +151,7 @@ discard block |
||
151 | 151 | * all new usages of the singleton should be made with Classname::instance()) and returns it |
152 | 152 | * @return EE_Data_Migration_Manager |
153 | 153 | */ |
154 | - public static function reset(){ |
|
154 | + public static function reset() { |
|
155 | 155 | self::$_instance = NULL; |
156 | 156 | return self::instance(); |
157 | 157 | } |
@@ -161,7 +161,7 @@ discard block |
||
161 | 161 | /** |
162 | 162 | * constructor |
163 | 163 | */ |
164 | - private function __construct(){ |
|
164 | + private function __construct() { |
|
165 | 165 | $this->stati_that_indicate_to_continue_migrations = array( |
166 | 166 | self::status_continue, |
167 | 167 | self::status_completed |
@@ -180,13 +180,13 @@ discard block |
||
180 | 180 | ); |
181 | 181 | //make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class |
182 | 182 | //to be defined, because right now it doesn't get autoloaded on its own |
183 | - EE_Registry::instance()->load_core( 'Data_Migration_Class_Base', array(), TRUE ); |
|
184 | - EE_Registry::instance()->load_core( 'Data_Migration_Script_Base', array(), TRUE ); |
|
185 | - EE_Registry::instance()->load_core( 'DMS_Unknown_1_0_0', array(), TRUE ); |
|
186 | - EE_Registry::instance()->load_core( 'Data_Migration_Script_Stage', array(), TRUE ); |
|
187 | - EE_Registry::instance()->load_core( 'Data_Migration_Script_Stage_Table', array(), TRUE ); |
|
188 | - $this->_table_manager = EE_Registry::instance()->create( 'TableManager', array(), true ); |
|
189 | - $this->_table_analysis = EE_Registry::instance()->create( 'TableAnalysis', array(), true ); |
|
183 | + EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), TRUE); |
|
184 | + EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), TRUE); |
|
185 | + EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), TRUE); |
|
186 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), TRUE); |
|
187 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), TRUE); |
|
188 | + $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true); |
|
189 | + $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
190 | 190 | } |
191 | 191 | |
192 | 192 | |
@@ -199,21 +199,21 @@ discard block |
||
199 | 199 | * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set) |
200 | 200 | * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of that plugin (eg '4.1.0') |
201 | 201 | */ |
202 | - private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name){ |
|
202 | + private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name) { |
|
203 | 203 | $plugin_slug_and_version_string = str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $option_name); |
204 | 204 | //check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style) |
205 | - $parts = explode(".",$plugin_slug_and_version_string); |
|
205 | + $parts = explode(".", $plugin_slug_and_version_string); |
|
206 | 206 | |
207 | - if(count($parts) == 4){ |
|
207 | + if (count($parts) == 4) { |
|
208 | 208 | //it's 4.2-style.eg Core.4.1.0 |
209 | - $plugin_slug = $parts[0];//eg Core |
|
209 | + $plugin_slug = $parts[0]; //eg Core |
|
210 | 210 | $version_string = $parts[1].".".$parts[2].".".$parts[3]; //eg 4.1.0 |
211 | - }else{ |
|
211 | + } else { |
|
212 | 212 | //it's 4.1-style: eg 4.1.0 |
213 | 213 | $plugin_slug = 'Core'; |
214 | - $version_string = $plugin_slug_and_version_string;//eg 4.1.0 |
|
214 | + $version_string = $plugin_slug_and_version_string; //eg 4.1.0 |
|
215 | 215 | } |
216 | - return array($plugin_slug,$version_string); |
|
216 | + return array($plugin_slug, $version_string); |
|
217 | 217 | } |
218 | 218 | |
219 | 219 | /** |
@@ -224,21 +224,21 @@ discard block |
||
224 | 224 | * @return EE_Data_Migration_Script_Base |
225 | 225 | * @throws EE_Error |
226 | 226 | */ |
227 | - private function _get_dms_class_from_wp_option($dms_option_name,$dms_option_value){ |
|
227 | + private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value) { |
|
228 | 228 | $data_migration_data = maybe_unserialize($dms_option_value); |
229 | - if(isset($data_migration_data['class']) && class_exists($data_migration_data['class'])){ |
|
229 | + if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) { |
|
230 | 230 | $class = new $data_migration_data['class']; |
231 | - if($class instanceof EE_Data_Migration_Script_Base){ |
|
231 | + if ($class instanceof EE_Data_Migration_Script_Base) { |
|
232 | 232 | $class->instantiate_from_array_of_properties($data_migration_data); |
233 | 233 | return $class; |
234 | - }else{ |
|
234 | + } else { |
|
235 | 235 | //huh, so its an object but not a data migration script?? that shouldn't happen |
236 | 236 | //just leave it as an array (which will probably just get ignored) |
237 | - throw new EE_Error(sprintf(__("Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", 'event_espresso'),$data_migration_data['class'])); |
|
237 | + throw new EE_Error(sprintf(__("Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", 'event_espresso'), $data_migration_data['class'])); |
|
238 | 238 | } |
239 | - }else{ |
|
239 | + } else { |
|
240 | 240 | //so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
241 | - throw new EE_Error(sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'),$dms_option_name)); |
|
241 | + throw new EE_Error(sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name)); |
|
242 | 242 | } |
243 | 243 | } |
244 | 244 | /** |
@@ -246,34 +246,34 @@ discard block |
||
246 | 246 | * the last ran which hasn't finished yet |
247 | 247 | * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy arrays in there - which should probably be ignored) |
248 | 248 | */ |
249 | - public function get_data_migrations_ran(){ |
|
250 | - if( ! $this->_data_migrations_ran ){ |
|
249 | + public function get_data_migrations_ran() { |
|
250 | + if ( ! $this->_data_migrations_ran) { |
|
251 | 251 | //setup autoloaders for each of the scripts in there |
252 | 252 | $this->get_all_data_migration_scripts_available(); |
253 | - $data_migrations_options = $this->get_all_migration_script_options();//get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
253 | + $data_migrations_options = $this->get_all_migration_script_options(); //get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
254 | 254 | |
255 | 255 | $data_migrations_ran = array(); |
256 | 256 | //convert into data migration script classes where possible |
257 | - foreach($data_migrations_options as $data_migration_option){ |
|
258 | - list($plugin_slug,$version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name($data_migration_option['option_name']); |
|
257 | + foreach ($data_migrations_options as $data_migration_option) { |
|
258 | + list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name($data_migration_option['option_name']); |
|
259 | 259 | |
260 | - try{ |
|
261 | - $class = $this->_get_dms_class_from_wp_option($data_migration_option['option_name'],$data_migration_option['option_value']); |
|
260 | + try { |
|
261 | + $class = $this->_get_dms_class_from_wp_option($data_migration_option['option_name'], $data_migration_option['option_value']); |
|
262 | 262 | $data_migrations_ran[$plugin_slug][$version_string] = $class; |
263 | 263 | //ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
264 | 264 | $this->_last_ran_script = $class; |
265 | - if( ! $class->is_completed()){ |
|
265 | + if ( ! $class->is_completed()) { |
|
266 | 266 | //sometimes we also like to know which was the last incomplete script (or if there are any at all) |
267 | 267 | $this->_last_ran_incomplete_script = $class; |
268 | 268 | } |
269 | - }catch(EE_Error $e){ |
|
269 | + } catch (EE_Error $e) { |
|
270 | 270 | //ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
271 | 271 | $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize($data_migration_option['option_value']); |
272 | 272 | } |
273 | 273 | } |
274 | 274 | //so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
275 | 275 | $this->_data_migrations_ran = $data_migrations_ran; |
276 | - if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran) ){ |
|
276 | + if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
277 | 277 | $this->_data_migrations_ran = array(); |
278 | 278 | } |
279 | 279 | } |
@@ -290,7 +290,7 @@ discard block |
||
290 | 290 | * @param $new_table |
291 | 291 | * @return mixed string or int |
292 | 292 | */ |
293 | - public function get_mapping_new_pk( $script_name, $old_table, $old_pk, $new_table){ |
|
293 | + public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table) { |
|
294 | 294 | $script = EE_Registry::instance()->load_dms($script_name); |
295 | 295 | $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table); |
296 | 296 | return $mapping; |
@@ -301,9 +301,9 @@ discard block |
||
301 | 301 | * option returned in this array is the most-recently ran DMS option |
302 | 302 | * @return array |
303 | 303 | */ |
304 | - public function get_all_migration_script_options(){ |
|
304 | + public function get_all_migration_script_options() { |
|
305 | 305 | global $wpdb; |
306 | - return $wpdb->get_results("SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC",ARRAY_A); |
|
306 | + return $wpdb->get_results("SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC", ARRAY_A); |
|
307 | 307 | } |
308 | 308 | |
309 | 309 | /** |
@@ -311,8 +311,8 @@ discard block |
||
311 | 311 | * @return array where each value is the full folder path of a folder containing data migration scripts, WITH slashes at the end of the |
312 | 312 | * folder name. |
313 | 313 | */ |
314 | - public function get_data_migration_script_folders(){ |
|
315 | - return apply_filters( 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',array(EE_CORE.'data_migration_scripts') ); |
|
314 | + public function get_data_migration_script_folders() { |
|
315 | + return apply_filters('FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', array(EE_CORE.'data_migration_scripts')); |
|
316 | 316 | } |
317 | 317 | |
318 | 318 | /** |
@@ -324,11 +324,11 @@ discard block |
||
324 | 324 | * } |
325 | 325 | * @throws EE_Error |
326 | 326 | */ |
327 | - public function script_migrates_to_version($migration_script_name){ |
|
327 | + public function script_migrates_to_version($migration_script_name) { |
|
328 | 328 | $dms_info = $this->parse_dms_classname($migration_script_name); |
329 | 329 | return array( |
330 | - 'slug'=> $dms_info[ 'slug' ], |
|
331 | - 'version'=> $dms_info[ 'major_version' ] . "." . $dms_info[ 'minor_version' ] . "." . $dms_info[ 'micro_version' ] ); |
|
330 | + 'slug'=> $dms_info['slug'], |
|
331 | + 'version'=> $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'] ); |
|
332 | 332 | } |
333 | 333 | |
334 | 334 | /** |
@@ -337,13 +337,13 @@ discard block |
||
337 | 337 | * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints) |
338 | 338 | * @throws EE_Error |
339 | 339 | */ |
340 | - public function parse_dms_classname($classname){ |
|
340 | + public function parse_dms_classname($classname) { |
|
341 | 341 | $matches = array(); |
342 | - preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~',$classname,$matches); |
|
343 | - if( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))){ |
|
344 | - throw new EE_Error(sprintf(__("%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", "event_espresso"),$classname)); |
|
342 | + preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
|
343 | + if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
344 | + throw new EE_Error(sprintf(__("%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", "event_espresso"), $classname)); |
|
345 | 345 | } |
346 | - return array('slug'=>$matches[1],'major_version'=>intval($matches[2]),'minor_version'=>intval($matches[3]),'micro_version'=>intval($matches[4])); |
|
346 | + return array('slug'=>$matches[1], 'major_version'=>intval($matches[2]), 'minor_version'=>intval($matches[3]), 'micro_version'=>intval($matches[4])); |
|
347 | 347 | } |
348 | 348 | /** |
349 | 349 | * Ensures that the option indicating the current DB version is set. This should only be |
@@ -352,33 +352,33 @@ discard block |
||
352 | 352 | * to 4.1.x. |
353 | 353 | * @return string of current db state |
354 | 354 | */ |
355 | - public function ensure_current_database_state_is_set(){ |
|
356 | - $espresso_db_core_updates = get_option( 'espresso_db_update', array() ); |
|
355 | + public function ensure_current_database_state_is_set() { |
|
356 | + $espresso_db_core_updates = get_option('espresso_db_update', array()); |
|
357 | 357 | $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
358 | - if( ! $db_state ){ |
|
358 | + if ( ! $db_state) { |
|
359 | 359 | //mark the DB as being in the state as the last version in there. |
360 | 360 | //this is done to trigger maintenance mode and do data migration scripts |
361 | 361 | //if the admin installed this version of EE over 3.1.x or 4.0.x |
362 | 362 | //otherwise, the normal maintenance mode code is fine |
363 | 363 | $previous_versions_installed = array_keys($espresso_db_core_updates); |
364 | 364 | $previous_version_installed = end($previous_versions_installed); |
365 | - if(version_compare('4.1.0', $previous_version_installed)){ |
|
365 | + if (version_compare('4.1.0', $previous_version_installed)) { |
|
366 | 366 | //last installed version was less than 4.1 |
367 | 367 | //so we want the data migrations to happen. SO, we're going to say the DB is at that state |
368 | 368 | // echo "4.1.0 is greater than $previous_version_installed! update the option"; |
369 | 369 | $db_state = array('Core'=>$previous_version_installed); |
370 | - }else{ |
|
370 | + } else { |
|
371 | 371 | // echo "4.1.0 is SMALLER than $previous_version_installed"; |
372 | 372 | $db_state = array('Core'=>EVENT_ESPRESSO_VERSION); |
373 | 373 | } |
374 | - update_option(EE_Data_Migration_Manager::current_database_state,$db_state); |
|
374 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
375 | 375 | } |
376 | 376 | //in 4.1, $db_state would have only been a simple string like '4.1.0', |
377 | 377 | //but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
378 | 378 | //db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
379 | - if( ! is_array($db_state)){ |
|
379 | + if ( ! is_array($db_state)) { |
|
380 | 380 | $db_state = array('Core'=>$db_state); |
381 | - update_option(EE_Data_Migration_Manager::current_database_state,$db_state); |
|
381 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
382 | 382 | } |
383 | 383 | return $db_state; |
384 | 384 | } |
@@ -389,7 +389,7 @@ discard block |
||
389 | 389 | * or they don't apply), returns an empty array |
390 | 390 | * @return EE_Data_Migration_Script_Base[] |
391 | 391 | */ |
392 | - public function check_for_applicable_data_migration_scripts(){ |
|
392 | + public function check_for_applicable_data_migration_scripts() { |
|
393 | 393 | //get the option describing what options have already run |
394 | 394 | $scripts_ran = $this->get_data_migrations_ran(); |
395 | 395 | //$scripts_ran = array('4.1.0.core'=>array('monkey'=>null)); |
@@ -402,62 +402,62 @@ discard block |
||
402 | 402 | $iteration = 0; |
403 | 403 | $next_database_state_to_consider = $current_database_state; |
404 | 404 | $theoretical_database_state = NULL; |
405 | - do{ |
|
405 | + do { |
|
406 | 406 | //the next state after the currently-considered one will start off looking the same as the current, but we may make additions... |
407 | 407 | $theoretical_database_state = $next_database_state_to_consider; |
408 | 408 | //the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?) |
409 | - foreach($script_class_and_filepaths_available as $classname => $filepath){ |
|
409 | + foreach ($script_class_and_filepaths_available as $classname => $filepath) { |
|
410 | 410 | |
411 | 411 | $migrates_to_version = $this->script_migrates_to_version($classname); |
412 | - $script_converts_plugin_slug = $migrates_to_version[ 'slug' ]; |
|
413 | - $script_converts_to_version = $migrates_to_version[ 'version' ]; |
|
412 | + $script_converts_plugin_slug = $migrates_to_version['slug']; |
|
413 | + $script_converts_to_version = $migrates_to_version['version']; |
|
414 | 414 | //check if this version script is DONE or not; or if it's never been ran |
415 | - if( ! $scripts_ran || |
|
415 | + if ( ! $scripts_ran || |
|
416 | 416 | ! isset($scripts_ran[$script_converts_plugin_slug]) || |
417 | - ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])){ |
|
417 | + ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])) { |
|
418 | 418 | //we haven't ran this conversion script before |
419 | 419 | //now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
420 | - $script = new $classname( $this->_get_table_manager(), $this->_get_table_analysis() ); |
|
420 | + $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
|
421 | 421 | /* @var $script EE_Data_Migration_Script_Base */ |
422 | 422 | $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
423 | - if($can_migrate){ |
|
423 | + if ($can_migrate) { |
|
424 | 424 | $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
425 | 425 | $migrates_to_version = $script->migrates_to_version(); |
426 | - $next_database_state_to_consider[ $migrates_to_version[ 'slug' ] ] = $migrates_to_version[ 'version' ]; |
|
426 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
427 | 427 | unset($script_class_and_filepaths_available[$classname]); |
428 | 428 | } |
429 | - } elseif($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base){ |
|
429 | + } elseif ($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base) { |
|
430 | 430 | //this script has been ran, or at least started |
431 | 431 | $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version]; |
432 | - if( $script->get_status() != self::status_completed){ |
|
432 | + if ($script->get_status() != self::status_completed) { |
|
433 | 433 | //this script is already underway... keep going with it |
434 | 434 | $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
435 | 435 | $migrates_to_version = $script->migrates_to_version(); |
436 | - $next_database_state_to_consider[ $migrates_to_version[ 'slug' ] ] = $migrates_to_version[ 'version' ]; |
|
436 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
437 | 437 | unset($script_class_and_filepaths_available[$classname]); |
438 | - }else{ |
|
438 | + } else { |
|
439 | 439 | //it must have a status that indicates it has finished, so we don't want to try and run it again |
440 | 440 | } |
441 | - }else{ |
|
441 | + } else { |
|
442 | 442 | //it exists but it's not a proper data migration script |
443 | 443 | //maybe the script got renamed? or was simply removed from EE? |
444 | 444 | //either way, its certainly not runnable! |
445 | 445 | } |
446 | 446 | } |
447 | 447 | $iteration++; |
448 | - }while( $next_database_state_to_consider != $theoretical_database_state && $iteration<6); |
|
448 | + }while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
449 | 449 | //ok we have all the scripts that should run, now let's make them into flat array |
450 | 450 | $scripts_that_should_run = array(); |
451 | - foreach($script_classes_that_should_run_per_iteration as $scripts_at_priority){ |
|
451 | + foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
|
452 | 452 | ksort($scripts_at_priority); |
453 | - foreach($scripts_at_priority as $scripts){ |
|
454 | - foreach($scripts as $script){ |
|
453 | + foreach ($scripts_at_priority as $scripts) { |
|
454 | + foreach ($scripts as $script) { |
|
455 | 455 | $scripts_that_should_run[get_class($script)] = $script; |
456 | 456 | } |
457 | 457 | } |
458 | 458 | } |
459 | 459 | |
460 | - do_action( 'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', $scripts_that_should_run ); |
|
460 | + do_action('AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', $scripts_that_should_run); |
|
461 | 461 | return $scripts_that_should_run; |
462 | 462 | } |
463 | 463 | |
@@ -471,14 +471,14 @@ discard block |
||
471 | 471 | * @param bool $include_completed_scripts |
472 | 472 | * @return EE_Data_Migration_Script_Base |
473 | 473 | */ |
474 | - public function get_last_ran_script($include_completed_scripts = false){ |
|
474 | + public function get_last_ran_script($include_completed_scripts = false) { |
|
475 | 475 | //make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
476 | - if( ! $this->_data_migrations_ran){ |
|
476 | + if ( ! $this->_data_migrations_ran) { |
|
477 | 477 | $this->get_data_migrations_ran(); |
478 | 478 | } |
479 | - if($include_completed_scripts){ |
|
479 | + if ($include_completed_scripts) { |
|
480 | 480 | return $this->_last_ran_script; |
481 | - }else{ |
|
481 | + } else { |
|
482 | 482 | return $this->_last_ran_incomplete_script; |
483 | 483 | } |
484 | 484 | } |
@@ -501,19 +501,19 @@ discard block |
||
501 | 501 | * @type string $message string describing what was done during this step |
502 | 502 | * } |
503 | 503 | */ |
504 | - public function migration_step( $step_size = 0 ){ |
|
504 | + public function migration_step($step_size = 0) { |
|
505 | 505 | |
506 | 506 | //bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535 |
507 | - if ( class_exists( 'EE_CPT_Strategy' ) ) { |
|
508 | - remove_action( 'pre_get_posts', array( EE_CPT_Strategy::instance(), 'pre_get_posts' ), 5 ); |
|
507 | + if (class_exists('EE_CPT_Strategy')) { |
|
508 | + remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5); |
|
509 | 509 | } |
510 | 510 | |
511 | - try{ |
|
511 | + try { |
|
512 | 512 | $currently_executing_script = $this->get_last_ran_script(); |
513 | - if( ! $currently_executing_script){ |
|
513 | + if ( ! $currently_executing_script) { |
|
514 | 514 | //Find the next script that needs to execute |
515 | 515 | $scripts = $this->check_for_applicable_data_migration_scripts(); |
516 | - if( ! $scripts ){ |
|
516 | + if ( ! $scripts) { |
|
517 | 517 | //huh, no more scripts to run... apparently we're done! |
518 | 518 | //but dont forget to make sure initial data is there |
519 | 519 | //we should be good to allow them to exit maintenance mode now |
@@ -534,18 +534,18 @@ discard block |
||
534 | 534 | //and add to the array/wp option showing the scripts ran |
535 | 535 | // $this->_data_migrations_ran[$this->script_migrates_to_version(get_class($currently_executing_script))] = $currently_executing_script; |
536 | 536 | $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
537 | - $plugin_slug = $migrates_to[ 'slug' ]; |
|
538 | - $version = $migrates_to[ 'version' ]; |
|
537 | + $plugin_slug = $migrates_to['slug']; |
|
538 | + $version = $migrates_to['version']; |
|
539 | 539 | $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script; |
540 | 540 | } |
541 | 541 | $current_script_name = get_class($currently_executing_script); |
542 | - }catch(Exception $e){ |
|
542 | + } catch (Exception $e) { |
|
543 | 543 | //an exception occurred while trying to get migration scripts |
544 | 544 | |
545 | - $message = sprintf( __("Error Message: %sStack Trace:%s", "event_espresso"), $e->getMessage() . '<br>', $e->getTraceAsString() ); |
|
545 | + $message = sprintf(__("Error Message: %sStack Trace:%s", "event_espresso"), $e->getMessage().'<br>', $e->getTraceAsString()); |
|
546 | 546 | //record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
547 | 547 | //but that's ok-- it's just an FYI to support that we couldn't even run any data migrations |
548 | - $this->add_error_to_migrations_ran(sprintf(__("Could not run data migrations because: %s", "event_espresso"),$message)); |
|
548 | + $this->add_error_to_migrations_ran(sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message)); |
|
549 | 549 | return array( |
550 | 550 | 'records_to_migrate'=>1, |
551 | 551 | 'records_migrated'=>0, |
@@ -555,16 +555,16 @@ discard block |
||
555 | 555 | ); |
556 | 556 | } |
557 | 557 | //ok so we definitely have a data migration script |
558 | - try{ |
|
558 | + try { |
|
559 | 559 | //how big of a bite do we want to take? Allow users to easily override via their wp-config |
560 | - if( ! absint( $step_size ) > 0 ){ |
|
561 | - $step_size = defined( 'EE_MIGRATION_STEP_SIZE' ) && absint( EE_MIGRATION_STEP_SIZE ) ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
560 | + if ( ! absint($step_size) > 0) { |
|
561 | + $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
562 | 562 | } |
563 | 563 | //do what we came to do! |
564 | 564 | $currently_executing_script->migration_step($step_size); |
565 | 565 | //can we wrap it up and verify default data? |
566 | 566 | $init_dbs = false; |
567 | - switch($currently_executing_script->get_status()){ |
|
567 | + switch ($currently_executing_script->get_status()) { |
|
568 | 568 | case EE_Data_Migration_Manager::status_continue: |
569 | 569 | $response_array = array( |
570 | 570 | 'records_to_migrate'=>$currently_executing_script->count_records_to_migrate(), |
@@ -576,16 +576,16 @@ discard block |
||
576 | 576 | case EE_Data_Migration_Manager::status_completed: |
577 | 577 | //ok so THAT script has completed |
578 | 578 | $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name)); |
579 | - $response_array = array( |
|
579 | + $response_array = array( |
|
580 | 580 | 'records_to_migrate'=>$currently_executing_script->count_records_to_migrate(), |
581 | 581 | 'records_migrated'=>$currently_executing_script->count_records_migrated(), |
582 | 582 | 'status'=> EE_Data_Migration_Manager::status_completed, |
583 | 583 | 'message'=>$currently_executing_script->get_feedback_message(), |
584 | - 'script'=> sprintf(__("%s Completed",'event_espresso'),$currently_executing_script->pretty_name()) |
|
584 | + 'script'=> sprintf(__("%s Completed", 'event_espresso'), $currently_executing_script->pretty_name()) |
|
585 | 585 | ); |
586 | 586 | //check if there are any more after this one. |
587 | 587 | $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
588 | - if( ! $scripts_remaining ){ |
|
588 | + if ( ! $scripts_remaining) { |
|
589 | 589 | //we should be good to allow them to exit maintenance mode now |
590 | 590 | EE_Maintenance_Mode::instance()->set_maintenance_level(intval(EE_Maintenance_Mode::level_0_not_in_maintenance)); |
591 | 591 | ////huh, no more scripts to run... apparently we're done! |
@@ -599,39 +599,39 @@ discard block |
||
599 | 599 | 'records_to_migrate'=>$currently_executing_script->count_records_to_migrate(), |
600 | 600 | 'records_migrated'=>$currently_executing_script->count_records_migrated(), |
601 | 601 | 'status'=> $currently_executing_script->get_status(), |
602 | - 'message'=> sprintf(__("Minor errors occurred during %s: %s", "event_espresso"), $currently_executing_script->pretty_name(), implode(", ",$currently_executing_script->get_errors())), |
|
602 | + 'message'=> sprintf(__("Minor errors occurred during %s: %s", "event_espresso"), $currently_executing_script->pretty_name(), implode(", ", $currently_executing_script->get_errors())), |
|
603 | 603 | 'script'=>$currently_executing_script->pretty_name() |
604 | 604 | ); |
605 | 605 | break; |
606 | 606 | } |
607 | - }catch(Exception $e){ |
|
607 | + } catch (Exception $e) { |
|
608 | 608 | //ok so some exception was thrown which killed the data migration script |
609 | 609 | //double-check we have a real script |
610 | - if($currently_executing_script instanceof EE_Data_Migration_Script_Base){ |
|
610 | + if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) { |
|
611 | 611 | $script_name = $currently_executing_script->pretty_name(); |
612 | 612 | $currently_executing_script->set_broken(); |
613 | 613 | $currently_executing_script->add_error($e->getMessage()); |
614 | - }else{ |
|
614 | + } else { |
|
615 | 615 | $script_name = __("Error getting Migration Script", "event_espresso"); |
616 | 616 | } |
617 | 617 | $response_array = array( |
618 | 618 | 'records_to_migrate'=>1, |
619 | 619 | 'records_migrated'=>0, |
620 | 620 | 'status'=>self::status_fatal_error, |
621 | - 'message'=> sprintf(__("A fatal error occurred during the migration: %s", "event_espresso"),$e->getMessage()), |
|
621 | + 'message'=> sprintf(__("A fatal error occurred during the migration: %s", "event_espresso"), $e->getMessage()), |
|
622 | 622 | 'script'=>$script_name |
623 | 623 | ); |
624 | 624 | } |
625 | 625 | $successful_save = $this->_save_migrations_ran(); |
626 | - if($successful_save !== TRUE){ |
|
626 | + if ($successful_save !== TRUE) { |
|
627 | 627 | //ok so the current wp option didn't save. that's tricky, because we'd like to update it |
628 | 628 | //and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION! |
629 | 629 | //however, if we throw an exception, and return that, then the next request |
630 | 630 | //won't have as much info in it, and it may be able to save |
631 | - throw new EE_Error(sprintf(__("The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", "event_espresso"),$successful_save)); |
|
631 | + throw new EE_Error(sprintf(__("The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", "event_espresso"), $successful_save)); |
|
632 | 632 | } |
633 | 633 | //if we're all done, initialize EE plugins' default data etc. |
634 | - if( $init_dbs ) { |
|
634 | + if ($init_dbs) { |
|
635 | 635 | $this->initialize_db_for_enqueued_ee_plugins(); |
636 | 636 | } |
637 | 637 | return $response_array; |
@@ -649,23 +649,23 @@ discard block |
||
649 | 649 | * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into errors, notifications, and successes |
650 | 650 | * 'script'=>a pretty name of the script currently running |
651 | 651 | */ |
652 | - public function response_to_migration_ajax_request(){ |
|
652 | + public function response_to_migration_ajax_request() { |
|
653 | 653 | // //start output buffer just to make sure we don't mess up the json |
654 | 654 | ob_start(); |
655 | - try{ |
|
655 | + try { |
|
656 | 656 | $response = $this->migration_step(); |
657 | - }catch(Exception $e){ |
|
657 | + } catch (Exception $e) { |
|
658 | 658 | $response = array( |
659 | 659 | 'records_to_migrate'=>0, |
660 | 660 | 'records_migrated'=>0, |
661 | 661 | 'status'=> EE_Data_Migration_Manager::status_fatal_error, |
662 | - 'message'=> sprintf(__("Unknown fatal error occurred: %s", "event_espresso"),$e->getMessage()), |
|
662 | + 'message'=> sprintf(__("Unknown fatal error occurred: %s", "event_espresso"), $e->getMessage()), |
|
663 | 663 | 'script'=>'Unknown'); |
664 | 664 | $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString()); |
665 | 665 | } |
666 | 666 | $warnings_etc = @ob_get_contents(); |
667 | 667 | ob_end_clean(); |
668 | - $response['message'] .=$warnings_etc; |
|
668 | + $response['message'] .= $warnings_etc; |
|
669 | 669 | return $response; |
670 | 670 | } |
671 | 671 | |
@@ -678,14 +678,14 @@ discard block |
||
678 | 678 | * } |
679 | 679 | * @return void |
680 | 680 | */ |
681 | - public function update_current_database_state_to($slug_and_version = null){ |
|
682 | - if( ! $slug_and_version ){ |
|
681 | + public function update_current_database_state_to($slug_and_version = null) { |
|
682 | + if ( ! $slug_and_version) { |
|
683 | 683 | //no version was provided, assume it should be at the current code version |
684 | 684 | $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
685 | 685 | } |
686 | 686 | $current_database_state = get_option(self::current_database_state); |
687 | - $current_database_state[ $slug_and_version[ 'slug' ] ]=$slug_and_version[ 'version' ]; |
|
688 | - update_option(self::current_database_state,$current_database_state); |
|
687 | + $current_database_state[$slug_and_version['slug']] = $slug_and_version['version']; |
|
688 | + update_option(self::current_database_state, $current_database_state); |
|
689 | 689 | } |
690 | 690 | |
691 | 691 | /** |
@@ -696,20 +696,20 @@ discard block |
||
696 | 696 | * } |
697 | 697 | * @return boolean |
698 | 698 | */ |
699 | - public function database_needs_updating_to( $slug_and_version ) { |
|
699 | + public function database_needs_updating_to($slug_and_version) { |
|
700 | 700 | |
701 | - $slug = $slug_and_version[ 'slug' ]; |
|
702 | - $version = $slug_and_version[ 'version' ]; |
|
701 | + $slug = $slug_and_version['slug']; |
|
702 | + $version = $slug_and_version['version']; |
|
703 | 703 | $current_database_state = get_option(self::current_database_state); |
704 | - if( ! isset( $current_database_state[ $slug ] ) ) { |
|
704 | + if ( ! isset($current_database_state[$slug])) { |
|
705 | 705 | return true; |
706 | - }else{ |
|
706 | + } else { |
|
707 | 707 | //just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
708 | - $version_parts_current_db_state = array_slice( explode('.', $current_database_state[ $slug ] ), 0, 3); |
|
709 | - $version_parts_of_provided_db_state = array_slice( explode( '.', $version ), 0, 3 ); |
|
708 | + $version_parts_current_db_state = array_slice(explode('.', $current_database_state[$slug]), 0, 3); |
|
709 | + $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
|
710 | 710 | $needs_updating = false; |
711 | - foreach($version_parts_current_db_state as $offset => $version_part_in_current_db_state ) { |
|
712 | - if( $version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ] ) { |
|
711 | + foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
|
712 | + if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) { |
|
713 | 713 | $needs_updating = true; |
714 | 714 | break; |
715 | 715 | } |
@@ -723,29 +723,29 @@ discard block |
||
723 | 723 | * in addons. Has the side effect of adding them for autoloading |
724 | 724 | * @return array keys are expected classnames, values are their filepaths |
725 | 725 | */ |
726 | - public function get_all_data_migration_scripts_available(){ |
|
727 | - if( ! $this->_data_migration_class_to_filepath_map){ |
|
726 | + public function get_all_data_migration_scripts_available() { |
|
727 | + if ( ! $this->_data_migration_class_to_filepath_map) { |
|
728 | 728 | $this->_data_migration_class_to_filepath_map = array(); |
729 | - foreach($this->get_data_migration_script_folders() as $folder_path){ |
|
730 | - if($folder_path[count($folder_path-1)] != DS ){ |
|
731 | - $folder_path.= DS; |
|
729 | + foreach ($this->get_data_migration_script_folders() as $folder_path) { |
|
730 | + if ($folder_path[count($folder_path - 1)] != DS) { |
|
731 | + $folder_path .= DS; |
|
732 | 732 | } |
733 | - $files = glob( $folder_path. '*.dms.php' ); |
|
733 | + $files = glob($folder_path.'*.dms.php'); |
|
734 | 734 | |
735 | - if ( empty( $files ) ) { |
|
735 | + if (empty($files)) { |
|
736 | 736 | continue; |
737 | 737 | } |
738 | 738 | |
739 | - foreach($files as $file){ |
|
740 | - $pos_of_last_slash = strrpos($file,DS); |
|
741 | - $classname = str_replace(".dms.php","", substr($file, $pos_of_last_slash+1)); |
|
742 | - $migrates_to = $this->script_migrates_to_version( $classname ); |
|
743 | - $slug = $migrates_to[ 'slug' ]; |
|
739 | + foreach ($files as $file) { |
|
740 | + $pos_of_last_slash = strrpos($file, DS); |
|
741 | + $classname = str_replace(".dms.php", "", substr($file, $pos_of_last_slash + 1)); |
|
742 | + $migrates_to = $this->script_migrates_to_version($classname); |
|
743 | + $slug = $migrates_to['slug']; |
|
744 | 744 | //check that the slug as contained in the DMS is associated with |
745 | 745 | //the slug of an addon or core |
746 | - if( $slug != 'Core' ){ |
|
747 | - if( ! EE_Registry::instance()->get_addon_by_name( $slug ) ) { |
|
748 | - EE_Error::doing_it_wrong(__FUNCTION__, sprintf( __( 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', 'event_espresso' ),$classname,$slug,implode(",", array_keys( EE_Registry::instance()->get_addons_by_name() ) ) ), '4.3.0.alpha.019' ); |
|
746 | + if ($slug != 'Core') { |
|
747 | + if ( ! EE_Registry::instance()->get_addon_by_name($slug)) { |
|
748 | + EE_Error::doing_it_wrong(__FUNCTION__, sprintf(__('The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', 'event_espresso'), $classname, $slug, implode(",", array_keys(EE_Registry::instance()->get_addons_by_name()))), '4.3.0.alpha.019'); |
|
749 | 749 | } |
750 | 750 | } |
751 | 751 | $this->_data_migration_class_to_filepath_map[$classname] = $file; |
@@ -765,7 +765,7 @@ discard block |
||
765 | 765 | * from each addon, and check if they need updating, |
766 | 766 | * @return boolean |
767 | 767 | */ |
768 | - public function addons_need_updating(){ |
|
768 | + public function addons_need_updating() { |
|
769 | 769 | return false; |
770 | 770 | } |
771 | 771 | /** |
@@ -774,25 +774,25 @@ discard block |
||
774 | 774 | * @param string $error_message |
775 | 775 | * @throws EE_Error |
776 | 776 | */ |
777 | - public function add_error_to_migrations_ran($error_message){ |
|
777 | + public function add_error_to_migrations_ran($error_message) { |
|
778 | 778 | //get last-ran migration script |
779 | 779 | global $wpdb; |
780 | - $last_migration_script_option = $wpdb->get_row("SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1",ARRAY_A); |
|
780 | + $last_migration_script_option = $wpdb->get_row("SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1", ARRAY_A); |
|
781 | 781 | |
782 | 782 | $last_ran_migration_script_properties = isset($last_migration_script_option['option_value']) ? maybe_unserialize($last_migration_script_option['option_value']) : null; |
783 | 783 | //now, tread lightly because we're here because a FATAL non-catchable error |
784 | 784 | //was thrown last time when we were trying to run a data migration script |
785 | 785 | //so the fatal error could have happened while getting the migration script |
786 | 786 | //or doing running it... |
787 | - $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix,"",$last_migration_script_option['option_name']) : null; |
|
787 | + $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(EE_Data_Migration_Manager::data_migration_script_option_prefix, "", $last_migration_script_option['option_name']) : null; |
|
788 | 788 | |
789 | 789 | //check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet |
790 | 790 | //because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done) |
791 | - if(isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed){ |
|
791 | + if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) { |
|
792 | 792 | //ok then just add this error to its list of errors |
793 | 793 | $last_ran_migration_script_properties['_errors'][] = $error_message; |
794 | 794 | $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
795 | - }else{ |
|
795 | + } else { |
|
796 | 796 | //so we don't even know which script was last running |
797 | 797 | //use the data migration error stub, which is designed specifically for this type of thing |
798 | 798 | $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
@@ -802,39 +802,39 @@ discard block |
||
802 | 802 | $versions_migrated_to = 'Unknown.1.0.0'; |
803 | 803 | //now just to make sure appears as last (in case the were previously a fatal error like this) |
804 | 804 | //delete the old one |
805 | - delete_option( self::data_migration_script_option_prefix . $versions_migrated_to ); |
|
805 | + delete_option(self::data_migration_script_option_prefix.$versions_migrated_to); |
|
806 | 806 | } |
807 | - update_option(self::data_migration_script_option_prefix.$versions_migrated_to,$last_ran_migration_script_properties); |
|
807 | + update_option(self::data_migration_script_option_prefix.$versions_migrated_to, $last_ran_migration_script_properties); |
|
808 | 808 | |
809 | 809 | } |
810 | 810 | /** |
811 | 811 | * saves what data migrations have ran to the database |
812 | 812 | * @return mixed TRUE if successfully saved migrations ran, string if an error occurred |
813 | 813 | */ |
814 | - protected function _save_migrations_ran(){ |
|
815 | - if($this->_data_migrations_ran == null){ |
|
814 | + protected function _save_migrations_ran() { |
|
815 | + if ($this->_data_migrations_ran == null) { |
|
816 | 816 | $this->get_data_migrations_ran(); |
817 | 817 | } |
818 | 818 | //now, we don't want to save actual classes to the DB because that's messy |
819 | 819 | $successful_updates = true; |
820 | - foreach($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin){ |
|
821 | - foreach($migrations_ran_for_plugin as $version_string => $array_or_migration_obj){ |
|
820 | + foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
|
821 | + foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
|
822 | 822 | // echo "saving migration script to $version_string<br>"; |
823 | 823 | $plugin_slug_for_use_in_option_name = $plugin_slug."."; |
824 | 824 | $option_name = self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string; |
825 | 825 | $old_option_value = get_option($option_name); |
826 | - if($array_or_migration_obj instanceof EE_Data_Migration_Script_Base){ |
|
826 | + if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
|
827 | 827 | $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
828 | - if( $old_option_value != $script_array_for_saving){ |
|
829 | - $successful_updates = update_option($option_name,$script_array_for_saving); |
|
828 | + if ($old_option_value != $script_array_for_saving) { |
|
829 | + $successful_updates = update_option($option_name, $script_array_for_saving); |
|
830 | 830 | } |
831 | - }else{//we don't know what this array-thing is. So just save it as-is |
|
831 | + } else {//we don't know what this array-thing is. So just save it as-is |
|
832 | 832 | // $array_of_migrations[$version_string] = $array_or_migration_obj; |
833 | - if($old_option_value != $array_or_migration_obj){ |
|
834 | - $successful_updates = update_option($option_name,$array_or_migration_obj); |
|
833 | + if ($old_option_value != $array_or_migration_obj) { |
|
834 | + $successful_updates = update_option($option_name, $array_or_migration_obj); |
|
835 | 835 | } |
836 | 836 | } |
837 | - if( ! $successful_updates ){ |
|
837 | + if ( ! $successful_updates) { |
|
838 | 838 | global $wpdb; |
839 | 839 | return $wpdb->last_error; |
840 | 840 | } |
@@ -858,17 +858,17 @@ discard block |
||
858 | 858 | * @return EE_Data_Migration_Script_Base |
859 | 859 | * @throws EE_Error |
860 | 860 | */ |
861 | - function _instantiate_script_from_properties_array($properties_array){ |
|
862 | - if( ! isset($properties_array['class'])){ |
|
863 | - throw new EE_Error(sprintf(__("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"),implode(",",$properties_array))); |
|
861 | + function _instantiate_script_from_properties_array($properties_array) { |
|
862 | + if ( ! isset($properties_array['class'])) { |
|
863 | + throw new EE_Error(sprintf(__("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), implode(",", $properties_array))); |
|
864 | 864 | } |
865 | 865 | $class_name = $properties_array['class']; |
866 | - if( ! class_exists($class_name)){ |
|
867 | - throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"),$class_name)); |
|
866 | + if ( ! class_exists($class_name)) { |
|
867 | + throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
|
868 | 868 | } |
869 | 869 | $class = new $class_name; |
870 | - if( ! $class instanceof EE_Data_Migration_Script_Base){ |
|
871 | - throw new EE_Error(sprintf(__("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),$class_name,get_class($class))); |
|
870 | + if ( ! $class instanceof EE_Data_Migration_Script_Base) { |
|
871 | + throw new EE_Error(sprintf(__("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), $class_name, get_class($class))); |
|
872 | 872 | } |
873 | 873 | $class->instantiate_from_array_of_properties($properties_array); |
874 | 874 | return $class; |
@@ -880,25 +880,25 @@ discard block |
||
880 | 880 | * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core' |
881 | 881 | * @return string |
882 | 882 | */ |
883 | - public function get_most_up_to_date_dms($plugin_slug = 'Core'){ |
|
883 | + public function get_most_up_to_date_dms($plugin_slug = 'Core') { |
|
884 | 884 | $class_to_filepath_map = $this->get_all_data_migration_scripts_available(); |
885 | 885 | $most_up_to_date_dms_classname = NULL; |
886 | - foreach($class_to_filepath_map as $classname => $filepath){ |
|
887 | - if($most_up_to_date_dms_classname === NULL){ |
|
886 | + foreach ($class_to_filepath_map as $classname => $filepath) { |
|
887 | + if ($most_up_to_date_dms_classname === NULL) { |
|
888 | 888 | $migrates_to = $this->script_migrates_to_version($classname); |
889 | - $this_plugin_slug = $migrates_to[ 'slug' ]; |
|
889 | + $this_plugin_slug = $migrates_to['slug']; |
|
890 | 890 | // $version_string = $migrates_to[ 'version' ]; |
891 | 891 | // $details = $this->parse_dms_classname($classname); |
892 | - if($this_plugin_slug == $plugin_slug){ |
|
892 | + if ($this_plugin_slug == $plugin_slug) { |
|
893 | 893 | //if it's for core, it wins |
894 | 894 | $most_up_to_date_dms_classname = $classname; |
895 | 895 | } |
896 | 896 | //if it wasn't for core, we must keep searching for one that is! |
897 | 897 | continue; |
898 | - }else{ |
|
899 | - $champion_migrates_to= $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
898 | + } else { |
|
899 | + $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
900 | 900 | $contender_migrates_to = $this->script_migrates_to_version($classname); |
901 | - if($contender_migrates_to[ 'slug' ] == $plugin_slug && version_compare($champion_migrates_to[ 'version' ], $contender_migrates_to[ 'version' ], '<')){ |
|
901 | + if ($contender_migrates_to['slug'] == $plugin_slug && version_compare($champion_migrates_to['version'], $contender_migrates_to['version'], '<')) { |
|
902 | 902 | //so the contenders version is higher and its for Core |
903 | 903 | $most_up_to_date_dms_classname = $classname; |
904 | 904 | } |
@@ -918,11 +918,11 @@ discard block |
||
918 | 918 | * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
919 | 919 | * @return EE_Data_Migration_Script_Base |
920 | 920 | */ |
921 | - public function get_migration_ran( $version, $plugin_slug = 'Core' ) { |
|
921 | + public function get_migration_ran($version, $plugin_slug = 'Core') { |
|
922 | 922 | $migrations_ran = $this->get_data_migrations_ran(); |
923 | - if( isset( $migrations_ran[ $plugin_slug ] ) && isset( $migrations_ran[ $plugin_slug ][ $version ] ) ){ |
|
924 | - return $migrations_ran[ $plugin_slug ][ $version ]; |
|
925 | - }else{ |
|
923 | + if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) { |
|
924 | + return $migrations_ran[$plugin_slug][$version]; |
|
925 | + } else { |
|
926 | 926 | return NULL; |
927 | 927 | } |
928 | 928 | } |
@@ -934,20 +934,20 @@ discard block |
||
934 | 934 | * @return bool |
935 | 935 | * @throws \EE_Error |
936 | 936 | */ |
937 | - public function reattempt(){ |
|
937 | + public function reattempt() { |
|
938 | 938 | //find if the last-ran script was borked |
939 | 939 | //set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
940 | 940 | //add an 'error' saying that we attempted to reset |
941 | 941 | //does it have a stage that was borked too? if so make it no longer borked |
942 | 942 | //add an 'error' saying we attempted to reset |
943 | 943 | $last_ran_script = $this->get_last_ran_script(); |
944 | - if( $last_ran_script instanceof EE_DMS_Unknown_1_0_0 ){ |
|
944 | + if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) { |
|
945 | 945 | //if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
946 | 946 | $last_ran_script->set_completed(); |
947 | - }elseif( $last_ran_script instanceof EE_Data_Migration_Script_Base ) { |
|
947 | + }elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) { |
|
948 | 948 | $last_ran_script->reattempt(); |
949 | - }else{ |
|
950 | - throw new EE_Error( sprintf( __( 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', 'event_espresso' ), print_r( $last_ran_script, true ) ) ); |
|
949 | + } else { |
|
950 | + throw new EE_Error(sprintf(__('Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', 'event_espresso'), print_r($last_ran_script, true))); |
|
951 | 951 | } |
952 | 952 | return $this->_save_migrations_ran(); |
953 | 953 | } |
@@ -957,19 +957,19 @@ discard block |
||
957 | 957 | * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
958 | 958 | * @return boolean |
959 | 959 | */ |
960 | - public function migration_has_ran( $version, $plugin_slug = 'Core' ) { |
|
961 | - return $this->get_migration_ran( $version, $plugin_slug ) !== NULL; |
|
960 | + public function migration_has_ran($version, $plugin_slug = 'Core') { |
|
961 | + return $this->get_migration_ran($version, $plugin_slug) !== NULL; |
|
962 | 962 | } |
963 | 963 | /** |
964 | 964 | * Enqueues this ee plugin to have its data initialized |
965 | 965 | * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value |
966 | 966 | */ |
967 | - public function enqueue_db_initialization_for( $plugin_slug ) { |
|
967 | + public function enqueue_db_initialization_for($plugin_slug) { |
|
968 | 968 | $queue = $this->get_db_initialization_queue(); |
969 | - if( ! in_array( $plugin_slug, $queue ) ) { |
|
969 | + if ( ! in_array($plugin_slug, $queue)) { |
|
970 | 970 | $queue[] = $plugin_slug; |
971 | 971 | } |
972 | - update_option( self::db_init_queue_option_name, $queue ); |
|
972 | + update_option(self::db_init_queue_option_name, $queue); |
|
973 | 973 | } |
974 | 974 | /** |
975 | 975 | * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon |
@@ -979,26 +979,26 @@ discard block |
||
979 | 979 | public function initialize_db_for_enqueued_ee_plugins() { |
980 | 980 | // EEH_Debug_Tools::instance()->start_timer( 'initialize_db_for_enqueued_ee_plugins' ); |
981 | 981 | $queue = $this->get_db_initialization_queue(); |
982 | - foreach( $queue as $plugin_slug ) { |
|
983 | - $most_up_to_date_dms = $this->get_most_up_to_date_dms( $plugin_slug ); |
|
984 | - if( ! $most_up_to_date_dms ) { |
|
982 | + foreach ($queue as $plugin_slug) { |
|
983 | + $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
|
984 | + if ( ! $most_up_to_date_dms) { |
|
985 | 985 | //if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
986 | 986 | $verify_db = false; |
987 | - }else{ |
|
988 | - $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version( $most_up_to_date_dms ); |
|
989 | - $verify_db = $this->database_needs_updating_to( $most_up_to_date_dms_migrates_to ); |
|
987 | + } else { |
|
988 | + $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms); |
|
989 | + $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to); |
|
990 | 990 | } |
991 | - if( $plugin_slug == 'Core' ){ |
|
991 | + if ($plugin_slug == 'Core') { |
|
992 | 992 | EE_System::instance()->initialize_db_if_no_migrations_required( |
993 | 993 | false, |
994 | 994 | $verify_db |
995 | 995 | ); |
996 | - }else{ |
|
996 | + } else { |
|
997 | 997 | //just loop through the addons to make sure their database is setup |
998 | - foreach( EE_Registry::instance()->addons as $addon ) { |
|
999 | - if( $addon->name() == $plugin_slug ) { |
|
998 | + foreach (EE_Registry::instance()->addons as $addon) { |
|
999 | + if ($addon->name() == $plugin_slug) { |
|
1000 | 1000 | |
1001 | - $addon->initialize_db_if_no_migrations_required( $verify_db ); |
|
1001 | + $addon->initialize_db_if_no_migrations_required($verify_db); |
|
1002 | 1002 | break; |
1003 | 1003 | } |
1004 | 1004 | } |
@@ -1008,7 +1008,7 @@ discard block |
||
1008 | 1008 | // EEH_Debug_Tools::instance()->show_times(); |
1009 | 1009 | //because we just initialized the DBs for the enqueued ee plugins |
1010 | 1010 | //we don't need to keep remembering which ones needed to be initialized |
1011 | - delete_option( self::db_init_queue_option_name ); |
|
1011 | + delete_option(self::db_init_queue_option_name); |
|
1012 | 1012 | } |
1013 | 1013 | |
1014 | 1014 | /** |
@@ -1017,8 +1017,8 @@ discard block |
||
1017 | 1017 | * 'Core', or the return value of EE_Addon::name() for an addon |
1018 | 1018 | * @return array |
1019 | 1019 | */ |
1020 | - public function get_db_initialization_queue(){ |
|
1021 | - return get_option ( self::db_init_queue_option_name, array() ); |
|
1020 | + public function get_db_initialization_queue() { |
|
1021 | + return get_option(self::db_init_queue_option_name, array()); |
|
1022 | 1022 | } |
1023 | 1023 | |
1024 | 1024 | /** |
@@ -1027,13 +1027,13 @@ discard block |
||
1027 | 1027 | * @throws \EE_Error |
1028 | 1028 | */ |
1029 | 1029 | protected function _get_table_analysis() { |
1030 | - if( $this->_table_analysis instanceof TableAnalysis ) { |
|
1030 | + if ($this->_table_analysis instanceof TableAnalysis) { |
|
1031 | 1031 | return $this->_table_analysis; |
1032 | 1032 | } else { |
1033 | 1033 | throw new \EE_Error( |
1034 | 1034 | sprintf( |
1035 | - __( 'Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
1036 | - get_class( $this ) |
|
1035 | + __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
1036 | + get_class($this) |
|
1037 | 1037 | ) |
1038 | 1038 | ); |
1039 | 1039 | } |
@@ -1045,13 +1045,13 @@ discard block |
||
1045 | 1045 | * @throws \EE_Error |
1046 | 1046 | */ |
1047 | 1047 | protected function _get_table_manager() { |
1048 | - if( $this->_table_manager instanceof TableManager ) { |
|
1048 | + if ($this->_table_manager instanceof TableManager) { |
|
1049 | 1049 | return $this->_table_manager; |
1050 | 1050 | } else { |
1051 | 1051 | throw new \EE_Error( |
1052 | 1052 | sprintf( |
1053 | - __( 'Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
1054 | - get_class( $this ) |
|
1053 | + __('Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
1054 | + get_class($this) |
|
1055 | 1055 | ) |
1056 | 1056 | ); |
1057 | 1057 | } |
@@ -208,7 +208,7 @@ discard block |
||
208 | 208 | //it's 4.2-style.eg Core.4.1.0 |
209 | 209 | $plugin_slug = $parts[0];//eg Core |
210 | 210 | $version_string = $parts[1].".".$parts[2].".".$parts[3]; //eg 4.1.0 |
211 | - }else{ |
|
211 | + } else{ |
|
212 | 212 | //it's 4.1-style: eg 4.1.0 |
213 | 213 | $plugin_slug = 'Core'; |
214 | 214 | $version_string = $plugin_slug_and_version_string;//eg 4.1.0 |
@@ -231,12 +231,12 @@ discard block |
||
231 | 231 | if($class instanceof EE_Data_Migration_Script_Base){ |
232 | 232 | $class->instantiate_from_array_of_properties($data_migration_data); |
233 | 233 | return $class; |
234 | - }else{ |
|
234 | + } else{ |
|
235 | 235 | //huh, so its an object but not a data migration script?? that shouldn't happen |
236 | 236 | //just leave it as an array (which will probably just get ignored) |
237 | 237 | throw new EE_Error(sprintf(__("Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", 'event_espresso'),$data_migration_data['class'])); |
238 | 238 | } |
239 | - }else{ |
|
239 | + } else{ |
|
240 | 240 | //so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
241 | 241 | throw new EE_Error(sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'),$dms_option_name)); |
242 | 242 | } |
@@ -266,7 +266,7 @@ discard block |
||
266 | 266 | //sometimes we also like to know which was the last incomplete script (or if there are any at all) |
267 | 267 | $this->_last_ran_incomplete_script = $class; |
268 | 268 | } |
269 | - }catch(EE_Error $e){ |
|
269 | + } catch(EE_Error $e){ |
|
270 | 270 | //ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
271 | 271 | $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize($data_migration_option['option_value']); |
272 | 272 | } |
@@ -367,7 +367,7 @@ discard block |
||
367 | 367 | //so we want the data migrations to happen. SO, we're going to say the DB is at that state |
368 | 368 | // echo "4.1.0 is greater than $previous_version_installed! update the option"; |
369 | 369 | $db_state = array('Core'=>$previous_version_installed); |
370 | - }else{ |
|
370 | + } else{ |
|
371 | 371 | // echo "4.1.0 is SMALLER than $previous_version_installed"; |
372 | 372 | $db_state = array('Core'=>EVENT_ESPRESSO_VERSION); |
373 | 373 | } |
@@ -435,10 +435,10 @@ discard block |
||
435 | 435 | $migrates_to_version = $script->migrates_to_version(); |
436 | 436 | $next_database_state_to_consider[ $migrates_to_version[ 'slug' ] ] = $migrates_to_version[ 'version' ]; |
437 | 437 | unset($script_class_and_filepaths_available[$classname]); |
438 | - }else{ |
|
438 | + } else{ |
|
439 | 439 | //it must have a status that indicates it has finished, so we don't want to try and run it again |
440 | 440 | } |
441 | - }else{ |
|
441 | + } else{ |
|
442 | 442 | //it exists but it's not a proper data migration script |
443 | 443 | //maybe the script got renamed? or was simply removed from EE? |
444 | 444 | //either way, its certainly not runnable! |
@@ -478,7 +478,7 @@ discard block |
||
478 | 478 | } |
479 | 479 | if($include_completed_scripts){ |
480 | 480 | return $this->_last_ran_script; |
481 | - }else{ |
|
481 | + } else{ |
|
482 | 482 | return $this->_last_ran_incomplete_script; |
483 | 483 | } |
484 | 484 | } |
@@ -539,7 +539,7 @@ discard block |
||
539 | 539 | $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script; |
540 | 540 | } |
541 | 541 | $current_script_name = get_class($currently_executing_script); |
542 | - }catch(Exception $e){ |
|
542 | + } catch(Exception $e){ |
|
543 | 543 | //an exception occurred while trying to get migration scripts |
544 | 544 | |
545 | 545 | $message = sprintf( __("Error Message: %sStack Trace:%s", "event_espresso"), $e->getMessage() . '<br>', $e->getTraceAsString() ); |
@@ -604,14 +604,14 @@ discard block |
||
604 | 604 | ); |
605 | 605 | break; |
606 | 606 | } |
607 | - }catch(Exception $e){ |
|
607 | + } catch(Exception $e){ |
|
608 | 608 | //ok so some exception was thrown which killed the data migration script |
609 | 609 | //double-check we have a real script |
610 | 610 | if($currently_executing_script instanceof EE_Data_Migration_Script_Base){ |
611 | 611 | $script_name = $currently_executing_script->pretty_name(); |
612 | 612 | $currently_executing_script->set_broken(); |
613 | 613 | $currently_executing_script->add_error($e->getMessage()); |
614 | - }else{ |
|
614 | + } else{ |
|
615 | 615 | $script_name = __("Error getting Migration Script", "event_espresso"); |
616 | 616 | } |
617 | 617 | $response_array = array( |
@@ -654,7 +654,7 @@ discard block |
||
654 | 654 | ob_start(); |
655 | 655 | try{ |
656 | 656 | $response = $this->migration_step(); |
657 | - }catch(Exception $e){ |
|
657 | + } catch(Exception $e){ |
|
658 | 658 | $response = array( |
659 | 659 | 'records_to_migrate'=>0, |
660 | 660 | 'records_migrated'=>0, |
@@ -703,7 +703,7 @@ discard block |
||
703 | 703 | $current_database_state = get_option(self::current_database_state); |
704 | 704 | if( ! isset( $current_database_state[ $slug ] ) ) { |
705 | 705 | return true; |
706 | - }else{ |
|
706 | + } else{ |
|
707 | 707 | //just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
708 | 708 | $version_parts_current_db_state = array_slice( explode('.', $current_database_state[ $slug ] ), 0, 3); |
709 | 709 | $version_parts_of_provided_db_state = array_slice( explode( '.', $version ), 0, 3 ); |
@@ -803,7 +803,7 @@ discard block |
||
803 | 803 | //ok then just add this error to its list of errors |
804 | 804 | $last_ran_migration_script_properties['_errors'][] = $error_message; |
805 | 805 | $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
806 | - }else{ |
|
806 | + } else{ |
|
807 | 807 | //so we don't even know which script was last running |
808 | 808 | //use the data migration error stub, which is designed specifically for this type of thing |
809 | 809 | $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
@@ -839,7 +839,7 @@ discard block |
||
839 | 839 | if( $old_option_value != $script_array_for_saving){ |
840 | 840 | $successful_updates = update_option($option_name,$script_array_for_saving); |
841 | 841 | } |
842 | - }else{//we don't know what this array-thing is. So just save it as-is |
|
842 | + } else{//we don't know what this array-thing is. So just save it as-is |
|
843 | 843 | // $array_of_migrations[$version_string] = $array_or_migration_obj; |
844 | 844 | if($old_option_value != $array_or_migration_obj){ |
845 | 845 | $successful_updates = update_option($option_name,$array_or_migration_obj); |
@@ -906,7 +906,7 @@ discard block |
||
906 | 906 | } |
907 | 907 | //if it wasn't for core, we must keep searching for one that is! |
908 | 908 | continue; |
909 | - }else{ |
|
909 | + } else{ |
|
910 | 910 | $champion_migrates_to= $this->script_migrates_to_version($most_up_to_date_dms_classname); |
911 | 911 | $contender_migrates_to = $this->script_migrates_to_version($classname); |
912 | 912 | if($contender_migrates_to[ 'slug' ] == $plugin_slug && version_compare($champion_migrates_to[ 'version' ], $contender_migrates_to[ 'version' ], '<')){ |
@@ -933,7 +933,7 @@ discard block |
||
933 | 933 | $migrations_ran = $this->get_data_migrations_ran(); |
934 | 934 | if( isset( $migrations_ran[ $plugin_slug ] ) && isset( $migrations_ran[ $plugin_slug ][ $version ] ) ){ |
935 | 935 | return $migrations_ran[ $plugin_slug ][ $version ]; |
936 | - }else{ |
|
936 | + } else{ |
|
937 | 937 | return NULL; |
938 | 938 | } |
939 | 939 | } |
@@ -955,9 +955,9 @@ discard block |
||
955 | 955 | if( $last_ran_script instanceof EE_DMS_Unknown_1_0_0 ){ |
956 | 956 | //if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
957 | 957 | $last_ran_script->set_completed(); |
958 | - }elseif( $last_ran_script instanceof EE_Data_Migration_Script_Base ) { |
|
958 | + } elseif( $last_ran_script instanceof EE_Data_Migration_Script_Base ) { |
|
959 | 959 | $last_ran_script->reattempt(); |
960 | - }else{ |
|
960 | + } else{ |
|
961 | 961 | throw new EE_Error( sprintf( __( 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', 'event_espresso' ), print_r( $last_ran_script, true ) ) ); |
962 | 962 | } |
963 | 963 | return $this->_save_migrations_ran(); |
@@ -995,7 +995,7 @@ discard block |
||
995 | 995 | if( ! $most_up_to_date_dms ) { |
996 | 996 | //if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
997 | 997 | $verify_db = false; |
998 | - }else{ |
|
998 | + } else{ |
|
999 | 999 | $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version( $most_up_to_date_dms ); |
1000 | 1000 | $verify_db = $this->database_needs_updating_to( $most_up_to_date_dms_migrates_to ); |
1001 | 1001 | } |
@@ -1004,7 +1004,7 @@ discard block |
||
1004 | 1004 | false, |
1005 | 1005 | $verify_db |
1006 | 1006 | ); |
1007 | - }else{ |
|
1007 | + } else{ |
|
1008 | 1008 | //just loop through the addons to make sure their database is setup |
1009 | 1009 | foreach( EE_Registry::instance()->addons as $addon ) { |
1010 | 1010 | if( $addon->name() == $plugin_slug ) { |
@@ -127,9 +127,9 @@ discard block |
||
127 | 127 | protected $_table_analysis; |
128 | 128 | |
129 | 129 | /** |
130 | - * @var EE_Data_Migration_Manager $_instance |
|
130 | + * @var EE_Data_Migration_Manager $_instance |
|
131 | 131 | * @access private |
132 | - */ |
|
132 | + */ |
|
133 | 133 | private static $_instance = NULL; |
134 | 134 | |
135 | 135 | |
@@ -928,12 +928,12 @@ discard block |
||
928 | 928 | } |
929 | 929 | |
930 | 930 | /** |
931 | - * Resets the borked data migration scripts so they're no longer borked |
|
932 | - * so we can again attempt to migrate |
|
933 | - * |
|
934 | - * @return bool |
|
935 | - * @throws \EE_Error |
|
936 | - */ |
|
931 | + * Resets the borked data migration scripts so they're no longer borked |
|
932 | + * so we can again attempt to migrate |
|
933 | + * |
|
934 | + * @return bool |
|
935 | + * @throws \EE_Error |
|
936 | + */ |
|
937 | 937 | public function reattempt(){ |
938 | 938 | //find if the last-ran script was borked |
939 | 939 | //set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
@@ -20,7 +20,7 @@ discard block |
||
20 | 20 | |
21 | 21 | |
22 | 22 | |
23 | -abstract class EE_Data_Migration_Class_Base{ |
|
23 | +abstract class EE_Data_Migration_Class_Base { |
|
24 | 24 | |
25 | 25 | /** |
26 | 26 | * @var $records_to_migrate int count of all that have been migrated |
@@ -72,7 +72,7 @@ discard block |
||
72 | 72 | * @param TableManager $table_manager |
73 | 73 | * @param TableAnalysis $table_analysis |
74 | 74 | */ |
75 | - public function __construct( TableManager $table_manager = null, TableAnalysis $table_analysis = null ){ |
|
75 | + public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null) { |
|
76 | 76 | $this->_table_manager = $table_manager; |
77 | 77 | $this->_table_analysis = $table_analysis; |
78 | 78 | $this->set_status(EE_Data_Migration_Manager::status_continue); |
@@ -85,9 +85,9 @@ discard block |
||
85 | 85 | * @throws EE_Error |
86 | 86 | * @return string |
87 | 87 | */ |
88 | - public function pretty_name(){ |
|
89 | - if($this->_pretty_name === null){ |
|
90 | - throw new EE_Error(sprintf(__("Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor", "event_espresso"),get_class($this))); |
|
88 | + public function pretty_name() { |
|
89 | + if ($this->_pretty_name === null) { |
|
90 | + throw new EE_Error(sprintf(__("Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor", "event_espresso"), get_class($this))); |
|
91 | 91 | } |
92 | 92 | return $this->_pretty_name; |
93 | 93 | } |
@@ -95,8 +95,8 @@ discard block |
||
95 | 95 | * |
96 | 96 | * @return int |
97 | 97 | */ |
98 | - public function count_records_to_migrate(){ |
|
99 | - if( $this->_records_to_migrate == null){ |
|
98 | + public function count_records_to_migrate() { |
|
99 | + if ($this->_records_to_migrate == null) { |
|
100 | 100 | $this->_records_to_migrate = $this->_count_records_to_migrate(); |
101 | 101 | } |
102 | 102 | return $this->_records_to_migrate; |
@@ -116,9 +116,9 @@ discard block |
||
116 | 116 | * @return string one of EE_Data_Migration_Manager::status_* constants |
117 | 117 | * @throws EE_Error |
118 | 118 | */ |
119 | - public function get_status(){ |
|
120 | - if($this->_status === null){ |
|
121 | - throw new EE_Error(sprintf(__("Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.", "event_espresso"),get_class($this))); |
|
119 | + public function get_status() { |
|
120 | + if ($this->_status === null) { |
|
121 | + throw new EE_Error(sprintf(__("Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.", "event_espresso"), get_class($this))); |
|
122 | 122 | } |
123 | 123 | return $this->_status; |
124 | 124 | } |
@@ -127,7 +127,7 @@ discard block |
||
127 | 127 | * @param string $status |
128 | 128 | * @return void |
129 | 129 | */ |
130 | - protected function set_status($status){ |
|
130 | + protected function set_status($status) { |
|
131 | 131 | $this->_status = $status; |
132 | 132 | } |
133 | 133 | /** |
@@ -139,11 +139,11 @@ discard block |
||
139 | 139 | * Returns the last error that occurred. If none occurred, returns null |
140 | 140 | * @return string |
141 | 141 | */ |
142 | - public function get_last_error(){ |
|
142 | + public function get_last_error() { |
|
143 | 143 | $errors = $this->get_errors(); |
144 | - if($errors){ |
|
144 | + if ($errors) { |
|
145 | 145 | return end($errors); |
146 | - }else{ |
|
146 | + } else { |
|
147 | 147 | return null; |
148 | 148 | } |
149 | 149 | } |
@@ -152,26 +152,26 @@ discard block |
||
152 | 152 | * @param string $error a string describing the error that will be useful for debugging. Consider including all the data that led to the error, and a stack trace etc. |
153 | 153 | * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are already at their limit, we will purposefully forget the first half |
154 | 154 | */ |
155 | - public function add_error($error, $force = FALSE ){ |
|
156 | - if( ! defined( 'EE_DMS_ERROR_LIMIT' ) ){ |
|
155 | + public function add_error($error, $force = FALSE) { |
|
156 | + if ( ! defined('EE_DMS_ERROR_LIMIT')) { |
|
157 | 157 | $limit = 50; |
158 | - }else{ |
|
158 | + } else { |
|
159 | 159 | $limit = EE_DMS_ERROR_LIMIT; |
160 | 160 | } |
161 | 161 | //make sure errors is an array, see ticket #8261 |
162 | - if( is_string( $this->_errors ) ){ |
|
163 | - $this->_errors = array( $this->_errors ); |
|
162 | + if (is_string($this->_errors)) { |
|
163 | + $this->_errors = array($this->_errors); |
|
164 | 164 | } |
165 | - if(count($this->_errors) >= $limit ){ |
|
166 | - if( $force ){ |
|
165 | + if (count($this->_errors) >= $limit) { |
|
166 | + if ($force) { |
|
167 | 167 | //get rid of the first half of the errors and any above the limit |
168 | - $this->_errors = array_slice( $this->_errors, $limit / 2, $limit / 2 ); |
|
168 | + $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2); |
|
169 | 169 | $this->_errors[] = "Limit reached; removed first half of errors to save space"; |
170 | 170 | $this->_errors[] = $error; |
171 | - }else{ |
|
172 | - $this->_errors[ $limit ] = 'More, but limit reached...'; |
|
171 | + } else { |
|
172 | + $this->_errors[$limit] = 'More, but limit reached...'; |
|
173 | 173 | } |
174 | - }else{ |
|
174 | + } else { |
|
175 | 175 | $this->_errors[] = $error; |
176 | 176 | } |
177 | 177 | } |
@@ -180,57 +180,57 @@ discard block |
||
180 | 180 | * Indicates there was a fatal error and the migration cannot possibly continue |
181 | 181 | * @return boolean |
182 | 182 | */ |
183 | - public function is_broken(){ |
|
183 | + public function is_broken() { |
|
184 | 184 | return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error; |
185 | 185 | } |
186 | 186 | /** |
187 | 187 | * @deprecated since 4.6.12 |
188 | 188 | */ |
189 | - public function is_borked(){ |
|
190 | - EE_Error::doing_it_wrong('is_borked', __( 'The cheeky "is_borked" method had been replaced with the more proper "is_broken"', 'event_espresso' ), '4.6.12'); |
|
189 | + public function is_borked() { |
|
190 | + EE_Error::doing_it_wrong('is_borked', __('The cheeky "is_borked" method had been replaced with the more proper "is_broken"', 'event_espresso'), '4.6.12'); |
|
191 | 191 | return $this->is_broken(); |
192 | 192 | } |
193 | 193 | /** |
194 | 194 | * Sets the status to as having a fatal error |
195 | 195 | */ |
196 | - public function set_broken(){ |
|
196 | + public function set_broken() { |
|
197 | 197 | $this->_status = EE_Data_Migration_Manager::status_fatal_error; |
198 | 198 | } |
199 | 199 | /** |
200 | 200 | * |
201 | 201 | * @deprecated since 4.6.12 |
202 | 202 | */ |
203 | - public function set_borked(){ |
|
204 | - EE_Error::doing_it_wrong('is_borked', __( 'The cheeky "is_borked" method had been replaced with the more proper "is_broken"', 'event_espresso' ), '4.6.12'); |
|
203 | + public function set_borked() { |
|
204 | + EE_Error::doing_it_wrong('is_borked', __('The cheeky "is_borked" method had been replaced with the more proper "is_broken"', 'event_espresso'), '4.6.12'); |
|
205 | 205 | return $this->set_broken(); |
206 | 206 | } |
207 | 207 | /** |
208 | 208 | * Checks if this thing believes it is completed |
209 | 209 | * @return boolean |
210 | 210 | */ |
211 | - public function is_completed(){ |
|
211 | + public function is_completed() { |
|
212 | 212 | return $this->get_status() == EE_Data_Migration_Manager::status_completed; |
213 | 213 | } |
214 | 214 | /** |
215 | 215 | * Checks if the current script has more to do or not (ie, if it's status is CONTINUE) |
216 | 216 | * @return boolean |
217 | 217 | */ |
218 | - public function has_more_to_do(){ |
|
218 | + public function has_more_to_do() { |
|
219 | 219 | return $this->get_status() == EE_Data_Migration_Manager::status_continue; |
220 | 220 | } |
221 | 221 | /** |
222 | 222 | * Marks that we believe this migration thing is completed |
223 | 223 | */ |
224 | - public function set_completed(){ |
|
224 | + public function set_completed() { |
|
225 | 225 | $this->_status = EE_Data_Migration_Manager::status_completed; |
226 | 226 | } |
227 | 227 | |
228 | 228 | /** |
229 | 229 | * Marks that we think this migration class can continue to migrate |
230 | 230 | */ |
231 | - public function reattempt(){ |
|
231 | + public function reattempt() { |
|
232 | 232 | $this->_status = EE_Data_Migration_Manager::status_continue; |
233 | - $this->add_error( __( 'Reattempt migration', 'event_espresso' ), TRUE ); |
|
233 | + $this->add_error(__('Reattempt migration', 'event_espresso'), TRUE); |
|
234 | 234 | } |
235 | 235 | |
236 | 236 | /** |
@@ -239,8 +239,8 @@ discard block |
||
239 | 239 | * possible that this class is defined when it goes to sleep, but NOT available when it |
240 | 240 | * awakes (eg, this class is part of an addon that is deactivated at some point). |
241 | 241 | */ |
242 | - public function properties_as_array(){ |
|
243 | - $properties = get_object_vars($this); |
|
242 | + public function properties_as_array() { |
|
243 | + $properties = get_object_vars($this); |
|
244 | 244 | $properties['class'] = get_class($this); |
245 | 245 | unset($properties['_migration_script']); |
246 | 246 | return $properties; |
@@ -261,22 +261,22 @@ discard block |
||
261 | 261 | * @param array $data_types numerically indexed |
262 | 262 | * @return string |
263 | 263 | */ |
264 | - protected function _create_error_message_for_db_insertion($old_table, $old_row_as_array, $new_table, $new_row_as_array, $data_types){ |
|
264 | + protected function _create_error_message_for_db_insertion($old_table, $old_row_as_array, $new_table, $new_row_as_array, $data_types) { |
|
265 | 265 | global $wpdb; |
266 | 266 | $old_columns_and_values_for_string = array(); |
267 | - foreach($old_row_as_array as $column => $value){ |
|
267 | + foreach ($old_row_as_array as $column => $value) { |
|
268 | 268 | $old_columns_and_values_for_string[] = "$column => $value"; |
269 | 269 | } |
270 | 270 | $new_columns_and_values_for_string = array(); |
271 | 271 | $count = 0; |
272 | - foreach($new_row_as_array as $column => $value){ |
|
272 | + foreach ($new_row_as_array as $column => $value) { |
|
273 | 273 | $new_columns_and_values_for_string[] = " $column => $value (".$data_types[$count++].")"; |
274 | 274 | } |
275 | 275 | return sprintf( |
276 | 276 | __('Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4%s.', "event_espresso"), |
277 | - implode(", ",$new_columns_and_values_for_string), |
|
277 | + implode(", ", $new_columns_and_values_for_string), |
|
278 | 278 | $new_table, |
279 | - implode(", ",$old_columns_and_values_for_string), |
|
279 | + implode(", ", $old_columns_and_values_for_string), |
|
280 | 280 | $old_table, |
281 | 281 | '<br/>', |
282 | 282 | $wpdb->last_error |
@@ -291,12 +291,12 @@ discard block |
||
291 | 291 | * @param array $array_of_data |
292 | 292 | * @return string |
293 | 293 | */ |
294 | - protected function _json_encode($array_of_data){ |
|
294 | + protected function _json_encode($array_of_data) { |
|
295 | 295 | //we'd rather NOT serialize the transaction details |
296 | 296 | $fields_to_include = array(); |
297 | - foreach($array_of_data as $name => $value){ |
|
297 | + foreach ($array_of_data as $name => $value) { |
|
298 | 298 | $unserialized_data = @unserialize($value); |
299 | - if($unserialized_data === FALSE){ |
|
299 | + if ($unserialized_data === FALSE) { |
|
300 | 300 | $fields_to_include[$name] = $value; |
301 | 301 | } |
302 | 302 | } |
@@ -309,13 +309,13 @@ discard block |
||
309 | 309 | * @throws EE_Error |
310 | 310 | */ |
311 | 311 | protected function _get_table_manager() { |
312 | - if( $this->_table_manager instanceof TableManager ) { |
|
312 | + if ($this->_table_manager instanceof TableManager) { |
|
313 | 313 | return $this->_table_manager; |
314 | 314 | } else { |
315 | 315 | throw new EE_Error( |
316 | 316 | sprintf( |
317 | - __( 'Table manager on migration class %1$s is not set properly.', 'event_espresso'), |
|
318 | - get_class( $this ) |
|
317 | + __('Table manager on migration class %1$s is not set properly.', 'event_espresso'), |
|
318 | + get_class($this) |
|
319 | 319 | ) |
320 | 320 | ); |
321 | 321 | } |
@@ -327,13 +327,13 @@ discard block |
||
327 | 327 | * @throws EE_Error |
328 | 328 | */ |
329 | 329 | protected function _get_table_analysis() { |
330 | - if( $this->_table_analysis instanceof TableAnalysis ) { |
|
330 | + if ($this->_table_analysis instanceof TableAnalysis) { |
|
331 | 331 | return $this->_table_analysis; |
332 | 332 | } else { |
333 | 333 | throw new EE_Error( |
334 | 334 | sprintf( |
335 | - __( 'Table analysis class on migration class %1$s is not set properly.', 'event_espresso'), |
|
336 | - get_class( $this ) |
|
335 | + __('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'), |
|
336 | + get_class($this) |
|
337 | 337 | ) |
338 | 338 | ); |
339 | 339 | } |
@@ -2,7 +2,7 @@ discard block |
||
2 | 2 | use EventEspresso\core\services\database\TableAnalysis; |
3 | 3 | use EventEspresso\core\services\database\TableManager; |
4 | 4 | |
5 | -if ( ! defined( 'EVENT_ESPRESSO_VERSION')) { |
|
5 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
6 | 6 | exit('No direct script access allowed'); |
7 | 7 | } |
8 | 8 | |
@@ -124,14 +124,14 @@ discard block |
||
124 | 124 | * @param TableManager $table_manager |
125 | 125 | * @param TableAnalysis $table_analysis |
126 | 126 | */ |
127 | - public function __construct( TableManager $table_manager = null, TableAnalysis $table_analysis = null ) { |
|
128 | - $this->_migration_stages = (array) apply_filters('FHEE__'.get_class($this).'__construct__migration_stages',$this->_migration_stages); |
|
129 | - foreach($this->_migration_stages as $migration_stage){ |
|
130 | - if ( $migration_stage instanceof EE_Data_Migration_Script_Stage ) { |
|
127 | + public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null) { |
|
128 | + $this->_migration_stages = (array) apply_filters('FHEE__'.get_class($this).'__construct__migration_stages', $this->_migration_stages); |
|
129 | + foreach ($this->_migration_stages as $migration_stage) { |
|
130 | + if ($migration_stage instanceof EE_Data_Migration_Script_Stage) { |
|
131 | 131 | $migration_stage->_construct_finalize($this); |
132 | 132 | } |
133 | 133 | } |
134 | - parent::__construct( $table_manager, $table_analysis ); |
|
134 | + parent::__construct($table_manager, $table_analysis); |
|
135 | 135 | } |
136 | 136 | |
137 | 137 | |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | * Place to add hooks and filters for tweaking the migrations page, in order |
141 | 141 | * to customize it |
142 | 142 | */ |
143 | - public function migration_page_hooks(){ |
|
143 | + public function migration_page_hooks() { |
|
144 | 144 | //by default none are added because we normally like the default look of the migration page |
145 | 145 | } |
146 | 146 | |
@@ -155,9 +155,9 @@ discard block |
||
155 | 155 | * @param int|string $new_pk eg posts.ID |
156 | 156 | * @return void |
157 | 157 | */ |
158 | - public function set_mapping($old_table,$old_pk,$new_table,$new_pk){ |
|
158 | + public function set_mapping($old_table, $old_pk, $new_table, $new_pk) { |
|
159 | 159 | //make sure it has the needed keys |
160 | - if( ! isset($this->_mappings[$old_table]) || ! isset($this->_mappings[$old_table][$new_table])){ |
|
160 | + if ( ! isset($this->_mappings[$old_table]) || ! isset($this->_mappings[$old_table][$new_table])) { |
|
161 | 161 | $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table); |
162 | 162 | } |
163 | 163 | $this->_mappings[$old_table][$new_table][$old_pk] = $new_pk; |
@@ -173,9 +173,9 @@ discard block |
||
173 | 173 | * @param string $new_table with wpdb prefix (wp_). Eg: wp_posts |
174 | 174 | * @return mixed the primary key on the new table |
175 | 175 | */ |
176 | - public function get_mapping_new_pk($old_table,$old_pk,$new_table){ |
|
177 | - if( ! isset($this->_mappings[$old_table]) || |
|
178 | - ! isset($this->_mappings[$old_table][$new_table])){ |
|
176 | + public function get_mapping_new_pk($old_table, $old_pk, $new_table) { |
|
177 | + if ( ! isset($this->_mappings[$old_table]) || |
|
178 | + ! isset($this->_mappings[$old_table][$new_table])) { |
|
179 | 179 | //try fetching the option |
180 | 180 | $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table); |
181 | 181 | } |
@@ -192,15 +192,15 @@ discard block |
||
192 | 192 | * @param mixed $new_pk |
193 | 193 | * @return mixed |
194 | 194 | */ |
195 | - public function get_mapping_old_pk($old_table,$new_table,$new_pk){ |
|
196 | - if( ! isset($this->_mappings[$old_table]) || |
|
197 | - ! isset($this->_mappings[$old_table][$new_table])){ |
|
195 | + public function get_mapping_old_pk($old_table, $new_table, $new_pk) { |
|
196 | + if ( ! isset($this->_mappings[$old_table]) || |
|
197 | + ! isset($this->_mappings[$old_table][$new_table])) { |
|
198 | 198 | //try fetching the option |
199 | 199 | $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table); |
200 | 200 | } |
201 | - if(isset($this->_mappings[$old_table][$new_table])){ |
|
201 | + if (isset($this->_mappings[$old_table][$new_table])) { |
|
202 | 202 | $new_pk_to_old_pk = array_flip($this->_mappings[$old_table][$new_table]); |
203 | - if(isset($new_pk_to_old_pk[$new_pk])){ |
|
203 | + if (isset($new_pk_to_old_pk[$new_pk])) { |
|
204 | 204 | return $new_pk_to_old_pk[$new_pk]; |
205 | 205 | } |
206 | 206 | } |
@@ -215,8 +215,8 @@ discard block |
||
215 | 215 | * @param string $new_table_name |
216 | 216 | * @return array |
217 | 217 | */ |
218 | - protected function _get_mapping_option($old_table_name,$new_table_name){ |
|
219 | - $option = get_option($this->_get_mapping_option_name($old_table_name, $new_table_name),array()); |
|
218 | + protected function _get_mapping_option($old_table_name, $new_table_name) { |
|
219 | + $option = get_option($this->_get_mapping_option_name($old_table_name, $new_table_name), array()); |
|
220 | 220 | return $option; |
221 | 221 | } |
222 | 222 | |
@@ -229,9 +229,9 @@ discard block |
||
229 | 229 | * @param array $mapping_array |
230 | 230 | * @return boolean success of updating option |
231 | 231 | */ |
232 | - protected function _set_mapping_option($old_table_name,$new_table_name,$mapping_array){ |
|
232 | + protected function _set_mapping_option($old_table_name, $new_table_name, $mapping_array) { |
|
233 | 233 | // echo "set mapping for $old_table_name $new_table_name".count($mapping_array)."<br>"; |
234 | - $success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name),$mapping_array); |
|
234 | + $success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name), $mapping_array); |
|
235 | 235 | return $success; |
236 | 236 | } |
237 | 237 | |
@@ -243,12 +243,12 @@ discard block |
||
243 | 243 | * @param string $new_table_name |
244 | 244 | * @return string |
245 | 245 | */ |
246 | - protected function _get_mapping_option_name($old_table_name,$new_table_name){ |
|
246 | + protected function _get_mapping_option_name($old_table_name, $new_table_name) { |
|
247 | 247 | global $wpdb; |
248 | - $old_table_name_sans_wp = str_replace($wpdb->prefix,"",$old_table_name); |
|
249 | - $new_table_name_sans_wp = str_replace($wpdb->prefix,"",$new_table_name); |
|
248 | + $old_table_name_sans_wp = str_replace($wpdb->prefix, "", $old_table_name); |
|
249 | + $new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name); |
|
250 | 250 | $migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this)); |
251 | - return substr( EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to [ 'slug' ] . '_' . $migrates_to[ 'version' ] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp, 0, 64 ); |
|
251 | + return substr(EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix.$migrates_to ['slug'].'_'.$migrates_to['version'].'_'.$old_table_name_sans_wp.'_'.$new_table_name_sans_wp, 0, 64); |
|
252 | 252 | } |
253 | 253 | |
254 | 254 | |
@@ -265,10 +265,10 @@ discard block |
||
265 | 265 | * 99% until the function "migration_step" returns EE_Data_Migration_Script_Base::status_complete. |
266 | 266 | * @return int |
267 | 267 | */ |
268 | - protected function _count_records_to_migrate(){ |
|
268 | + protected function _count_records_to_migrate() { |
|
269 | 269 | $count = 0; |
270 | - foreach($this->stages() as $stage){ |
|
271 | - $count+= $stage->count_records_to_migrate(); |
|
270 | + foreach ($this->stages() as $stage) { |
|
271 | + $count += $stage->count_records_to_migrate(); |
|
272 | 272 | } |
273 | 273 | return $count; |
274 | 274 | } |
@@ -280,10 +280,10 @@ discard block |
||
280 | 280 | * by just setting a transient and updating it after each migration_step |
281 | 281 | * @return int |
282 | 282 | */ |
283 | - public function count_records_migrated(){ |
|
283 | + public function count_records_migrated() { |
|
284 | 284 | $count = 0; |
285 | - foreach($this->stages() as $stage){ |
|
286 | - $count+= $stage->count_records_migrated(); |
|
285 | + foreach ($this->stages() as $stage) { |
|
286 | + $count += $stage->count_records_migrated(); |
|
287 | 287 | } |
288 | 288 | $this->_records_migrated = $count; |
289 | 289 | return $count; |
@@ -297,24 +297,24 @@ discard block |
||
297 | 297 | * @throws EE_Error |
298 | 298 | * @throws Exception |
299 | 299 | */ |
300 | - public function migration_step($num_records_to_migrate_limit){ |
|
300 | + public function migration_step($num_records_to_migrate_limit) { |
|
301 | 301 | //reset the feedback message |
302 | 302 | $this->_feedback_message = ''; |
303 | 303 | //if we haven't yet done the 1st schema changes, do them now. buffer any output |
304 | 304 | $this->_maybe_do_schema_changes(true); |
305 | 305 | |
306 | - $num_records_actually_migrated =0; |
|
306 | + $num_records_actually_migrated = 0; |
|
307 | 307 | $records_migrated_per_stage = array(); |
308 | 308 | //setup the 'stage' variable, which should hold the last run stage of the migration (or none at all if nothing runs) |
309 | 309 | $stage = null; |
310 | 310 | //get the next stage that isn't complete |
311 | - foreach($this->stages() as $stage){ |
|
312 | - if( $stage->get_status() == EE_Data_Migration_Manager::status_continue){ |
|
313 | - try{ |
|
311 | + foreach ($this->stages() as $stage) { |
|
312 | + if ($stage->get_status() == EE_Data_Migration_Manager::status_continue) { |
|
313 | + try { |
|
314 | 314 | $records_migrated_during_stage = $stage->migration_step($num_records_to_migrate_limit - $num_records_actually_migrated); |
315 | 315 | $num_records_actually_migrated += $records_migrated_during_stage; |
316 | 316 | $records_migrated_per_stage[$stage->pretty_name()] = $records_migrated_during_stage; |
317 | - }catch(Exception $e){ |
|
317 | + } catch (Exception $e) { |
|
318 | 318 | //yes if we catch an exception here, we consider that migration stage borked. |
319 | 319 | $stage->set_status(EE_Data_Migration_Manager::status_fatal_error); |
320 | 320 | $this->set_status(EE_Data_Migration_Manager::status_fatal_error); |
@@ -322,7 +322,7 @@ discard block |
||
322 | 322 | throw $e; |
323 | 323 | } |
324 | 324 | //check that the migration stage didn't mark itself as having a fatal error |
325 | - if($stage->is_broken()){ |
|
325 | + if ($stage->is_broken()) { |
|
326 | 326 | $this->set_broken(); |
327 | 327 | throw new EE_Error($stage->get_last_error()); |
328 | 328 | } |
@@ -330,24 +330,24 @@ discard block |
||
330 | 330 | //once we've migrated all the number we intended to (possibly from different stages), stop migrating |
331 | 331 | //or if we had a fatal error |
332 | 332 | //or if the current script stopped early- its not done, but it's done all it thinks we should do on this step |
333 | - if ($num_records_actually_migrated >= $num_records_to_migrate_limit || $stage->is_broken() || $stage->has_more_to_do()){ |
|
333 | + if ($num_records_actually_migrated >= $num_records_to_migrate_limit || $stage->is_broken() || $stage->has_more_to_do()) { |
|
334 | 334 | break; |
335 | 335 | } |
336 | 336 | } |
337 | 337 | //check if we're all done this data migration... |
338 | 338 | //which is indicated by being done early AND the last stage claims to be done |
339 | - if($stage == NULL){ |
|
339 | + if ($stage == NULL) { |
|
340 | 340 | //this migration script apparently has NO stages... which is super weird, but whatever |
341 | 341 | $this->set_completed(); |
342 | 342 | $this->_maybe_do_schema_changes(false); |
343 | - }else if( $num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()){ |
|
343 | + } else if ($num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()) { |
|
344 | 344 | //apparently we're done, because we couldn't migrate the number we intended to |
345 | 345 | $this->set_completed(); |
346 | 346 | $this->_update_feedback_message(array_reverse($records_migrated_per_stage)); |
347 | 347 | //do schema changes for after the migration now |
348 | 348 | //first double-check we haven't already done this |
349 | 349 | $this->_maybe_do_schema_changes(false); |
350 | - }else{ |
|
350 | + } else { |
|
351 | 351 | //update feedback message, keeping in mind that we show them with the most recent at the top |
352 | 352 | $this->_update_feedback_message(array_reverse($records_migrated_per_stage)); |
353 | 353 | } |
@@ -361,12 +361,12 @@ discard block |
||
361 | 361 | * @param array $records_migrated_per_stage KEYS are pretty names for each stage; values are the count of records migrated from that stage |
362 | 362 | * @return void |
363 | 363 | */ |
364 | - private function _update_feedback_message($records_migrated_per_stage){ |
|
364 | + private function _update_feedback_message($records_migrated_per_stage) { |
|
365 | 365 | $feedback_message_array = array(); |
366 | - foreach($records_migrated_per_stage as $migration_stage_name => $num_records_migrated){ |
|
367 | - $feedback_message_array[] = sprintf(__("Migrated %d records successfully during %s", "event_espresso"),$num_records_migrated,$migration_stage_name) ; |
|
366 | + foreach ($records_migrated_per_stage as $migration_stage_name => $num_records_migrated) { |
|
367 | + $feedback_message_array[] = sprintf(__("Migrated %d records successfully during %s", "event_espresso"), $num_records_migrated, $migration_stage_name); |
|
368 | 368 | } |
369 | - $this->_feedback_message .= implode("<br>",$feedback_message_array); |
|
369 | + $this->_feedback_message .= implode("<br>", $feedback_message_array); |
|
370 | 370 | } |
371 | 371 | |
372 | 372 | |
@@ -378,27 +378,27 @@ discard block |
||
378 | 378 | * @throws Exception |
379 | 379 | * @return void |
380 | 380 | */ |
381 | - private function _maybe_do_schema_changes($before = true){ |
|
381 | + private function _maybe_do_schema_changes($before = true) { |
|
382 | 382 | //so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran |
383 | - $property_name = '_schema_changes_'. ($before ? 'before' : 'after').'_migration_ran'; |
|
384 | - if ( ! $this->{$property_name} ){ |
|
385 | - try{ |
|
383 | + $property_name = '_schema_changes_'.($before ? 'before' : 'after').'_migration_ran'; |
|
384 | + if ( ! $this->{$property_name} ) { |
|
385 | + try { |
|
386 | 386 | ob_start(); |
387 | - if($before){ |
|
387 | + if ($before) { |
|
388 | 388 | $this->schema_changes_before_migration(); |
389 | - }else{ |
|
389 | + } else { |
|
390 | 390 | $this->schema_changes_after_migration(); |
391 | 391 | } |
392 | 392 | $output = ob_get_contents(); |
393 | 393 | ob_end_clean(); |
394 | - }catch(Exception $e){ |
|
394 | + } catch (Exception $e) { |
|
395 | 395 | $this->set_status(EE_Data_Migration_Manager::status_fatal_error); |
396 | 396 | throw $e; |
397 | 397 | } |
398 | 398 | //record that we've done these schema changes |
399 | 399 | $this->{$property_name} = true; |
400 | 400 | //if there were any warnings etc, record them as non-fatal errors |
401 | - if( $output ){ |
|
401 | + if ($output) { |
|
402 | 402 | //there were some warnings |
403 | 403 | $this->_errors[] = $output; |
404 | 404 | } |
@@ -425,9 +425,9 @@ discard block |
||
425 | 425 | * @param string $table_definition_sql |
426 | 426 | * @param string $engine_string |
427 | 427 | */ |
428 | - protected function _table_is_new_in_this_version($table_name,$table_definition_sql,$engine_string='ENGINE=InnoDB '){ |
|
428 | + protected function _table_is_new_in_this_version($table_name, $table_definition_sql, $engine_string = 'ENGINE=InnoDB ') { |
|
429 | 429 | // EEH_Debug_Tools::instance()->start_timer( '_table_is_new_in_this_version_' . $table_name ); |
430 | - $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped( true ) ); |
|
430 | + $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped(true)); |
|
431 | 431 | // EEH_Debug_Tools::instance()->stop_timer( '_table_is_new_in_this_version_' . $table_name ); |
432 | 432 | } |
433 | 433 | |
@@ -441,9 +441,9 @@ discard block |
||
441 | 441 | * @param string $table_definition_sql |
442 | 442 | * @param string $engine_string |
443 | 443 | */ |
444 | - protected function _table_is_changed_in_this_version($table_name,$table_definition_sql,$engine_string = 'ENGINE=MyISAM'){ |
|
444 | + protected function _table_is_changed_in_this_version($table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM') { |
|
445 | 445 | // EEH_Debug_Tools::instance()->start_timer( '_table_is_changed_in_this_version' . $table_name ); |
446 | - $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped( false ) ); |
|
446 | + $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped(false)); |
|
447 | 447 | // EEH_Debug_Tools::instance()->stop_timer( '_table_is_changed_in_this_version' . $table_name ); |
448 | 448 | } |
449 | 449 | |
@@ -454,8 +454,8 @@ discard block |
||
454 | 454 | * @param string $table_name |
455 | 455 | * @return boolean |
456 | 456 | */ |
457 | - protected function _old_table_exists( $table_name ) { |
|
458 | - return $this->_get_table_analysis()->tableExists( $table_name ); |
|
457 | + protected function _old_table_exists($table_name) { |
|
458 | + return $this->_get_table_analysis()->tableExists($table_name); |
|
459 | 459 | } |
460 | 460 | |
461 | 461 | |
@@ -465,8 +465,8 @@ discard block |
||
465 | 465 | * @param string $table_name |
466 | 466 | * @return boolean |
467 | 467 | */ |
468 | - protected function _delete_table_if_empty( $table_name ) { |
|
469 | - return EEH_Activation::delete_db_table_if_empty( $table_name ); |
|
468 | + protected function _delete_table_if_empty($table_name) { |
|
469 | + return EEH_Activation::delete_db_table_if_empty($table_name); |
|
470 | 470 | } |
471 | 471 | |
472 | 472 | |
@@ -485,9 +485,9 @@ discard block |
||
485 | 485 | * @param string $table_definition_sql |
486 | 486 | * @param string $engine_string |
487 | 487 | */ |
488 | - protected function _table_should_exist_previously($table_name,$table_definition_sql,$engine_string = 'ENGINE=MyISAM'){ |
|
488 | + protected function _table_should_exist_previously($table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM') { |
|
489 | 489 | // EEH_Debug_Tools::instance()->start_timer( '_table_should_exist_previously' . $table_name ); |
490 | - $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped( false ) ); |
|
490 | + $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped(false)); |
|
491 | 491 | // EEH_Debug_Tools::instance()->stop_timer( '_table_should_exist_previously' . $table_name ); |
492 | 492 | } |
493 | 493 | |
@@ -502,13 +502,13 @@ discard block |
||
502 | 502 | * @param string $table_definition_sql |
503 | 503 | * @param string $engine_string |
504 | 504 | */ |
505 | - protected function _table_has_not_changed_since_previous( $table_name,$table_definition_sql,$engine_string = 'ENGINE=MyISAM'){ |
|
506 | - if( $this->_currently_migrating() ) { |
|
505 | + protected function _table_has_not_changed_since_previous($table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM') { |
|
506 | + if ($this->_currently_migrating()) { |
|
507 | 507 | //if we're doing a migration, and this table apparently already exists, then we don't need do anything right? |
508 | 508 | // EEH_Debug_Tools::instance()->stop_timer( '_table_should_exist_previously' . $table_name ); |
509 | 509 | return; |
510 | 510 | } |
511 | - $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped( false ) ); |
|
511 | + $this->_create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string, $this->_pre_existing_table_should_be_dropped(false)); |
|
512 | 512 | } |
513 | 513 | |
514 | 514 | /** |
@@ -518,7 +518,7 @@ discard block |
||
518 | 518 | protected function _currently_migrating() { |
519 | 519 | //we want to know if we are currently performing a migration. We could just believe what was set on the _migrating property, but let's double-check (ie the script should apply and we should be in MM) |
520 | 520 | return $this->_migrating && |
521 | - $this->can_migrate_from_version( EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set() ) && |
|
521 | + $this->can_migrate_from_version(EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set()) && |
|
522 | 522 | EE_Maintenance_Mode::instance()->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance; |
523 | 523 | } |
524 | 524 | |
@@ -529,17 +529,17 @@ discard block |
||
529 | 529 | * @param boolean $table_is_new |
530 | 530 | * @return boolean |
531 | 531 | */ |
532 | - protected function _pre_existing_table_should_be_dropped( $table_is_new ) { |
|
533 | - if( $table_is_new ) { |
|
534 | - if( $this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation || $this->_currently_migrating() ){ |
|
532 | + protected function _pre_existing_table_should_be_dropped($table_is_new) { |
|
533 | + if ($table_is_new) { |
|
534 | + if ($this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation || $this->_currently_migrating()) { |
|
535 | 535 | return true; |
536 | - }else{ |
|
536 | + } else { |
|
537 | 537 | return false; |
538 | 538 | } |
539 | - }else{ |
|
540 | - if(in_array($this->_get_req_type_for_plugin_corresponding_to_this_dms(),array(EE_System::req_type_new_activation))){ |
|
539 | + } else { |
|
540 | + if (in_array($this->_get_req_type_for_plugin_corresponding_to_this_dms(), array(EE_System::req_type_new_activation))) { |
|
541 | 541 | return true; |
542 | - }else{ |
|
542 | + } else { |
|
543 | 543 | return false; |
544 | 544 | } |
545 | 545 | } |
@@ -552,12 +552,12 @@ discard block |
||
552 | 552 | * @param string $engine_string |
553 | 553 | * @param boolean $drop_pre_existing_tables |
554 | 554 | */ |
555 | - private function _create_table_and_catch_errors( $table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM', $drop_pre_existing_tables = FALSE ){ |
|
556 | - try{ |
|
557 | - EEH_Activation::create_table($table_name,$table_definition_sql, $engine_string, $drop_pre_existing_tables); |
|
558 | - }catch( EE_Error $e ) { |
|
559 | - $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString(); |
|
560 | - $this->add_error( $message ); |
|
555 | + private function _create_table_and_catch_errors($table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM', $drop_pre_existing_tables = FALSE) { |
|
556 | + try { |
|
557 | + EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables); |
|
558 | + } catch (EE_Error $e) { |
|
559 | + $message = $e->getMessage().'<br>Stack Trace:'.$e->getTraceAsString(); |
|
560 | + $this->add_error($message); |
|
561 | 561 | $this->_feedback_message .= $message; |
562 | 562 | } |
563 | 563 | } |
@@ -569,15 +569,15 @@ discard block |
||
569 | 569 | * @return int one of EE_System::_req_type_* constants |
570 | 570 | * @throws EE_Error |
571 | 571 | */ |
572 | - private function _get_req_type_for_plugin_corresponding_to_this_dms(){ |
|
573 | - if($this->slug() == 'Core'){ |
|
572 | + private function _get_req_type_for_plugin_corresponding_to_this_dms() { |
|
573 | + if ($this->slug() == 'Core') { |
|
574 | 574 | return EE_System::instance()->detect_req_type(); |
575 | - }else{//it must be for an addon |
|
575 | + } else {//it must be for an addon |
|
576 | 576 | $addon_name = $this->slug(); |
577 | - if( EE_Registry::instance()->get_addon_by_name($addon_name)){ |
|
577 | + if (EE_Registry::instance()->get_addon_by_name($addon_name)) { |
|
578 | 578 | return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type(); |
579 | - }else{ |
|
580 | - throw new EE_Error(sprintf(__("The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s", "event_espresso"),$this->slug(),$addon_name,implode(",",array_keys( EE_Registry::instance()->get_addons_by_name() ) ) ) ) ; |
|
579 | + } else { |
|
580 | + throw new EE_Error(sprintf(__("The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s", "event_espresso"), $this->slug(), $addon_name, implode(",", array_keys(EE_Registry::instance()->get_addons_by_name())))); |
|
581 | 581 | } |
582 | 582 | } |
583 | 583 | } |
@@ -588,13 +588,13 @@ discard block |
||
588 | 588 | * returns an array of strings describing errors by all the script's stages |
589 | 589 | * @return array |
590 | 590 | */ |
591 | - public function get_errors(){ |
|
591 | + public function get_errors() { |
|
592 | 592 | $all_errors = $this->_errors; |
593 | - if( ! is_array($all_errors)){ |
|
593 | + if ( ! is_array($all_errors)) { |
|
594 | 594 | $all_errors = array(); |
595 | 595 | } |
596 | - foreach($this->stages() as $stage){ |
|
597 | - $all_errors = array_merge($stage->get_errors(),$all_errors); |
|
596 | + foreach ($this->stages() as $stage) { |
|
597 | + $all_errors = array_merge($stage->get_errors(), $all_errors); |
|
598 | 598 | } |
599 | 599 | return $all_errors; |
600 | 600 | } |
@@ -605,8 +605,8 @@ discard block |
||
605 | 605 | * Indicates whether or not this migration script should continue |
606 | 606 | * @return boolean |
607 | 607 | */ |
608 | - public function can_continue(){ |
|
609 | - return in_array($this->get_status(), EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script); |
|
608 | + public function can_continue() { |
|
609 | + return in_array($this->get_status(), EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script); |
|
610 | 610 | } |
611 | 611 | |
612 | 612 | |
@@ -618,8 +618,8 @@ discard block |
||
618 | 618 | * get ordered by the indexes |
619 | 619 | * @return EE_Data_Migration_Script_Stage[] |
620 | 620 | */ |
621 | - protected function stages(){ |
|
622 | - $stages = apply_filters( 'FHEE__'.get_class($this).'__stages',$this->_migration_stages ); |
|
621 | + protected function stages() { |
|
622 | + $stages = apply_filters('FHEE__'.get_class($this).'__stages', $this->_migration_stages); |
|
623 | 623 | ksort($stages); |
624 | 624 | return $stages; |
625 | 625 | } |
@@ -631,7 +631,7 @@ discard block |
||
631 | 631 | * can be displayed to the user |
632 | 632 | * @return string |
633 | 633 | */ |
634 | - public function get_feedback_message(){ |
|
634 | + public function get_feedback_message() { |
|
635 | 635 | return $this->_feedback_message; |
636 | 636 | } |
637 | 637 | |
@@ -643,16 +643,16 @@ discard block |
||
643 | 643 | * possible that this class is defined when it goes to sleep, but NOT available when it |
644 | 644 | * awakes (eg, this class is part of an addon that is deactivated at some point). |
645 | 645 | */ |
646 | - public function properties_as_array(){ |
|
646 | + public function properties_as_array() { |
|
647 | 647 | $properties = parent::properties_as_array(); |
648 | 648 | $properties['_migration_stages'] = array(); |
649 | - foreach($this->_migration_stages as $migration_stage_priority => $migration_stage_class){ |
|
649 | + foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) { |
|
650 | 650 | $properties['_migration_stages'][$migration_stage_priority] = $migration_stage_class->properties_as_array(); |
651 | 651 | } |
652 | 652 | unset($properties['_mappings']); |
653 | 653 | |
654 | - foreach($this->_mappings as $old_table_name => $mapping_to_new_table){ |
|
655 | - foreach($mapping_to_new_table as $new_table_name => $mapping){ |
|
654 | + foreach ($this->_mappings as $old_table_name => $mapping_to_new_table) { |
|
655 | + foreach ($mapping_to_new_table as $new_table_name => $mapping) { |
|
656 | 656 | $this->_set_mapping_option($old_table_name, $new_table_name, $mapping); |
657 | 657 | } |
658 | 658 | } |
@@ -667,19 +667,19 @@ discard block |
||
667 | 667 | * @param array $array_of_properties like what's produced from properties_as_array() method |
668 | 668 | * @return void |
669 | 669 | */ |
670 | - public function instantiate_from_array_of_properties($array_of_properties){ |
|
670 | + public function instantiate_from_array_of_properties($array_of_properties) { |
|
671 | 671 | $stages_properties_arrays = $array_of_properties['_migration_stages']; |
672 | 672 | unset($array_of_properties['_migration_stages']); |
673 | 673 | unset($array_of_properties['class']); |
674 | - foreach($array_of_properties as $property_name => $property_value){ |
|
674 | + foreach ($array_of_properties as $property_name => $property_value) { |
|
675 | 675 | $this->{$property_name} = $property_value; |
676 | 676 | } |
677 | 677 | //_migration_stages are already instantiated, but have only default data |
678 | - foreach($this->_migration_stages as $stage){ |
|
679 | - $stage_data = $this->_find_migration_stage_data_with_classname(get_class($stage),$stages_properties_arrays); |
|
678 | + foreach ($this->_migration_stages as $stage) { |
|
679 | + $stage_data = $this->_find_migration_stage_data_with_classname(get_class($stage), $stages_properties_arrays); |
|
680 | 680 | //SO, if we found the stage data that was saved, use it. Otherwise, I guess the stage is new? (maybe added by |
681 | 681 | //an addon? Unlikely... not sure why it wouldn't exist, but if it doesn't just treat it like it was never started yet) |
682 | - if($stage_data){ |
|
682 | + if ($stage_data) { |
|
683 | 683 | $stage->instantiate_from_array_of_properties($stage_data); |
684 | 684 | } |
685 | 685 | } |
@@ -695,9 +695,9 @@ discard block |
||
695 | 695 | * @param array $migration_stage_data_arrays |
696 | 696 | * @return null |
697 | 697 | */ |
698 | - private function _find_migration_stage_data_with_classname($classname,$migration_stage_data_arrays){ |
|
699 | - foreach($migration_stage_data_arrays as $migration_stage_data_array){ |
|
700 | - if(isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname){ |
|
698 | + private function _find_migration_stage_data_with_classname($classname, $migration_stage_data_arrays) { |
|
699 | + foreach ($migration_stage_data_arrays as $migration_stage_data_array) { |
|
700 | + if (isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname) { |
|
701 | 701 | return $migration_stage_data_array; |
702 | 702 | } |
703 | 703 | } |
@@ -713,8 +713,8 @@ discard block |
||
713 | 713 | * @return array where the first key is the plugin's slug, the 2nd is the version of that plugin |
714 | 714 | * that will be updated to. Eg array('Core','4.1.0') |
715 | 715 | */ |
716 | - public final function migrates_to_version(){ |
|
717 | - return EE_Data_Migration_Manager::instance()->script_migrates_to_version( get_class( $this ) ); |
|
716 | + public final function migrates_to_version() { |
|
717 | + return EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this)); |
|
718 | 718 | } |
719 | 719 | |
720 | 720 | |
@@ -726,10 +726,10 @@ discard block |
||
726 | 726 | * Or 'Core' for core (non-addon). |
727 | 727 | * @return string |
728 | 728 | */ |
729 | - public function slug(){ |
|
729 | + public function slug() { |
|
730 | 730 | $migrates_to_version_info = $this->migrates_to_version(); |
731 | 731 | //the slug is the first part of the array |
732 | - return $migrates_to_version_info[ 'slug' ]; |
|
732 | + return $migrates_to_version_info['slug']; |
|
733 | 733 | } |
734 | 734 | |
735 | 735 | |
@@ -743,7 +743,7 @@ discard block |
||
743 | 743 | * the database up so it can run), then you can set "A" to priority 3 or something. |
744 | 744 | * @return int |
745 | 745 | */ |
746 | - public function priority(){ |
|
746 | + public function priority() { |
|
747 | 747 | return $this->_priority; |
748 | 748 | } |
749 | 749 | |
@@ -756,18 +756,18 @@ discard block |
||
756 | 756 | * @param boolean $migrating |
757 | 757 | * @return void |
758 | 758 | */ |
759 | - public function set_migrating( $migrating = TRUE ){ |
|
759 | + public function set_migrating($migrating = TRUE) { |
|
760 | 760 | $this->_migrating = $migrating; |
761 | 761 | } |
762 | 762 | |
763 | 763 | /** |
764 | 764 | * Marks that we think this migration class can continue to migrate |
765 | 765 | */ |
766 | - public function reattempt(){ |
|
766 | + public function reattempt() { |
|
767 | 767 | parent::reattempt(); |
768 | 768 | //also, we want to reattempt any stages that were marked as borked |
769 | - foreach( $this->stages() as $stage ) { |
|
770 | - if( $stage->is_broken() ) { |
|
769 | + foreach ($this->stages() as $stage) { |
|
770 | + if ($stage->is_broken()) { |
|
771 | 771 | $stage->reattempt(); |
772 | 772 | } |
773 | 773 | } |
@@ -314,7 +314,7 @@ discard block |
||
314 | 314 | $records_migrated_during_stage = $stage->migration_step($num_records_to_migrate_limit - $num_records_actually_migrated); |
315 | 315 | $num_records_actually_migrated += $records_migrated_during_stage; |
316 | 316 | $records_migrated_per_stage[$stage->pretty_name()] = $records_migrated_during_stage; |
317 | - }catch(Exception $e){ |
|
317 | + } catch(Exception $e){ |
|
318 | 318 | //yes if we catch an exception here, we consider that migration stage borked. |
319 | 319 | $stage->set_status(EE_Data_Migration_Manager::status_fatal_error); |
320 | 320 | $this->set_status(EE_Data_Migration_Manager::status_fatal_error); |
@@ -340,14 +340,14 @@ discard block |
||
340 | 340 | //this migration script apparently has NO stages... which is super weird, but whatever |
341 | 341 | $this->set_completed(); |
342 | 342 | $this->_maybe_do_schema_changes(false); |
343 | - }else if( $num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()){ |
|
343 | + } else if( $num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()){ |
|
344 | 344 | //apparently we're done, because we couldn't migrate the number we intended to |
345 | 345 | $this->set_completed(); |
346 | 346 | $this->_update_feedback_message(array_reverse($records_migrated_per_stage)); |
347 | 347 | //do schema changes for after the migration now |
348 | 348 | //first double-check we haven't already done this |
349 | 349 | $this->_maybe_do_schema_changes(false); |
350 | - }else{ |
|
350 | + } else{ |
|
351 | 351 | //update feedback message, keeping in mind that we show them with the most recent at the top |
352 | 352 | $this->_update_feedback_message(array_reverse($records_migrated_per_stage)); |
353 | 353 | } |
@@ -386,12 +386,12 @@ discard block |
||
386 | 386 | ob_start(); |
387 | 387 | if($before){ |
388 | 388 | $this->schema_changes_before_migration(); |
389 | - }else{ |
|
389 | + } else{ |
|
390 | 390 | $this->schema_changes_after_migration(); |
391 | 391 | } |
392 | 392 | $output = ob_get_contents(); |
393 | 393 | ob_end_clean(); |
394 | - }catch(Exception $e){ |
|
394 | + } catch(Exception $e){ |
|
395 | 395 | $this->set_status(EE_Data_Migration_Manager::status_fatal_error); |
396 | 396 | throw $e; |
397 | 397 | } |
@@ -533,13 +533,13 @@ discard block |
||
533 | 533 | if( $table_is_new ) { |
534 | 534 | if( $this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation || $this->_currently_migrating() ){ |
535 | 535 | return true; |
536 | - }else{ |
|
536 | + } else{ |
|
537 | 537 | return false; |
538 | 538 | } |
539 | - }else{ |
|
539 | + } else{ |
|
540 | 540 | if(in_array($this->_get_req_type_for_plugin_corresponding_to_this_dms(),array(EE_System::req_type_new_activation))){ |
541 | 541 | return true; |
542 | - }else{ |
|
542 | + } else{ |
|
543 | 543 | return false; |
544 | 544 | } |
545 | 545 | } |
@@ -555,7 +555,7 @@ discard block |
||
555 | 555 | private function _create_table_and_catch_errors( $table_name, $table_definition_sql, $engine_string = 'ENGINE=MyISAM', $drop_pre_existing_tables = FALSE ){ |
556 | 556 | try{ |
557 | 557 | EEH_Activation::create_table($table_name,$table_definition_sql, $engine_string, $drop_pre_existing_tables); |
558 | - }catch( EE_Error $e ) { |
|
558 | + } catch( EE_Error $e ) { |
|
559 | 559 | $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString(); |
560 | 560 | $this->add_error( $message ); |
561 | 561 | $this->_feedback_message .= $message; |
@@ -572,11 +572,11 @@ discard block |
||
572 | 572 | private function _get_req_type_for_plugin_corresponding_to_this_dms(){ |
573 | 573 | if($this->slug() == 'Core'){ |
574 | 574 | return EE_System::instance()->detect_req_type(); |
575 | - }else{//it must be for an addon |
|
575 | + } else{//it must be for an addon |
|
576 | 576 | $addon_name = $this->slug(); |
577 | 577 | if( EE_Registry::instance()->get_addon_by_name($addon_name)){ |
578 | 578 | return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type(); |
579 | - }else{ |
|
579 | + } else{ |
|
580 | 580 | throw new EE_Error(sprintf(__("The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s", "event_espresso"),$this->slug(),$addon_name,implode(",",array_keys( EE_Registry::instance()->get_addons_by_name() ) ) ) ) ; |
581 | 581 | } |
582 | 582 | } |