@@ -25,8 +25,8 @@ discard block |
||
25 | 25 | $defaults[ $key ] = $setting['std']; |
26 | 26 | } |
27 | 27 | } |
28 | - } |
|
29 | - } |
|
28 | + } |
|
29 | + } |
|
30 | 30 | |
31 | 31 | return $defaults; |
32 | 32 | |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | * |
145 | 145 | */ |
146 | 146 | function wpinv_register_settings() { |
147 | - do_action( 'getpaid_before_register_settings' ); |
|
147 | + do_action( 'getpaid_before_register_settings' ); |
|
148 | 148 | |
149 | 149 | // Loop through all tabs. |
150 | 150 | foreach ( wpinv_get_registered_settings() as $tab => $sections ) { |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | $settings = $sections; |
160 | 160 | } |
161 | 161 | |
162 | - do_action( "getpaid_register_{$tab}_{$section}" ); |
|
162 | + do_action( "getpaid_register_{$tab}_{$section}" ); |
|
163 | 163 | |
164 | 164 | // Register the setting section. |
165 | 165 | add_settings_section( |
@@ -180,7 +180,7 @@ discard block |
||
180 | 180 | // Creates our settings in the options table. |
181 | 181 | register_setting( 'wpinv_settings', 'wpinv_settings', 'wpinv_settings_sanitize' ); |
182 | 182 | |
183 | - do_action( 'getpaid_after_register_settings' ); |
|
183 | + do_action( 'getpaid_after_register_settings' ); |
|
184 | 184 | } |
185 | 185 | add_action( 'admin_init', 'wpinv_register_settings' ); |
186 | 186 | |
@@ -197,13 +197,13 @@ discard block |
||
197 | 197 | $name = isset( $option['name'] ) ? $option['name'] : ''; |
198 | 198 | $cb = "wpinv_{$option['type']}_callback"; |
199 | 199 | $section = "wpinv_settings_{$tab}_$section"; |
200 | - $is_wizzard = is_admin() && isset( $_GET['page'] ) && 'gp-setup' == $_GET['page']; |
|
200 | + $is_wizzard = is_admin() && isset( $_GET['page'] ) && 'gp-setup' == $_GET['page']; |
|
201 | 201 | |
202 | - if ( isset( $option['desc'] ) && ( ! $is_wizzard && ! empty( $option['help-tip'] ) ) ) { |
|
203 | - $tip = wpinv_clean( $option['desc'] ); |
|
204 | - $name .= "<span class='dashicons dashicons-editor-help wpi-help-tip' title='$tip'></span>"; |
|
205 | - unset( $option['desc'] ); |
|
206 | - } |
|
202 | + if ( isset( $option['desc'] ) && ( ! $is_wizzard && ! empty( $option['help-tip'] ) ) ) { |
|
203 | + $tip = wpinv_clean( $option['desc'] ); |
|
204 | + $name .= "<span class='dashicons dashicons-editor-help wpi-help-tip' title='$tip'></span>"; |
|
205 | + unset( $option['desc'] ); |
|
206 | + } |
|
207 | 207 | |
208 | 208 | // Loop through all tabs. |
209 | 209 | add_settings_field( |
@@ -230,9 +230,9 @@ discard block |
||
230 | 230 | 'faux' => isset( $option['faux'] ) ? $option['faux'] : false, |
231 | 231 | 'onchange' => isset( $option['onchange'] ) ? $option['onchange'] : '', |
232 | 232 | 'custom' => isset( $option['custom'] ) ? $option['custom'] : '', |
233 | - 'default_content' => isset( $option['default_content'] ) ? $option['default_content'] : '', |
|
234 | - 'class' => isset( $option['class'] ) ? $option['class'] : '', |
|
235 | - 'style' => isset( $option['style'] ) ? $option['style'] : '', |
|
233 | + 'default_content' => isset( $option['default_content'] ) ? $option['default_content'] : '', |
|
234 | + 'class' => isset( $option['class'] ) ? $option['class'] : '', |
|
235 | + 'style' => isset( $option['style'] ) ? $option['style'] : '', |
|
236 | 236 | 'cols' => isset( $option['cols'] ) && (int) $option['cols'] > 0 ? (int) $option['cols'] : 50, |
237 | 237 | 'rows' => isset( $option['rows'] ) && (int) $option['rows'] > 0 ? (int) $option['rows'] : 5, |
238 | 238 | ) |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | * @return array |
247 | 247 | */ |
248 | 248 | function wpinv_get_registered_settings() { |
249 | - return array_filter( apply_filters( 'wpinv_registered_settings', wpinv_get_data( 'admin-settings' ) ) ); |
|
249 | + return array_filter( apply_filters( 'wpinv_registered_settings', wpinv_get_data( 'admin-settings' ) ) ); |
|
250 | 250 | } |
251 | 251 | |
252 | 252 | /** |
@@ -265,18 +265,18 @@ discard block |
||
265 | 265 | */ |
266 | 266 | function wpinv_settings_sanitize( $input = array() ) { |
267 | 267 | |
268 | - $wpinv_options = wpinv_get_options(); |
|
269 | - $raw_referrer = wp_get_raw_referer(); |
|
268 | + $wpinv_options = wpinv_get_options(); |
|
269 | + $raw_referrer = wp_get_raw_referer(); |
|
270 | 270 | |
271 | 271 | if ( empty( $raw_referrer ) ) { |
272 | - return array_merge( $wpinv_options, $input ); |
|
272 | + return array_merge( $wpinv_options, $input ); |
|
273 | 273 | } |
274 | 274 | |
275 | 275 | wp_parse_str( $raw_referrer, $referrer ); |
276 | 276 | |
277 | - if ( in_array( 'gp-setup', $referrer ) ) { |
|
278 | - return array_merge( $wpinv_options, $input ); |
|
279 | - } |
|
277 | + if ( in_array( 'gp-setup', $referrer ) ) { |
|
278 | + return array_merge( $wpinv_options, $input ); |
|
279 | + } |
|
280 | 280 | |
281 | 281 | $settings = wpinv_get_registered_settings(); |
282 | 282 | $tab = isset( $referrer['tab'] ) ? $referrer['tab'] : 'general'; |
@@ -298,10 +298,10 @@ discard block |
||
298 | 298 | } |
299 | 299 | |
300 | 300 | // General filter |
301 | - $input[ $key ] = apply_filters( 'wpinv_settings_sanitize', $input[ $key ], $key ); |
|
301 | + $input[ $key ] = apply_filters( 'wpinv_settings_sanitize', $input[ $key ], $key ); |
|
302 | 302 | |
303 | - // Key specific filter. |
|
304 | - $input[ $key ] = apply_filters( "wpinv_settings_sanitize_$key", $input[ $key ] ); |
|
303 | + // Key specific filter. |
|
304 | + $input[ $key ] = apply_filters( "wpinv_settings_sanitize_$key", $input[ $key ] ); |
|
305 | 305 | } |
306 | 306 | |
307 | 307 | // Loop through the whitelist and unset any that are empty for the tab being saved |
@@ -344,14 +344,14 @@ discard block |
||
344 | 344 | |
345 | 345 | foreach ( $new_rates as $rate ) { |
346 | 346 | |
347 | - $rate['rate'] = wpinv_sanitize_amount( $rate['rate'] ); |
|
348 | - $rate['name'] = sanitize_text_field( $rate['name'] ); |
|
349 | - $rate['state'] = sanitize_text_field( $rate['state'] ); |
|
350 | - $rate['country'] = sanitize_text_field( $rate['country'] ); |
|
351 | - $rate['global'] = empty( $rate['state'] ); |
|
352 | - $tax_rates[] = $rate; |
|
347 | + $rate['rate'] = wpinv_sanitize_amount( $rate['rate'] ); |
|
348 | + $rate['name'] = sanitize_text_field( $rate['name'] ); |
|
349 | + $rate['state'] = sanitize_text_field( $rate['state'] ); |
|
350 | + $rate['country'] = sanitize_text_field( $rate['country'] ); |
|
351 | + $rate['global'] = empty( $rate['state'] ); |
|
352 | + $tax_rates[] = $rate; |
|
353 | 353 | |
354 | - } |
|
354 | + } |
|
355 | 355 | |
356 | 356 | update_option( 'wpinv_tax_rates', $tax_rates ); |
357 | 357 | |
@@ -364,21 +364,21 @@ discard block |
||
364 | 364 | return $input; |
365 | 365 | } |
366 | 366 | |
367 | - if ( empty( $_POST['wpinv_tax_rules_nonce'] ) || ! wp_verify_nonce( $_POST['wpinv_tax_rules_nonce'], 'wpinv_tax_rules' ) ) { |
|
368 | - return $input; |
|
369 | - } |
|
367 | + if ( empty( $_POST['wpinv_tax_rules_nonce'] ) || ! wp_verify_nonce( $_POST['wpinv_tax_rules_nonce'], 'wpinv_tax_rules' ) ) { |
|
368 | + return $input; |
|
369 | + } |
|
370 | 370 | |
371 | 371 | $new_rules = ! empty( $_POST['tax_rules'] ) ? wp_kses_post_deep( array_values( $_POST['tax_rules'] ) ) : array(); |
372 | 372 | $tax_rules = array(); |
373 | 373 | |
374 | 374 | foreach ( $new_rules as $rule ) { |
375 | 375 | |
376 | - $rule['key'] = sanitize_title_with_dashes( $rule['key'] ); |
|
377 | - $rule['label'] = sanitize_text_field( $rule['label'] ); |
|
378 | - $rule['tax_base'] = sanitize_text_field( $rule['tax_base'] ); |
|
379 | - $tax_rules[] = $rule; |
|
376 | + $rule['key'] = sanitize_title_with_dashes( $rule['key'] ); |
|
377 | + $rule['label'] = sanitize_text_field( $rule['label'] ); |
|
378 | + $rule['tax_base'] = sanitize_text_field( $rule['tax_base'] ); |
|
379 | + $tax_rules[] = $rule; |
|
380 | 380 | |
381 | - } |
|
381 | + } |
|
382 | 382 | |
383 | 383 | update_option( 'wpinv_tax_rules', $tax_rules ); |
384 | 384 | |
@@ -391,11 +391,11 @@ discard block |
||
391 | 391 | $tabs['general'] = __( 'General', 'invoicing' ); |
392 | 392 | $tabs['gateways'] = __( 'Payment Gateways', 'invoicing' ); |
393 | 393 | $tabs['taxes'] = __( 'Taxes', 'invoicing' ); |
394 | - $tabs['emails'] = __( 'Emails', 'invoicing' ); |
|
394 | + $tabs['emails'] = __( 'Emails', 'invoicing' ); |
|
395 | 395 | |
396 | - if ( count( getpaid_get_integration_settings() ) > 0 ) { |
|
397 | - $tabs['integrations'] = __( 'Integrations', 'invoicing' ); |
|
398 | - } |
|
396 | + if ( count( getpaid_get_integration_settings() ) > 0 ) { |
|
397 | + $tabs['integrations'] = __( 'Integrations', 'invoicing' ); |
|
398 | + } |
|
399 | 399 | |
400 | 400 | $tabs['privacy'] = __( 'Privacy', 'invoicing' ); |
401 | 401 | $tabs['misc'] = __( 'Misc', 'invoicing' ); |
@@ -426,53 +426,53 @@ discard block |
||
426 | 426 | 'general' => apply_filters( |
427 | 427 | 'wpinv_settings_sections_general', |
428 | 428 | array( |
429 | - 'main' => __( 'General Settings', 'invoicing' ), |
|
430 | - 'page_section' => __( 'Page Settings', 'invoicing' ), |
|
431 | - 'currency_section' => __( 'Currency Settings', 'invoicing' ), |
|
432 | - 'labels' => __( 'Label Texts', 'invoicing' ), |
|
429 | + 'main' => __( 'General Settings', 'invoicing' ), |
|
430 | + 'page_section' => __( 'Page Settings', 'invoicing' ), |
|
431 | + 'currency_section' => __( 'Currency Settings', 'invoicing' ), |
|
432 | + 'labels' => __( 'Label Texts', 'invoicing' ), |
|
433 | 433 | ) |
434 | 434 | ), |
435 | 435 | 'gateways' => apply_filters( |
436 | 436 | 'wpinv_settings_sections_gateways', |
437 | 437 | array( |
438 | - 'main' => __( 'Gateway Settings', 'invoicing' ), |
|
438 | + 'main' => __( 'Gateway Settings', 'invoicing' ), |
|
439 | 439 | ) |
440 | 440 | ), |
441 | 441 | 'taxes' => apply_filters( |
442 | 442 | 'wpinv_settings_sections_taxes', |
443 | 443 | array( |
444 | - 'main' => __( 'Tax Settings', 'invoicing' ), |
|
445 | - 'rules' => __( 'Tax Rules', 'invoicing' ), |
|
446 | - 'rates' => __( 'Tax Rates', 'invoicing' ), |
|
447 | - 'vat' => __( 'EU VAT Settings', 'invoicing' ), |
|
444 | + 'main' => __( 'Tax Settings', 'invoicing' ), |
|
445 | + 'rules' => __( 'Tax Rules', 'invoicing' ), |
|
446 | + 'rates' => __( 'Tax Rates', 'invoicing' ), |
|
447 | + 'vat' => __( 'EU VAT Settings', 'invoicing' ), |
|
448 | 448 | ) |
449 | 449 | ), |
450 | 450 | 'emails' => apply_filters( |
451 | 451 | 'wpinv_settings_sections_emails', |
452 | 452 | array( |
453 | - 'main' => __( 'Email Settings', 'invoicing' ), |
|
453 | + 'main' => __( 'Email Settings', 'invoicing' ), |
|
454 | 454 | ) |
455 | 455 | ), |
456 | 456 | |
457 | - 'integrations' => wp_list_pluck( getpaid_get_integration_settings(), 'label', 'id' ), |
|
457 | + 'integrations' => wp_list_pluck( getpaid_get_integration_settings(), 'label', 'id' ), |
|
458 | 458 | |
459 | 459 | 'privacy' => apply_filters( |
460 | 460 | 'wpinv_settings_sections_privacy', |
461 | 461 | array( |
462 | - 'main' => __( 'Privacy policy', 'invoicing' ), |
|
462 | + 'main' => __( 'Privacy policy', 'invoicing' ), |
|
463 | 463 | ) |
464 | 464 | ), |
465 | 465 | 'misc' => apply_filters( |
466 | 466 | 'wpinv_settings_sections_misc', |
467 | 467 | array( |
468 | - 'main' => __( 'Miscellaneous', 'invoicing' ), |
|
469 | - 'custom-css' => __( 'Custom CSS', 'invoicing' ), |
|
468 | + 'main' => __( 'Miscellaneous', 'invoicing' ), |
|
469 | + 'custom-css' => __( 'Custom CSS', 'invoicing' ), |
|
470 | 470 | ) |
471 | 471 | ), |
472 | 472 | 'tools' => apply_filters( |
473 | 473 | 'wpinv_settings_sections_tools', |
474 | 474 | array( |
475 | - 'main' => __( 'Diagnostic Tools', 'invoicing' ), |
|
475 | + 'main' => __( 'Diagnostic Tools', 'invoicing' ), |
|
476 | 476 | ) |
477 | 477 | ), |
478 | 478 | ); |
@@ -483,46 +483,46 @@ discard block |
||
483 | 483 | } |
484 | 484 | |
485 | 485 | function wpinv_get_pages( $with_slug = false, $default_label = null ) { |
486 | - $pages_options = array(); |
|
486 | + $pages_options = array(); |
|
487 | 487 | |
488 | - if ( $default_label !== null && $default_label !== false ) { |
|
489 | - $pages_options = array( '' => $default_label ); // Blank option |
|
490 | - } |
|
488 | + if ( $default_label !== null && $default_label !== false ) { |
|
489 | + $pages_options = array( '' => $default_label ); // Blank option |
|
490 | + } |
|
491 | 491 | |
492 | - $pages = get_pages(); |
|
493 | - if ( $pages ) { |
|
494 | - foreach ( $pages as $page ) { |
|
495 | - $title = $with_slug ? $page->post_title . ' (' . $page->post_name . ')' : $page->post_title; |
|
492 | + $pages = get_pages(); |
|
493 | + if ( $pages ) { |
|
494 | + foreach ( $pages as $page ) { |
|
495 | + $title = $with_slug ? $page->post_title . ' (' . $page->post_name . ')' : $page->post_title; |
|
496 | 496 | $pages_options[ $page->ID ] = $title; |
497 | - } |
|
498 | - } |
|
497 | + } |
|
498 | + } |
|
499 | 499 | |
500 | - return $pages_options; |
|
500 | + return $pages_options; |
|
501 | 501 | } |
502 | 502 | |
503 | 503 | function wpinv_header_callback( $args ) { |
504 | - if ( ! empty( $args['desc'] ) ) { |
|
504 | + if ( ! empty( $args['desc'] ) ) { |
|
505 | 505 | echo wp_kses_post( $args['desc'] ); |
506 | 506 | } |
507 | 507 | } |
508 | 508 | |
509 | 509 | function wpinv_hidden_callback( $args ) { |
510 | 510 | |
511 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
512 | - $value = wpinv_get_option( $args['id'], $std ); |
|
511 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
512 | + $value = wpinv_get_option( $args['id'], $std ); |
|
513 | 513 | |
514 | - if ( isset( $args['set_value'] ) ) { |
|
515 | - $value = $args['set_value']; |
|
516 | - } |
|
514 | + if ( isset( $args['set_value'] ) ) { |
|
515 | + $value = $args['set_value']; |
|
516 | + } |
|
517 | 517 | |
518 | - if ( isset( $args['faux'] ) && true === $args['faux'] ) { |
|
519 | - $args['readonly'] = true; |
|
520 | - $name = ''; |
|
521 | - } else { |
|
522 | - $name = 'wpinv_settings[' . esc_attr( $args['id'] ) . ']'; |
|
523 | - } |
|
518 | + if ( isset( $args['faux'] ) && true === $args['faux'] ) { |
|
519 | + $args['readonly'] = true; |
|
520 | + $name = ''; |
|
521 | + } else { |
|
522 | + $name = 'wpinv_settings[' . esc_attr( $args['id'] ) . ']'; |
|
523 | + } |
|
524 | 524 | |
525 | - echo '<input type="hidden" id="wpinv_settings[' . esc_attr( $args['id'] ) . ']" name="' . esc_attr( $name ) . '" value="' . esc_attr( stripslashes( $value ) ) . '" />'; |
|
525 | + echo '<input type="hidden" id="wpinv_settings[' . esc_attr( $args['id'] ) . ']" name="' . esc_attr( $name ) . '" value="' . esc_attr( stripslashes( $value ) ) . '" />'; |
|
526 | 526 | |
527 | 527 | } |
528 | 528 | |
@@ -531,12 +531,12 @@ discard block |
||
531 | 531 | */ |
532 | 532 | function wpinv_checkbox_callback( $args ) { |
533 | 533 | |
534 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
535 | - $std = wpinv_get_option( $args['id'], $std ); |
|
536 | - $id = esc_attr( $args['id'] ); |
|
534 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
535 | + $std = wpinv_get_option( $args['id'], $std ); |
|
536 | + $id = esc_attr( $args['id'] ); |
|
537 | 537 | |
538 | - getpaid_hidden_field( "wpinv_settings[$id]", '0' ); |
|
539 | - ?> |
|
538 | + getpaid_hidden_field( "wpinv_settings[$id]", '0' ); |
|
539 | + ?> |
|
540 | 540 | <label> |
541 | 541 | <input id="wpinv-settings-<?php echo esc_attr( $id ); ?>" name="wpinv_settings[<?php echo esc_attr( $id ); ?>]" <?php checked( empty( $std ), false ); ?> value="1" type="checkbox" /> |
542 | 542 | <?php echo wp_kses_post( $args['desc'] ); ?> |
@@ -546,75 +546,75 @@ discard block |
||
546 | 546 | |
547 | 547 | function wpinv_multicheck_callback( $args ) { |
548 | 548 | |
549 | - $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
|
550 | - $class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : ''; |
|
549 | + $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
|
550 | + $class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : ''; |
|
551 | 551 | |
552 | - if ( ! empty( $args['options'] ) ) { |
|
552 | + if ( ! empty( $args['options'] ) ) { |
|
553 | 553 | |
554 | - $std = isset( $args['std'] ) ? $args['std'] : array(); |
|
555 | - $value = wpinv_get_option( $args['id'], $std ); |
|
554 | + $std = isset( $args['std'] ) ? $args['std'] : array(); |
|
555 | + $value = wpinv_get_option( $args['id'], $std ); |
|
556 | 556 | |
557 | - echo '<div class="wpi-mcheck-rows wpi-mcheck-' . esc_attr( $sanitize_id . $class ) . '">'; |
|
557 | + echo '<div class="wpi-mcheck-rows wpi-mcheck-' . esc_attr( $sanitize_id . $class ) . '">'; |
|
558 | 558 | foreach ( $args['options'] as $key => $option ) : |
559 | - $sanitize_key = esc_attr( wpinv_sanitize_key( $key ) ); |
|
560 | - if ( in_array( $sanitize_key, $value ) ) { |
|
561 | - $enabled = $sanitize_key; |
|
562 | - } else { |
|
563 | - $enabled = null; |
|
564 | - } |
|
565 | - echo '<div class="wpi-mcheck-row"><input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $sanitize_key ) . '" ' . checked( $sanitize_key, $enabled, false ) . '/> '; |
|
566 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']">' . wp_kses_post( $option ) . '</label></div>'; |
|
567 | - endforeach; |
|
568 | - echo '</div>'; |
|
569 | - echo '<p class="description">' . wp_kses_post( $args['desc'] ) . '</p>'; |
|
570 | - } |
|
559 | + $sanitize_key = esc_attr( wpinv_sanitize_key( $key ) ); |
|
560 | + if ( in_array( $sanitize_key, $value ) ) { |
|
561 | + $enabled = $sanitize_key; |
|
562 | + } else { |
|
563 | + $enabled = null; |
|
564 | + } |
|
565 | + echo '<div class="wpi-mcheck-row"><input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $sanitize_key ) . '" ' . checked( $sanitize_key, $enabled, false ) . '/> '; |
|
566 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']">' . wp_kses_post( $option ) . '</label></div>'; |
|
567 | + endforeach; |
|
568 | + echo '</div>'; |
|
569 | + echo '<p class="description">' . wp_kses_post( $args['desc'] ) . '</p>'; |
|
570 | + } |
|
571 | 571 | } |
572 | 572 | |
573 | 573 | function wpinv_payment_icons_callback( $args ) { |
574 | 574 | |
575 | 575 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
576 | - $value = wpinv_get_option( $args['id'], false ); |
|
576 | + $value = wpinv_get_option( $args['id'], false ); |
|
577 | 577 | |
578 | - if ( ! empty( $args['options'] ) ) { |
|
579 | - foreach ( $args['options'] as $key => $option ) { |
|
578 | + if ( ! empty( $args['options'] ) ) { |
|
579 | + foreach ( $args['options'] as $key => $option ) { |
|
580 | 580 | $sanitize_key = wpinv_sanitize_key( $key ); |
581 | 581 | |
582 | - if ( empty( $value ) ) { |
|
583 | - $enabled = $option; |
|
584 | - } else { |
|
585 | - $enabled = null; |
|
586 | - } |
|
587 | - |
|
588 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" style="margin-right:10px;line-height:16px;height:16px;display:inline-block;">'; |
|
589 | - |
|
590 | - echo '<input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $option ) . '" ' . checked( $option, $enabled, false ) . '/> '; |
|
591 | - |
|
592 | - if ( wpinv_string_is_image_url( $key ) ) { |
|
593 | - echo '<img class="payment-icon" src="' . esc_url( $key ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>'; |
|
594 | - } else { |
|
595 | - $card = strtolower( str_replace( ' ', '', $option ) ); |
|
596 | - |
|
597 | - if ( has_filter( 'wpinv_accepted_payment_' . $card . '_image' ) ) { |
|
598 | - $image = apply_filters( 'wpinv_accepted_payment_' . $card . '_image', '' ); |
|
599 | - } else { |
|
600 | - $image = wpinv_locate_template( 'images' . DIRECTORY_SEPARATOR . 'icons' . DIRECTORY_SEPARATOR . $card . '.gif', false ); |
|
601 | - $content_dir = WP_CONTENT_DIR; |
|
602 | - |
|
603 | - if ( function_exists( 'wp_normalize_path' ) ) { |
|
604 | - // Replaces backslashes with forward slashes for Windows systems |
|
605 | - $image = wp_normalize_path( $image ); |
|
606 | - $content_dir = wp_normalize_path( $content_dir ); |
|
607 | - } |
|
608 | - |
|
609 | - $image = str_replace( $content_dir, content_url(), $image ); |
|
610 | - } |
|
611 | - |
|
612 | - echo '<img class="payment-icon" src="' . esc_url( $image ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>'; |
|
613 | - } |
|
614 | - echo wp_kses_post( $option ) . '</label>'; |
|
615 | - } |
|
616 | - echo '<p class="description" style="margin-top:16px;">' . wp_kses_post( $args['desc'] ) . '</p>'; |
|
617 | - } |
|
582 | + if ( empty( $value ) ) { |
|
583 | + $enabled = $option; |
|
584 | + } else { |
|
585 | + $enabled = null; |
|
586 | + } |
|
587 | + |
|
588 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" style="margin-right:10px;line-height:16px;height:16px;display:inline-block;">'; |
|
589 | + |
|
590 | + echo '<input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $option ) . '" ' . checked( $option, $enabled, false ) . '/> '; |
|
591 | + |
|
592 | + if ( wpinv_string_is_image_url( $key ) ) { |
|
593 | + echo '<img class="payment-icon" src="' . esc_url( $key ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>'; |
|
594 | + } else { |
|
595 | + $card = strtolower( str_replace( ' ', '', $option ) ); |
|
596 | + |
|
597 | + if ( has_filter( 'wpinv_accepted_payment_' . $card . '_image' ) ) { |
|
598 | + $image = apply_filters( 'wpinv_accepted_payment_' . $card . '_image', '' ); |
|
599 | + } else { |
|
600 | + $image = wpinv_locate_template( 'images' . DIRECTORY_SEPARATOR . 'icons' . DIRECTORY_SEPARATOR . $card . '.gif', false ); |
|
601 | + $content_dir = WP_CONTENT_DIR; |
|
602 | + |
|
603 | + if ( function_exists( 'wp_normalize_path' ) ) { |
|
604 | + // Replaces backslashes with forward slashes for Windows systems |
|
605 | + $image = wp_normalize_path( $image ); |
|
606 | + $content_dir = wp_normalize_path( $content_dir ); |
|
607 | + } |
|
608 | + |
|
609 | + $image = str_replace( $content_dir, content_url(), $image ); |
|
610 | + } |
|
611 | + |
|
612 | + echo '<img class="payment-icon" src="' . esc_url( $image ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>'; |
|
613 | + } |
|
614 | + echo wp_kses_post( $option ) . '</label>'; |
|
615 | + } |
|
616 | + echo '<p class="description" style="margin-top:16px;">' . wp_kses_post( $args['desc'] ) . '</p>'; |
|
617 | + } |
|
618 | 618 | } |
619 | 619 | |
620 | 620 | /** |
@@ -622,9 +622,9 @@ discard block |
||
622 | 622 | */ |
623 | 623 | function wpinv_radio_callback( $args ) { |
624 | 624 | |
625 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
626 | - $std = wpinv_get_option( $args['id'], $std ); |
|
627 | - ?> |
|
625 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
626 | + $std = wpinv_get_option( $args['id'], $std ); |
|
627 | + ?> |
|
628 | 628 | <fieldset> |
629 | 629 | <ul id="wpinv-settings-<?php echo esc_attr( $args['id'] ); ?>" style="margin-top: 0;"> |
630 | 630 | <?php foreach ( $args['options'] as $key => $option ) : ?> |
@@ -638,7 +638,7 @@ discard block |
||
638 | 638 | </ul> |
639 | 639 | </fieldset> |
640 | 640 | <?php |
641 | - getpaid_settings_description_callback( $args ); |
|
641 | + getpaid_settings_description_callback( $args ); |
|
642 | 642 | } |
643 | 643 | |
644 | 644 | /** |
@@ -646,10 +646,10 @@ discard block |
||
646 | 646 | */ |
647 | 647 | function getpaid_settings_description_callback( $args ) { |
648 | 648 | |
649 | - if ( ! empty( $args['desc'] ) ) { |
|
650 | - $description = $args['desc']; |
|
651 | - echo wp_kses_post( "<p class='description'>$description</p>" ); |
|
652 | - } |
|
649 | + if ( ! empty( $args['desc'] ) ) { |
|
650 | + $description = $args['desc']; |
|
651 | + echo wp_kses_post( "<p class='description'>$description</p>" ); |
|
652 | + } |
|
653 | 653 | |
654 | 654 | } |
655 | 655 | |
@@ -658,7 +658,7 @@ discard block |
||
658 | 658 | */ |
659 | 659 | function wpinv_gateways_callback() { |
660 | 660 | |
661 | - ?> |
|
661 | + ?> |
|
662 | 662 | </td> |
663 | 663 | </tr> |
664 | 664 | <tr class="bsui"> |
@@ -672,26 +672,26 @@ discard block |
||
672 | 672 | |
673 | 673 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
674 | 674 | $class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : ''; |
675 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
676 | - $value = wpinv_get_option( $args['id'], $std ); |
|
675 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
676 | + $value = wpinv_get_option( $args['id'], $std ); |
|
677 | 677 | |
678 | - echo '<select name="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" class="' . esc_attr( $class ) . '" >'; |
|
678 | + echo '<select name="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" class="' . esc_attr( $class ) . '" >'; |
|
679 | 679 | |
680 | - foreach ( $args['options'] as $key => $option ) : |
|
680 | + foreach ( $args['options'] as $key => $option ) : |
|
681 | 681 | |
682 | - echo '<option value="' . esc_attr( $key ) . '" '; |
|
682 | + echo '<option value="' . esc_attr( $key ) . '" '; |
|
683 | 683 | |
684 | - if ( isset( $args['selected'] ) && $args['selected'] !== null && $args['selected'] !== false ) { |
|
684 | + if ( isset( $args['selected'] ) && $args['selected'] !== null && $args['selected'] !== false ) { |
|
685 | 685 | selected( $key, $args['selected'] ); |
686 | 686 | } else { |
687 | 687 | selected( $key, $value ); |
688 | 688 | } |
689 | 689 | |
690 | - echo '>' . esc_html( $option['admin_label'] ) . '</option>'; |
|
691 | - endforeach; |
|
690 | + echo '>' . esc_html( $option['admin_label'] ) . '</option>'; |
|
691 | + endforeach; |
|
692 | 692 | |
693 | - echo '</select>'; |
|
694 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
693 | + echo '</select>'; |
|
694 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
695 | 695 | } |
696 | 696 | |
697 | 697 | /** |
@@ -702,38 +702,38 @@ discard block |
||
702 | 702 | */ |
703 | 703 | function wpinv_settings_attrs_helper( $args ) { |
704 | 704 | |
705 | - $value = isset( $args['std'] ) ? $args['std'] : ''; |
|
706 | - $id = esc_attr( $args['id'] ); |
|
707 | - $value = is_scalar( $value ) ? $value : ''; |
|
708 | - |
|
709 | - $attrs = array( |
|
710 | - 'name' => ! empty( $args['faux'] ) ? false : "wpinv_settings[$id]", |
|
711 | - 'readonly' => ! empty( $args['faux'] ), |
|
712 | - 'value' => ! empty( $args['faux'] ) ? $value : wpinv_get_option( $args['id'], $value ), |
|
713 | - 'id' => 'wpinv-settings-' . $args['id'], |
|
714 | - 'style' => $args['style'], |
|
715 | - 'class' => $args['class'], |
|
716 | - 'placeholder' => $args['placeholder'], |
|
717 | - 'data-placeholder' => $args['placeholder'], |
|
718 | - ); |
|
705 | + $value = isset( $args['std'] ) ? $args['std'] : ''; |
|
706 | + $id = esc_attr( $args['id'] ); |
|
707 | + $value = is_scalar( $value ) ? $value : ''; |
|
708 | + |
|
709 | + $attrs = array( |
|
710 | + 'name' => ! empty( $args['faux'] ) ? false : "wpinv_settings[$id]", |
|
711 | + 'readonly' => ! empty( $args['faux'] ), |
|
712 | + 'value' => ! empty( $args['faux'] ) ? $value : wpinv_get_option( $args['id'], $value ), |
|
713 | + 'id' => 'wpinv-settings-' . $args['id'], |
|
714 | + 'style' => $args['style'], |
|
715 | + 'class' => $args['class'], |
|
716 | + 'placeholder' => $args['placeholder'], |
|
717 | + 'data-placeholder' => $args['placeholder'], |
|
718 | + ); |
|
719 | 719 | |
720 | - if ( ! empty( $args['onchange'] ) ) { |
|
721 | - $attrs['onchange'] = $args['onchange']; |
|
722 | - } |
|
720 | + if ( ! empty( $args['onchange'] ) ) { |
|
721 | + $attrs['onchange'] = $args['onchange']; |
|
722 | + } |
|
723 | 723 | |
724 | - foreach ( $attrs as $key => $value ) { |
|
724 | + foreach ( $attrs as $key => $value ) { |
|
725 | 725 | |
726 | - if ( false === $value ) { |
|
727 | - continue; |
|
728 | - } |
|
726 | + if ( false === $value ) { |
|
727 | + continue; |
|
728 | + } |
|
729 | 729 | |
730 | - if ( true === $value ) { |
|
731 | - echo ' ' . esc_attr( $key ); |
|
732 | - } else { |
|
733 | - echo ' ' . esc_attr( $key ) . '="' . esc_attr( $value ) . '"'; |
|
734 | - } |
|
730 | + if ( true === $value ) { |
|
731 | + echo ' ' . esc_attr( $key ); |
|
732 | + } else { |
|
733 | + echo ' ' . esc_attr( $key ) . '="' . esc_attr( $value ) . '"'; |
|
734 | + } |
|
735 | 735 | |
736 | - } |
|
736 | + } |
|
737 | 737 | |
738 | 738 | } |
739 | 739 | |
@@ -742,7 +742,7 @@ discard block |
||
742 | 742 | */ |
743 | 743 | function wpinv_text_callback( $args ) { |
744 | 744 | |
745 | - ?> |
|
745 | + ?> |
|
746 | 746 | <label style="width: 100%;"> |
747 | 747 | <input type="text" <?php wpinv_settings_attrs_helper( $args ); ?>> |
748 | 748 | <?php getpaid_settings_description_callback( $args ); ?> |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | */ |
757 | 757 | function wpinv_number_callback( $args ) { |
758 | 758 | |
759 | - ?> |
|
759 | + ?> |
|
760 | 760 | <label style="width: 100%;"> |
761 | 761 | <input type="number" step="<?php echo esc_attr( $args['step'] ); ?>" max="<?php echo intval( $args['max'] ); ?>" min="<?php echo intval( $args['min'] ); ?>" <?php wpinv_settings_attrs_helper( $args ); ?>> |
762 | 762 | <?php getpaid_settings_description_callback( $args ); ?> |
@@ -768,34 +768,34 @@ discard block |
||
768 | 768 | function wpinv_textarea_callback( $args ) { |
769 | 769 | |
770 | 770 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
771 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
772 | - $value = wpinv_get_option( $args['id'], $std ); |
|
771 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
772 | + $value = wpinv_get_option( $args['id'], $std ); |
|
773 | 773 | |
774 | 774 | $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular'; |
775 | 775 | $class = ( isset( $args['class'] ) && ! is_null( $args['class'] ) ) ? $args['class'] : 'large-text'; |
776 | 776 | |
777 | - echo '<textarea class="' . esc_attr( $class ) . ' txtarea-' . esc_attr( $size ) . ' wpi-' . esc_attr( sanitize_html_class( $sanitize_id ) ) . ' " cols="' . esc_attr( $args['cols'] ) . '" rows="' . esc_attr( $args['rows'] ) . '" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']">' . esc_textarea( stripslashes( $value ) ) . '</textarea>'; |
|
778 | - echo '<br /><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
777 | + echo '<textarea class="' . esc_attr( $class ) . ' txtarea-' . esc_attr( $size ) . ' wpi-' . esc_attr( sanitize_html_class( $sanitize_id ) ) . ' " cols="' . esc_attr( $args['cols'] ) . '" rows="' . esc_attr( $args['rows'] ) . '" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']">' . esc_textarea( stripslashes( $value ) ) . '</textarea>'; |
|
778 | + echo '<br /><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
779 | 779 | |
780 | 780 | } |
781 | 781 | |
782 | 782 | function wpinv_password_callback( $args ) { |
783 | 783 | |
784 | 784 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
785 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
786 | - $value = wpinv_get_option( $args['id'], $std ); |
|
785 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
786 | + $value = wpinv_get_option( $args['id'], $std ); |
|
787 | 787 | |
788 | - $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular'; |
|
789 | - echo '<input type="password" class="' . esc_attr( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '"/>'; |
|
790 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
788 | + $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular'; |
|
789 | + echo '<input type="password" class="' . esc_attr( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '"/>'; |
|
790 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
791 | 791 | |
792 | 792 | } |
793 | 793 | |
794 | 794 | function wpinv_missing_callback( $args ) { |
795 | - printf( |
|
796 | - esc_html__( 'The callback function used for the %s setting is missing.', 'invoicing' ), |
|
797 | - '<strong>' . esc_html( $args['id'] ) . '</strong>' |
|
798 | - ); |
|
795 | + printf( |
|
796 | + esc_html__( 'The callback function used for the %s setting is missing.', 'invoicing' ), |
|
797 | + '<strong>' . esc_html( $args['id'] ) . '</strong>' |
|
798 | + ); |
|
799 | 799 | } |
800 | 800 | |
801 | 801 | /** |
@@ -803,13 +803,13 @@ discard block |
||
803 | 803 | */ |
804 | 804 | function wpinv_select_callback( $args ) { |
805 | 805 | |
806 | - $desc = wp_kses_post( $args['desc'] ); |
|
807 | - $desc = empty( $desc ) ? '' : "<p class='description'>$desc</p>"; |
|
808 | - $value = isset( $args['std'] ) ? $args['std'] : ''; |
|
809 | - $value = wpinv_get_option( $args['id'], $value ); |
|
810 | - $rand = uniqid( 'random_id' ); |
|
806 | + $desc = wp_kses_post( $args['desc'] ); |
|
807 | + $desc = empty( $desc ) ? '' : "<p class='description'>$desc</p>"; |
|
808 | + $value = isset( $args['std'] ) ? $args['std'] : ''; |
|
809 | + $value = wpinv_get_option( $args['id'], $value ); |
|
810 | + $rand = uniqid( 'random_id' ); |
|
811 | 811 | |
812 | - ?> |
|
812 | + ?> |
|
813 | 813 | <label style="width: 100%;"> |
814 | 814 | <select <?php wpinv_settings_attrs_helper( $args ); ?> data-allow-clear="true"> |
815 | 815 | <?php foreach ( $args['options'] as $option => $name ) : ?> |
@@ -842,50 +842,50 @@ discard block |
||
842 | 842 | function wpinv_color_select_callback( $args ) { |
843 | 843 | |
844 | 844 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
845 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
846 | - $value = wpinv_get_option( $args['id'], $std ); |
|
845 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
846 | + $value = wpinv_get_option( $args['id'], $std ); |
|
847 | 847 | |
848 | - echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']"/>'; |
|
848 | + echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']"/>'; |
|
849 | 849 | |
850 | - foreach ( $args['options'] as $option => $color ) { |
|
851 | - echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $color['label'] ) . '</option>'; |
|
852 | - } |
|
850 | + foreach ( $args['options'] as $option => $color ) { |
|
851 | + echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $color['label'] ) . '</option>'; |
|
852 | + } |
|
853 | 853 | |
854 | - echo '</select>'; |
|
855 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
854 | + echo '</select>'; |
|
855 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
856 | 856 | |
857 | 857 | } |
858 | 858 | |
859 | 859 | function wpinv_rich_editor_callback( $args ) { |
860 | - global $wp_version; |
|
860 | + global $wp_version; |
|
861 | 861 | |
862 | 862 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
863 | 863 | |
864 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
865 | - $value = wpinv_get_option( $args['id'], $std ); |
|
864 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
865 | + $value = wpinv_get_option( $args['id'], $std ); |
|
866 | 866 | |
867 | - if ( ! empty( $args['allow_blank'] ) && empty( $value ) ) { |
|
868 | - $value = $std; |
|
869 | - } |
|
867 | + if ( ! empty( $args['allow_blank'] ) && empty( $value ) ) { |
|
868 | + $value = $std; |
|
869 | + } |
|
870 | 870 | |
871 | - $rows = isset( $args['size'] ) ? $args['size'] : 20; |
|
871 | + $rows = isset( $args['size'] ) ? $args['size'] : 20; |
|
872 | 872 | |
873 | - echo '<div class="getpaid-settings-editor-input">'; |
|
874 | - if ( $wp_version >= 3.3 && function_exists( 'wp_editor' ) ) { |
|
875 | - wp_editor( |
|
873 | + echo '<div class="getpaid-settings-editor-input">'; |
|
874 | + if ( $wp_version >= 3.3 && function_exists( 'wp_editor' ) ) { |
|
875 | + wp_editor( |
|
876 | 876 | stripslashes( $value ), |
877 | 877 | 'wpinv_settings_' . esc_attr( $args['id'] ), |
878 | 878 | array( |
879 | - 'textarea_name' => 'wpinv_settings[' . esc_attr( $args['id'] ) . ']', |
|
880 | - 'textarea_rows' => absint( $rows ), |
|
881 | - 'media_buttons' => false, |
|
879 | + 'textarea_name' => 'wpinv_settings[' . esc_attr( $args['id'] ) . ']', |
|
880 | + 'textarea_rows' => absint( $rows ), |
|
881 | + 'media_buttons' => false, |
|
882 | 882 | ) |
883 | 883 | ); |
884 | - } else { |
|
885 | - echo '<textarea class="large-text" rows="10" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="wpi-' . esc_attr( sanitize_html_class( $args['id'] ) ) . '">' . esc_textarea( stripslashes( $value ) ) . '</textarea>'; |
|
886 | - } |
|
884 | + } else { |
|
885 | + echo '<textarea class="large-text" rows="10" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="wpi-' . esc_attr( sanitize_html_class( $args['id'] ) ) . '">' . esc_textarea( stripslashes( $value ) ) . '</textarea>'; |
|
886 | + } |
|
887 | 887 | |
888 | - echo '</div><br/><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
888 | + echo '</div><br/><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
889 | 889 | |
890 | 890 | } |
891 | 891 | |
@@ -893,51 +893,51 @@ discard block |
||
893 | 893 | |
894 | 894 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
895 | 895 | |
896 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
897 | - $value = wpinv_get_option( $args['id'], $std ); |
|
896 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
897 | + $value = wpinv_get_option( $args['id'], $std ); |
|
898 | 898 | |
899 | - $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular'; |
|
900 | - echo '<input type="text" class="' . sanitize_html_class( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( stripslashes( $value ) ) . '"/>'; |
|
901 | - echo '<span> <input type="button" class="wpinv_settings_upload_button button-secondary" value="' . esc_attr__( 'Upload File', 'invoicing' ) . '"/></span>'; |
|
902 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
899 | + $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular'; |
|
900 | + echo '<input type="text" class="' . sanitize_html_class( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( stripslashes( $value ) ) . '"/>'; |
|
901 | + echo '<span> <input type="button" class="wpinv_settings_upload_button button-secondary" value="' . esc_attr__( 'Upload File', 'invoicing' ) . '"/></span>'; |
|
902 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
903 | 903 | |
904 | 904 | } |
905 | 905 | |
906 | 906 | function wpinv_color_callback( $args ) { |
907 | 907 | |
908 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
909 | - $value = wpinv_get_option( $args['id'], $std ); |
|
908 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
909 | + $value = wpinv_get_option( $args['id'], $std ); |
|
910 | 910 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
911 | 911 | |
912 | - echo '<input type="text" class="wpinv-color-picker" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '" data-default-color="' . esc_attr( $std ) . '" />'; |
|
913 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
912 | + echo '<input type="text" class="wpinv-color-picker" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '" data-default-color="' . esc_attr( $std ) . '" />'; |
|
913 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
914 | 914 | |
915 | 915 | } |
916 | 916 | |
917 | 917 | function wpinv_country_states_callback( $args ) { |
918 | 918 | |
919 | - $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
920 | - $value = wpinv_get_option( $args['id'], $std ); |
|
919 | + $std = isset( $args['std'] ) ? $args['std'] : ''; |
|
920 | + $value = wpinv_get_option( $args['id'], $std ); |
|
921 | 921 | |
922 | 922 | $sanitize_id = wpinv_sanitize_key( $args['id'] ); |
923 | 923 | |
924 | - if ( isset( $args['placeholder'] ) ) { |
|
925 | - $placeholder = $args['placeholder']; |
|
926 | - } else { |
|
927 | - $placeholder = ''; |
|
928 | - } |
|
924 | + if ( isset( $args['placeholder'] ) ) { |
|
925 | + $placeholder = $args['placeholder']; |
|
926 | + } else { |
|
927 | + $placeholder = ''; |
|
928 | + } |
|
929 | 929 | |
930 | - $states = wpinv_get_country_states(); |
|
930 | + $states = wpinv_get_country_states(); |
|
931 | 931 | |
932 | - $class = empty( $states ) ? 'wpinv-no-states' : 'wpi_select2'; |
|
933 | - echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="' . esc_attr( $class ) . '" data-placeholder="' . esc_html( $placeholder ) . '"/>'; |
|
932 | + $class = empty( $states ) ? 'wpinv-no-states' : 'wpi_select2'; |
|
933 | + echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="' . esc_attr( $class ) . '" data-placeholder="' . esc_html( $placeholder ) . '"/>'; |
|
934 | 934 | |
935 | - foreach ( $states as $option => $name ) { |
|
936 | - echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $name ) . '</option>'; |
|
937 | - } |
|
935 | + foreach ( $states as $option => $name ) { |
|
936 | + echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $name ) . '</option>'; |
|
937 | + } |
|
938 | 938 | |
939 | - echo '</select>'; |
|
940 | - echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
939 | + echo '</select>'; |
|
940 | + echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>'; |
|
941 | 941 | |
942 | 942 | } |
943 | 943 | |
@@ -946,7 +946,7 @@ discard block |
||
946 | 946 | */ |
947 | 947 | function wpinv_tax_rates_callback() { |
948 | 948 | |
949 | - ?> |
|
949 | + ?> |
|
950 | 950 | </td> |
951 | 951 | </tr> |
952 | 952 | <tr class="bsui"> |
@@ -962,9 +962,9 @@ discard block |
||
962 | 962 | */ |
963 | 963 | function wpinv_tax_rate_callback( $tax_rate, $key ) { |
964 | 964 | |
965 | - $key = sanitize_key( $key ); |
|
966 | - $tax_rate['reduced_rate'] = empty( $tax_rate['reduced_rate'] ) ? 0 : $tax_rate['reduced_rate']; |
|
967 | - include plugin_dir_path( __FILE__ ) . 'views/html-tax-rate-edit.php'; |
|
965 | + $key = sanitize_key( $key ); |
|
966 | + $tax_rate['reduced_rate'] = empty( $tax_rate['reduced_rate'] ) ? 0 : $tax_rate['reduced_rate']; |
|
967 | + include plugin_dir_path( __FILE__ ) . 'views/html-tax-rate-edit.php'; |
|
968 | 968 | |
969 | 969 | } |
970 | 970 | |
@@ -973,7 +973,7 @@ discard block |
||
973 | 973 | */ |
974 | 974 | function wpinv_tax_rules_callback() { |
975 | 975 | |
976 | - ?> |
|
976 | + ?> |
|
977 | 977 | </td> |
978 | 978 | </tr> |
979 | 979 | <tr class="bsui"> |
@@ -1011,14 +1011,14 @@ discard block |
||
1011 | 1011 | <td> |
1012 | 1012 | <a href=" |
1013 | 1013 | <?php |
1014 | - echo esc_url( |
|
1015 | - wp_nonce_url( |
|
1016 | - add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
1017 | - 'getpaid-nonce', |
|
1018 | - 'getpaid-nonce' |
|
1019 | - ) |
|
1020 | - ); |
|
1021 | - ?> |
|
1014 | + echo esc_url( |
|
1015 | + wp_nonce_url( |
|
1016 | + add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
1017 | + 'getpaid-nonce', |
|
1018 | + 'getpaid-nonce' |
|
1019 | + ) |
|
1020 | + ); |
|
1021 | + ?> |
|
1022 | 1022 | " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a> |
1023 | 1023 | </td> |
1024 | 1024 | </tr> |
@@ -1030,14 +1030,14 @@ discard block |
||
1030 | 1030 | <td> |
1031 | 1031 | <a href=" |
1032 | 1032 | <?php |
1033 | - echo esc_url( |
|
1034 | - wp_nonce_url( |
|
1035 | - add_query_arg( 'getpaid-admin-action', 'refresh_permalinks' ), |
|
1036 | - 'getpaid-nonce', |
|
1037 | - 'getpaid-nonce' |
|
1038 | - ) |
|
1039 | - ); |
|
1040 | - ?> |
|
1033 | + echo esc_url( |
|
1034 | + wp_nonce_url( |
|
1035 | + add_query_arg( 'getpaid-admin-action', 'refresh_permalinks' ), |
|
1036 | + 'getpaid-nonce', |
|
1037 | + 'getpaid-nonce' |
|
1038 | + ) |
|
1039 | + ); |
|
1040 | + ?> |
|
1041 | 1041 | " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a> |
1042 | 1042 | </td> |
1043 | 1043 | </tr> |
@@ -1049,14 +1049,14 @@ discard block |
||
1049 | 1049 | <td> |
1050 | 1050 | <a href=" |
1051 | 1051 | <?php |
1052 | - echo esc_url( |
|
1053 | - wp_nonce_url( |
|
1054 | - add_query_arg( 'getpaid-admin-action', 'create_missing_tables' ), |
|
1055 | - 'getpaid-nonce', |
|
1056 | - 'getpaid-nonce' |
|
1057 | - ) |
|
1058 | - ); |
|
1059 | - ?> |
|
1052 | + echo esc_url( |
|
1053 | + wp_nonce_url( |
|
1054 | + add_query_arg( 'getpaid-admin-action', 'create_missing_tables' ), |
|
1055 | + 'getpaid-nonce', |
|
1056 | + 'getpaid-nonce' |
|
1057 | + ) |
|
1058 | + ); |
|
1059 | + ?> |
|
1060 | 1060 | " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a> |
1061 | 1061 | </td> |
1062 | 1062 | </tr> |
@@ -1068,14 +1068,14 @@ discard block |
||
1068 | 1068 | <td> |
1069 | 1069 | <a href=" |
1070 | 1070 | <?php |
1071 | - echo esc_url( |
|
1072 | - wp_nonce_url( |
|
1073 | - add_query_arg( 'getpaid-admin-action', 'migrate_old_invoices' ), |
|
1074 | - 'getpaid-nonce', |
|
1075 | - 'getpaid-nonce' |
|
1076 | - ) |
|
1077 | - ); |
|
1078 | - ?> |
|
1071 | + echo esc_url( |
|
1072 | + wp_nonce_url( |
|
1073 | + add_query_arg( 'getpaid-admin-action', 'migrate_old_invoices' ), |
|
1074 | + 'getpaid-nonce', |
|
1075 | + 'getpaid-nonce' |
|
1076 | + ) |
|
1077 | + ); |
|
1078 | + ?> |
|
1079 | 1079 | " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a> |
1080 | 1080 | </td> |
1081 | 1081 | </tr> |
@@ -1088,14 +1088,14 @@ discard block |
||
1088 | 1088 | <td> |
1089 | 1089 | <a href=" |
1090 | 1090 | <?php |
1091 | - echo esc_url( |
|
1092 | - wp_nonce_url( |
|
1093 | - add_query_arg( 'getpaid-admin-action', 'recalculate_discounts' ), |
|
1094 | - 'getpaid-nonce', |
|
1095 | - 'getpaid-nonce' |
|
1096 | - ) |
|
1097 | - ); |
|
1098 | - ?> |
|
1091 | + echo esc_url( |
|
1092 | + wp_nonce_url( |
|
1093 | + add_query_arg( 'getpaid-admin-action', 'recalculate_discounts' ), |
|
1094 | + 'getpaid-nonce', |
|
1095 | + 'getpaid-nonce' |
|
1096 | + ) |
|
1097 | + ); |
|
1098 | + ?> |
|
1099 | 1099 | " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a> |
1100 | 1100 | </td> |
1101 | 1101 | </tr> |
@@ -1108,8 +1108,8 @@ discard block |
||
1108 | 1108 | <td> |
1109 | 1109 | <a href=" |
1110 | 1110 | <?php |
1111 | - echo esc_url( admin_url( 'index.php?page=gp-setup' ) ); |
|
1112 | - ?> |
|
1111 | + echo esc_url( admin_url( 'index.php?page=gp-setup' ) ); |
|
1112 | + ?> |
|
1113 | 1113 | " class="button button-primary"><?php esc_html_e( 'Launch', 'invoicing' ); ?></a> |
1114 | 1114 | </td> |
1115 | 1115 | </tr> |
@@ -1123,19 +1123,19 @@ discard block |
||
1123 | 1123 | |
1124 | 1124 | |
1125 | 1125 | function wpinv_descriptive_text_callback( $args ) { |
1126 | - echo wp_kses_post( $args['desc'] ); |
|
1126 | + echo wp_kses_post( $args['desc'] ); |
|
1127 | 1127 | } |
1128 | 1128 | |
1129 | 1129 | function wpinv_raw_html_callback( $args ) { |
1130 | - echo wp_kses( $args['desc'], getpaid_allowed_html() ); |
|
1130 | + echo wp_kses( $args['desc'], getpaid_allowed_html() ); |
|
1131 | 1131 | } |
1132 | 1132 | |
1133 | 1133 | function wpinv_hook_callback( $args ) { |
1134 | - do_action( 'wpinv_' . $args['id'], $args ); |
|
1134 | + do_action( 'wpinv_' . $args['id'], $args ); |
|
1135 | 1135 | } |
1136 | 1136 | |
1137 | 1137 | function wpinv_set_settings_cap() { |
1138 | - return wpinv_get_capability(); |
|
1138 | + return wpinv_get_capability(); |
|
1139 | 1139 | } |
1140 | 1140 | add_filter( 'option_page_capability_wpinv_settings', 'wpinv_set_settings_cap' ); |
1141 | 1141 | |
@@ -1161,47 +1161,47 @@ discard block |
||
1161 | 1161 | * @return array |
1162 | 1162 | */ |
1163 | 1163 | function wpinv_get_email_merge_tags( $subscription = false ) { |
1164 | - $merge_tags = array( |
|
1165 | - '{site_title}' => __( 'Site Title', 'invoicing' ), |
|
1166 | - '{name}' => __( "Customer's full name", 'invoicing' ), |
|
1167 | - '{first_name}' => __( "Customer's first name", 'invoicing' ), |
|
1168 | - '{last_name}' => __( "Customer's last name", 'invoicing' ), |
|
1169 | - '{email}' => __( "Customer's email address", 'invoicing' ), |
|
1170 | - '{invoice_number}' => __( 'The invoice number', 'invoicing' ), |
|
1171 | - '{invoice_currency}' => __( 'The invoice currency', 'invoicing' ), |
|
1172 | - '{invoice_total}' => __( 'The invoice total', 'invoicing' ), |
|
1173 | - '{invoice_link}' => __( 'The invoice link', 'invoicing' ), |
|
1174 | - '{invoice_pay_link}' => __( 'The payment link', 'invoicing' ), |
|
1175 | - '{invoice_receipt_link}' => __( 'The receipt link', 'invoicing' ), |
|
1176 | - '{invoice_date}' => __( 'The date the invoice was created', 'invoicing' ), |
|
1177 | - '{invoice_due_date}' => __( 'The date the invoice is due', 'invoicing' ), |
|
1178 | - '{date}' => __( "Today's date", 'invoicing' ), |
|
1179 | - '{is_was}' => __( 'If due date of invoice is past, displays "was" otherwise displays "is"', 'invoicing' ), |
|
1180 | - '{invoice_label}' => __( 'Invoices/quotes singular name. Ex: Invoice/Quote', 'invoicing' ), |
|
1181 | - '{invoice_quote}' => __( 'Invoices/quotes singular name in small letters. Ex: invoice/quote', 'invoicing' ), |
|
1182 | - '{invoice_description}' => __( 'The description of the invoice', 'invoicing' ), |
|
1183 | - ); |
|
1184 | - |
|
1185 | - if ( $subscription ) { |
|
1186 | - $merge_tags = array_merge( |
|
1187 | - $merge_tags, |
|
1188 | - array( |
|
1189 | - '{subscription_renewal_date}' => __( 'The next renewal date of the subscription', 'invoicing' ), |
|
1190 | - '{subscription_created}' => __( "The subscription's creation date", 'invoicing' ), |
|
1191 | - '{subscription_status}' => __( "The subscription's status", 'invoicing' ), |
|
1192 | - '{subscription_profile_id}' => __( "The subscription's remote profile id", 'invoicing' ), |
|
1193 | - '{subscription_id}' => __( "The subscription's id", 'invoicing' ), |
|
1194 | - '{subscription_recurring_amount}' => __( 'The renewal amount of the subscription', 'invoicing' ), |
|
1195 | - '{subscription_initial_amount}' => __( 'The initial amount of the subscription', 'invoicing' ), |
|
1196 | - '{subscription_recurring_period}' => __( 'The recurring period of the subscription (e.g 1 year)', 'invoicing' ), |
|
1197 | - '{subscription_bill_times}' => __( 'The maximum number of times the subscription can be renewed', 'invoicing' ), |
|
1198 | - '{subscription_url}' => __( 'The URL to manage a subscription', 'invoicing' ), |
|
1199 | - '{subscription_name}' => __( 'The name of the recurring item', 'invoicing' ), |
|
1200 | - ) |
|
1201 | - ); |
|
1202 | - } |
|
1203 | - |
|
1204 | - return $merge_tags; |
|
1164 | + $merge_tags = array( |
|
1165 | + '{site_title}' => __( 'Site Title', 'invoicing' ), |
|
1166 | + '{name}' => __( "Customer's full name", 'invoicing' ), |
|
1167 | + '{first_name}' => __( "Customer's first name", 'invoicing' ), |
|
1168 | + '{last_name}' => __( "Customer's last name", 'invoicing' ), |
|
1169 | + '{email}' => __( "Customer's email address", 'invoicing' ), |
|
1170 | + '{invoice_number}' => __( 'The invoice number', 'invoicing' ), |
|
1171 | + '{invoice_currency}' => __( 'The invoice currency', 'invoicing' ), |
|
1172 | + '{invoice_total}' => __( 'The invoice total', 'invoicing' ), |
|
1173 | + '{invoice_link}' => __( 'The invoice link', 'invoicing' ), |
|
1174 | + '{invoice_pay_link}' => __( 'The payment link', 'invoicing' ), |
|
1175 | + '{invoice_receipt_link}' => __( 'The receipt link', 'invoicing' ), |
|
1176 | + '{invoice_date}' => __( 'The date the invoice was created', 'invoicing' ), |
|
1177 | + '{invoice_due_date}' => __( 'The date the invoice is due', 'invoicing' ), |
|
1178 | + '{date}' => __( "Today's date", 'invoicing' ), |
|
1179 | + '{is_was}' => __( 'If due date of invoice is past, displays "was" otherwise displays "is"', 'invoicing' ), |
|
1180 | + '{invoice_label}' => __( 'Invoices/quotes singular name. Ex: Invoice/Quote', 'invoicing' ), |
|
1181 | + '{invoice_quote}' => __( 'Invoices/quotes singular name in small letters. Ex: invoice/quote', 'invoicing' ), |
|
1182 | + '{invoice_description}' => __( 'The description of the invoice', 'invoicing' ), |
|
1183 | + ); |
|
1184 | + |
|
1185 | + if ( $subscription ) { |
|
1186 | + $merge_tags = array_merge( |
|
1187 | + $merge_tags, |
|
1188 | + array( |
|
1189 | + '{subscription_renewal_date}' => __( 'The next renewal date of the subscription', 'invoicing' ), |
|
1190 | + '{subscription_created}' => __( "The subscription's creation date", 'invoicing' ), |
|
1191 | + '{subscription_status}' => __( "The subscription's status", 'invoicing' ), |
|
1192 | + '{subscription_profile_id}' => __( "The subscription's remote profile id", 'invoicing' ), |
|
1193 | + '{subscription_id}' => __( "The subscription's id", 'invoicing' ), |
|
1194 | + '{subscription_recurring_amount}' => __( 'The renewal amount of the subscription', 'invoicing' ), |
|
1195 | + '{subscription_initial_amount}' => __( 'The initial amount of the subscription', 'invoicing' ), |
|
1196 | + '{subscription_recurring_period}' => __( 'The recurring period of the subscription (e.g 1 year)', 'invoicing' ), |
|
1197 | + '{subscription_bill_times}' => __( 'The maximum number of times the subscription can be renewed', 'invoicing' ), |
|
1198 | + '{subscription_url}' => __( 'The URL to manage a subscription', 'invoicing' ), |
|
1199 | + '{subscription_name}' => __( 'The name of the recurring item', 'invoicing' ), |
|
1200 | + ) |
|
1201 | + ); |
|
1202 | + } |
|
1203 | + |
|
1204 | + return $merge_tags; |
|
1205 | 1205 | } |
1206 | 1206 | |
1207 | 1207 | |
@@ -1213,28 +1213,28 @@ discard block |
||
1213 | 1213 | * @return string |
1214 | 1214 | */ |
1215 | 1215 | function wpinv_get_merge_tags_help_text( $subscription = false ) { |
1216 | - $merge_tags = wpinv_get_email_merge_tags( $subscription ); |
|
1216 | + $merge_tags = wpinv_get_email_merge_tags( $subscription ); |
|
1217 | 1217 | |
1218 | - $output = '<div class="bsui">'; |
|
1218 | + $output = '<div class="bsui">'; |
|
1219 | 1219 | |
1220 | - $link = sprintf( |
|
1221 | - '<strong class="getpaid-merge-tags text-primary" role="button">%s</strong>', |
|
1222 | - esc_html__( 'View available merge tags.', 'invoicing' ) |
|
1223 | - ); |
|
1220 | + $link = sprintf( |
|
1221 | + '<strong class="getpaid-merge-tags text-primary" role="button">%s</strong>', |
|
1222 | + esc_html__( 'View available merge tags.', 'invoicing' ) |
|
1223 | + ); |
|
1224 | 1224 | |
1225 | - $description = esc_html__( 'The content of the email (Merge Tags and HTML are allowed).', 'invoicing' ); |
|
1225 | + $description = esc_html__( 'The content of the email (Merge Tags and HTML are allowed).', 'invoicing' ); |
|
1226 | 1226 | |
1227 | - $output .= "$description $link"; |
|
1227 | + $output .= "$description $link"; |
|
1228 | 1228 | |
1229 | - $output .= '<div class="getpaid-merge-tags-content mt-2 p-1 d-none">'; |
|
1230 | - $output .= '<p class="mb-2">' . esc_html__( 'The following wildcards can be used in email subjects, heading and content:', 'invoicing' ) . '</p>'; |
|
1229 | + $output .= '<div class="getpaid-merge-tags-content mt-2 p-1 d-none">'; |
|
1230 | + $output .= '<p class="mb-2">' . esc_html__( 'The following wildcards can be used in email subjects, heading and content:', 'invoicing' ) . '</p>'; |
|
1231 | 1231 | |
1232 | - $output .= '<ul class="p-0 m-0">'; |
|
1233 | - foreach($merge_tags as $tag => $tag_description) { |
|
1234 | - $output .= "<li class='mb-2'><strong class='text-dark'>$tag</strong> — $tag_description</li>"; |
|
1235 | - } |
|
1232 | + $output .= '<ul class="p-0 m-0">'; |
|
1233 | + foreach($merge_tags as $tag => $tag_description) { |
|
1234 | + $output .= "<li class='mb-2'><strong class='text-dark'>$tag</strong> — $tag_description</li>"; |
|
1235 | + } |
|
1236 | 1236 | |
1237 | - $output .= '</ul></div></div>'; |
|
1237 | + $output .= '</ul></div></div>'; |
|
1238 | 1238 | |
1239 | - return $output; |
|
1239 | + return $output; |
|
1240 | 1240 | } |
@@ -16,496 +16,496 @@ |
||
16 | 16 | */ |
17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
18 | 18 | |
19 | - /** |
|
20 | - * Group response items by day or month. |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - public $groupby = 'day'; |
|
25 | - |
|
26 | - /** |
|
27 | - * Returns an array with arguments to request the previous report. |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - public $previous_range = array(); |
|
32 | - |
|
33 | - /** |
|
34 | - * The period interval. |
|
35 | - * |
|
36 | - * @var int |
|
37 | - */ |
|
38 | - public $interval; |
|
39 | - |
|
40 | - /** |
|
41 | - * Retrieves the before and after dates. |
|
42 | - * |
|
43 | - * @param WP_REST_Request $request Request object. |
|
44 | - * @return array The appropriate date range. |
|
45 | - */ |
|
46 | - public function get_date_range( $request ) { |
|
47 | - |
|
48 | - // Check if the period is x_days. |
|
49 | - if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) { |
|
50 | - $date_range = $this->get_x_days_date_range( absint( $matches[1] ) ); |
|
51 | - } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) { |
|
52 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
53 | - } else { |
|
54 | - $request['period'] = '7_days'; |
|
55 | - $date_range = $this->get_x_days_date_range(); |
|
56 | - } |
|
57 | - |
|
58 | - // 3 months max for day view. |
|
59 | - $before = strtotime( $date_range['before'] ); |
|
60 | - $after = strtotime( $date_range['after'] ); |
|
61 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) { |
|
62 | - $this->groupby = 'month'; |
|
63 | - } |
|
64 | - |
|
65 | - $this->prepare_interval( $date_range ); |
|
66 | - |
|
67 | - return $date_range; |
|
68 | - |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Groups by month or days. |
|
73 | - * |
|
74 | - * @param array $range Date range. |
|
75 | - * @return array The appropriate date range. |
|
76 | - */ |
|
77 | - public function prepare_interval( $range ) { |
|
78 | - |
|
79 | - $before = strtotime( $range['before'] ); |
|
80 | - $after = strtotime( $range['after'] ); |
|
81 | - if ( 'day' === $this->groupby ) { |
|
82 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
83 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
84 | - return; |
|
85 | - } |
|
86 | - |
|
87 | - $this->interval = 0; |
|
88 | - $min_date = strtotime( gmdate( 'Y-m-01', $after ) ); |
|
89 | - |
|
90 | - while ( $min_date <= $before ) { |
|
91 | - $this->interval ++; |
|
92 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
93 | - } |
|
94 | - |
|
95 | - $this->interval = max( 1, $this->interval ); |
|
96 | - |
|
97 | - } |
|
98 | - |
|
99 | - /** |
|
100 | - * Retrieves a custom date range. |
|
101 | - * |
|
102 | - * @param WP_REST_Request $request Request object. |
|
103 | - * @return array The appropriate date range. |
|
104 | - */ |
|
105 | - public function get_custom_date_range( $request ) { |
|
106 | - |
|
107 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
108 | - $before = gmdate( 'Y-m-d' ); |
|
19 | + /** |
|
20 | + * Group response items by day or month. |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + public $groupby = 'day'; |
|
25 | + |
|
26 | + /** |
|
27 | + * Returns an array with arguments to request the previous report. |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + public $previous_range = array(); |
|
32 | + |
|
33 | + /** |
|
34 | + * The period interval. |
|
35 | + * |
|
36 | + * @var int |
|
37 | + */ |
|
38 | + public $interval; |
|
39 | + |
|
40 | + /** |
|
41 | + * Retrieves the before and after dates. |
|
42 | + * |
|
43 | + * @param WP_REST_Request $request Request object. |
|
44 | + * @return array The appropriate date range. |
|
45 | + */ |
|
46 | + public function get_date_range( $request ) { |
|
47 | + |
|
48 | + // Check if the period is x_days. |
|
49 | + if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) { |
|
50 | + $date_range = $this->get_x_days_date_range( absint( $matches[1] ) ); |
|
51 | + } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) { |
|
52 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
53 | + } else { |
|
54 | + $request['period'] = '7_days'; |
|
55 | + $date_range = $this->get_x_days_date_range(); |
|
56 | + } |
|
57 | + |
|
58 | + // 3 months max for day view. |
|
59 | + $before = strtotime( $date_range['before'] ); |
|
60 | + $after = strtotime( $date_range['after'] ); |
|
61 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) { |
|
62 | + $this->groupby = 'month'; |
|
63 | + } |
|
64 | + |
|
65 | + $this->prepare_interval( $date_range ); |
|
66 | + |
|
67 | + return $date_range; |
|
68 | + |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Groups by month or days. |
|
73 | + * |
|
74 | + * @param array $range Date range. |
|
75 | + * @return array The appropriate date range. |
|
76 | + */ |
|
77 | + public function prepare_interval( $range ) { |
|
78 | + |
|
79 | + $before = strtotime( $range['before'] ); |
|
80 | + $after = strtotime( $range['after'] ); |
|
81 | + if ( 'day' === $this->groupby ) { |
|
82 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
83 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
84 | + return; |
|
85 | + } |
|
86 | + |
|
87 | + $this->interval = 0; |
|
88 | + $min_date = strtotime( gmdate( 'Y-m-01', $after ) ); |
|
89 | + |
|
90 | + while ( $min_date <= $before ) { |
|
91 | + $this->interval ++; |
|
92 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
93 | + } |
|
94 | + |
|
95 | + $this->interval = max( 1, $this->interval ); |
|
96 | + |
|
97 | + } |
|
98 | + |
|
99 | + /** |
|
100 | + * Retrieves a custom date range. |
|
101 | + * |
|
102 | + * @param WP_REST_Request $request Request object. |
|
103 | + * @return array The appropriate date range. |
|
104 | + */ |
|
105 | + public function get_custom_date_range( $request ) { |
|
106 | + |
|
107 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
108 | + $before = gmdate( 'Y-m-d' ); |
|
109 | 109 | |
110 | - if ( ! empty( $request['before'] ) ) { |
|
111 | - $before = min( strtotime( $before ), strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
112 | - } |
|
113 | - |
|
114 | - // Set the previous date range. |
|
115 | - $difference = $before - $after; |
|
116 | - $this->previous_range = array( |
|
117 | - 'period' => 'custom', |
|
118 | - 'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ), |
|
119 | - 'after' => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ), |
|
120 | - ); |
|
121 | - |
|
122 | - // Generate the report. |
|
123 | - return array( |
|
124 | - 'before' => gmdate( 'Y-m-d', $before ), |
|
125 | - 'after' => gmdate( 'Y-m-d', $after ), |
|
126 | - ); |
|
127 | - |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Retrieves todays date range. |
|
132 | - * |
|
133 | - * @return array The appropriate date range. |
|
134 | - */ |
|
135 | - public function get_today_date_range() { |
|
136 | - |
|
137 | - // Set the previous date range. |
|
138 | - $this->previous_range = array( |
|
139 | - 'period' => 'yesterday', |
|
140 | - ); |
|
141 | - |
|
142 | - // Generate the report. |
|
143 | - return array( |
|
144 | - 'before' => gmdate( 'Y-m-d' ), |
|
145 | - 'after' => gmdate( 'Y-m-d' ), |
|
146 | - ); |
|
147 | - |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Retrieves yesterdays date range. |
|
152 | - * |
|
153 | - * @return array The appropriate date range. |
|
154 | - */ |
|
155 | - public function get_yesterday_date_range() { |
|
156 | - |
|
157 | - // Set the previous date range. |
|
158 | - $this->previous_range = array( |
|
159 | - 'period' => 'custom', |
|
160 | - 'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
161 | - 'after' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
162 | - ); |
|
163 | - |
|
164 | - // Generate the report. |
|
165 | - return array( |
|
166 | - 'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
167 | - 'after' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
168 | - ); |
|
169 | - |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Retrieves this week's date range. |
|
174 | - * |
|
175 | - * @return array The appropriate date range. |
|
176 | - */ |
|
177 | - public function get_week_date_range() { |
|
178 | - |
|
179 | - // Set the previous date range. |
|
180 | - $this->previous_range = array( |
|
181 | - 'period' => 'last_week', |
|
182 | - ); |
|
183 | - |
|
184 | - // Generate the report. |
|
185 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
186 | - return array( |
|
187 | - 'before' => gmdate( 'Y-m-d' ), |
|
188 | - 'after' => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ), |
|
189 | - ); |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * Retrieves last week's date range. |
|
194 | - * |
|
195 | - * @return array The appropriate date range. |
|
196 | - */ |
|
197 | - public function get_last_week_date_range() { |
|
198 | - |
|
199 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
200 | - $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' ); |
|
201 | - $date_range = array( |
|
202 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
203 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
204 | - ); |
|
205 | - |
|
206 | - // Set the previous date range. |
|
207 | - $week_starts = $week_starts - 7 * DAY_IN_SECONDS; |
|
208 | - $this->previous_range = array( |
|
209 | - 'period' => 'custom', |
|
210 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
211 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
212 | - ); |
|
213 | - |
|
214 | - // Generate the report. |
|
215 | - return $date_range; |
|
216 | - } |
|
217 | - |
|
218 | - /** |
|
219 | - * Retrieves last x days date range. |
|
220 | - * |
|
221 | - * @return array The appropriate date range. |
|
222 | - */ |
|
223 | - public function get_x_days_date_range( $days = 7 ) { |
|
224 | - |
|
225 | - $days--; |
|
226 | - |
|
227 | - $date_range = array( |
|
228 | - 'before' => gmdate( 'Y-m-d' ), |
|
229 | - 'after' => gmdate( 'Y-m-d', strtotime( "-$days days" ) ), |
|
230 | - ); |
|
231 | - |
|
232 | - $days++; |
|
233 | - |
|
234 | - // Set the previous date range. |
|
235 | - $this->previous_range = array( |
|
236 | - 'period' => 'custom', |
|
237 | - 'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ), |
|
238 | - 'after' => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ), |
|
239 | - ); |
|
240 | - |
|
241 | - // Generate the report. |
|
242 | - return $date_range; |
|
243 | - } |
|
244 | - |
|
245 | - /** |
|
246 | - * Retrieves this month date range. |
|
247 | - * |
|
248 | - * @return array The appropriate date range. |
|
249 | - */ |
|
250 | - public function get_month_date_range() { |
|
251 | - |
|
252 | - // Set the previous date range. |
|
253 | - $this->previous_range = array( |
|
254 | - 'period' => 'last_month', |
|
255 | - ); |
|
256 | - |
|
257 | - // Generate the report. |
|
258 | - return array( |
|
259 | - 'after' => gmdate( 'Y-m-01' ), |
|
260 | - 'before' => gmdate( 'Y-m-t' ), |
|
261 | - ); |
|
262 | - |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Retrieves last month's date range. |
|
267 | - * |
|
268 | - * @return array The appropriate date range. |
|
269 | - */ |
|
270 | - public function get_last_month_date_range() { |
|
271 | - |
|
272 | - // Set the previous date range. |
|
273 | - $this->previous_range = array( |
|
274 | - 'period' => 'custom', |
|
275 | - 'after' => gmdate( 'Y-m-01', strtotime( '-2 months' ) ), |
|
276 | - 'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ), |
|
277 | - ); |
|
278 | - |
|
279 | - // Generate the report. |
|
280 | - return array( |
|
281 | - 'after' => gmdate( 'Y-m-01', strtotime( 'last month' ) ), |
|
282 | - 'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ), |
|
283 | - ); |
|
284 | - |
|
285 | - } |
|
286 | - |
|
287 | - /** |
|
288 | - * Retrieves this quarter date range. |
|
289 | - * |
|
290 | - * @return array The available quarters. |
|
291 | - */ |
|
292 | - public function get_quarters() { |
|
293 | - |
|
294 | - $year = (int) gmdate( 'Y' ); |
|
295 | - $last_year = (int) $year - 1; |
|
296 | - return array( |
|
297 | - |
|
298 | - // Third quarter of previous year: July 1st to September 30th |
|
299 | - array( |
|
300 | - 'before' => "{$last_year}-09-30", |
|
301 | - 'after' => "{$last_year}-07-01", |
|
302 | - ), |
|
303 | - |
|
304 | - // Last quarter of previous year: October 1st to December 31st |
|
305 | - array( |
|
306 | - 'before' => "{$last_year}-12-31", |
|
307 | - 'after' => "{$last_year}-10-01", |
|
308 | - ), |
|
309 | - |
|
310 | - // First quarter: January 1st to March 31st |
|
311 | - array( |
|
312 | - 'before' => "{$year}-03-31", |
|
313 | - 'after' => "{$year}-01-01", |
|
314 | - ), |
|
315 | - |
|
316 | - // Second quarter: April 1st to June 30th |
|
317 | - array( |
|
318 | - 'before' => "{$year}-06-30", |
|
319 | - 'after' => "{$year}-04-01", |
|
320 | - ), |
|
321 | - |
|
322 | - // Third quarter: July 1st to September 30th |
|
323 | - array( |
|
324 | - 'before' => "{$year}-09-30", |
|
325 | - 'after' => "{$year}-07-01", |
|
326 | - ), |
|
327 | - |
|
328 | - // Fourth quarter: October 1st to December 31st |
|
329 | - array( |
|
330 | - 'before' => "{$year}-12-31", |
|
331 | - 'after' => "{$year}-10-01", |
|
332 | - ), |
|
333 | - ); |
|
334 | - } |
|
335 | - |
|
336 | - /** |
|
337 | - * Retrieves the current quater. |
|
338 | - * |
|
339 | - * @return int The current quarter. |
|
340 | - */ |
|
341 | - public function get_quarter() { |
|
342 | - |
|
343 | - $month = (int) gmdate( 'n' ); |
|
344 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
345 | - return $quarters[ $month - 1 ]; |
|
346 | - |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Retrieves this quarter date range. |
|
351 | - * |
|
352 | - * @return array The appropriate date range. |
|
353 | - */ |
|
354 | - public function get_quarter_date_range() { |
|
355 | - |
|
356 | - // Set the previous date range. |
|
357 | - $this->previous_range = array( |
|
358 | - 'period' => 'last_quarter', |
|
359 | - ); |
|
360 | - |
|
361 | - // Generate the report. |
|
362 | - $quarter = $this->get_quarter(); |
|
363 | - $quarters = $this->get_quarters(); |
|
364 | - return $quarters[ $quarter + 1 ]; |
|
365 | - |
|
366 | - } |
|
367 | - |
|
368 | - /** |
|
369 | - * Retrieves last quarter's date range. |
|
370 | - * |
|
371 | - * @return array The appropriate date range. |
|
372 | - */ |
|
373 | - public function get_last_quarter_date_range() { |
|
374 | - |
|
375 | - $quarters = $this->get_quarters(); |
|
376 | - $quarter = $this->get_quarter(); |
|
377 | - |
|
378 | - // Set the previous date range. |
|
379 | - $this->previous_range = array_merge( |
|
380 | - $quarters[ $quarter - 1 ], |
|
381 | - array( 'period' => 'custom' ) |
|
382 | - ); |
|
383 | - |
|
384 | - // Generate the report. |
|
385 | - return $quarters[ $quarter ]; |
|
386 | - |
|
387 | - } |
|
388 | - |
|
389 | - /** |
|
390 | - * Retrieves this year date range. |
|
391 | - * |
|
392 | - * @return array The appropriate date range. |
|
393 | - */ |
|
394 | - public function get_year_date_range() { |
|
395 | - |
|
396 | - // Set the previous date range. |
|
397 | - $this->previous_range = array( |
|
398 | - 'period' => 'last_year', |
|
399 | - ); |
|
400 | - |
|
401 | - // Generate the report. |
|
402 | - return array( |
|
403 | - 'after' => gmdate( 'Y-01-01' ), |
|
404 | - 'before' => gmdate( 'Y-12-31' ), |
|
405 | - ); |
|
406 | - |
|
407 | - } |
|
408 | - |
|
409 | - /** |
|
410 | - * Retrieves last year date range. |
|
411 | - * |
|
412 | - * @return array The appropriate date range. |
|
413 | - */ |
|
414 | - public function get_last_year_date_range() { |
|
415 | - |
|
416 | - // Set the previous date range. |
|
417 | - $this->previous_range = array( |
|
418 | - 'period' => 'custom', |
|
419 | - 'after' => gmdate( 'Y-01-01', strtotime( '-2 years' ) ), |
|
420 | - 'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ), |
|
421 | - ); |
|
422 | - |
|
423 | - // Generate the report. |
|
424 | - return array( |
|
425 | - 'after' => gmdate( 'Y-01-01', strtotime( 'last year' ) ), |
|
426 | - 'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ), |
|
427 | - ); |
|
428 | - |
|
429 | - } |
|
430 | - |
|
431 | - /** |
|
432 | - * Prepare a the request date for SQL usage. |
|
433 | - * |
|
434 | - * @param WP_REST_Request $request Request object. |
|
435 | - * @param string $date_field The date field. |
|
436 | - * @return string The appropriate SQL. |
|
437 | - */ |
|
438 | - public function get_date_range_sql( $request, $date_field ) { |
|
439 | - global $wpdb; |
|
440 | - |
|
441 | - $sql = '1=1'; |
|
442 | - $range = $this->get_date_range( $request ); |
|
443 | - |
|
444 | - if ( ! empty( $range['after'] ) ) { |
|
445 | - $sql .= ' AND ' . $wpdb->prepare( |
|
446 | - "$date_field >= %s", |
|
447 | - $range['after'] |
|
448 | - ); |
|
449 | - } |
|
450 | - |
|
451 | - if ( ! empty( $range['before'] ) ) { |
|
452 | - $sql .= ' AND ' . $wpdb->prepare( |
|
453 | - "$date_field <= %s", |
|
454 | - $range['before'] |
|
455 | - ); |
|
456 | - } |
|
457 | - |
|
458 | - return $sql; |
|
459 | - |
|
460 | - } |
|
461 | - |
|
462 | - /** |
|
463 | - * Prepares a group by query. |
|
464 | - * |
|
465 | - * @param string $date_field The date field. |
|
466 | - * @return string The appropriate SQL. |
|
467 | - */ |
|
468 | - public function get_group_by_sql( $date_field ) { |
|
469 | - |
|
470 | - if ( 'day' === $this->groupby ) { |
|
471 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
472 | - } |
|
473 | - |
|
474 | - return "YEAR($date_field), MONTH($date_field)"; |
|
475 | - } |
|
476 | - |
|
477 | - /** |
|
478 | - * Get the query params for collections. |
|
479 | - * |
|
480 | - * @return array |
|
481 | - */ |
|
482 | - public function get_collection_params() { |
|
483 | - return array( |
|
484 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
485 | - 'period' => array( |
|
486 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
487 | - 'type' => 'string', |
|
488 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
489 | - 'validate_callback' => 'rest_validate_request_arg', |
|
490 | - 'sanitize_callback' => 'sanitize_text_field', |
|
491 | - 'default' => '7_days', |
|
492 | - ), |
|
493 | - 'after' => array( |
|
494 | - /* translators: %s: date format */ |
|
495 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
496 | - 'type' => 'string', |
|
497 | - 'validate_callback' => 'rest_validate_request_arg', |
|
498 | - 'sanitize_callback' => 'sanitize_text_field', |
|
499 | - 'default' => gmdate( 'Y-m-d', strtotime( '-7 days' ) ), |
|
500 | - ), |
|
501 | - 'before' => array( |
|
502 | - /* translators: %s: date format */ |
|
503 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
504 | - 'type' => 'string', |
|
505 | - 'validate_callback' => 'rest_validate_request_arg', |
|
506 | - 'sanitize_callback' => 'sanitize_text_field', |
|
507 | - 'default' => gmdate( 'Y-m-d' ), |
|
508 | - ), |
|
509 | - ); |
|
510 | - } |
|
110 | + if ( ! empty( $request['before'] ) ) { |
|
111 | + $before = min( strtotime( $before ), strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
112 | + } |
|
113 | + |
|
114 | + // Set the previous date range. |
|
115 | + $difference = $before - $after; |
|
116 | + $this->previous_range = array( |
|
117 | + 'period' => 'custom', |
|
118 | + 'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ), |
|
119 | + 'after' => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ), |
|
120 | + ); |
|
121 | + |
|
122 | + // Generate the report. |
|
123 | + return array( |
|
124 | + 'before' => gmdate( 'Y-m-d', $before ), |
|
125 | + 'after' => gmdate( 'Y-m-d', $after ), |
|
126 | + ); |
|
127 | + |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Retrieves todays date range. |
|
132 | + * |
|
133 | + * @return array The appropriate date range. |
|
134 | + */ |
|
135 | + public function get_today_date_range() { |
|
136 | + |
|
137 | + // Set the previous date range. |
|
138 | + $this->previous_range = array( |
|
139 | + 'period' => 'yesterday', |
|
140 | + ); |
|
141 | + |
|
142 | + // Generate the report. |
|
143 | + return array( |
|
144 | + 'before' => gmdate( 'Y-m-d' ), |
|
145 | + 'after' => gmdate( 'Y-m-d' ), |
|
146 | + ); |
|
147 | + |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Retrieves yesterdays date range. |
|
152 | + * |
|
153 | + * @return array The appropriate date range. |
|
154 | + */ |
|
155 | + public function get_yesterday_date_range() { |
|
156 | + |
|
157 | + // Set the previous date range. |
|
158 | + $this->previous_range = array( |
|
159 | + 'period' => 'custom', |
|
160 | + 'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
161 | + 'after' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
162 | + ); |
|
163 | + |
|
164 | + // Generate the report. |
|
165 | + return array( |
|
166 | + 'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
167 | + 'after' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
168 | + ); |
|
169 | + |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Retrieves this week's date range. |
|
174 | + * |
|
175 | + * @return array The appropriate date range. |
|
176 | + */ |
|
177 | + public function get_week_date_range() { |
|
178 | + |
|
179 | + // Set the previous date range. |
|
180 | + $this->previous_range = array( |
|
181 | + 'period' => 'last_week', |
|
182 | + ); |
|
183 | + |
|
184 | + // Generate the report. |
|
185 | + $week_starts = absint( get_option( 'start_of_week' ) ); |
|
186 | + return array( |
|
187 | + 'before' => gmdate( 'Y-m-d' ), |
|
188 | + 'after' => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ), |
|
189 | + ); |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * Retrieves last week's date range. |
|
194 | + * |
|
195 | + * @return array The appropriate date range. |
|
196 | + */ |
|
197 | + public function get_last_week_date_range() { |
|
198 | + |
|
199 | + $week_starts = absint( get_option( 'start_of_week' ) ); |
|
200 | + $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' ); |
|
201 | + $date_range = array( |
|
202 | + 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
203 | + 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
204 | + ); |
|
205 | + |
|
206 | + // Set the previous date range. |
|
207 | + $week_starts = $week_starts - 7 * DAY_IN_SECONDS; |
|
208 | + $this->previous_range = array( |
|
209 | + 'period' => 'custom', |
|
210 | + 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
211 | + 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
212 | + ); |
|
213 | + |
|
214 | + // Generate the report. |
|
215 | + return $date_range; |
|
216 | + } |
|
217 | + |
|
218 | + /** |
|
219 | + * Retrieves last x days date range. |
|
220 | + * |
|
221 | + * @return array The appropriate date range. |
|
222 | + */ |
|
223 | + public function get_x_days_date_range( $days = 7 ) { |
|
224 | + |
|
225 | + $days--; |
|
226 | + |
|
227 | + $date_range = array( |
|
228 | + 'before' => gmdate( 'Y-m-d' ), |
|
229 | + 'after' => gmdate( 'Y-m-d', strtotime( "-$days days" ) ), |
|
230 | + ); |
|
231 | + |
|
232 | + $days++; |
|
233 | + |
|
234 | + // Set the previous date range. |
|
235 | + $this->previous_range = array( |
|
236 | + 'period' => 'custom', |
|
237 | + 'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ), |
|
238 | + 'after' => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ), |
|
239 | + ); |
|
240 | + |
|
241 | + // Generate the report. |
|
242 | + return $date_range; |
|
243 | + } |
|
244 | + |
|
245 | + /** |
|
246 | + * Retrieves this month date range. |
|
247 | + * |
|
248 | + * @return array The appropriate date range. |
|
249 | + */ |
|
250 | + public function get_month_date_range() { |
|
251 | + |
|
252 | + // Set the previous date range. |
|
253 | + $this->previous_range = array( |
|
254 | + 'period' => 'last_month', |
|
255 | + ); |
|
256 | + |
|
257 | + // Generate the report. |
|
258 | + return array( |
|
259 | + 'after' => gmdate( 'Y-m-01' ), |
|
260 | + 'before' => gmdate( 'Y-m-t' ), |
|
261 | + ); |
|
262 | + |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Retrieves last month's date range. |
|
267 | + * |
|
268 | + * @return array The appropriate date range. |
|
269 | + */ |
|
270 | + public function get_last_month_date_range() { |
|
271 | + |
|
272 | + // Set the previous date range. |
|
273 | + $this->previous_range = array( |
|
274 | + 'period' => 'custom', |
|
275 | + 'after' => gmdate( 'Y-m-01', strtotime( '-2 months' ) ), |
|
276 | + 'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ), |
|
277 | + ); |
|
278 | + |
|
279 | + // Generate the report. |
|
280 | + return array( |
|
281 | + 'after' => gmdate( 'Y-m-01', strtotime( 'last month' ) ), |
|
282 | + 'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ), |
|
283 | + ); |
|
284 | + |
|
285 | + } |
|
286 | + |
|
287 | + /** |
|
288 | + * Retrieves this quarter date range. |
|
289 | + * |
|
290 | + * @return array The available quarters. |
|
291 | + */ |
|
292 | + public function get_quarters() { |
|
293 | + |
|
294 | + $year = (int) gmdate( 'Y' ); |
|
295 | + $last_year = (int) $year - 1; |
|
296 | + return array( |
|
297 | + |
|
298 | + // Third quarter of previous year: July 1st to September 30th |
|
299 | + array( |
|
300 | + 'before' => "{$last_year}-09-30", |
|
301 | + 'after' => "{$last_year}-07-01", |
|
302 | + ), |
|
303 | + |
|
304 | + // Last quarter of previous year: October 1st to December 31st |
|
305 | + array( |
|
306 | + 'before' => "{$last_year}-12-31", |
|
307 | + 'after' => "{$last_year}-10-01", |
|
308 | + ), |
|
309 | + |
|
310 | + // First quarter: January 1st to March 31st |
|
311 | + array( |
|
312 | + 'before' => "{$year}-03-31", |
|
313 | + 'after' => "{$year}-01-01", |
|
314 | + ), |
|
315 | + |
|
316 | + // Second quarter: April 1st to June 30th |
|
317 | + array( |
|
318 | + 'before' => "{$year}-06-30", |
|
319 | + 'after' => "{$year}-04-01", |
|
320 | + ), |
|
321 | + |
|
322 | + // Third quarter: July 1st to September 30th |
|
323 | + array( |
|
324 | + 'before' => "{$year}-09-30", |
|
325 | + 'after' => "{$year}-07-01", |
|
326 | + ), |
|
327 | + |
|
328 | + // Fourth quarter: October 1st to December 31st |
|
329 | + array( |
|
330 | + 'before' => "{$year}-12-31", |
|
331 | + 'after' => "{$year}-10-01", |
|
332 | + ), |
|
333 | + ); |
|
334 | + } |
|
335 | + |
|
336 | + /** |
|
337 | + * Retrieves the current quater. |
|
338 | + * |
|
339 | + * @return int The current quarter. |
|
340 | + */ |
|
341 | + public function get_quarter() { |
|
342 | + |
|
343 | + $month = (int) gmdate( 'n' ); |
|
344 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
345 | + return $quarters[ $month - 1 ]; |
|
346 | + |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Retrieves this quarter date range. |
|
351 | + * |
|
352 | + * @return array The appropriate date range. |
|
353 | + */ |
|
354 | + public function get_quarter_date_range() { |
|
355 | + |
|
356 | + // Set the previous date range. |
|
357 | + $this->previous_range = array( |
|
358 | + 'period' => 'last_quarter', |
|
359 | + ); |
|
360 | + |
|
361 | + // Generate the report. |
|
362 | + $quarter = $this->get_quarter(); |
|
363 | + $quarters = $this->get_quarters(); |
|
364 | + return $quarters[ $quarter + 1 ]; |
|
365 | + |
|
366 | + } |
|
367 | + |
|
368 | + /** |
|
369 | + * Retrieves last quarter's date range. |
|
370 | + * |
|
371 | + * @return array The appropriate date range. |
|
372 | + */ |
|
373 | + public function get_last_quarter_date_range() { |
|
374 | + |
|
375 | + $quarters = $this->get_quarters(); |
|
376 | + $quarter = $this->get_quarter(); |
|
377 | + |
|
378 | + // Set the previous date range. |
|
379 | + $this->previous_range = array_merge( |
|
380 | + $quarters[ $quarter - 1 ], |
|
381 | + array( 'period' => 'custom' ) |
|
382 | + ); |
|
383 | + |
|
384 | + // Generate the report. |
|
385 | + return $quarters[ $quarter ]; |
|
386 | + |
|
387 | + } |
|
388 | + |
|
389 | + /** |
|
390 | + * Retrieves this year date range. |
|
391 | + * |
|
392 | + * @return array The appropriate date range. |
|
393 | + */ |
|
394 | + public function get_year_date_range() { |
|
395 | + |
|
396 | + // Set the previous date range. |
|
397 | + $this->previous_range = array( |
|
398 | + 'period' => 'last_year', |
|
399 | + ); |
|
400 | + |
|
401 | + // Generate the report. |
|
402 | + return array( |
|
403 | + 'after' => gmdate( 'Y-01-01' ), |
|
404 | + 'before' => gmdate( 'Y-12-31' ), |
|
405 | + ); |
|
406 | + |
|
407 | + } |
|
408 | + |
|
409 | + /** |
|
410 | + * Retrieves last year date range. |
|
411 | + * |
|
412 | + * @return array The appropriate date range. |
|
413 | + */ |
|
414 | + public function get_last_year_date_range() { |
|
415 | + |
|
416 | + // Set the previous date range. |
|
417 | + $this->previous_range = array( |
|
418 | + 'period' => 'custom', |
|
419 | + 'after' => gmdate( 'Y-01-01', strtotime( '-2 years' ) ), |
|
420 | + 'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ), |
|
421 | + ); |
|
422 | + |
|
423 | + // Generate the report. |
|
424 | + return array( |
|
425 | + 'after' => gmdate( 'Y-01-01', strtotime( 'last year' ) ), |
|
426 | + 'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ), |
|
427 | + ); |
|
428 | + |
|
429 | + } |
|
430 | + |
|
431 | + /** |
|
432 | + * Prepare a the request date for SQL usage. |
|
433 | + * |
|
434 | + * @param WP_REST_Request $request Request object. |
|
435 | + * @param string $date_field The date field. |
|
436 | + * @return string The appropriate SQL. |
|
437 | + */ |
|
438 | + public function get_date_range_sql( $request, $date_field ) { |
|
439 | + global $wpdb; |
|
440 | + |
|
441 | + $sql = '1=1'; |
|
442 | + $range = $this->get_date_range( $request ); |
|
443 | + |
|
444 | + if ( ! empty( $range['after'] ) ) { |
|
445 | + $sql .= ' AND ' . $wpdb->prepare( |
|
446 | + "$date_field >= %s", |
|
447 | + $range['after'] |
|
448 | + ); |
|
449 | + } |
|
450 | + |
|
451 | + if ( ! empty( $range['before'] ) ) { |
|
452 | + $sql .= ' AND ' . $wpdb->prepare( |
|
453 | + "$date_field <= %s", |
|
454 | + $range['before'] |
|
455 | + ); |
|
456 | + } |
|
457 | + |
|
458 | + return $sql; |
|
459 | + |
|
460 | + } |
|
461 | + |
|
462 | + /** |
|
463 | + * Prepares a group by query. |
|
464 | + * |
|
465 | + * @param string $date_field The date field. |
|
466 | + * @return string The appropriate SQL. |
|
467 | + */ |
|
468 | + public function get_group_by_sql( $date_field ) { |
|
469 | + |
|
470 | + if ( 'day' === $this->groupby ) { |
|
471 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
472 | + } |
|
473 | + |
|
474 | + return "YEAR($date_field), MONTH($date_field)"; |
|
475 | + } |
|
476 | + |
|
477 | + /** |
|
478 | + * Get the query params for collections. |
|
479 | + * |
|
480 | + * @return array |
|
481 | + */ |
|
482 | + public function get_collection_params() { |
|
483 | + return array( |
|
484 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
485 | + 'period' => array( |
|
486 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
487 | + 'type' => 'string', |
|
488 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
489 | + 'validate_callback' => 'rest_validate_request_arg', |
|
490 | + 'sanitize_callback' => 'sanitize_text_field', |
|
491 | + 'default' => '7_days', |
|
492 | + ), |
|
493 | + 'after' => array( |
|
494 | + /* translators: %s: date format */ |
|
495 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
496 | + 'type' => 'string', |
|
497 | + 'validate_callback' => 'rest_validate_request_arg', |
|
498 | + 'sanitize_callback' => 'sanitize_text_field', |
|
499 | + 'default' => gmdate( 'Y-m-d', strtotime( '-7 days' ) ), |
|
500 | + ), |
|
501 | + 'before' => array( |
|
502 | + /* translators: %s: date format */ |
|
503 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
504 | + 'type' => 'string', |
|
505 | + 'validate_callback' => 'rest_validate_request_arg', |
|
506 | + 'sanitize_callback' => 'sanitize_text_field', |
|
507 | + 'default' => gmdate( 'Y-m-d' ), |
|
508 | + ), |
|
509 | + ); |
|
510 | + } |
|
511 | 511 | } |
@@ -18,688 +18,688 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * Route base. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $rest_base = 'reports/sales'; |
|
27 | - |
|
28 | - /** |
|
29 | - * The report data. |
|
30 | - * |
|
31 | - * @var stdClass |
|
32 | - */ |
|
33 | - public $report_data; |
|
34 | - |
|
35 | - /** |
|
36 | - * The report range. |
|
37 | - * |
|
38 | - * @var array |
|
39 | - */ |
|
40 | - public $report_range; |
|
41 | - |
|
42 | - /** |
|
43 | - * Registers the routes for the objects of the controller. |
|
44 | - * |
|
45 | - * @since 2.0.0 |
|
46 | - * |
|
47 | - * @see register_rest_route() |
|
48 | - */ |
|
49 | - public function register_namespace_routes( $namespace ) { |
|
50 | - |
|
51 | - // Get sales report. |
|
52 | - register_rest_route( |
|
53 | - $namespace, |
|
54 | - $this->rest_base, |
|
55 | - array( |
|
56 | - array( |
|
57 | - 'methods' => WP_REST_Server::READABLE, |
|
58 | - 'callback' => array( $this, 'get_items' ), |
|
59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | - 'args' => $this->get_collection_params(), |
|
61 | - ), |
|
62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
63 | - ) |
|
64 | - ); |
|
65 | - |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Makes sure the current user has access to READ the report APIs. |
|
70 | - * |
|
71 | - * @since 2.0.0 |
|
72 | - * @param WP_REST_Request $request Full data about the request. |
|
73 | - * @return WP_Error|boolean |
|
74 | - */ |
|
75 | - public function get_items_permissions_check( $request ) { |
|
76 | - |
|
77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | - } |
|
80 | - |
|
81 | - return true; |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * Get sales reports. |
|
86 | - * |
|
87 | - * @param WP_REST_Request $request |
|
88 | - * @return array|WP_Error |
|
89 | - */ |
|
90 | - public function get_items( $request ) { |
|
91 | - $data = array(); |
|
92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | - |
|
95 | - return rest_ensure_response( $data ); |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Prepare a report sales object for serialization. |
|
100 | - * |
|
101 | - * @param null $_ |
|
102 | - * @param WP_REST_Request $request Request object. |
|
103 | - * @return WP_REST_Response $response Response data. |
|
104 | - */ |
|
105 | - public function prepare_item_for_response( $_, $request ) { |
|
106 | - |
|
107 | - // Set report range. |
|
108 | - $this->report_range = $this->get_date_range( $request ); |
|
109 | - |
|
110 | - $report_data = $this->get_report_data(); |
|
111 | - $period_totals = array(); |
|
112 | - |
|
113 | - // Setup period totals by ensuring each period in the interval has data. |
|
114 | - $start_date = strtotime( $this->report_range['after'] ); |
|
115 | - |
|
116 | - if ( 'month' === $this->groupby ) { |
|
117 | - $start_date = strtotime( gmdate( 'Y-m-01', $start_date ) ); |
|
118 | - } |
|
119 | - |
|
120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | - |
|
122 | - switch ( $this->groupby ) { |
|
123 | - case 'day': |
|
124 | - $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | - break; |
|
126 | - default: |
|
127 | - $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | - break; |
|
129 | - } |
|
130 | - |
|
131 | - // Set the defaults for each period. |
|
132 | - $period_totals[ $time ] = array( |
|
133 | - 'invoices' => 0, |
|
134 | - 'items' => 0, |
|
135 | - 'refunded_items' => 0, |
|
136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | - ); |
|
142 | - |
|
143 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | - } |
|
147 | - } |
|
148 | - } |
|
149 | - |
|
150 | - // add total sales, total invoice count, total tax for each period |
|
151 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | - foreach ( $report_data->invoices as $invoice ) { |
|
153 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
154 | - |
|
155 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | - continue; |
|
157 | - } |
|
158 | - |
|
159 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
163 | - |
|
164 | - } |
|
165 | - |
|
166 | - foreach ( $report_data->refunds as $invoice ) { |
|
167 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
168 | - |
|
169 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | - continue; |
|
171 | - } |
|
172 | - |
|
173 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
177 | - |
|
178 | - } |
|
179 | - |
|
180 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
182 | - |
|
183 | - if ( isset( $period_totals[ $time ] ) ) { |
|
184 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - // Add total invoice items for each period. |
|
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | - |
|
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | - } |
|
195 | - } |
|
196 | - |
|
197 | - // Add total discount for each period. |
|
198 | - foreach ( $report_data->coupons as $discount ) { |
|
199 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) ); |
|
200 | - |
|
201 | - if ( isset( $period_totals[ $time ] ) ) { |
|
202 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | - } |
|
204 | - } |
|
205 | - |
|
206 | - // Extra fields. |
|
207 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | - |
|
209 | - // Abort unprepared. |
|
210 | - if ( ! isset( $report_data->$key ) ) { |
|
211 | - continue; |
|
212 | - } |
|
213 | - |
|
214 | - // Abort defaults. |
|
215 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | - continue; |
|
217 | - } |
|
218 | - |
|
219 | - // Set values. |
|
220 | - foreach ( $report_data->$key as $item ) { |
|
221 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) ); |
|
222 | - |
|
223 | - if ( isset( $period_totals[ $time ] ) ) { |
|
224 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - unset( $report_data->$key ); |
|
229 | - } |
|
230 | - |
|
231 | - $report_data->totals = $period_totals; |
|
232 | - $report_data->grouped_by = $this->groupby; |
|
233 | - $report_data->interval = max( $this->interval, 1 ); |
|
234 | - $report_data->currency = wpinv_get_currency(); |
|
235 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | - $report_data->currency_position = wpinv_currency_position(); |
|
237 | - $report_data->decimal_places = wpinv_decimals(); |
|
238 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | - $report_data->start_date = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ); |
|
241 | - $report_data->end_date = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ); |
|
242 | - $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) ); |
|
243 | - $report_data->end_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) ); |
|
244 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | - |
|
246 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | - $data = $report_data; |
|
248 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | - $data = $this->filter_response_by_context( $data, $context ); |
|
251 | - |
|
252 | - // Wrap the data in a response object. |
|
253 | - $response = rest_ensure_response( $data ); |
|
254 | - $response->add_links( |
|
21 | + /** |
|
22 | + * Route base. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $rest_base = 'reports/sales'; |
|
27 | + |
|
28 | + /** |
|
29 | + * The report data. |
|
30 | + * |
|
31 | + * @var stdClass |
|
32 | + */ |
|
33 | + public $report_data; |
|
34 | + |
|
35 | + /** |
|
36 | + * The report range. |
|
37 | + * |
|
38 | + * @var array |
|
39 | + */ |
|
40 | + public $report_range; |
|
41 | + |
|
42 | + /** |
|
43 | + * Registers the routes for the objects of the controller. |
|
44 | + * |
|
45 | + * @since 2.0.0 |
|
46 | + * |
|
47 | + * @see register_rest_route() |
|
48 | + */ |
|
49 | + public function register_namespace_routes( $namespace ) { |
|
50 | + |
|
51 | + // Get sales report. |
|
52 | + register_rest_route( |
|
53 | + $namespace, |
|
54 | + $this->rest_base, |
|
255 | 55 | array( |
256 | - 'about' => array( |
|
257 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | - ), |
|
56 | + array( |
|
57 | + 'methods' => WP_REST_Server::READABLE, |
|
58 | + 'callback' => array( $this, 'get_items' ), |
|
59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | + 'args' => $this->get_collection_params(), |
|
61 | + ), |
|
62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
259 | 63 | ) |
260 | 64 | ); |
261 | 65 | |
262 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Get report data. |
|
267 | - * |
|
268 | - * @return stdClass |
|
269 | - */ |
|
270 | - public function get_report_data() { |
|
271 | - if ( empty( $this->report_data ) ) { |
|
272 | - $this->query_report_data(); |
|
273 | - } |
|
274 | - return $this->report_data; |
|
275 | - } |
|
276 | - |
|
277 | - /** |
|
278 | - * Get all data needed for this report and store in the class. |
|
279 | - */ |
|
280 | - protected function query_report_data() { |
|
281 | - |
|
282 | - // Prepare reports. |
|
283 | - $this->report_data = (object) array( |
|
284 | - 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | - 'previous_range' => $this->previous_range, |
|
291 | - ); |
|
292 | - |
|
293 | - // Calculated totals. |
|
294 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | - |
|
307 | - // Calculate average based on net. |
|
308 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | - |
|
311 | - // Total invoices in this period, even if refunded. |
|
312 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | - |
|
314 | - // Items invoiced in this period, even if refunded. |
|
315 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | - |
|
317 | - // 3rd party filtering of report data |
|
318 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | - } |
|
320 | - |
|
321 | - /** |
|
322 | - * Prepares invoice counts. |
|
323 | - * |
|
324 | - * @return array. |
|
325 | - */ |
|
326 | - protected function query_invoice_counts() { |
|
327 | - |
|
328 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | - array( |
|
330 | - 'data' => array( |
|
331 | - 'ID' => array( |
|
332 | - 'type' => 'post_data', |
|
333 | - 'function' => 'COUNT', |
|
334 | - 'name' => 'count', |
|
335 | - 'distinct' => true, |
|
336 | - ), |
|
337 | - 'post_date' => array( |
|
338 | - 'type' => 'post_data', |
|
339 | - 'function' => 'MIN', |
|
340 | - 'name' => 'post_date', |
|
341 | - ), |
|
342 | - ), |
|
343 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | - 'order_by' => 'post_date ASC', |
|
345 | - 'query_type' => 'get_results', |
|
346 | - 'filter_range' => $this->report_range, |
|
347 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | - ) |
|
349 | - ); |
|
350 | - |
|
351 | - } |
|
352 | - |
|
353 | - /** |
|
354 | - * Prepares coupon counts. |
|
355 | - * |
|
356 | - * @return array. |
|
357 | - */ |
|
358 | - protected function query_coupon_counts() { |
|
359 | - |
|
360 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | - array( |
|
362 | - 'data' => array( |
|
363 | - 'discount' => array( |
|
364 | - 'type' => 'invoice_data', |
|
365 | - 'function' => 'SUM', |
|
366 | - 'name' => 'discount_amount', |
|
367 | - ), |
|
368 | - 'post_date' => array( |
|
369 | - 'type' => 'post_data', |
|
370 | - 'function' => 'MIN', |
|
371 | - 'name' => 'post_date', |
|
372 | - ), |
|
373 | - ), |
|
374 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | - 'order_by' => 'post_date ASC', |
|
376 | - 'query_type' => 'get_results', |
|
377 | - 'filter_range' => $this->report_range, |
|
378 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | - ) |
|
380 | - ); |
|
381 | - |
|
382 | - } |
|
383 | - |
|
384 | - /** |
|
385 | - * Prepares item counts. |
|
386 | - * |
|
387 | - * @return array. |
|
388 | - */ |
|
389 | - protected function query_item_counts() { |
|
390 | - |
|
391 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
392 | - array( |
|
393 | - 'data' => array( |
|
394 | - 'quantity' => array( |
|
395 | - 'type' => 'invoice_item', |
|
396 | - 'function' => 'SUM', |
|
397 | - 'name' => 'invoice_item_count', |
|
398 | - ), |
|
399 | - 'post_date' => array( |
|
400 | - 'type' => 'post_data', |
|
401 | - 'function' => 'MIN', |
|
402 | - 'name' => 'post_date', |
|
403 | - ), |
|
404 | - ), |
|
405 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | - 'order_by' => 'post_date ASC', |
|
407 | - 'query_type' => 'get_results', |
|
408 | - 'filter_range' => $this->report_range, |
|
409 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
410 | - ) |
|
411 | - ); |
|
412 | - |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * Prepares refunded item counts. |
|
417 | - * |
|
418 | - * @return array. |
|
419 | - */ |
|
420 | - protected function count_refunded_items() { |
|
421 | - |
|
422 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | - array( |
|
424 | - 'data' => array( |
|
425 | - 'quantity' => array( |
|
426 | - 'type' => 'invoice_item', |
|
427 | - 'function' => 'SUM', |
|
428 | - 'name' => 'invoice_item_count', |
|
429 | - ), |
|
430 | - ), |
|
431 | - 'query_type' => 'get_var', |
|
432 | - 'filter_range' => $this->report_range, |
|
433 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | - ) |
|
435 | - ); |
|
436 | - |
|
437 | - } |
|
438 | - |
|
439 | - /** |
|
440 | - * Prepares daily invoice totals. |
|
441 | - * |
|
442 | - * @return array. |
|
443 | - */ |
|
444 | - protected function query_invoice_totals() { |
|
445 | - |
|
446 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | - array( |
|
448 | - 'data' => array( |
|
449 | - 'total' => array( |
|
450 | - 'type' => 'invoice_data', |
|
451 | - 'function' => 'SUM', |
|
452 | - 'name' => 'total_sales', |
|
453 | - ), |
|
454 | - 'tax' => array( |
|
455 | - 'type' => 'invoice_data', |
|
456 | - 'function' => 'SUM', |
|
457 | - 'name' => 'total_tax', |
|
458 | - ), |
|
459 | - 'discount' => array( |
|
460 | - 'type' => 'invoice_data', |
|
461 | - 'function' => 'SUM', |
|
462 | - 'name' => 'total_discount', |
|
463 | - ), |
|
464 | - 'fees_total' => array( |
|
465 | - 'type' => 'invoice_data', |
|
466 | - 'function' => 'SUM', |
|
467 | - 'name' => 'total_fees', |
|
468 | - ), |
|
469 | - 'subtotal' => array( |
|
470 | - 'type' => 'invoice_data', |
|
471 | - 'function' => 'SUM', |
|
472 | - 'name' => 'subtotal', |
|
473 | - ), |
|
474 | - 'post_date' => array( |
|
475 | - 'type' => 'post_data', |
|
476 | - 'function' => '', |
|
477 | - 'name' => 'post_date', |
|
478 | - ), |
|
479 | - ), |
|
480 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | - 'order_by' => 'post_date ASC', |
|
482 | - 'query_type' => 'get_results', |
|
483 | - 'filter_range' => $this->report_range, |
|
484 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | - ) |
|
486 | - ); |
|
487 | - |
|
488 | - } |
|
489 | - |
|
490 | - /** |
|
491 | - * Prepares daily invoice totals. |
|
492 | - * |
|
493 | - * @return array. |
|
494 | - */ |
|
495 | - protected function query_refunded_totals() { |
|
496 | - |
|
497 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | - array( |
|
499 | - 'data' => array( |
|
500 | - 'total' => array( |
|
501 | - 'type' => 'invoice_data', |
|
502 | - 'function' => 'SUM', |
|
503 | - 'name' => 'total_sales', |
|
504 | - ), |
|
505 | - 'tax' => array( |
|
506 | - 'type' => 'invoice_data', |
|
507 | - 'function' => 'SUM', |
|
508 | - 'name' => 'total_tax', |
|
509 | - ), |
|
510 | - 'discount' => array( |
|
511 | - 'type' => 'invoice_data', |
|
512 | - 'function' => 'SUM', |
|
513 | - 'name' => 'total_discount', |
|
514 | - ), |
|
515 | - 'fees_total' => array( |
|
516 | - 'type' => 'invoice_data', |
|
517 | - 'function' => 'SUM', |
|
518 | - 'name' => 'total_fees', |
|
519 | - ), |
|
520 | - 'subtotal' => array( |
|
521 | - 'type' => 'invoice_data', |
|
522 | - 'function' => 'SUM', |
|
523 | - 'name' => 'subtotal', |
|
524 | - ), |
|
525 | - 'post_date' => array( |
|
526 | - 'type' => 'post_data', |
|
527 | - 'function' => '', |
|
528 | - 'name' => 'post_date', |
|
529 | - ), |
|
530 | - ), |
|
531 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | - 'order_by' => 'post_date ASC', |
|
533 | - 'query_type' => 'get_results', |
|
534 | - 'filter_range' => $this->report_range, |
|
535 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | - ) |
|
537 | - ); |
|
538 | - |
|
539 | - } |
|
540 | - |
|
541 | - /** |
|
542 | - * Get the Report's schema, conforming to JSON Schema. |
|
543 | - * |
|
544 | - * @return array |
|
545 | - */ |
|
546 | - public function get_item_schema() { |
|
547 | - |
|
548 | - $schema = array( |
|
549 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | - 'title' => 'sales_report', |
|
551 | - 'type' => 'object', |
|
552 | - 'properties' => array( |
|
553 | - 'total_sales' => array( |
|
554 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | - 'type' => 'string', |
|
556 | - 'context' => array( 'view' ), |
|
557 | - 'readonly' => true, |
|
558 | - ), |
|
559 | - 'net_sales' => array( |
|
560 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | - 'type' => 'string', |
|
562 | - 'context' => array( 'view' ), |
|
563 | - 'readonly' => true, |
|
564 | - ), |
|
565 | - 'average_sales' => array( |
|
566 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | - 'type' => 'string', |
|
568 | - 'context' => array( 'view' ), |
|
569 | - 'readonly' => true, |
|
570 | - ), |
|
571 | - 'average_total_sales' => array( |
|
572 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | - 'type' => 'string', |
|
574 | - 'context' => array( 'view' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'total_invoices' => array( |
|
578 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | - 'type' => 'integer', |
|
580 | - 'context' => array( 'view' ), |
|
581 | - 'readonly' => true, |
|
582 | - ), |
|
583 | - 'total_items' => array( |
|
584 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | - 'type' => 'integer', |
|
586 | - 'context' => array( 'view' ), |
|
587 | - 'readonly' => true, |
|
588 | - ), |
|
589 | - 'refunded_items' => array( |
|
590 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | - 'type' => 'integer', |
|
592 | - 'context' => array( 'view' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'total_tax' => array( |
|
596 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | - 'type' => 'string', |
|
598 | - 'context' => array( 'view' ), |
|
599 | - 'readonly' => true, |
|
600 | - ), |
|
601 | - 'total_refunded_tax' => array( |
|
602 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | - 'type' => 'string', |
|
604 | - 'context' => array( 'view' ), |
|
605 | - 'readonly' => true, |
|
606 | - ), |
|
607 | - 'total_fees' => array( |
|
608 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | - 'type' => 'string', |
|
610 | - 'context' => array( 'view' ), |
|
611 | - 'readonly' => true, |
|
612 | - ), |
|
613 | - 'total_refunds' => array( |
|
614 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | - 'type' => 'integer', |
|
616 | - 'context' => array( 'view' ), |
|
617 | - 'readonly' => true, |
|
618 | - ), |
|
619 | - 'net_refunds' => array( |
|
620 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | - 'type' => 'integer', |
|
622 | - 'context' => array( 'view' ), |
|
623 | - 'readonly' => true, |
|
624 | - ), |
|
625 | - 'total_discount' => array( |
|
626 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | - 'type' => 'integer', |
|
628 | - 'context' => array( 'view' ), |
|
629 | - 'readonly' => true, |
|
630 | - ), |
|
631 | - 'totals' => array( |
|
632 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | - 'type' => 'array', |
|
634 | - 'items' => array( |
|
635 | - 'type' => 'array', |
|
636 | - ), |
|
637 | - 'context' => array( 'view' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
640 | - 'interval' => array( |
|
641 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | - 'type' => 'integer', |
|
643 | - 'context' => array( 'view' ), |
|
644 | - 'readonly' => true, |
|
645 | - ), |
|
646 | - 'previous_range' => array( |
|
647 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | - 'type' => 'array', |
|
649 | - 'items' => array( |
|
650 | - 'type' => 'string', |
|
651 | - ), |
|
652 | - 'context' => array( 'view' ), |
|
653 | - 'readonly' => true, |
|
654 | - ), |
|
655 | - 'grouped_by' => array( |
|
656 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | - 'type' => 'string', |
|
658 | - 'context' => array( 'view' ), |
|
659 | - 'enum' => array( 'day', 'month' ), |
|
660 | - 'readonly' => true, |
|
661 | - ), |
|
662 | - 'currency' => array( |
|
663 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | - 'type' => 'string', |
|
665 | - 'context' => array( 'view' ), |
|
666 | - 'readonly' => true, |
|
667 | - ), |
|
668 | - 'currency_symbol' => array( |
|
669 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | - 'type' => 'string', |
|
671 | - 'context' => array( 'view' ), |
|
672 | - 'readonly' => true, |
|
673 | - ), |
|
674 | - 'currency_position' => array( |
|
675 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | - 'type' => 'string', |
|
677 | - 'context' => array( 'view' ), |
|
678 | - 'readonly' => true, |
|
679 | - ), |
|
680 | - 'decimal_places' => array( |
|
681 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | - 'type' => 'string', |
|
683 | - 'context' => array( 'view' ), |
|
684 | - 'readonly' => true, |
|
685 | - ), |
|
686 | - 'thousands_sep' => array( |
|
687 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | - 'type' => 'string', |
|
689 | - 'context' => array( 'view' ), |
|
690 | - 'readonly' => true, |
|
691 | - ), |
|
692 | - 'decimals_sep' => array( |
|
693 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | - 'type' => 'string', |
|
695 | - 'context' => array( 'view' ), |
|
696 | - 'readonly' => true, |
|
697 | - ), |
|
698 | - ), |
|
699 | - ); |
|
700 | - |
|
701 | - return $this->add_additional_fields_schema( $schema ); |
|
702 | - |
|
703 | - } |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Makes sure the current user has access to READ the report APIs. |
|
70 | + * |
|
71 | + * @since 2.0.0 |
|
72 | + * @param WP_REST_Request $request Full data about the request. |
|
73 | + * @return WP_Error|boolean |
|
74 | + */ |
|
75 | + public function get_items_permissions_check( $request ) { |
|
76 | + |
|
77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | + } |
|
80 | + |
|
81 | + return true; |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * Get sales reports. |
|
86 | + * |
|
87 | + * @param WP_REST_Request $request |
|
88 | + * @return array|WP_Error |
|
89 | + */ |
|
90 | + public function get_items( $request ) { |
|
91 | + $data = array(); |
|
92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | + |
|
95 | + return rest_ensure_response( $data ); |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Prepare a report sales object for serialization. |
|
100 | + * |
|
101 | + * @param null $_ |
|
102 | + * @param WP_REST_Request $request Request object. |
|
103 | + * @return WP_REST_Response $response Response data. |
|
104 | + */ |
|
105 | + public function prepare_item_for_response( $_, $request ) { |
|
106 | + |
|
107 | + // Set report range. |
|
108 | + $this->report_range = $this->get_date_range( $request ); |
|
109 | + |
|
110 | + $report_data = $this->get_report_data(); |
|
111 | + $period_totals = array(); |
|
112 | + |
|
113 | + // Setup period totals by ensuring each period in the interval has data. |
|
114 | + $start_date = strtotime( $this->report_range['after'] ); |
|
115 | + |
|
116 | + if ( 'month' === $this->groupby ) { |
|
117 | + $start_date = strtotime( gmdate( 'Y-m-01', $start_date ) ); |
|
118 | + } |
|
119 | + |
|
120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | + |
|
122 | + switch ( $this->groupby ) { |
|
123 | + case 'day': |
|
124 | + $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | + break; |
|
126 | + default: |
|
127 | + $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | + break; |
|
129 | + } |
|
130 | + |
|
131 | + // Set the defaults for each period. |
|
132 | + $period_totals[ $time ] = array( |
|
133 | + 'invoices' => 0, |
|
134 | + 'items' => 0, |
|
135 | + 'refunded_items' => 0, |
|
136 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | + ); |
|
142 | + |
|
143 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | + if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | + } |
|
147 | + } |
|
148 | + } |
|
149 | + |
|
150 | + // add total sales, total invoice count, total tax for each period |
|
151 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | + foreach ( $report_data->invoices as $invoice ) { |
|
153 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
154 | + |
|
155 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | + continue; |
|
157 | + } |
|
158 | + |
|
159 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
163 | + |
|
164 | + } |
|
165 | + |
|
166 | + foreach ( $report_data->refunds as $invoice ) { |
|
167 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
168 | + |
|
169 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | + continue; |
|
171 | + } |
|
172 | + |
|
173 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
177 | + |
|
178 | + } |
|
179 | + |
|
180 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
182 | + |
|
183 | + if ( isset( $period_totals[ $time ] ) ) { |
|
184 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + // Add total invoice items for each period. |
|
189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | + |
|
192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | + } |
|
195 | + } |
|
196 | + |
|
197 | + // Add total discount for each period. |
|
198 | + foreach ( $report_data->coupons as $discount ) { |
|
199 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) ); |
|
200 | + |
|
201 | + if ( isset( $period_totals[ $time ] ) ) { |
|
202 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | + } |
|
204 | + } |
|
205 | + |
|
206 | + // Extra fields. |
|
207 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | + |
|
209 | + // Abort unprepared. |
|
210 | + if ( ! isset( $report_data->$key ) ) { |
|
211 | + continue; |
|
212 | + } |
|
213 | + |
|
214 | + // Abort defaults. |
|
215 | + if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | + continue; |
|
217 | + } |
|
218 | + |
|
219 | + // Set values. |
|
220 | + foreach ( $report_data->$key as $item ) { |
|
221 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) ); |
|
222 | + |
|
223 | + if ( isset( $period_totals[ $time ] ) ) { |
|
224 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + unset( $report_data->$key ); |
|
229 | + } |
|
230 | + |
|
231 | + $report_data->totals = $period_totals; |
|
232 | + $report_data->grouped_by = $this->groupby; |
|
233 | + $report_data->interval = max( $this->interval, 1 ); |
|
234 | + $report_data->currency = wpinv_get_currency(); |
|
235 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | + $report_data->currency_position = wpinv_currency_position(); |
|
237 | + $report_data->decimal_places = wpinv_decimals(); |
|
238 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | + $report_data->start_date = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ); |
|
241 | + $report_data->end_date = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ); |
|
242 | + $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) ); |
|
243 | + $report_data->end_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) ); |
|
244 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | + |
|
246 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | + $data = $report_data; |
|
248 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | + $data = $this->filter_response_by_context( $data, $context ); |
|
251 | + |
|
252 | + // Wrap the data in a response object. |
|
253 | + $response = rest_ensure_response( $data ); |
|
254 | + $response->add_links( |
|
255 | + array( |
|
256 | + 'about' => array( |
|
257 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | + ), |
|
259 | + ) |
|
260 | + ); |
|
261 | + |
|
262 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Get report data. |
|
267 | + * |
|
268 | + * @return stdClass |
|
269 | + */ |
|
270 | + public function get_report_data() { |
|
271 | + if ( empty( $this->report_data ) ) { |
|
272 | + $this->query_report_data(); |
|
273 | + } |
|
274 | + return $this->report_data; |
|
275 | + } |
|
276 | + |
|
277 | + /** |
|
278 | + * Get all data needed for this report and store in the class. |
|
279 | + */ |
|
280 | + protected function query_report_data() { |
|
281 | + |
|
282 | + // Prepare reports. |
|
283 | + $this->report_data = (object) array( |
|
284 | + 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | + 'previous_range' => $this->previous_range, |
|
291 | + ); |
|
292 | + |
|
293 | + // Calculated totals. |
|
294 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | + |
|
307 | + // Calculate average based on net. |
|
308 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | + |
|
311 | + // Total invoices in this period, even if refunded. |
|
312 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | + |
|
314 | + // Items invoiced in this period, even if refunded. |
|
315 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | + |
|
317 | + // 3rd party filtering of report data |
|
318 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | + } |
|
320 | + |
|
321 | + /** |
|
322 | + * Prepares invoice counts. |
|
323 | + * |
|
324 | + * @return array. |
|
325 | + */ |
|
326 | + protected function query_invoice_counts() { |
|
327 | + |
|
328 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | + array( |
|
330 | + 'data' => array( |
|
331 | + 'ID' => array( |
|
332 | + 'type' => 'post_data', |
|
333 | + 'function' => 'COUNT', |
|
334 | + 'name' => 'count', |
|
335 | + 'distinct' => true, |
|
336 | + ), |
|
337 | + 'post_date' => array( |
|
338 | + 'type' => 'post_data', |
|
339 | + 'function' => 'MIN', |
|
340 | + 'name' => 'post_date', |
|
341 | + ), |
|
342 | + ), |
|
343 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | + 'order_by' => 'post_date ASC', |
|
345 | + 'query_type' => 'get_results', |
|
346 | + 'filter_range' => $this->report_range, |
|
347 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | + ) |
|
349 | + ); |
|
350 | + |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * Prepares coupon counts. |
|
355 | + * |
|
356 | + * @return array. |
|
357 | + */ |
|
358 | + protected function query_coupon_counts() { |
|
359 | + |
|
360 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | + array( |
|
362 | + 'data' => array( |
|
363 | + 'discount' => array( |
|
364 | + 'type' => 'invoice_data', |
|
365 | + 'function' => 'SUM', |
|
366 | + 'name' => 'discount_amount', |
|
367 | + ), |
|
368 | + 'post_date' => array( |
|
369 | + 'type' => 'post_data', |
|
370 | + 'function' => 'MIN', |
|
371 | + 'name' => 'post_date', |
|
372 | + ), |
|
373 | + ), |
|
374 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | + 'order_by' => 'post_date ASC', |
|
376 | + 'query_type' => 'get_results', |
|
377 | + 'filter_range' => $this->report_range, |
|
378 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | + ) |
|
380 | + ); |
|
381 | + |
|
382 | + } |
|
383 | + |
|
384 | + /** |
|
385 | + * Prepares item counts. |
|
386 | + * |
|
387 | + * @return array. |
|
388 | + */ |
|
389 | + protected function query_item_counts() { |
|
390 | + |
|
391 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
392 | + array( |
|
393 | + 'data' => array( |
|
394 | + 'quantity' => array( |
|
395 | + 'type' => 'invoice_item', |
|
396 | + 'function' => 'SUM', |
|
397 | + 'name' => 'invoice_item_count', |
|
398 | + ), |
|
399 | + 'post_date' => array( |
|
400 | + 'type' => 'post_data', |
|
401 | + 'function' => 'MIN', |
|
402 | + 'name' => 'post_date', |
|
403 | + ), |
|
404 | + ), |
|
405 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | + 'order_by' => 'post_date ASC', |
|
407 | + 'query_type' => 'get_results', |
|
408 | + 'filter_range' => $this->report_range, |
|
409 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
410 | + ) |
|
411 | + ); |
|
412 | + |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * Prepares refunded item counts. |
|
417 | + * |
|
418 | + * @return array. |
|
419 | + */ |
|
420 | + protected function count_refunded_items() { |
|
421 | + |
|
422 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | + array( |
|
424 | + 'data' => array( |
|
425 | + 'quantity' => array( |
|
426 | + 'type' => 'invoice_item', |
|
427 | + 'function' => 'SUM', |
|
428 | + 'name' => 'invoice_item_count', |
|
429 | + ), |
|
430 | + ), |
|
431 | + 'query_type' => 'get_var', |
|
432 | + 'filter_range' => $this->report_range, |
|
433 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | + ) |
|
435 | + ); |
|
436 | + |
|
437 | + } |
|
438 | + |
|
439 | + /** |
|
440 | + * Prepares daily invoice totals. |
|
441 | + * |
|
442 | + * @return array. |
|
443 | + */ |
|
444 | + protected function query_invoice_totals() { |
|
445 | + |
|
446 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | + array( |
|
448 | + 'data' => array( |
|
449 | + 'total' => array( |
|
450 | + 'type' => 'invoice_data', |
|
451 | + 'function' => 'SUM', |
|
452 | + 'name' => 'total_sales', |
|
453 | + ), |
|
454 | + 'tax' => array( |
|
455 | + 'type' => 'invoice_data', |
|
456 | + 'function' => 'SUM', |
|
457 | + 'name' => 'total_tax', |
|
458 | + ), |
|
459 | + 'discount' => array( |
|
460 | + 'type' => 'invoice_data', |
|
461 | + 'function' => 'SUM', |
|
462 | + 'name' => 'total_discount', |
|
463 | + ), |
|
464 | + 'fees_total' => array( |
|
465 | + 'type' => 'invoice_data', |
|
466 | + 'function' => 'SUM', |
|
467 | + 'name' => 'total_fees', |
|
468 | + ), |
|
469 | + 'subtotal' => array( |
|
470 | + 'type' => 'invoice_data', |
|
471 | + 'function' => 'SUM', |
|
472 | + 'name' => 'subtotal', |
|
473 | + ), |
|
474 | + 'post_date' => array( |
|
475 | + 'type' => 'post_data', |
|
476 | + 'function' => '', |
|
477 | + 'name' => 'post_date', |
|
478 | + ), |
|
479 | + ), |
|
480 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | + 'order_by' => 'post_date ASC', |
|
482 | + 'query_type' => 'get_results', |
|
483 | + 'filter_range' => $this->report_range, |
|
484 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | + ) |
|
486 | + ); |
|
487 | + |
|
488 | + } |
|
489 | + |
|
490 | + /** |
|
491 | + * Prepares daily invoice totals. |
|
492 | + * |
|
493 | + * @return array. |
|
494 | + */ |
|
495 | + protected function query_refunded_totals() { |
|
496 | + |
|
497 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | + array( |
|
499 | + 'data' => array( |
|
500 | + 'total' => array( |
|
501 | + 'type' => 'invoice_data', |
|
502 | + 'function' => 'SUM', |
|
503 | + 'name' => 'total_sales', |
|
504 | + ), |
|
505 | + 'tax' => array( |
|
506 | + 'type' => 'invoice_data', |
|
507 | + 'function' => 'SUM', |
|
508 | + 'name' => 'total_tax', |
|
509 | + ), |
|
510 | + 'discount' => array( |
|
511 | + 'type' => 'invoice_data', |
|
512 | + 'function' => 'SUM', |
|
513 | + 'name' => 'total_discount', |
|
514 | + ), |
|
515 | + 'fees_total' => array( |
|
516 | + 'type' => 'invoice_data', |
|
517 | + 'function' => 'SUM', |
|
518 | + 'name' => 'total_fees', |
|
519 | + ), |
|
520 | + 'subtotal' => array( |
|
521 | + 'type' => 'invoice_data', |
|
522 | + 'function' => 'SUM', |
|
523 | + 'name' => 'subtotal', |
|
524 | + ), |
|
525 | + 'post_date' => array( |
|
526 | + 'type' => 'post_data', |
|
527 | + 'function' => '', |
|
528 | + 'name' => 'post_date', |
|
529 | + ), |
|
530 | + ), |
|
531 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | + 'order_by' => 'post_date ASC', |
|
533 | + 'query_type' => 'get_results', |
|
534 | + 'filter_range' => $this->report_range, |
|
535 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | + ) |
|
537 | + ); |
|
538 | + |
|
539 | + } |
|
540 | + |
|
541 | + /** |
|
542 | + * Get the Report's schema, conforming to JSON Schema. |
|
543 | + * |
|
544 | + * @return array |
|
545 | + */ |
|
546 | + public function get_item_schema() { |
|
547 | + |
|
548 | + $schema = array( |
|
549 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | + 'title' => 'sales_report', |
|
551 | + 'type' => 'object', |
|
552 | + 'properties' => array( |
|
553 | + 'total_sales' => array( |
|
554 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | + 'type' => 'string', |
|
556 | + 'context' => array( 'view' ), |
|
557 | + 'readonly' => true, |
|
558 | + ), |
|
559 | + 'net_sales' => array( |
|
560 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | + 'type' => 'string', |
|
562 | + 'context' => array( 'view' ), |
|
563 | + 'readonly' => true, |
|
564 | + ), |
|
565 | + 'average_sales' => array( |
|
566 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | + 'type' => 'string', |
|
568 | + 'context' => array( 'view' ), |
|
569 | + 'readonly' => true, |
|
570 | + ), |
|
571 | + 'average_total_sales' => array( |
|
572 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | + 'type' => 'string', |
|
574 | + 'context' => array( 'view' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'total_invoices' => array( |
|
578 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | + 'type' => 'integer', |
|
580 | + 'context' => array( 'view' ), |
|
581 | + 'readonly' => true, |
|
582 | + ), |
|
583 | + 'total_items' => array( |
|
584 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | + 'type' => 'integer', |
|
586 | + 'context' => array( 'view' ), |
|
587 | + 'readonly' => true, |
|
588 | + ), |
|
589 | + 'refunded_items' => array( |
|
590 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | + 'type' => 'integer', |
|
592 | + 'context' => array( 'view' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'total_tax' => array( |
|
596 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | + 'type' => 'string', |
|
598 | + 'context' => array( 'view' ), |
|
599 | + 'readonly' => true, |
|
600 | + ), |
|
601 | + 'total_refunded_tax' => array( |
|
602 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | + 'type' => 'string', |
|
604 | + 'context' => array( 'view' ), |
|
605 | + 'readonly' => true, |
|
606 | + ), |
|
607 | + 'total_fees' => array( |
|
608 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | + 'type' => 'string', |
|
610 | + 'context' => array( 'view' ), |
|
611 | + 'readonly' => true, |
|
612 | + ), |
|
613 | + 'total_refunds' => array( |
|
614 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | + 'type' => 'integer', |
|
616 | + 'context' => array( 'view' ), |
|
617 | + 'readonly' => true, |
|
618 | + ), |
|
619 | + 'net_refunds' => array( |
|
620 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | + 'type' => 'integer', |
|
622 | + 'context' => array( 'view' ), |
|
623 | + 'readonly' => true, |
|
624 | + ), |
|
625 | + 'total_discount' => array( |
|
626 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | + 'type' => 'integer', |
|
628 | + 'context' => array( 'view' ), |
|
629 | + 'readonly' => true, |
|
630 | + ), |
|
631 | + 'totals' => array( |
|
632 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | + 'type' => 'array', |
|
634 | + 'items' => array( |
|
635 | + 'type' => 'array', |
|
636 | + ), |
|
637 | + 'context' => array( 'view' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | + 'interval' => array( |
|
641 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | + 'type' => 'integer', |
|
643 | + 'context' => array( 'view' ), |
|
644 | + 'readonly' => true, |
|
645 | + ), |
|
646 | + 'previous_range' => array( |
|
647 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | + 'type' => 'array', |
|
649 | + 'items' => array( |
|
650 | + 'type' => 'string', |
|
651 | + ), |
|
652 | + 'context' => array( 'view' ), |
|
653 | + 'readonly' => true, |
|
654 | + ), |
|
655 | + 'grouped_by' => array( |
|
656 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | + 'type' => 'string', |
|
658 | + 'context' => array( 'view' ), |
|
659 | + 'enum' => array( 'day', 'month' ), |
|
660 | + 'readonly' => true, |
|
661 | + ), |
|
662 | + 'currency' => array( |
|
663 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | + 'type' => 'string', |
|
665 | + 'context' => array( 'view' ), |
|
666 | + 'readonly' => true, |
|
667 | + ), |
|
668 | + 'currency_symbol' => array( |
|
669 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | + 'type' => 'string', |
|
671 | + 'context' => array( 'view' ), |
|
672 | + 'readonly' => true, |
|
673 | + ), |
|
674 | + 'currency_position' => array( |
|
675 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | + 'type' => 'string', |
|
677 | + 'context' => array( 'view' ), |
|
678 | + 'readonly' => true, |
|
679 | + ), |
|
680 | + 'decimal_places' => array( |
|
681 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | + 'type' => 'string', |
|
683 | + 'context' => array( 'view' ), |
|
684 | + 'readonly' => true, |
|
685 | + ), |
|
686 | + 'thousands_sep' => array( |
|
687 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | + 'type' => 'string', |
|
689 | + 'context' => array( 'view' ), |
|
690 | + 'readonly' => true, |
|
691 | + ), |
|
692 | + 'decimals_sep' => array( |
|
693 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | + 'type' => 'string', |
|
695 | + 'context' => array( 'view' ), |
|
696 | + 'readonly' => true, |
|
697 | + ), |
|
698 | + ), |
|
699 | + ); |
|
700 | + |
|
701 | + return $this->add_additional_fields_schema( $schema ); |
|
702 | + |
|
703 | + } |
|
704 | 704 | |
705 | 705 | } |
@@ -18,756 +18,756 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * An array of available settings. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $settings; |
|
27 | - |
|
28 | - /** |
|
29 | - * Route base. |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $rest_base = 'settings'; |
|
34 | - |
|
35 | - /** |
|
36 | - * Registers the routes for the objects of the controller. |
|
37 | - * |
|
38 | - * @since 2.0.0 |
|
39 | - * |
|
40 | - * @see register_rest_route() |
|
41 | - */ |
|
42 | - public function register_namespace_routes( $namespace ) { |
|
43 | - |
|
44 | - // List all registered tabs. |
|
45 | - register_rest_route( |
|
46 | - $namespace, |
|
47 | - $this->rest_base, |
|
48 | - array( |
|
49 | - array( |
|
50 | - 'methods' => WP_REST_Server::READABLE, |
|
51 | - 'callback' => array( $this, 'get_tabs' ), |
|
52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | - ), |
|
54 | - 'schema' => '__return_empty_array', |
|
55 | - ) |
|
56 | - ); |
|
57 | - |
|
58 | - // View/Update a single setting. |
|
59 | - register_rest_route( |
|
60 | - $namespace, |
|
61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | - array( |
|
63 | - 'args' => array( |
|
64 | - 'id' => array( |
|
65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | - 'type' => 'string', |
|
67 | - 'required' => true, |
|
68 | - ), |
|
69 | - ), |
|
70 | - array( |
|
71 | - 'methods' => WP_REST_Server::READABLE, |
|
72 | - 'callback' => array( $this, 'get_item' ), |
|
73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | - ), |
|
75 | - array( |
|
76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
77 | - 'callback' => array( $this, 'update_item' ), |
|
78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | - ), |
|
81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | - ) |
|
83 | - ); |
|
84 | - |
|
85 | - // List registered sections for a given tab. |
|
86 | - register_rest_route( |
|
87 | - $namespace, |
|
88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | - array( |
|
90 | - 'args' => array( |
|
91 | - 'tab' => array( |
|
92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | - 'type' => 'string', |
|
94 | - 'required' => true, |
|
95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | - ), |
|
97 | - ), |
|
98 | - array( |
|
99 | - 'methods' => WP_REST_Server::READABLE, |
|
100 | - 'callback' => array( $this, 'get_sections' ), |
|
101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | - ), |
|
103 | - 'schema' => '__return_empty_array', |
|
104 | - ) |
|
105 | - ); |
|
106 | - |
|
107 | - // List all registered settings for a given tab. |
|
108 | - register_rest_route( |
|
109 | - $namespace, |
|
110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | - array( |
|
112 | - 'args' => array( |
|
113 | - 'tab' => array( |
|
114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'required' => true, |
|
117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | - ), |
|
119 | - 'section' => array( |
|
120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | - 'type' => 'string', |
|
122 | - 'required' => true, |
|
123 | - ), |
|
124 | - ), |
|
125 | - array( |
|
126 | - 'methods' => WP_REST_Server::READABLE, |
|
127 | - 'callback' => array( $this, 'get_items' ), |
|
128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | - ), |
|
130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | - ) |
|
132 | - ); |
|
133 | - |
|
134 | - register_rest_route( |
|
135 | - $namespace, |
|
136 | - '/' . $this->rest_base . '/batch', |
|
137 | - array( |
|
138 | - 'args' => array( |
|
139 | - 'id' => array( |
|
140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - ), |
|
143 | - ), |
|
144 | - array( |
|
145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
146 | - 'callback' => array( $this, 'batch_items' ), |
|
147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | - ), |
|
150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | - ) |
|
152 | - ); |
|
153 | - |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Return all settings. |
|
158 | - * |
|
159 | - * @since 2.0.0 |
|
160 | - * @param WP_REST_Request $request Request data. |
|
161 | - * @return WP_Error|WP_REST_Response |
|
162 | - */ |
|
163 | - public function get_items( $request ) { |
|
164 | - |
|
165 | - $settings = $this->get_settings(); |
|
166 | - |
|
167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | - } |
|
170 | - |
|
171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | - } |
|
174 | - |
|
175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | - $prepared = array(); |
|
177 | - |
|
178 | - foreach ( $settings as $setting ) { |
|
179 | - |
|
180 | - $setting = $this->sanitize_setting( $setting ); |
|
181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | - |
|
184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | - $prepared[] = $setting_data; |
|
186 | - } |
|
21 | + /** |
|
22 | + * An array of available settings. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $settings; |
|
27 | + |
|
28 | + /** |
|
29 | + * Route base. |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $rest_base = 'settings'; |
|
34 | + |
|
35 | + /** |
|
36 | + * Registers the routes for the objects of the controller. |
|
37 | + * |
|
38 | + * @since 2.0.0 |
|
39 | + * |
|
40 | + * @see register_rest_route() |
|
41 | + */ |
|
42 | + public function register_namespace_routes( $namespace ) { |
|
43 | + |
|
44 | + // List all registered tabs. |
|
45 | + register_rest_route( |
|
46 | + $namespace, |
|
47 | + $this->rest_base, |
|
48 | + array( |
|
49 | + array( |
|
50 | + 'methods' => WP_REST_Server::READABLE, |
|
51 | + 'callback' => array( $this, 'get_tabs' ), |
|
52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | + ), |
|
54 | + 'schema' => '__return_empty_array', |
|
55 | + ) |
|
56 | + ); |
|
57 | + |
|
58 | + // View/Update a single setting. |
|
59 | + register_rest_route( |
|
60 | + $namespace, |
|
61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | + array( |
|
63 | + 'args' => array( |
|
64 | + 'id' => array( |
|
65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | + 'type' => 'string', |
|
67 | + 'required' => true, |
|
68 | + ), |
|
69 | + ), |
|
70 | + array( |
|
71 | + 'methods' => WP_REST_Server::READABLE, |
|
72 | + 'callback' => array( $this, 'get_item' ), |
|
73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | + ), |
|
75 | + array( |
|
76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
77 | + 'callback' => array( $this, 'update_item' ), |
|
78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | + ), |
|
81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | + ) |
|
83 | + ); |
|
84 | + |
|
85 | + // List registered sections for a given tab. |
|
86 | + register_rest_route( |
|
87 | + $namespace, |
|
88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | + array( |
|
90 | + 'args' => array( |
|
91 | + 'tab' => array( |
|
92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | + 'type' => 'string', |
|
94 | + 'required' => true, |
|
95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | + ), |
|
97 | + ), |
|
98 | + array( |
|
99 | + 'methods' => WP_REST_Server::READABLE, |
|
100 | + 'callback' => array( $this, 'get_sections' ), |
|
101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | + ), |
|
103 | + 'schema' => '__return_empty_array', |
|
104 | + ) |
|
105 | + ); |
|
106 | + |
|
107 | + // List all registered settings for a given tab. |
|
108 | + register_rest_route( |
|
109 | + $namespace, |
|
110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | + array( |
|
112 | + 'args' => array( |
|
113 | + 'tab' => array( |
|
114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'required' => true, |
|
117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | + ), |
|
119 | + 'section' => array( |
|
120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | + 'type' => 'string', |
|
122 | + 'required' => true, |
|
123 | + ), |
|
124 | + ), |
|
125 | + array( |
|
126 | + 'methods' => WP_REST_Server::READABLE, |
|
127 | + 'callback' => array( $this, 'get_items' ), |
|
128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | + ), |
|
130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | + ) |
|
132 | + ); |
|
133 | + |
|
134 | + register_rest_route( |
|
135 | + $namespace, |
|
136 | + '/' . $this->rest_base . '/batch', |
|
137 | + array( |
|
138 | + 'args' => array( |
|
139 | + 'id' => array( |
|
140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + ), |
|
143 | + ), |
|
144 | + array( |
|
145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
146 | + 'callback' => array( $this, 'batch_items' ), |
|
147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | + ), |
|
150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | + ) |
|
152 | + ); |
|
153 | + |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Return all settings. |
|
158 | + * |
|
159 | + * @since 2.0.0 |
|
160 | + * @param WP_REST_Request $request Request data. |
|
161 | + * @return WP_Error|WP_REST_Response |
|
162 | + */ |
|
163 | + public function get_items( $request ) { |
|
164 | + |
|
165 | + $settings = $this->get_settings(); |
|
166 | + |
|
167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | + } |
|
170 | + |
|
171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | + } |
|
174 | + |
|
175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | + $prepared = array(); |
|
177 | + |
|
178 | + foreach ( $settings as $setting ) { |
|
179 | + |
|
180 | + $setting = $this->sanitize_setting( $setting ); |
|
181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | + |
|
184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | + $prepared[] = $setting_data; |
|
186 | + } |
|
187 | 187 | } |
188 | 188 | |
189 | - return rest_ensure_response( $prepared ); |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * Return a single setting. |
|
194 | - * |
|
195 | - * @since 2.0.0 |
|
196 | - * @param WP_REST_Request $request Request data. |
|
197 | - * @return WP_Error|WP_REST_Response |
|
198 | - */ |
|
199 | - public function get_item( $request ) { |
|
200 | - $setting = $this->get_setting( $request['id'] ); |
|
201 | - |
|
202 | - if ( is_wp_error( $setting ) ) { |
|
203 | - return $setting; |
|
204 | - } |
|
205 | - |
|
206 | - $setting = $this->sanitize_setting( $setting ); |
|
207 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
208 | - return rest_ensure_response( $response ); |
|
209 | - } |
|
210 | - |
|
211 | - /** |
|
212 | - * Update a single setting. |
|
213 | - * |
|
214 | - * @since 2.0.0 |
|
215 | - * @param WP_REST_Request $request Request data. |
|
216 | - * @return WP_Error|WP_REST_Response |
|
217 | - */ |
|
218 | - public function update_item( $request ) { |
|
219 | - $setting = $this->get_setting( $request['id'] ); |
|
220 | - |
|
221 | - if ( is_wp_error( $setting ) ) { |
|
222 | - return $setting; |
|
223 | - } |
|
224 | - |
|
225 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
226 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
227 | - } else { |
|
228 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
229 | - } |
|
230 | - |
|
231 | - if ( is_wp_error( $value ) ) { |
|
232 | - return $value; |
|
233 | - } |
|
234 | - |
|
235 | - wpinv_update_option( $request['id'], $value ); |
|
236 | - $setting['value'] = $value; |
|
237 | - $setting = $this->sanitize_setting( $setting ); |
|
238 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
239 | - |
|
240 | - return rest_ensure_response( $response ); |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Makes sure the current user has access to READ the settings APIs. |
|
245 | - * |
|
246 | - * @since 2.0.0 |
|
247 | - * @param WP_REST_Request $request Full data about the request. |
|
248 | - * @return WP_Error|boolean |
|
249 | - */ |
|
250 | - public function get_items_permissions_check( $request ) { |
|
251 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
252 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
253 | - } |
|
254 | - |
|
255 | - return true; |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
260 | - * |
|
261 | - * @since 2.0.0 |
|
262 | - * @param WP_REST_Request $request Full data about the request. |
|
263 | - * @return WP_Error|boolean |
|
264 | - */ |
|
265 | - public function update_items_permissions_check( $request ) { |
|
266 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
267 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
268 | - } |
|
269 | - |
|
270 | - return true; |
|
271 | - } |
|
272 | - |
|
273 | - /** |
|
274 | - * Check if a given request has access batch create, update and delete items. |
|
275 | - * |
|
276 | - * @param WP_REST_Request $request Full details about the request. |
|
277 | - * |
|
278 | - * @return boolean|WP_Error |
|
279 | - */ |
|
280 | - public function batch_items_permissions_check( $request ) { |
|
281 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * Prepare links for the request. |
|
286 | - * |
|
287 | - * @param string $setting_id Setting ID. |
|
288 | - * @return array Links for the given setting. |
|
289 | - */ |
|
290 | - protected function prepare_links( $setting_id ) { |
|
291 | - |
|
292 | - $links = array( |
|
293 | - 'self' => array( |
|
294 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
295 | - ), |
|
296 | - 'collection' => array( |
|
297 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
298 | - ), |
|
299 | - ); |
|
300 | - |
|
301 | - return $links; |
|
302 | - } |
|
303 | - |
|
304 | - /** |
|
305 | - * Prepare a settings object for serialization. |
|
306 | - * |
|
307 | - * @since 2.0.0 |
|
308 | - * @param array $item Setting object. |
|
309 | - * @param WP_REST_Request $request Request object. |
|
310 | - * @return WP_REST_Response $response Response data. |
|
311 | - */ |
|
312 | - public function prepare_item_for_response( $item, $request ) { |
|
313 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
314 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
315 | - $data = $this->filter_response_by_context( $data, $context ); |
|
316 | - |
|
317 | - $response = rest_ensure_response( $data ); |
|
318 | - |
|
319 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
320 | - |
|
321 | - return $response; |
|
322 | - } |
|
323 | - |
|
324 | - /** |
|
325 | - * Filters out bad values from the settings array/filter so we |
|
326 | - * only return known values via the API. |
|
327 | - * |
|
328 | - * @since 2.0.0 |
|
329 | - * @param array $setting Setting. |
|
330 | - * @return array |
|
331 | - */ |
|
332 | - public function filter_setting( $setting ) { |
|
333 | - return array_intersect_key( |
|
334 | - $setting, |
|
335 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
336 | - ); |
|
337 | - } |
|
338 | - |
|
339 | - /** |
|
340 | - * Callback for allowed keys for each setting response. |
|
341 | - * |
|
342 | - * @param string $key Key to check. |
|
343 | - * @return boolean |
|
344 | - */ |
|
345 | - public function allowed_setting_keys( $key ) { |
|
346 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Returns default options for a setting. null means the field is required. |
|
351 | - * |
|
352 | - * @since 2.0.0 |
|
353 | - * @return array |
|
354 | - */ |
|
355 | - protected function setting_defaults() { |
|
356 | - return array( |
|
357 | - 'id' => null, |
|
358 | - 'name' => null, |
|
359 | - 'desc' => '', |
|
360 | - 'options' => array(), |
|
361 | - 'std' => false, |
|
362 | - 'value' => false, |
|
363 | - 'placeholder' => '', |
|
364 | - 'readonly' => false, |
|
365 | - 'faux' => false, |
|
366 | - 'section' => 'main', |
|
367 | - 'tab' => 'general', |
|
368 | - 'type' => 'text', |
|
369 | - ); |
|
370 | - } |
|
371 | - |
|
372 | - /** |
|
373 | - * Sanitizes a setting's field. |
|
374 | - * |
|
375 | - * @param array $setting The setting to sanitize. |
|
376 | - * @return array |
|
377 | - */ |
|
378 | - public function sanitize_setting( $setting ) { |
|
379 | - |
|
380 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
381 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
382 | - return $this->filter_setting( $setting ); |
|
383 | - |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Get setting data. |
|
388 | - * |
|
389 | - * @since 2.0.0 |
|
390 | - * @param string $setting_id Setting ID. |
|
391 | - * @return array|WP_Error |
|
392 | - */ |
|
393 | - public function get_setting( $setting_id ) { |
|
394 | - |
|
395 | - if ( empty( $setting_id ) ) { |
|
396 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
397 | - } |
|
398 | - |
|
399 | - $settings = $this->get_settings(); |
|
400 | - |
|
401 | - foreach ( $settings as $tabs ) { |
|
402 | - |
|
403 | - foreach ( $tabs as $sections ) { |
|
404 | - |
|
405 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
406 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
407 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
408 | - } |
|
409 | - |
|
410 | - return $sections[ $setting_id ]; |
|
411 | - } |
|
189 | + return rest_ensure_response( $prepared ); |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * Return a single setting. |
|
194 | + * |
|
195 | + * @since 2.0.0 |
|
196 | + * @param WP_REST_Request $request Request data. |
|
197 | + * @return WP_Error|WP_REST_Response |
|
198 | + */ |
|
199 | + public function get_item( $request ) { |
|
200 | + $setting = $this->get_setting( $request['id'] ); |
|
201 | + |
|
202 | + if ( is_wp_error( $setting ) ) { |
|
203 | + return $setting; |
|
204 | + } |
|
205 | + |
|
206 | + $setting = $this->sanitize_setting( $setting ); |
|
207 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
208 | + return rest_ensure_response( $response ); |
|
209 | + } |
|
210 | + |
|
211 | + /** |
|
212 | + * Update a single setting. |
|
213 | + * |
|
214 | + * @since 2.0.0 |
|
215 | + * @param WP_REST_Request $request Request data. |
|
216 | + * @return WP_Error|WP_REST_Response |
|
217 | + */ |
|
218 | + public function update_item( $request ) { |
|
219 | + $setting = $this->get_setting( $request['id'] ); |
|
220 | + |
|
221 | + if ( is_wp_error( $setting ) ) { |
|
222 | + return $setting; |
|
223 | + } |
|
224 | + |
|
225 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
226 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
227 | + } else { |
|
228 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
229 | + } |
|
230 | + |
|
231 | + if ( is_wp_error( $value ) ) { |
|
232 | + return $value; |
|
233 | + } |
|
234 | + |
|
235 | + wpinv_update_option( $request['id'], $value ); |
|
236 | + $setting['value'] = $value; |
|
237 | + $setting = $this->sanitize_setting( $setting ); |
|
238 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
239 | + |
|
240 | + return rest_ensure_response( $response ); |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Makes sure the current user has access to READ the settings APIs. |
|
245 | + * |
|
246 | + * @since 2.0.0 |
|
247 | + * @param WP_REST_Request $request Full data about the request. |
|
248 | + * @return WP_Error|boolean |
|
249 | + */ |
|
250 | + public function get_items_permissions_check( $request ) { |
|
251 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
252 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
253 | + } |
|
254 | + |
|
255 | + return true; |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
260 | + * |
|
261 | + * @since 2.0.0 |
|
262 | + * @param WP_REST_Request $request Full data about the request. |
|
263 | + * @return WP_Error|boolean |
|
264 | + */ |
|
265 | + public function update_items_permissions_check( $request ) { |
|
266 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
267 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
268 | + } |
|
269 | + |
|
270 | + return true; |
|
271 | + } |
|
272 | + |
|
273 | + /** |
|
274 | + * Check if a given request has access batch create, update and delete items. |
|
275 | + * |
|
276 | + * @param WP_REST_Request $request Full details about the request. |
|
277 | + * |
|
278 | + * @return boolean|WP_Error |
|
279 | + */ |
|
280 | + public function batch_items_permissions_check( $request ) { |
|
281 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * Prepare links for the request. |
|
286 | + * |
|
287 | + * @param string $setting_id Setting ID. |
|
288 | + * @return array Links for the given setting. |
|
289 | + */ |
|
290 | + protected function prepare_links( $setting_id ) { |
|
291 | + |
|
292 | + $links = array( |
|
293 | + 'self' => array( |
|
294 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
295 | + ), |
|
296 | + 'collection' => array( |
|
297 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
298 | + ), |
|
299 | + ); |
|
300 | + |
|
301 | + return $links; |
|
302 | + } |
|
303 | + |
|
304 | + /** |
|
305 | + * Prepare a settings object for serialization. |
|
306 | + * |
|
307 | + * @since 2.0.0 |
|
308 | + * @param array $item Setting object. |
|
309 | + * @param WP_REST_Request $request Request object. |
|
310 | + * @return WP_REST_Response $response Response data. |
|
311 | + */ |
|
312 | + public function prepare_item_for_response( $item, $request ) { |
|
313 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
314 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
315 | + $data = $this->filter_response_by_context( $data, $context ); |
|
316 | + |
|
317 | + $response = rest_ensure_response( $data ); |
|
318 | + |
|
319 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
320 | + |
|
321 | + return $response; |
|
322 | + } |
|
323 | + |
|
324 | + /** |
|
325 | + * Filters out bad values from the settings array/filter so we |
|
326 | + * only return known values via the API. |
|
327 | + * |
|
328 | + * @since 2.0.0 |
|
329 | + * @param array $setting Setting. |
|
330 | + * @return array |
|
331 | + */ |
|
332 | + public function filter_setting( $setting ) { |
|
333 | + return array_intersect_key( |
|
334 | + $setting, |
|
335 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
336 | + ); |
|
337 | + } |
|
338 | + |
|
339 | + /** |
|
340 | + * Callback for allowed keys for each setting response. |
|
341 | + * |
|
342 | + * @param string $key Key to check. |
|
343 | + * @return boolean |
|
344 | + */ |
|
345 | + public function allowed_setting_keys( $key ) { |
|
346 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Returns default options for a setting. null means the field is required. |
|
351 | + * |
|
352 | + * @since 2.0.0 |
|
353 | + * @return array |
|
354 | + */ |
|
355 | + protected function setting_defaults() { |
|
356 | + return array( |
|
357 | + 'id' => null, |
|
358 | + 'name' => null, |
|
359 | + 'desc' => '', |
|
360 | + 'options' => array(), |
|
361 | + 'std' => false, |
|
362 | + 'value' => false, |
|
363 | + 'placeholder' => '', |
|
364 | + 'readonly' => false, |
|
365 | + 'faux' => false, |
|
366 | + 'section' => 'main', |
|
367 | + 'tab' => 'general', |
|
368 | + 'type' => 'text', |
|
369 | + ); |
|
370 | + } |
|
371 | + |
|
372 | + /** |
|
373 | + * Sanitizes a setting's field. |
|
374 | + * |
|
375 | + * @param array $setting The setting to sanitize. |
|
376 | + * @return array |
|
377 | + */ |
|
378 | + public function sanitize_setting( $setting ) { |
|
379 | + |
|
380 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
381 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
382 | + return $this->filter_setting( $setting ); |
|
383 | + |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Get setting data. |
|
388 | + * |
|
389 | + * @since 2.0.0 |
|
390 | + * @param string $setting_id Setting ID. |
|
391 | + * @return array|WP_Error |
|
392 | + */ |
|
393 | + public function get_setting( $setting_id ) { |
|
394 | + |
|
395 | + if ( empty( $setting_id ) ) { |
|
396 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
397 | + } |
|
398 | + |
|
399 | + $settings = $this->get_settings(); |
|
400 | + |
|
401 | + foreach ( $settings as $tabs ) { |
|
402 | + |
|
403 | + foreach ( $tabs as $sections ) { |
|
404 | + |
|
405 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
406 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
407 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
408 | + } |
|
409 | + |
|
410 | + return $sections[ $setting_id ]; |
|
411 | + } |
|
412 | 412 | } |
413 | 413 | } |
414 | 414 | |
415 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
416 | - } |
|
417 | - |
|
418 | - /** |
|
419 | - * Get all tabs. |
|
420 | - * |
|
421 | - * @param WP_REST_Request $request Request data. |
|
422 | - * @return array |
|
423 | - */ |
|
424 | - public function get_tabs( $request ) { |
|
425 | - $tabs = wpinv_get_settings_tabs(); |
|
426 | - $prepared = array(); |
|
427 | - |
|
428 | - foreach ( $tabs as $id => $tab ) { |
|
429 | - |
|
430 | - $_request = $request; |
|
431 | - $_request['tab'] = sanitize_title( $id ); |
|
432 | - $data = array( |
|
433 | - 'id' => sanitize_title( $id ), |
|
434 | - 'label' => sanitize_text_field( $tab ), |
|
435 | - 'sections' => $this->get_sections( $_request ), |
|
436 | - ); |
|
437 | - |
|
438 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
439 | - $response = rest_ensure_response( $data ); |
|
440 | - |
|
441 | - if ( ! is_wp_error( $response ) ) { |
|
442 | - $links = array( |
|
443 | - 'sections' => array( |
|
444 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
445 | - ), |
|
446 | - 'collection' => array( |
|
447 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
448 | - ), |
|
449 | - ); |
|
450 | - $response->add_links( $links ); |
|
451 | - $response = $this->prepare_response_for_collection( $response ); |
|
452 | - } |
|
453 | - |
|
454 | - $prepared[] = $response; |
|
455 | - |
|
456 | - } |
|
457 | - |
|
458 | - return rest_ensure_response( $prepared ); |
|
459 | - } |
|
460 | - |
|
461 | - /** |
|
462 | - * Get all sections. |
|
463 | - * |
|
464 | - * @param WP_REST_Request $request Request data. |
|
465 | - * @return array |
|
466 | - */ |
|
467 | - public function get_sections( $request ) { |
|
468 | - |
|
469 | - $tab = sanitize_title( $request['tab'] ); |
|
470 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
471 | - $prepared = array(); |
|
472 | - |
|
473 | - foreach ( $sections as $id => $section ) { |
|
474 | - |
|
475 | - $data = array( |
|
476 | - 'id' => sanitize_title( $id ), |
|
477 | - 'label' => sanitize_text_field( $section ), |
|
478 | - ); |
|
479 | - |
|
480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
481 | - $response = rest_ensure_response( $data ); |
|
482 | - |
|
483 | - if ( ! is_wp_error( $response ) ) { |
|
484 | - $links = array( |
|
485 | - 'settings' => array( |
|
486 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
487 | - ), |
|
488 | - 'collection' => array( |
|
489 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
490 | - ), |
|
491 | - 'tabs' => array( |
|
492 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
493 | - ), |
|
494 | - ); |
|
495 | - $response->add_links( $links ); |
|
496 | - $response = $this->prepare_response_for_collection( $response ); |
|
497 | - } |
|
498 | - |
|
499 | - $prepared[] = $response; |
|
500 | - |
|
501 | - } |
|
502 | - |
|
503 | - return rest_ensure_response( $prepared ); |
|
504 | - } |
|
505 | - |
|
506 | - /** |
|
507 | - * Get all settings. |
|
508 | - * |
|
509 | - * @return array |
|
510 | - */ |
|
511 | - public function get_settings() { |
|
512 | - |
|
513 | - if ( empty( $this->settings ) ) { |
|
514 | - $this->settings = wpinv_get_registered_settings(); |
|
515 | - } |
|
516 | - |
|
517 | - return $this->settings; |
|
518 | - |
|
519 | - } |
|
520 | - |
|
521 | - /** |
|
522 | - * Boolean for if a setting type is a valid supported setting type. |
|
523 | - * |
|
524 | - * @since 2.0.0 |
|
525 | - * @param string $type Type. |
|
526 | - * @return bool |
|
527 | - */ |
|
528 | - public function is_setting_type_valid( $type ) { |
|
529 | - |
|
530 | - return in_array( |
|
531 | - $type, |
|
415 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
416 | + } |
|
417 | + |
|
418 | + /** |
|
419 | + * Get all tabs. |
|
420 | + * |
|
421 | + * @param WP_REST_Request $request Request data. |
|
422 | + * @return array |
|
423 | + */ |
|
424 | + public function get_tabs( $request ) { |
|
425 | + $tabs = wpinv_get_settings_tabs(); |
|
426 | + $prepared = array(); |
|
427 | + |
|
428 | + foreach ( $tabs as $id => $tab ) { |
|
429 | + |
|
430 | + $_request = $request; |
|
431 | + $_request['tab'] = sanitize_title( $id ); |
|
432 | + $data = array( |
|
433 | + 'id' => sanitize_title( $id ), |
|
434 | + 'label' => sanitize_text_field( $tab ), |
|
435 | + 'sections' => $this->get_sections( $_request ), |
|
436 | + ); |
|
437 | + |
|
438 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
439 | + $response = rest_ensure_response( $data ); |
|
440 | + |
|
441 | + if ( ! is_wp_error( $response ) ) { |
|
442 | + $links = array( |
|
443 | + 'sections' => array( |
|
444 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
445 | + ), |
|
446 | + 'collection' => array( |
|
447 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
448 | + ), |
|
449 | + ); |
|
450 | + $response->add_links( $links ); |
|
451 | + $response = $this->prepare_response_for_collection( $response ); |
|
452 | + } |
|
453 | + |
|
454 | + $prepared[] = $response; |
|
455 | + |
|
456 | + } |
|
457 | + |
|
458 | + return rest_ensure_response( $prepared ); |
|
459 | + } |
|
460 | + |
|
461 | + /** |
|
462 | + * Get all sections. |
|
463 | + * |
|
464 | + * @param WP_REST_Request $request Request data. |
|
465 | + * @return array |
|
466 | + */ |
|
467 | + public function get_sections( $request ) { |
|
468 | + |
|
469 | + $tab = sanitize_title( $request['tab'] ); |
|
470 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
471 | + $prepared = array(); |
|
472 | + |
|
473 | + foreach ( $sections as $id => $section ) { |
|
474 | + |
|
475 | + $data = array( |
|
476 | + 'id' => sanitize_title( $id ), |
|
477 | + 'label' => sanitize_text_field( $section ), |
|
478 | + ); |
|
479 | + |
|
480 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
481 | + $response = rest_ensure_response( $data ); |
|
482 | + |
|
483 | + if ( ! is_wp_error( $response ) ) { |
|
484 | + $links = array( |
|
485 | + 'settings' => array( |
|
486 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
487 | + ), |
|
488 | + 'collection' => array( |
|
489 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
490 | + ), |
|
491 | + 'tabs' => array( |
|
492 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
493 | + ), |
|
494 | + ); |
|
495 | + $response->add_links( $links ); |
|
496 | + $response = $this->prepare_response_for_collection( $response ); |
|
497 | + } |
|
498 | + |
|
499 | + $prepared[] = $response; |
|
500 | + |
|
501 | + } |
|
502 | + |
|
503 | + return rest_ensure_response( $prepared ); |
|
504 | + } |
|
505 | + |
|
506 | + /** |
|
507 | + * Get all settings. |
|
508 | + * |
|
509 | + * @return array |
|
510 | + */ |
|
511 | + public function get_settings() { |
|
512 | + |
|
513 | + if ( empty( $this->settings ) ) { |
|
514 | + $this->settings = wpinv_get_registered_settings(); |
|
515 | + } |
|
516 | + |
|
517 | + return $this->settings; |
|
518 | + |
|
519 | + } |
|
520 | + |
|
521 | + /** |
|
522 | + * Boolean for if a setting type is a valid supported setting type. |
|
523 | + * |
|
524 | + * @since 2.0.0 |
|
525 | + * @param string $type Type. |
|
526 | + * @return bool |
|
527 | + */ |
|
528 | + public function is_setting_type_valid( $type ) { |
|
529 | + |
|
530 | + return in_array( |
|
531 | + $type, |
|
532 | 532 | array( |
533 | - 'text', // Validates with validate_setting_text_field. |
|
534 | - 'email', // Validates with validate_setting_text_field. |
|
535 | - 'number', // Validates with validate_setting_text_field. |
|
536 | - 'color', // Validates with validate_setting_text_field. |
|
537 | - 'password', // Validates with validate_setting_text_field. |
|
538 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | - 'select', // Validates with validate_setting_select_field. |
|
540 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | - 'header', // Validates with validate_setting_text_field. |
|
544 | - ) |
|
545 | - ); |
|
546 | - |
|
547 | - } |
|
548 | - |
|
549 | - /** |
|
550 | - * Get the settings schema, conforming to JSON Schema. |
|
551 | - * |
|
552 | - * @return array |
|
553 | - */ |
|
554 | - public function get_item_schema() { |
|
555 | - |
|
556 | - // Maybe retrieve the schema from cache. |
|
557 | - if ( ! empty( $this->schema ) ) { |
|
558 | - return $this->add_additional_fields_schema( $this->schema ); |
|
559 | - } |
|
560 | - |
|
561 | - $schema = array( |
|
562 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
563 | - 'title' => 'setting', |
|
564 | - 'type' => 'object', |
|
565 | - 'properties' => array( |
|
566 | - 'id' => array( |
|
567 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
568 | - 'type' => 'string', |
|
569 | - 'arg_options' => array( |
|
570 | - 'sanitize_callback' => 'sanitize_title', |
|
571 | - ), |
|
572 | - 'context' => array( 'view', 'edit' ), |
|
573 | - 'readonly' => true, |
|
574 | - ), |
|
575 | - 'tab' => array( |
|
576 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
577 | - 'type' => 'string', |
|
578 | - 'arg_options' => array( |
|
579 | - 'sanitize_callback' => 'sanitize_title', |
|
580 | - ), |
|
581 | - 'context' => array( 'view', 'edit' ), |
|
582 | - 'readonly' => true, |
|
583 | - ), |
|
584 | - 'section' => array( |
|
585 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
586 | - 'type' => 'string', |
|
587 | - 'arg_options' => array( |
|
588 | - 'sanitize_callback' => 'sanitize_title', |
|
589 | - ), |
|
590 | - 'context' => array( 'view', 'edit' ), |
|
591 | - 'readonly' => true, |
|
592 | - ), |
|
593 | - 'name' => array( |
|
594 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
595 | - 'type' => 'string', |
|
596 | - 'arg_options' => array( |
|
597 | - 'sanitize_callback' => 'sanitize_text_field', |
|
598 | - ), |
|
599 | - 'context' => array( 'view', 'edit' ), |
|
600 | - 'readonly' => true, |
|
601 | - ), |
|
602 | - 'desc' => array( |
|
603 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
604 | - 'type' => 'string', |
|
605 | - 'context' => array( 'view', 'edit' ), |
|
606 | - 'readonly' => true, |
|
607 | - ), |
|
608 | - 'value' => array( |
|
609 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
610 | - 'type' => 'mixed', |
|
611 | - 'context' => array( 'view', 'edit' ), |
|
612 | - ), |
|
613 | - 'default' => array( |
|
614 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
615 | - 'type' => 'mixed', |
|
616 | - 'context' => array( 'view', 'edit' ), |
|
617 | - 'readonly' => true, |
|
618 | - ), |
|
619 | - 'placeholder' => array( |
|
620 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
621 | - 'type' => 'string', |
|
622 | - 'arg_options' => array( |
|
623 | - 'sanitize_callback' => 'sanitize_text_field', |
|
624 | - ), |
|
625 | - 'context' => array( 'view', 'edit' ), |
|
626 | - 'readonly' => true, |
|
627 | - ), |
|
628 | - 'type' => array( |
|
629 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
630 | - 'type' => 'string', |
|
631 | - 'arg_options' => array( |
|
632 | - 'sanitize_callback' => 'sanitize_text_field', |
|
633 | - ), |
|
634 | - 'context' => array( 'view', 'edit' ), |
|
635 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
636 | - 'readonly' => true, |
|
637 | - ), |
|
638 | - 'options' => array( |
|
639 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
640 | - 'type' => 'object', |
|
641 | - 'context' => array( 'view', 'edit' ), |
|
642 | - 'readonly' => true, |
|
643 | - ), |
|
644 | - 'readonly' => array( |
|
645 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
646 | - 'type' => 'string', |
|
647 | - 'context' => array( 'view' ), |
|
648 | - 'readonly' => true, |
|
649 | - ), |
|
650 | - 'faux' => array( |
|
651 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
652 | - 'type' => 'string', |
|
653 | - 'context' => array( 'view' ), |
|
654 | - 'readonly' => true, |
|
655 | - ), |
|
656 | - ), |
|
657 | - ); |
|
658 | - |
|
659 | - // Filters the settings schema for the REST API. |
|
533 | + 'text', // Validates with validate_setting_text_field. |
|
534 | + 'email', // Validates with validate_setting_text_field. |
|
535 | + 'number', // Validates with validate_setting_text_field. |
|
536 | + 'color', // Validates with validate_setting_text_field. |
|
537 | + 'password', // Validates with validate_setting_text_field. |
|
538 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | + 'select', // Validates with validate_setting_select_field. |
|
540 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | + 'header', // Validates with validate_setting_text_field. |
|
544 | + ) |
|
545 | + ); |
|
546 | + |
|
547 | + } |
|
548 | + |
|
549 | + /** |
|
550 | + * Get the settings schema, conforming to JSON Schema. |
|
551 | + * |
|
552 | + * @return array |
|
553 | + */ |
|
554 | + public function get_item_schema() { |
|
555 | + |
|
556 | + // Maybe retrieve the schema from cache. |
|
557 | + if ( ! empty( $this->schema ) ) { |
|
558 | + return $this->add_additional_fields_schema( $this->schema ); |
|
559 | + } |
|
560 | + |
|
561 | + $schema = array( |
|
562 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
563 | + 'title' => 'setting', |
|
564 | + 'type' => 'object', |
|
565 | + 'properties' => array( |
|
566 | + 'id' => array( |
|
567 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
568 | + 'type' => 'string', |
|
569 | + 'arg_options' => array( |
|
570 | + 'sanitize_callback' => 'sanitize_title', |
|
571 | + ), |
|
572 | + 'context' => array( 'view', 'edit' ), |
|
573 | + 'readonly' => true, |
|
574 | + ), |
|
575 | + 'tab' => array( |
|
576 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
577 | + 'type' => 'string', |
|
578 | + 'arg_options' => array( |
|
579 | + 'sanitize_callback' => 'sanitize_title', |
|
580 | + ), |
|
581 | + 'context' => array( 'view', 'edit' ), |
|
582 | + 'readonly' => true, |
|
583 | + ), |
|
584 | + 'section' => array( |
|
585 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
586 | + 'type' => 'string', |
|
587 | + 'arg_options' => array( |
|
588 | + 'sanitize_callback' => 'sanitize_title', |
|
589 | + ), |
|
590 | + 'context' => array( 'view', 'edit' ), |
|
591 | + 'readonly' => true, |
|
592 | + ), |
|
593 | + 'name' => array( |
|
594 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
595 | + 'type' => 'string', |
|
596 | + 'arg_options' => array( |
|
597 | + 'sanitize_callback' => 'sanitize_text_field', |
|
598 | + ), |
|
599 | + 'context' => array( 'view', 'edit' ), |
|
600 | + 'readonly' => true, |
|
601 | + ), |
|
602 | + 'desc' => array( |
|
603 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
604 | + 'type' => 'string', |
|
605 | + 'context' => array( 'view', 'edit' ), |
|
606 | + 'readonly' => true, |
|
607 | + ), |
|
608 | + 'value' => array( |
|
609 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
610 | + 'type' => 'mixed', |
|
611 | + 'context' => array( 'view', 'edit' ), |
|
612 | + ), |
|
613 | + 'default' => array( |
|
614 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
615 | + 'type' => 'mixed', |
|
616 | + 'context' => array( 'view', 'edit' ), |
|
617 | + 'readonly' => true, |
|
618 | + ), |
|
619 | + 'placeholder' => array( |
|
620 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
621 | + 'type' => 'string', |
|
622 | + 'arg_options' => array( |
|
623 | + 'sanitize_callback' => 'sanitize_text_field', |
|
624 | + ), |
|
625 | + 'context' => array( 'view', 'edit' ), |
|
626 | + 'readonly' => true, |
|
627 | + ), |
|
628 | + 'type' => array( |
|
629 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
630 | + 'type' => 'string', |
|
631 | + 'arg_options' => array( |
|
632 | + 'sanitize_callback' => 'sanitize_text_field', |
|
633 | + ), |
|
634 | + 'context' => array( 'view', 'edit' ), |
|
635 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
636 | + 'readonly' => true, |
|
637 | + ), |
|
638 | + 'options' => array( |
|
639 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
640 | + 'type' => 'object', |
|
641 | + 'context' => array( 'view', 'edit' ), |
|
642 | + 'readonly' => true, |
|
643 | + ), |
|
644 | + 'readonly' => array( |
|
645 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
646 | + 'type' => 'string', |
|
647 | + 'context' => array( 'view' ), |
|
648 | + 'readonly' => true, |
|
649 | + ), |
|
650 | + 'faux' => array( |
|
651 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
652 | + 'type' => 'string', |
|
653 | + 'context' => array( 'view' ), |
|
654 | + 'readonly' => true, |
|
655 | + ), |
|
656 | + ), |
|
657 | + ); |
|
658 | + |
|
659 | + // Filters the settings schema for the REST API. |
|
660 | 660 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
661 | 661 | |
662 | - // Cache the settings schema. |
|
663 | - $this->schema = $schema; |
|
664 | - |
|
665 | - return $this->add_additional_fields_schema( $this->schema ); |
|
666 | - |
|
667 | - } |
|
668 | - |
|
669 | - /** |
|
670 | - * Validate a text value for a text based setting. |
|
671 | - * |
|
672 | - * @since 2.0.0 |
|
673 | - * @param string $value Value. |
|
674 | - * @param array $setting Setting. |
|
675 | - * @return string |
|
676 | - */ |
|
677 | - public function validate_setting_text_field( $value ) { |
|
678 | - $value = is_null( $value ) ? '' : $value; |
|
679 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
680 | - } |
|
681 | - |
|
682 | - /** |
|
683 | - * Validate select based settings. |
|
684 | - * |
|
685 | - * @since 2.0.0 |
|
686 | - * @param string $value Value. |
|
687 | - * @param array $setting Setting. |
|
688 | - * @return string|WP_Error |
|
689 | - */ |
|
690 | - public function validate_setting_select_field( $value, $setting ) { |
|
691 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
692 | - return $value; |
|
693 | - } else { |
|
694 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
695 | - } |
|
696 | - } |
|
697 | - |
|
698 | - /** |
|
699 | - * Validate multiselect based settings. |
|
700 | - * |
|
701 | - * @since 2.0.0 |
|
702 | - * @param array $values Values. |
|
703 | - * @param array $setting Setting. |
|
704 | - * @return array|WP_Error |
|
705 | - */ |
|
706 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
707 | - if ( empty( $values ) ) { |
|
708 | - return array(); |
|
709 | - } |
|
710 | - |
|
711 | - if ( ! is_array( $values ) ) { |
|
712 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
713 | - } |
|
714 | - |
|
715 | - $final_values = array(); |
|
716 | - foreach ( $values as $value ) { |
|
717 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
718 | - $final_values[] = $value; |
|
719 | - } |
|
720 | - } |
|
721 | - |
|
722 | - return $final_values; |
|
723 | - } |
|
724 | - |
|
725 | - /** |
|
726 | - * Validate radio based settings. |
|
727 | - * |
|
728 | - * @since 2.0.0 |
|
729 | - * @param string $value Value. |
|
730 | - * @param array $setting Setting. |
|
731 | - * @return string|WP_Error |
|
732 | - */ |
|
733 | - public function validate_setting_radio_field( $value, $setting ) { |
|
734 | - return $this->validate_setting_select_field( $value, $setting ); |
|
735 | - } |
|
736 | - |
|
737 | - /** |
|
738 | - * Validate checkbox based settings. |
|
739 | - * |
|
740 | - * @since 2.0.0 |
|
741 | - * @param string $value Value. |
|
742 | - * @return int |
|
743 | - */ |
|
744 | - public function validate_setting_checkbox_field( $value ) { |
|
745 | - return (int) ! empty( $value ); |
|
746 | - } |
|
747 | - |
|
748 | - /** |
|
749 | - * Validate textarea based settings. |
|
750 | - * |
|
751 | - * @since 2.0.0 |
|
752 | - * @param string $value Value. |
|
753 | - * @return string |
|
754 | - */ |
|
755 | - public function validate_setting_textarea_field( $value ) { |
|
756 | - $value = is_null( $value ) ? '' : $value; |
|
757 | - return wp_kses( |
|
758 | - trim( stripslashes( $value ) ), |
|
759 | - array_merge( |
|
760 | - array( |
|
761 | - 'iframe' => array( |
|
762 | - 'src' => true, |
|
763 | - 'style' => true, |
|
764 | - 'id' => true, |
|
765 | - 'class' => true, |
|
766 | - ), |
|
767 | - ), |
|
768 | - wp_kses_allowed_html( 'post' ) |
|
769 | - ) |
|
770 | - ); |
|
771 | - } |
|
662 | + // Cache the settings schema. |
|
663 | + $this->schema = $schema; |
|
664 | + |
|
665 | + return $this->add_additional_fields_schema( $this->schema ); |
|
666 | + |
|
667 | + } |
|
668 | + |
|
669 | + /** |
|
670 | + * Validate a text value for a text based setting. |
|
671 | + * |
|
672 | + * @since 2.0.0 |
|
673 | + * @param string $value Value. |
|
674 | + * @param array $setting Setting. |
|
675 | + * @return string |
|
676 | + */ |
|
677 | + public function validate_setting_text_field( $value ) { |
|
678 | + $value = is_null( $value ) ? '' : $value; |
|
679 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
680 | + } |
|
681 | + |
|
682 | + /** |
|
683 | + * Validate select based settings. |
|
684 | + * |
|
685 | + * @since 2.0.0 |
|
686 | + * @param string $value Value. |
|
687 | + * @param array $setting Setting. |
|
688 | + * @return string|WP_Error |
|
689 | + */ |
|
690 | + public function validate_setting_select_field( $value, $setting ) { |
|
691 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
692 | + return $value; |
|
693 | + } else { |
|
694 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
695 | + } |
|
696 | + } |
|
697 | + |
|
698 | + /** |
|
699 | + * Validate multiselect based settings. |
|
700 | + * |
|
701 | + * @since 2.0.0 |
|
702 | + * @param array $values Values. |
|
703 | + * @param array $setting Setting. |
|
704 | + * @return array|WP_Error |
|
705 | + */ |
|
706 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
707 | + if ( empty( $values ) ) { |
|
708 | + return array(); |
|
709 | + } |
|
710 | + |
|
711 | + if ( ! is_array( $values ) ) { |
|
712 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
713 | + } |
|
714 | + |
|
715 | + $final_values = array(); |
|
716 | + foreach ( $values as $value ) { |
|
717 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
718 | + $final_values[] = $value; |
|
719 | + } |
|
720 | + } |
|
721 | + |
|
722 | + return $final_values; |
|
723 | + } |
|
724 | + |
|
725 | + /** |
|
726 | + * Validate radio based settings. |
|
727 | + * |
|
728 | + * @since 2.0.0 |
|
729 | + * @param string $value Value. |
|
730 | + * @param array $setting Setting. |
|
731 | + * @return string|WP_Error |
|
732 | + */ |
|
733 | + public function validate_setting_radio_field( $value, $setting ) { |
|
734 | + return $this->validate_setting_select_field( $value, $setting ); |
|
735 | + } |
|
736 | + |
|
737 | + /** |
|
738 | + * Validate checkbox based settings. |
|
739 | + * |
|
740 | + * @since 2.0.0 |
|
741 | + * @param string $value Value. |
|
742 | + * @return int |
|
743 | + */ |
|
744 | + public function validate_setting_checkbox_field( $value ) { |
|
745 | + return (int) ! empty( $value ); |
|
746 | + } |
|
747 | + |
|
748 | + /** |
|
749 | + * Validate textarea based settings. |
|
750 | + * |
|
751 | + * @since 2.0.0 |
|
752 | + * @param string $value Value. |
|
753 | + * @return string |
|
754 | + */ |
|
755 | + public function validate_setting_textarea_field( $value ) { |
|
756 | + $value = is_null( $value ) ? '' : $value; |
|
757 | + return wp_kses( |
|
758 | + trim( stripslashes( $value ) ), |
|
759 | + array_merge( |
|
760 | + array( |
|
761 | + 'iframe' => array( |
|
762 | + 'src' => true, |
|
763 | + 'style' => true, |
|
764 | + 'id' => true, |
|
765 | + 'class' => true, |
|
766 | + ), |
|
767 | + ), |
|
768 | + wp_kses_allowed_html( 'post' ) |
|
769 | + ) |
|
770 | + ); |
|
771 | + } |
|
772 | 772 | |
773 | 773 | } |