@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | ?> |
| 13 | 13 | |
@@ -16,11 +16,11 @@ discard block |
||
| 16 | 16 | <div class="row"> |
| 17 | 17 | |
| 18 | 18 | <div class="col-12 col-sm-6 text-sm-left pl-sm-0"> |
| 19 | - <?php do_action( 'getpaid_invoice_header_left', $invoice );?> |
|
| 19 | + <?php do_action('getpaid_invoice_header_left', $invoice); ?> |
|
| 20 | 20 | </div> |
| 21 | 21 | |
| 22 | 22 | <div class="col-12 col-sm-6 text-sm-right pr-sm-0"> |
| 23 | - <?php do_action( 'getpaid_invoice_header_right', $invoice );?> |
|
| 23 | + <?php do_action('getpaid_invoice_header_right', $invoice); ?> |
|
| 24 | 24 | </div> |
| 25 | 25 | |
| 26 | 26 | </div> |
@@ -7,24 +7,24 @@ |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | ?> |
| 13 | 13 | |
| 14 | - <?php do_action( 'getpaid_before_invoice_details_top', $invoice ); ?> |
|
| 14 | + <?php do_action('getpaid_before_invoice_details_top', $invoice); ?> |
|
| 15 | 15 | |
| 16 | 16 | <div class="getpaid-invoice-details-top mb-5"> |
| 17 | 17 | <div class="row"> |
| 18 | 18 | <div class="col-12 col-sm-6 text-sm-left"> |
| 19 | - <?php do_action( 'getpaid_invoice_details_top_left', $invoice ); ?> |
|
| 19 | + <?php do_action('getpaid_invoice_details_top_left', $invoice); ?> |
|
| 20 | 20 | </div> |
| 21 | 21 | |
| 22 | 22 | <div class="col-12 col-sm-6 text-sm-right"> |
| 23 | - <?php do_action( 'getpaid_invoice_details_top_right', $invoice ); ?> |
|
| 23 | + <?php do_action('getpaid_invoice_details_top_right', $invoice); ?> |
|
| 24 | 24 | </div> |
| 25 | 25 | </div> |
| 26 | 26 | </div> |
| 27 | 27 | |
| 28 | - <?php do_action( 'getpaid_after_invoice_details_top', $invoice ); ?> |
|
| 28 | + <?php do_action('getpaid_after_invoice_details_top', $invoice); ?> |
|
| 29 | 29 | |
| 30 | 30 | <?php |
@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | ?> |
| 13 | 13 | |
@@ -18,7 +18,7 @@ discard block |
||
| 18 | 18 | <?php |
| 19 | 19 | |
| 20 | 20 | // Fires when printing the header. |
| 21 | - do_action( 'getpaid_invoice_header', $invoice ); |
|
| 21 | + do_action('getpaid_invoice_header', $invoice); |
|
| 22 | 22 | |
| 23 | 23 | // Print the opening wrapper. |
| 24 | 24 | echo '<div class="container bg-white border mt-4 mb-4 p-4 position-relative flex-grow-1">'; |
@@ -27,16 +27,16 @@ discard block |
||
| 27 | 27 | wpinv_print_errors(); |
| 28 | 28 | |
| 29 | 29 | // Fires when printing the invoice details. |
| 30 | - do_action( 'getpaid_invoice_details', $invoice ); |
|
| 30 | + do_action('getpaid_invoice_details', $invoice); |
|
| 31 | 31 | |
| 32 | 32 | // Fires when printing the invoice line items. |
| 33 | - do_action( 'getpaid_invoice_line_items', $invoice ); |
|
| 33 | + do_action('getpaid_invoice_line_items', $invoice); |
|
| 34 | 34 | |
| 35 | 35 | // Print the closing wrapper. |
| 36 | 36 | echo '</div>'; |
| 37 | 37 | |
| 38 | 38 | // Fires when printing the invoice footer. |
| 39 | - do_action( 'getpaid_invoice_footer', $invoice ); |
|
| 39 | + do_action('getpaid_invoice_footer', $invoice); |
|
| 40 | 40 | |
| 41 | 41 | ?> |
| 42 | 42 | |
@@ -36,36 +36,36 @@ discard block |
||
| 36 | 36 | 'desc_tip' => true, |
| 37 | 37 | 'default' => '', |
| 38 | 38 | 'advanced' => false |
| 39 | - ), |
|
| 39 | + ), |
|
| 40 | 40 | |
| 41 | 41 | 'form' => array( |
| 42 | - 'title' => __( 'Form', 'invoicing' ), |
|
| 43 | - 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
| 44 | - 'type' => 'text', |
|
| 45 | - 'desc_tip' => true, |
|
| 46 | - 'default' => '', |
|
| 47 | - 'placeholder' => __('1','invoicing'), |
|
| 48 | - 'advanced' => false |
|
| 49 | - ), |
|
| 50 | - |
|
| 51 | - 'item' => array( |
|
| 52 | - 'title' => __( 'Items', 'invoicing' ), |
|
| 53 | - 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
| 54 | - 'type' => 'text', |
|
| 55 | - 'desc_tip' => true, |
|
| 56 | - 'default' => '', |
|
| 57 | - 'placeholder' => __('1','invoicing'), |
|
| 58 | - 'advanced' => false |
|
| 59 | - ), |
|
| 42 | + 'title' => __( 'Form', 'invoicing' ), |
|
| 43 | + 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
| 44 | + 'type' => 'text', |
|
| 45 | + 'desc_tip' => true, |
|
| 46 | + 'default' => '', |
|
| 47 | + 'placeholder' => __('1','invoicing'), |
|
| 48 | + 'advanced' => false |
|
| 49 | + ), |
|
| 50 | + |
|
| 51 | + 'item' => array( |
|
| 52 | + 'title' => __( 'Items', 'invoicing' ), |
|
| 53 | + 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
| 54 | + 'type' => 'text', |
|
| 55 | + 'desc_tip' => true, |
|
| 56 | + 'default' => '', |
|
| 57 | + 'placeholder' => __('1','invoicing'), |
|
| 58 | + 'advanced' => false |
|
| 59 | + ), |
|
| 60 | 60 | |
| 61 | 61 | 'button' => array( |
| 62 | - 'title' => __( 'Button', 'invoicing' ), |
|
| 63 | - 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
| 64 | - 'type' => 'text', |
|
| 65 | - 'desc_tip' => true, |
|
| 66 | - 'default' => '', |
|
| 67 | - 'advanced' => false |
|
| 68 | - ) |
|
| 62 | + 'title' => __( 'Button', 'invoicing' ), |
|
| 63 | + 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
| 64 | + 'type' => 'text', |
|
| 65 | + 'desc_tip' => true, |
|
| 66 | + 'default' => '', |
|
| 67 | + 'advanced' => false |
|
| 68 | + ) |
|
| 69 | 69 | |
| 70 | 70 | ) |
| 71 | 71 | |
@@ -75,96 +75,96 @@ discard block |
||
| 75 | 75 | parent::__construct( $options ); |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * The Super block output function. |
|
| 80 | - * |
|
| 81 | - * @param array $args |
|
| 82 | - * @param array $widget_args |
|
| 83 | - * @param string $content |
|
| 84 | - * |
|
| 85 | - * @return string |
|
| 86 | - */ |
|
| 78 | + /** |
|
| 79 | + * The Super block output function. |
|
| 80 | + * |
|
| 81 | + * @param array $args |
|
| 82 | + * @param array $widget_args |
|
| 83 | + * @param string $content |
|
| 84 | + * |
|
| 85 | + * @return string |
|
| 86 | + */ |
|
| 87 | 87 | public function output( $args = array(), $widget_args = array(), $content = '' ) { |
| 88 | 88 | |
| 89 | - // Is the shortcode set up correctly? |
|
| 90 | - if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
| 91 | - return aui()->alert( |
|
| 92 | - array( |
|
| 93 | - 'type' => 'warning', |
|
| 94 | - 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
| 95 | - ) |
|
| 96 | - ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - // Payment form or button? |
|
| 100 | - if ( ! empty( $args['form'] ) ) { |
|
| 101 | - return $this->handle_payment_form( $args ); |
|
| 102 | - } else { |
|
| 103 | - return $this->handle_buy_item( $args ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Displaying a payment form |
|
| 110 | - * |
|
| 111 | - * @return string |
|
| 112 | - */ |
|
| 89 | + // Is the shortcode set up correctly? |
|
| 90 | + if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
| 91 | + return aui()->alert( |
|
| 92 | + array( |
|
| 93 | + 'type' => 'warning', |
|
| 94 | + 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
| 95 | + ) |
|
| 96 | + ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + // Payment form or button? |
|
| 100 | + if ( ! empty( $args['form'] ) ) { |
|
| 101 | + return $this->handle_payment_form( $args ); |
|
| 102 | + } else { |
|
| 103 | + return $this->handle_buy_item( $args ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Displaying a payment form |
|
| 110 | + * |
|
| 111 | + * @return string |
|
| 112 | + */ |
|
| 113 | 113 | protected function handle_payment_form( $args = array() ) { |
| 114 | 114 | |
| 115 | - if ( empty( $args['button'] ) ) { |
|
| 116 | - ob_start(); |
|
| 117 | - getpaid_display_payment_form( $args['form'] ); |
|
| 118 | - return ob_get_clean(); |
|
| 119 | - } |
|
| 115 | + if ( empty( $args['button'] ) ) { |
|
| 116 | + ob_start(); |
|
| 117 | + getpaid_display_payment_form( $args['form'] ); |
|
| 118 | + return ob_get_clean(); |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - return $this->payment_form_button( $args['form'], $args['button'] ); |
|
| 122 | - } |
|
| 121 | + return $this->payment_form_button( $args['form'], $args['button'] ); |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Displays a payment form button. |
|
| 126 | - * |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 124 | + /** |
|
| 125 | + * Displays a payment form button. |
|
| 126 | + * |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | 129 | protected function payment_form_button( $form, $button ) { |
| 130 | - return getpaid_get_payment_button( $button, $form ); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Selling an item |
|
| 135 | - * |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 130 | + return getpaid_get_payment_button( $button, $form ); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Selling an item |
|
| 135 | + * |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | 138 | protected function handle_buy_item( $args = array() ) { |
| 139 | 139 | |
| 140 | - if ( empty( $args['button'] ) ) { |
|
| 141 | - return $this->buy_item_form( $args['item'] ); |
|
| 142 | - } |
|
| 140 | + if ( empty( $args['button'] ) ) { |
|
| 141 | + return $this->buy_item_form( $args['item'] ); |
|
| 142 | + } |
|
| 143 | 143 | |
| 144 | - return $this->buy_item_button( $args['item'], $args['button'] ); |
|
| 144 | + return $this->buy_item_button( $args['item'], $args['button'] ); |
|
| 145 | 145 | |
| 146 | - } |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Displays a buy item form. |
|
| 150 | - * |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 148 | + /** |
|
| 149 | + * Displays a buy item form. |
|
| 150 | + * |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | 153 | protected function buy_item_form( $item ) { |
| 154 | - $items = getpaid_convert_items_to_array( $item ); |
|
| 155 | - ob_start(); |
|
| 156 | - getpaid_display_item_payment_form( $items ); |
|
| 157 | - return ob_get_clean(); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * Displays a buy item button. |
|
| 162 | - * |
|
| 163 | - * @return string |
|
| 164 | - */ |
|
| 154 | + $items = getpaid_convert_items_to_array( $item ); |
|
| 155 | + ob_start(); |
|
| 156 | + getpaid_display_item_payment_form( $items ); |
|
| 157 | + return ob_get_clean(); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * Displays a buy item button. |
|
| 162 | + * |
|
| 163 | + * @return string |
|
| 164 | + */ |
|
| 165 | 165 | protected function buy_item_button( $item, $button ) { |
| 166 | - $button = getpaid_get_payment_button( $button, null, $item ); |
|
| 167 | - return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
| 166 | + $button = getpaid_get_payment_button( $button, null, $item ); |
|
| 167 | + return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
| 168 | 168 | } |
| 169 | 169 | |
| 170 | 170 | } |
@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 2 | +if (!defined('ABSPATH')) { |
|
| 3 | 3 | exit; |
| 4 | 4 | } |
| 5 | 5 | |
@@ -22,16 +22,16 @@ discard block |
||
| 22 | 22 | 'block-keywords'=> "['invoicing','buy', 'buy item', 'form']", |
| 23 | 23 | 'class_name' => __CLASS__, |
| 24 | 24 | 'base_id' => 'getpaid', |
| 25 | - 'name' => __('GetPaid','invoicing'), |
|
| 25 | + 'name' => __('GetPaid', 'invoicing'), |
|
| 26 | 26 | 'widget_ops' => array( |
| 27 | 27 | 'classname' => 'getpaid bsui', |
| 28 | - 'description' => esc_html__('Show payment forms or buttons.','invoicing'), |
|
| 28 | + 'description' => esc_html__('Show payment forms or buttons.', 'invoicing'), |
|
| 29 | 29 | ), |
| 30 | 30 | 'arguments' => array( |
| 31 | 31 | |
| 32 | 32 | 'title' => array( |
| 33 | - 'title' => __( 'Widget title', 'invoicing' ), |
|
| 34 | - 'desc' => __( 'Enter widget title.', 'invoicing' ), |
|
| 33 | + 'title' => __('Widget title', 'invoicing'), |
|
| 34 | + 'desc' => __('Enter widget title.', 'invoicing'), |
|
| 35 | 35 | 'type' => 'text', |
| 36 | 36 | 'desc_tip' => true, |
| 37 | 37 | 'default' => '', |
@@ -39,28 +39,28 @@ discard block |
||
| 39 | 39 | ), |
| 40 | 40 | |
| 41 | 41 | 'form' => array( |
| 42 | - 'title' => __( 'Form', 'invoicing' ), |
|
| 43 | - 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
| 42 | + 'title' => __('Form', 'invoicing'), |
|
| 43 | + 'desc' => __('Enter a form id in case you want to display a specific payment form', 'invoicing'), |
|
| 44 | 44 | 'type' => 'text', |
| 45 | 45 | 'desc_tip' => true, |
| 46 | 46 | 'default' => '', |
| 47 | - 'placeholder' => __('1','invoicing'), |
|
| 47 | + 'placeholder' => __('1', 'invoicing'), |
|
| 48 | 48 | 'advanced' => false |
| 49 | 49 | ), |
| 50 | 50 | |
| 51 | 51 | 'item' => array( |
| 52 | - 'title' => __( 'Items', 'invoicing' ), |
|
| 53 | - 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
| 52 | + 'title' => __('Items', 'invoicing'), |
|
| 53 | + 'desc' => __('Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing'), |
|
| 54 | 54 | 'type' => 'text', |
| 55 | 55 | 'desc_tip' => true, |
| 56 | 56 | 'default' => '', |
| 57 | - 'placeholder' => __('1','invoicing'), |
|
| 57 | + 'placeholder' => __('1', 'invoicing'), |
|
| 58 | 58 | 'advanced' => false |
| 59 | 59 | ), |
| 60 | 60 | |
| 61 | 61 | 'button' => array( |
| 62 | - 'title' => __( 'Button', 'invoicing' ), |
|
| 63 | - 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
| 62 | + 'title' => __('Button', 'invoicing'), |
|
| 63 | + 'desc' => __('Enter button label in case you would like to display the forms in a popup.', 'invoicing'), |
|
| 64 | 64 | 'type' => 'text', |
| 65 | 65 | 'desc_tip' => true, |
| 66 | 66 | 'default' => '', |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | ); |
| 73 | 73 | |
| 74 | 74 | |
| 75 | - parent::__construct( $options ); |
|
| 75 | + parent::__construct($options); |
|
| 76 | 76 | } |
| 77 | 77 | |
| 78 | 78 | /** |
@@ -84,23 +84,23 @@ discard block |
||
| 84 | 84 | * |
| 85 | 85 | * @return string |
| 86 | 86 | */ |
| 87 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 87 | + public function output($args = array(), $widget_args = array(), $content = '') { |
|
| 88 | 88 | |
| 89 | 89 | // Is the shortcode set up correctly? |
| 90 | - if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
| 90 | + if (empty($args['form']) && empty($args['item'])) { |
|
| 91 | 91 | return aui()->alert( |
| 92 | 92 | array( |
| 93 | 93 | 'type' => 'warning', |
| 94 | - 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
| 94 | + 'content' => __('No payment form or item selected', 'invoicing'), |
|
| 95 | 95 | ) |
| 96 | 96 | ); |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | 99 | // Payment form or button? |
| 100 | - if ( ! empty( $args['form'] ) ) { |
|
| 101 | - return $this->handle_payment_form( $args ); |
|
| 100 | + if (!empty($args['form'])) { |
|
| 101 | + return $this->handle_payment_form($args); |
|
| 102 | 102 | } else { |
| 103 | - return $this->handle_buy_item( $args ); |
|
| 103 | + return $this->handle_buy_item($args); |
|
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | } |
@@ -110,15 +110,15 @@ discard block |
||
| 110 | 110 | * |
| 111 | 111 | * @return string |
| 112 | 112 | */ |
| 113 | - protected function handle_payment_form( $args = array() ) { |
|
| 113 | + protected function handle_payment_form($args = array()) { |
|
| 114 | 114 | |
| 115 | - if ( empty( $args['button'] ) ) { |
|
| 115 | + if (empty($args['button'])) { |
|
| 116 | 116 | ob_start(); |
| 117 | - getpaid_display_payment_form( $args['form'] ); |
|
| 117 | + getpaid_display_payment_form($args['form']); |
|
| 118 | 118 | return ob_get_clean(); |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - return $this->payment_form_button( $args['form'], $args['button'] ); |
|
| 121 | + return $this->payment_form_button($args['form'], $args['button']); |
|
| 122 | 122 | } |
| 123 | 123 | |
| 124 | 124 | /** |
@@ -126,8 +126,8 @@ discard block |
||
| 126 | 126 | * |
| 127 | 127 | * @return string |
| 128 | 128 | */ |
| 129 | - protected function payment_form_button( $form, $button ) { |
|
| 130 | - return getpaid_get_payment_button( $button, $form ); |
|
| 129 | + protected function payment_form_button($form, $button) { |
|
| 130 | + return getpaid_get_payment_button($button, $form); |
|
| 131 | 131 | } |
| 132 | 132 | |
| 133 | 133 | /** |
@@ -135,13 +135,13 @@ discard block |
||
| 135 | 135 | * |
| 136 | 136 | * @return string |
| 137 | 137 | */ |
| 138 | - protected function handle_buy_item( $args = array() ) { |
|
| 138 | + protected function handle_buy_item($args = array()) { |
|
| 139 | 139 | |
| 140 | - if ( empty( $args['button'] ) ) { |
|
| 141 | - return $this->buy_item_form( $args['item'] ); |
|
| 140 | + if (empty($args['button'])) { |
|
| 141 | + return $this->buy_item_form($args['item']); |
|
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - return $this->buy_item_button( $args['item'], $args['button'] ); |
|
| 144 | + return $this->buy_item_button($args['item'], $args['button']); |
|
| 145 | 145 | |
| 146 | 146 | } |
| 147 | 147 | |
@@ -150,10 +150,10 @@ discard block |
||
| 150 | 150 | * |
| 151 | 151 | * @return string |
| 152 | 152 | */ |
| 153 | - protected function buy_item_form( $item ) { |
|
| 154 | - $items = getpaid_convert_items_to_array( $item ); |
|
| 153 | + protected function buy_item_form($item) { |
|
| 154 | + $items = getpaid_convert_items_to_array($item); |
|
| 155 | 155 | ob_start(); |
| 156 | - getpaid_display_item_payment_form( $items ); |
|
| 156 | + getpaid_display_item_payment_form($items); |
|
| 157 | 157 | return ob_get_clean(); |
| 158 | 158 | } |
| 159 | 159 | |
@@ -162,9 +162,9 @@ discard block |
||
| 162 | 162 | * |
| 163 | 163 | * @return string |
| 164 | 164 | */ |
| 165 | - protected function buy_item_button( $item, $button ) { |
|
| 166 | - $button = getpaid_get_payment_button( $button, null, $item ); |
|
| 167 | - return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
| 165 | + protected function buy_item_button($item, $button) { |
|
| 166 | + $button = getpaid_get_payment_button($button, null, $item); |
|
| 167 | + return apply_filters('getpaid_buy_item_button_widget', $button, $item); |
|
| 168 | 168 | } |
| 169 | 169 | |
| 170 | 170 | } |
@@ -18,758 +18,758 @@ |
||
| 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 | - } |
|
| 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 | 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 | - |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - return rest_ensure_response( $prepared ); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * Return a single setting. |
|
| 195 | - * |
|
| 196 | - * @since 2.0.0 |
|
| 197 | - * @param WP_REST_Request $request Request data. |
|
| 198 | - * @return WP_Error|WP_REST_Response |
|
| 199 | - */ |
|
| 200 | - public function get_item( $request ) { |
|
| 201 | - $setting = $this->get_setting( $request['id'] ); |
|
| 202 | - |
|
| 203 | - if ( is_wp_error( $setting ) ) { |
|
| 204 | - return $setting; |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - $setting = $this->sanitize_setting( $setting ); |
|
| 208 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 209 | - return rest_ensure_response( $response ); |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Update a single setting. |
|
| 214 | - * |
|
| 215 | - * @since 2.0.0 |
|
| 216 | - * @param WP_REST_Request $request Request data. |
|
| 217 | - * @return WP_Error|WP_REST_Response |
|
| 218 | - */ |
|
| 219 | - public function update_item( $request ) { |
|
| 220 | - $setting = $this->get_setting( $request['id'] ); |
|
| 221 | - |
|
| 222 | - if ( is_wp_error( $setting ) ) { |
|
| 223 | - return $setting; |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 227 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 228 | - } else { |
|
| 229 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - if ( is_wp_error( $value ) ) { |
|
| 233 | - return $value; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - wpinv_update_option( $request['id'], $value ); |
|
| 237 | - $setting['value'] = $value; |
|
| 238 | - $setting = $this->sanitize_setting( $setting ); |
|
| 239 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 240 | - |
|
| 241 | - return rest_ensure_response( $response ); |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * Makes sure the current user has access to READ the settings APIs. |
|
| 246 | - * |
|
| 247 | - * @since 2.0.0 |
|
| 248 | - * @param WP_REST_Request $request Full data about the request. |
|
| 249 | - * @return WP_Error|boolean |
|
| 250 | - */ |
|
| 251 | - public function get_items_permissions_check( $request ) { |
|
| 252 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 253 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - return true; |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
| 261 | - * |
|
| 262 | - * @since 2.0.0 |
|
| 263 | - * @param WP_REST_Request $request Full data about the request. |
|
| 264 | - * @return WP_Error|boolean |
|
| 265 | - */ |
|
| 266 | - public function update_items_permissions_check( $request ) { |
|
| 267 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 268 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - return true; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Check if a given request has access batch create, update and delete items. |
|
| 276 | - * |
|
| 277 | - * @param WP_REST_Request $request Full details about the request. |
|
| 278 | - * |
|
| 279 | - * @return boolean|WP_Error |
|
| 280 | - */ |
|
| 281 | - public function batch_items_permissions_check( $request ) { |
|
| 282 | - 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() ) ); |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * Prepare links for the request. |
|
| 287 | - * |
|
| 288 | - * @param string $setting_id Setting ID. |
|
| 289 | - * @return array Links for the given setting. |
|
| 290 | - */ |
|
| 291 | - protected function prepare_links( $setting_id ) { |
|
| 292 | - |
|
| 293 | - $links = array( |
|
| 294 | - 'self' => array( |
|
| 295 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 296 | - ), |
|
| 297 | - 'collection' => array( |
|
| 298 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 299 | - ), |
|
| 300 | - ); |
|
| 301 | - |
|
| 302 | - return $links; |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Prepare a settings object for serialization. |
|
| 307 | - * |
|
| 308 | - * @since 2.0.0 |
|
| 309 | - * @param array $item Setting object. |
|
| 310 | - * @param WP_REST_Request $request Request object. |
|
| 311 | - * @return WP_REST_Response $response Response data. |
|
| 312 | - */ |
|
| 313 | - public function prepare_item_for_response( $item, $request ) { |
|
| 314 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 315 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 316 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 317 | - |
|
| 318 | - $response = rest_ensure_response( $data ); |
|
| 319 | - |
|
| 320 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 321 | - |
|
| 322 | - return $response; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - /** |
|
| 326 | - * Filters out bad values from the settings array/filter so we |
|
| 327 | - * only return known values via the API. |
|
| 328 | - * |
|
| 329 | - * @since 2.0.0 |
|
| 330 | - * @param array $setting Setting. |
|
| 331 | - * @return array |
|
| 332 | - */ |
|
| 333 | - public function filter_setting( $setting ) { |
|
| 334 | - return array_intersect_key( |
|
| 335 | - $setting, |
|
| 336 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 337 | - ); |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /** |
|
| 341 | - * Callback for allowed keys for each setting response. |
|
| 342 | - * |
|
| 343 | - * @param string $key Key to check. |
|
| 344 | - * @return boolean |
|
| 345 | - */ |
|
| 346 | - public function allowed_setting_keys( $key ) { |
|
| 347 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * Returns default options for a setting. null means the field is required. |
|
| 352 | - * |
|
| 353 | - * @since 2.0.0 |
|
| 354 | - * @return array |
|
| 355 | - */ |
|
| 356 | - protected function setting_defaults() { |
|
| 357 | - return array( |
|
| 358 | - 'id' => null, |
|
| 359 | - 'name' => null, |
|
| 360 | - 'desc' => '', |
|
| 361 | - 'options' => array(), |
|
| 362 | - 'std' => false, |
|
| 363 | - 'value' => false, |
|
| 364 | - 'placeholder' => '', |
|
| 365 | - 'readonly' => false, |
|
| 366 | - 'faux' => false, |
|
| 367 | - 'section' => 'main', |
|
| 368 | - 'tab' => 'general', |
|
| 369 | - 'type' => 'text', |
|
| 370 | - ); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 374 | - * Sanitizes a setting's field. |
|
| 375 | - * |
|
| 376 | - * @param array $setting The setting to sanitize. |
|
| 377 | - * @return array |
|
| 378 | - */ |
|
| 379 | - public function sanitize_setting( $setting ) { |
|
| 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 | + |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + return rest_ensure_response( $prepared ); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * Return a single setting. |
|
| 195 | + * |
|
| 196 | + * @since 2.0.0 |
|
| 197 | + * @param WP_REST_Request $request Request data. |
|
| 198 | + * @return WP_Error|WP_REST_Response |
|
| 199 | + */ |
|
| 200 | + public function get_item( $request ) { |
|
| 201 | + $setting = $this->get_setting( $request['id'] ); |
|
| 202 | + |
|
| 203 | + if ( is_wp_error( $setting ) ) { |
|
| 204 | + return $setting; |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + $setting = $this->sanitize_setting( $setting ); |
|
| 208 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 209 | + return rest_ensure_response( $response ); |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Update a single setting. |
|
| 214 | + * |
|
| 215 | + * @since 2.0.0 |
|
| 216 | + * @param WP_REST_Request $request Request data. |
|
| 217 | + * @return WP_Error|WP_REST_Response |
|
| 218 | + */ |
|
| 219 | + public function update_item( $request ) { |
|
| 220 | + $setting = $this->get_setting( $request['id'] ); |
|
| 221 | + |
|
| 222 | + if ( is_wp_error( $setting ) ) { |
|
| 223 | + return $setting; |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 227 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 228 | + } else { |
|
| 229 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + if ( is_wp_error( $value ) ) { |
|
| 233 | + return $value; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + wpinv_update_option( $request['id'], $value ); |
|
| 237 | + $setting['value'] = $value; |
|
| 238 | + $setting = $this->sanitize_setting( $setting ); |
|
| 239 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 240 | + |
|
| 241 | + return rest_ensure_response( $response ); |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * Makes sure the current user has access to READ the settings APIs. |
|
| 246 | + * |
|
| 247 | + * @since 2.0.0 |
|
| 248 | + * @param WP_REST_Request $request Full data about the request. |
|
| 249 | + * @return WP_Error|boolean |
|
| 250 | + */ |
|
| 251 | + public function get_items_permissions_check( $request ) { |
|
| 252 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 253 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + return true; |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
| 261 | + * |
|
| 262 | + * @since 2.0.0 |
|
| 263 | + * @param WP_REST_Request $request Full data about the request. |
|
| 264 | + * @return WP_Error|boolean |
|
| 265 | + */ |
|
| 266 | + public function update_items_permissions_check( $request ) { |
|
| 267 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 268 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + return true; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Check if a given request has access batch create, update and delete items. |
|
| 276 | + * |
|
| 277 | + * @param WP_REST_Request $request Full details about the request. |
|
| 278 | + * |
|
| 279 | + * @return boolean|WP_Error |
|
| 280 | + */ |
|
| 281 | + public function batch_items_permissions_check( $request ) { |
|
| 282 | + 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() ) ); |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * Prepare links for the request. |
|
| 287 | + * |
|
| 288 | + * @param string $setting_id Setting ID. |
|
| 289 | + * @return array Links for the given setting. |
|
| 290 | + */ |
|
| 291 | + protected function prepare_links( $setting_id ) { |
|
| 292 | + |
|
| 293 | + $links = array( |
|
| 294 | + 'self' => array( |
|
| 295 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 296 | + ), |
|
| 297 | + 'collection' => array( |
|
| 298 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 299 | + ), |
|
| 300 | + ); |
|
| 301 | + |
|
| 302 | + return $links; |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Prepare a settings object for serialization. |
|
| 307 | + * |
|
| 308 | + * @since 2.0.0 |
|
| 309 | + * @param array $item Setting object. |
|
| 310 | + * @param WP_REST_Request $request Request object. |
|
| 311 | + * @return WP_REST_Response $response Response data. |
|
| 312 | + */ |
|
| 313 | + public function prepare_item_for_response( $item, $request ) { |
|
| 314 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 315 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 316 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 317 | + |
|
| 318 | + $response = rest_ensure_response( $data ); |
|
| 319 | + |
|
| 320 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 321 | + |
|
| 322 | + return $response; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + /** |
|
| 326 | + * Filters out bad values from the settings array/filter so we |
|
| 327 | + * only return known values via the API. |
|
| 328 | + * |
|
| 329 | + * @since 2.0.0 |
|
| 330 | + * @param array $setting Setting. |
|
| 331 | + * @return array |
|
| 332 | + */ |
|
| 333 | + public function filter_setting( $setting ) { |
|
| 334 | + return array_intersect_key( |
|
| 335 | + $setting, |
|
| 336 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 337 | + ); |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /** |
|
| 341 | + * Callback for allowed keys for each setting response. |
|
| 342 | + * |
|
| 343 | + * @param string $key Key to check. |
|
| 344 | + * @return boolean |
|
| 345 | + */ |
|
| 346 | + public function allowed_setting_keys( $key ) { |
|
| 347 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * Returns default options for a setting. null means the field is required. |
|
| 352 | + * |
|
| 353 | + * @since 2.0.0 |
|
| 354 | + * @return array |
|
| 355 | + */ |
|
| 356 | + protected function setting_defaults() { |
|
| 357 | + return array( |
|
| 358 | + 'id' => null, |
|
| 359 | + 'name' => null, |
|
| 360 | + 'desc' => '', |
|
| 361 | + 'options' => array(), |
|
| 362 | + 'std' => false, |
|
| 363 | + 'value' => false, |
|
| 364 | + 'placeholder' => '', |
|
| 365 | + 'readonly' => false, |
|
| 366 | + 'faux' => false, |
|
| 367 | + 'section' => 'main', |
|
| 368 | + 'tab' => 'general', |
|
| 369 | + 'type' => 'text', |
|
| 370 | + ); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | + * Sanitizes a setting's field. |
|
| 375 | + * |
|
| 376 | + * @param array $setting The setting to sanitize. |
|
| 377 | + * @return array |
|
| 378 | + */ |
|
| 379 | + public function sanitize_setting( $setting ) { |
|
| 380 | 380 | |
| 381 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 382 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 383 | - return $this->filter_setting( $setting ); |
|
| 384 | - |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Get setting data. |
|
| 389 | - * |
|
| 390 | - * @since 2.0.0 |
|
| 391 | - * @param string $setting_id Setting ID. |
|
| 392 | - * @return array|WP_Error |
|
| 393 | - */ |
|
| 394 | - public function get_setting( $setting_id ) { |
|
| 395 | - |
|
| 396 | - if ( empty( $setting_id ) ) { |
|
| 397 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - $settings = $this->get_settings(); |
|
| 401 | - |
|
| 402 | - foreach ( $settings as $tabs ) { |
|
| 403 | - |
|
| 404 | - foreach ( $tabs as $sections ) { |
|
| 405 | - |
|
| 406 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
| 407 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 408 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - return $sections[ $setting_id ]; |
|
| 412 | - } |
|
| 413 | - |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 419 | - } |
|
| 420 | - |
|
| 421 | - /** |
|
| 422 | - * Get all tabs. |
|
| 423 | - * |
|
| 424 | - * @param WP_REST_Request $request Request data. |
|
| 425 | - * @return array |
|
| 426 | - */ |
|
| 427 | - public function get_tabs( $request ) { |
|
| 428 | - $tabs = wpinv_get_settings_tabs(); |
|
| 429 | - $prepared = array(); |
|
| 430 | - |
|
| 431 | - foreach ( $tabs as $id => $tab ) { |
|
| 432 | - |
|
| 433 | - $_request = $request; |
|
| 434 | - $_request['tab'] = sanitize_title( $id ); |
|
| 435 | - $data = array( |
|
| 436 | - 'id' => sanitize_title( $id ), |
|
| 437 | - 'label' => sanitize_text_field( $tab ), |
|
| 438 | - 'sections' => $this->get_sections( $_request ), |
|
| 439 | - ); |
|
| 440 | - |
|
| 441 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 442 | - $response = rest_ensure_response( $data ); |
|
| 443 | - |
|
| 444 | - if ( ! is_wp_error( $response ) ) { |
|
| 445 | - $links = array( |
|
| 446 | - 'sections' => array( |
|
| 447 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 448 | - ), |
|
| 449 | - 'collection' => array( |
|
| 450 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 451 | - ), |
|
| 452 | - ); |
|
| 453 | - $response->add_links( $links ); |
|
| 454 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - $prepared[] = $response; |
|
| 458 | - |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - return rest_ensure_response( $prepared ); |
|
| 462 | - } |
|
| 463 | - |
|
| 464 | - /** |
|
| 465 | - * Get all sections. |
|
| 466 | - * |
|
| 467 | - * @param WP_REST_Request $request Request data. |
|
| 468 | - * @return array |
|
| 469 | - */ |
|
| 470 | - public function get_sections( $request ) { |
|
| 471 | - |
|
| 472 | - $tab = sanitize_title( $request['tab'] ); |
|
| 473 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 474 | - $prepared = array(); |
|
| 475 | - |
|
| 476 | - foreach ( $sections as $id => $section ) { |
|
| 477 | - |
|
| 478 | - $data = array( |
|
| 479 | - 'id' => sanitize_title( $id ), |
|
| 480 | - 'label' => sanitize_text_field( $section ), |
|
| 481 | - ); |
|
| 482 | - |
|
| 483 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 484 | - $response = rest_ensure_response( $data ); |
|
| 485 | - |
|
| 486 | - if ( ! is_wp_error( $response ) ) { |
|
| 487 | - $links = array( |
|
| 488 | - 'settings' => array( |
|
| 489 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 490 | - ), |
|
| 491 | - 'collection' => array( |
|
| 492 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 493 | - ), |
|
| 494 | - 'tabs' => array( |
|
| 495 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 496 | - ), |
|
| 497 | - ); |
|
| 498 | - $response->add_links( $links ); |
|
| 499 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - $prepared[] = $response; |
|
| 503 | - |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - return rest_ensure_response( $prepared ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Get all settings. |
|
| 511 | - * |
|
| 512 | - * @return array |
|
| 513 | - */ |
|
| 514 | - public function get_settings() { |
|
| 515 | - |
|
| 516 | - if ( empty( $this->settings ) ) { |
|
| 517 | - $this->settings = wpinv_get_registered_settings(); |
|
| 518 | - } |
|
| 519 | - |
|
| 520 | - return $this->settings; |
|
| 521 | - |
|
| 522 | - } |
|
| 523 | - |
|
| 524 | - /** |
|
| 525 | - * Boolean for if a setting type is a valid supported setting type. |
|
| 526 | - * |
|
| 527 | - * @since 2.0.0 |
|
| 528 | - * @param string $type Type. |
|
| 529 | - * @return bool |
|
| 530 | - */ |
|
| 531 | - public function is_setting_type_valid( $type ) { |
|
| 532 | - |
|
| 533 | - return in_array( |
|
| 534 | - $type, array( |
|
| 535 | - 'text', // Validates with validate_setting_text_field. |
|
| 536 | - 'email', // Validates with validate_setting_text_field. |
|
| 537 | - 'number', // Validates with validate_setting_text_field. |
|
| 538 | - 'color', // Validates with validate_setting_text_field. |
|
| 539 | - 'password', // Validates with validate_setting_text_field. |
|
| 540 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | - 'select', // Validates with validate_setting_select_field. |
|
| 542 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | - 'header', // Validates with validate_setting_text_field. |
|
| 546 | - ) |
|
| 547 | - ); |
|
| 548 | - |
|
| 549 | - } |
|
| 550 | - |
|
| 551 | - /** |
|
| 552 | - * Get the settings schema, conforming to JSON Schema. |
|
| 553 | - * |
|
| 554 | - * @return array |
|
| 555 | - */ |
|
| 556 | - public function get_item_schema() { |
|
| 557 | - |
|
| 558 | - // Maybe retrieve the schema from cache. |
|
| 559 | - if ( ! empty( $this->schema ) ) { |
|
| 560 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 561 | - } |
|
| 562 | - |
|
| 563 | - $schema = array( |
|
| 564 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 565 | - 'title' => 'setting', |
|
| 566 | - 'type' => 'object', |
|
| 567 | - 'properties' => array( |
|
| 568 | - 'id' => array( |
|
| 569 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 570 | - 'type' => 'string', |
|
| 571 | - 'arg_options' => array( |
|
| 572 | - 'sanitize_callback' => 'sanitize_title', |
|
| 573 | - ), |
|
| 574 | - 'context' => array( 'view', 'edit' ), |
|
| 575 | - 'readonly' => true, |
|
| 576 | - ), |
|
| 577 | - 'tab' => array( |
|
| 578 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 579 | - 'type' => 'string', |
|
| 580 | - 'arg_options' => array( |
|
| 581 | - 'sanitize_callback' => 'sanitize_title', |
|
| 582 | - ), |
|
| 583 | - 'context' => array( 'view', 'edit' ), |
|
| 584 | - 'readonly' => true, |
|
| 585 | - ), |
|
| 586 | - 'section' => array( |
|
| 587 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 588 | - 'type' => 'string', |
|
| 589 | - 'arg_options' => array( |
|
| 590 | - 'sanitize_callback' => 'sanitize_title', |
|
| 591 | - ), |
|
| 592 | - 'context' => array( 'view', 'edit' ), |
|
| 593 | - 'readonly' => true, |
|
| 594 | - ), |
|
| 595 | - 'name' => array( |
|
| 596 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 597 | - 'type' => 'string', |
|
| 598 | - 'arg_options' => array( |
|
| 599 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 600 | - ), |
|
| 601 | - 'context' => array( 'view', 'edit' ), |
|
| 602 | - 'readonly' => true, |
|
| 603 | - ), |
|
| 604 | - 'desc' => array( |
|
| 605 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 606 | - 'type' => 'string', |
|
| 607 | - 'context' => array( 'view', 'edit' ), |
|
| 608 | - 'readonly' => true, |
|
| 609 | - ), |
|
| 610 | - 'value' => array( |
|
| 611 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 612 | - 'type' => 'mixed', |
|
| 613 | - 'context' => array( 'view', 'edit' ), |
|
| 614 | - ), |
|
| 615 | - 'default' => array( |
|
| 616 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 617 | - 'type' => 'mixed', |
|
| 618 | - 'context' => array( 'view', 'edit' ), |
|
| 619 | - 'readonly' => true, |
|
| 620 | - ), |
|
| 621 | - 'placeholder' => array( |
|
| 622 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 623 | - 'type' => 'string', |
|
| 624 | - 'arg_options' => array( |
|
| 625 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 626 | - ), |
|
| 627 | - 'context' => array( 'view', 'edit' ), |
|
| 628 | - 'readonly' => true, |
|
| 629 | - ), |
|
| 630 | - 'type' => array( |
|
| 631 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 632 | - 'type' => 'string', |
|
| 633 | - 'arg_options' => array( |
|
| 634 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 635 | - ), |
|
| 636 | - 'context' => array( 'view', 'edit' ), |
|
| 637 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 638 | - 'readonly' => true, |
|
| 639 | - ), |
|
| 640 | - 'options' => array( |
|
| 641 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 642 | - 'type' => 'object', |
|
| 643 | - 'context' => array( 'view', 'edit' ), |
|
| 644 | - 'readonly' => true, |
|
| 645 | - ), |
|
| 646 | - 'readonly' => array( |
|
| 647 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 648 | - 'type' => 'string', |
|
| 649 | - 'context' => array( 'view' ), |
|
| 650 | - 'readonly' => true, |
|
| 651 | - ), |
|
| 652 | - 'faux' => array( |
|
| 653 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 654 | - 'type' => 'string', |
|
| 655 | - 'context' => array( 'view' ), |
|
| 656 | - 'readonly' => true, |
|
| 657 | - ), |
|
| 658 | - ), |
|
| 659 | - ); |
|
| 660 | - |
|
| 661 | - // Filters the settings schema for the REST API. |
|
| 381 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 382 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 383 | + return $this->filter_setting( $setting ); |
|
| 384 | + |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Get setting data. |
|
| 389 | + * |
|
| 390 | + * @since 2.0.0 |
|
| 391 | + * @param string $setting_id Setting ID. |
|
| 392 | + * @return array|WP_Error |
|
| 393 | + */ |
|
| 394 | + public function get_setting( $setting_id ) { |
|
| 395 | + |
|
| 396 | + if ( empty( $setting_id ) ) { |
|
| 397 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + $settings = $this->get_settings(); |
|
| 401 | + |
|
| 402 | + foreach ( $settings as $tabs ) { |
|
| 403 | + |
|
| 404 | + foreach ( $tabs as $sections ) { |
|
| 405 | + |
|
| 406 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
| 407 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 408 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + return $sections[ $setting_id ]; |
|
| 412 | + } |
|
| 413 | + |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 419 | + } |
|
| 420 | + |
|
| 421 | + /** |
|
| 422 | + * Get all tabs. |
|
| 423 | + * |
|
| 424 | + * @param WP_REST_Request $request Request data. |
|
| 425 | + * @return array |
|
| 426 | + */ |
|
| 427 | + public function get_tabs( $request ) { |
|
| 428 | + $tabs = wpinv_get_settings_tabs(); |
|
| 429 | + $prepared = array(); |
|
| 430 | + |
|
| 431 | + foreach ( $tabs as $id => $tab ) { |
|
| 432 | + |
|
| 433 | + $_request = $request; |
|
| 434 | + $_request['tab'] = sanitize_title( $id ); |
|
| 435 | + $data = array( |
|
| 436 | + 'id' => sanitize_title( $id ), |
|
| 437 | + 'label' => sanitize_text_field( $tab ), |
|
| 438 | + 'sections' => $this->get_sections( $_request ), |
|
| 439 | + ); |
|
| 440 | + |
|
| 441 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 442 | + $response = rest_ensure_response( $data ); |
|
| 443 | + |
|
| 444 | + if ( ! is_wp_error( $response ) ) { |
|
| 445 | + $links = array( |
|
| 446 | + 'sections' => array( |
|
| 447 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 448 | + ), |
|
| 449 | + 'collection' => array( |
|
| 450 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 451 | + ), |
|
| 452 | + ); |
|
| 453 | + $response->add_links( $links ); |
|
| 454 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + $prepared[] = $response; |
|
| 458 | + |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + return rest_ensure_response( $prepared ); |
|
| 462 | + } |
|
| 463 | + |
|
| 464 | + /** |
|
| 465 | + * Get all sections. |
|
| 466 | + * |
|
| 467 | + * @param WP_REST_Request $request Request data. |
|
| 468 | + * @return array |
|
| 469 | + */ |
|
| 470 | + public function get_sections( $request ) { |
|
| 471 | + |
|
| 472 | + $tab = sanitize_title( $request['tab'] ); |
|
| 473 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 474 | + $prepared = array(); |
|
| 475 | + |
|
| 476 | + foreach ( $sections as $id => $section ) { |
|
| 477 | + |
|
| 478 | + $data = array( |
|
| 479 | + 'id' => sanitize_title( $id ), |
|
| 480 | + 'label' => sanitize_text_field( $section ), |
|
| 481 | + ); |
|
| 482 | + |
|
| 483 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 484 | + $response = rest_ensure_response( $data ); |
|
| 485 | + |
|
| 486 | + if ( ! is_wp_error( $response ) ) { |
|
| 487 | + $links = array( |
|
| 488 | + 'settings' => array( |
|
| 489 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 490 | + ), |
|
| 491 | + 'collection' => array( |
|
| 492 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 493 | + ), |
|
| 494 | + 'tabs' => array( |
|
| 495 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 496 | + ), |
|
| 497 | + ); |
|
| 498 | + $response->add_links( $links ); |
|
| 499 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + $prepared[] = $response; |
|
| 503 | + |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + return rest_ensure_response( $prepared ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Get all settings. |
|
| 511 | + * |
|
| 512 | + * @return array |
|
| 513 | + */ |
|
| 514 | + public function get_settings() { |
|
| 515 | + |
|
| 516 | + if ( empty( $this->settings ) ) { |
|
| 517 | + $this->settings = wpinv_get_registered_settings(); |
|
| 518 | + } |
|
| 519 | + |
|
| 520 | + return $this->settings; |
|
| 521 | + |
|
| 522 | + } |
|
| 523 | + |
|
| 524 | + /** |
|
| 525 | + * Boolean for if a setting type is a valid supported setting type. |
|
| 526 | + * |
|
| 527 | + * @since 2.0.0 |
|
| 528 | + * @param string $type Type. |
|
| 529 | + * @return bool |
|
| 530 | + */ |
|
| 531 | + public function is_setting_type_valid( $type ) { |
|
| 532 | + |
|
| 533 | + return in_array( |
|
| 534 | + $type, array( |
|
| 535 | + 'text', // Validates with validate_setting_text_field. |
|
| 536 | + 'email', // Validates with validate_setting_text_field. |
|
| 537 | + 'number', // Validates with validate_setting_text_field. |
|
| 538 | + 'color', // Validates with validate_setting_text_field. |
|
| 539 | + 'password', // Validates with validate_setting_text_field. |
|
| 540 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | + 'select', // Validates with validate_setting_select_field. |
|
| 542 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | + 'header', // Validates with validate_setting_text_field. |
|
| 546 | + ) |
|
| 547 | + ); |
|
| 548 | + |
|
| 549 | + } |
|
| 550 | + |
|
| 551 | + /** |
|
| 552 | + * Get the settings schema, conforming to JSON Schema. |
|
| 553 | + * |
|
| 554 | + * @return array |
|
| 555 | + */ |
|
| 556 | + public function get_item_schema() { |
|
| 557 | + |
|
| 558 | + // Maybe retrieve the schema from cache. |
|
| 559 | + if ( ! empty( $this->schema ) ) { |
|
| 560 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 561 | + } |
|
| 562 | + |
|
| 563 | + $schema = array( |
|
| 564 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 565 | + 'title' => 'setting', |
|
| 566 | + 'type' => 'object', |
|
| 567 | + 'properties' => array( |
|
| 568 | + 'id' => array( |
|
| 569 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 570 | + 'type' => 'string', |
|
| 571 | + 'arg_options' => array( |
|
| 572 | + 'sanitize_callback' => 'sanitize_title', |
|
| 573 | + ), |
|
| 574 | + 'context' => array( 'view', 'edit' ), |
|
| 575 | + 'readonly' => true, |
|
| 576 | + ), |
|
| 577 | + 'tab' => array( |
|
| 578 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 579 | + 'type' => 'string', |
|
| 580 | + 'arg_options' => array( |
|
| 581 | + 'sanitize_callback' => 'sanitize_title', |
|
| 582 | + ), |
|
| 583 | + 'context' => array( 'view', 'edit' ), |
|
| 584 | + 'readonly' => true, |
|
| 585 | + ), |
|
| 586 | + 'section' => array( |
|
| 587 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 588 | + 'type' => 'string', |
|
| 589 | + 'arg_options' => array( |
|
| 590 | + 'sanitize_callback' => 'sanitize_title', |
|
| 591 | + ), |
|
| 592 | + 'context' => array( 'view', 'edit' ), |
|
| 593 | + 'readonly' => true, |
|
| 594 | + ), |
|
| 595 | + 'name' => array( |
|
| 596 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 597 | + 'type' => 'string', |
|
| 598 | + 'arg_options' => array( |
|
| 599 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 600 | + ), |
|
| 601 | + 'context' => array( 'view', 'edit' ), |
|
| 602 | + 'readonly' => true, |
|
| 603 | + ), |
|
| 604 | + 'desc' => array( |
|
| 605 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 606 | + 'type' => 'string', |
|
| 607 | + 'context' => array( 'view', 'edit' ), |
|
| 608 | + 'readonly' => true, |
|
| 609 | + ), |
|
| 610 | + 'value' => array( |
|
| 611 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 612 | + 'type' => 'mixed', |
|
| 613 | + 'context' => array( 'view', 'edit' ), |
|
| 614 | + ), |
|
| 615 | + 'default' => array( |
|
| 616 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 617 | + 'type' => 'mixed', |
|
| 618 | + 'context' => array( 'view', 'edit' ), |
|
| 619 | + 'readonly' => true, |
|
| 620 | + ), |
|
| 621 | + 'placeholder' => array( |
|
| 622 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 623 | + 'type' => 'string', |
|
| 624 | + 'arg_options' => array( |
|
| 625 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 626 | + ), |
|
| 627 | + 'context' => array( 'view', 'edit' ), |
|
| 628 | + 'readonly' => true, |
|
| 629 | + ), |
|
| 630 | + 'type' => array( |
|
| 631 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 632 | + 'type' => 'string', |
|
| 633 | + 'arg_options' => array( |
|
| 634 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 635 | + ), |
|
| 636 | + 'context' => array( 'view', 'edit' ), |
|
| 637 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 638 | + 'readonly' => true, |
|
| 639 | + ), |
|
| 640 | + 'options' => array( |
|
| 641 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 642 | + 'type' => 'object', |
|
| 643 | + 'context' => array( 'view', 'edit' ), |
|
| 644 | + 'readonly' => true, |
|
| 645 | + ), |
|
| 646 | + 'readonly' => array( |
|
| 647 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 648 | + 'type' => 'string', |
|
| 649 | + 'context' => array( 'view' ), |
|
| 650 | + 'readonly' => true, |
|
| 651 | + ), |
|
| 652 | + 'faux' => array( |
|
| 653 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 654 | + 'type' => 'string', |
|
| 655 | + 'context' => array( 'view' ), |
|
| 656 | + 'readonly' => true, |
|
| 657 | + ), |
|
| 658 | + ), |
|
| 659 | + ); |
|
| 660 | + |
|
| 661 | + // Filters the settings schema for the REST API. |
|
| 662 | 662 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
| 663 | 663 | |
| 664 | - // Cache the settings schema. |
|
| 665 | - $this->schema = $schema; |
|
| 666 | - |
|
| 667 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 668 | - |
|
| 669 | - } |
|
| 670 | - |
|
| 671 | - /** |
|
| 672 | - * Validate a text value for a text based setting. |
|
| 673 | - * |
|
| 674 | - * @since 2.0.0 |
|
| 675 | - * @param string $value Value. |
|
| 676 | - * @param array $setting Setting. |
|
| 677 | - * @return string |
|
| 678 | - */ |
|
| 679 | - public function validate_setting_text_field( $value ) { |
|
| 680 | - $value = is_null( $value ) ? '' : $value; |
|
| 681 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 682 | - } |
|
| 683 | - |
|
| 684 | - /** |
|
| 685 | - * Validate select based settings. |
|
| 686 | - * |
|
| 687 | - * @since 2.0.0 |
|
| 688 | - * @param string $value Value. |
|
| 689 | - * @param array $setting Setting. |
|
| 690 | - * @return string|WP_Error |
|
| 691 | - */ |
|
| 692 | - public function validate_setting_select_field( $value, $setting ) { |
|
| 693 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 694 | - return $value; |
|
| 695 | - } else { |
|
| 696 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 697 | - } |
|
| 698 | - } |
|
| 699 | - |
|
| 700 | - /** |
|
| 701 | - * Validate multiselect based settings. |
|
| 702 | - * |
|
| 703 | - * @since 2.0.0 |
|
| 704 | - * @param array $values Values. |
|
| 705 | - * @param array $setting Setting. |
|
| 706 | - * @return array|WP_Error |
|
| 707 | - */ |
|
| 708 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 709 | - if ( empty( $values ) ) { |
|
| 710 | - return array(); |
|
| 711 | - } |
|
| 712 | - |
|
| 713 | - if ( ! is_array( $values ) ) { |
|
| 714 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - $final_values = array(); |
|
| 718 | - foreach ( $values as $value ) { |
|
| 719 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 720 | - $final_values[] = $value; |
|
| 721 | - } |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - return $final_values; |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * Validate radio based settings. |
|
| 729 | - * |
|
| 730 | - * @since 2.0.0 |
|
| 731 | - * @param string $value Value. |
|
| 732 | - * @param array $setting Setting. |
|
| 733 | - * @return string|WP_Error |
|
| 734 | - */ |
|
| 735 | - public function validate_setting_radio_field( $value, $setting ) { |
|
| 736 | - return $this->validate_setting_select_field( $value, $setting ); |
|
| 737 | - } |
|
| 738 | - |
|
| 739 | - /** |
|
| 740 | - * Validate checkbox based settings. |
|
| 741 | - * |
|
| 742 | - * @since 2.0.0 |
|
| 743 | - * @param string $value Value. |
|
| 744 | - * @return int |
|
| 745 | - */ |
|
| 746 | - public function validate_setting_checkbox_field( $value ) { |
|
| 747 | - return (int) ! empty( $value ); |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Validate textarea based settings. |
|
| 752 | - * |
|
| 753 | - * @since 2.0.0 |
|
| 754 | - * @param string $value Value. |
|
| 755 | - * @return string |
|
| 756 | - */ |
|
| 757 | - public function validate_setting_textarea_field( $value ) { |
|
| 758 | - $value = is_null( $value ) ? '' : $value; |
|
| 759 | - return wp_kses( |
|
| 760 | - trim( stripslashes( $value ) ), |
|
| 761 | - array_merge( |
|
| 762 | - array( |
|
| 763 | - 'iframe' => array( |
|
| 764 | - 'src' => true, |
|
| 765 | - 'style' => true, |
|
| 766 | - 'id' => true, |
|
| 767 | - 'class' => true, |
|
| 768 | - ), |
|
| 769 | - ), |
|
| 770 | - wp_kses_allowed_html( 'post' ) |
|
| 771 | - ) |
|
| 772 | - ); |
|
| 773 | - } |
|
| 664 | + // Cache the settings schema. |
|
| 665 | + $this->schema = $schema; |
|
| 666 | + |
|
| 667 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 668 | + |
|
| 669 | + } |
|
| 670 | + |
|
| 671 | + /** |
|
| 672 | + * Validate a text value for a text based setting. |
|
| 673 | + * |
|
| 674 | + * @since 2.0.0 |
|
| 675 | + * @param string $value Value. |
|
| 676 | + * @param array $setting Setting. |
|
| 677 | + * @return string |
|
| 678 | + */ |
|
| 679 | + public function validate_setting_text_field( $value ) { |
|
| 680 | + $value = is_null( $value ) ? '' : $value; |
|
| 681 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 682 | + } |
|
| 683 | + |
|
| 684 | + /** |
|
| 685 | + * Validate select based settings. |
|
| 686 | + * |
|
| 687 | + * @since 2.0.0 |
|
| 688 | + * @param string $value Value. |
|
| 689 | + * @param array $setting Setting. |
|
| 690 | + * @return string|WP_Error |
|
| 691 | + */ |
|
| 692 | + public function validate_setting_select_field( $value, $setting ) { |
|
| 693 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 694 | + return $value; |
|
| 695 | + } else { |
|
| 696 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 697 | + } |
|
| 698 | + } |
|
| 699 | + |
|
| 700 | + /** |
|
| 701 | + * Validate multiselect based settings. |
|
| 702 | + * |
|
| 703 | + * @since 2.0.0 |
|
| 704 | + * @param array $values Values. |
|
| 705 | + * @param array $setting Setting. |
|
| 706 | + * @return array|WP_Error |
|
| 707 | + */ |
|
| 708 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 709 | + if ( empty( $values ) ) { |
|
| 710 | + return array(); |
|
| 711 | + } |
|
| 712 | + |
|
| 713 | + if ( ! is_array( $values ) ) { |
|
| 714 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 715 | + } |
|
| 716 | + |
|
| 717 | + $final_values = array(); |
|
| 718 | + foreach ( $values as $value ) { |
|
| 719 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 720 | + $final_values[] = $value; |
|
| 721 | + } |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + return $final_values; |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * Validate radio based settings. |
|
| 729 | + * |
|
| 730 | + * @since 2.0.0 |
|
| 731 | + * @param string $value Value. |
|
| 732 | + * @param array $setting Setting. |
|
| 733 | + * @return string|WP_Error |
|
| 734 | + */ |
|
| 735 | + public function validate_setting_radio_field( $value, $setting ) { |
|
| 736 | + return $this->validate_setting_select_field( $value, $setting ); |
|
| 737 | + } |
|
| 738 | + |
|
| 739 | + /** |
|
| 740 | + * Validate checkbox based settings. |
|
| 741 | + * |
|
| 742 | + * @since 2.0.0 |
|
| 743 | + * @param string $value Value. |
|
| 744 | + * @return int |
|
| 745 | + */ |
|
| 746 | + public function validate_setting_checkbox_field( $value ) { |
|
| 747 | + return (int) ! empty( $value ); |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Validate textarea based settings. |
|
| 752 | + * |
|
| 753 | + * @since 2.0.0 |
|
| 754 | + * @param string $value Value. |
|
| 755 | + * @return string |
|
| 756 | + */ |
|
| 757 | + public function validate_setting_textarea_field( $value ) { |
|
| 758 | + $value = is_null( $value ) ? '' : $value; |
|
| 759 | + return wp_kses( |
|
| 760 | + trim( stripslashes( $value ) ), |
|
| 761 | + array_merge( |
|
| 762 | + array( |
|
| 763 | + 'iframe' => array( |
|
| 764 | + 'src' => true, |
|
| 765 | + 'style' => true, |
|
| 766 | + 'id' => true, |
|
| 767 | + 'class' => true, |
|
| 768 | + ), |
|
| 769 | + ), |
|
| 770 | + wp_kses_allowed_html( 'post' ) |
|
| 771 | + ) |
|
| 772 | + ); |
|
| 773 | + } |
|
| 774 | 774 | |
| 775 | 775 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST Setting controller class. |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | * |
| 40 | 40 | * @see register_rest_route() |
| 41 | 41 | */ |
| 42 | - public function register_namespace_routes( $namespace ) { |
|
| 42 | + public function register_namespace_routes($namespace) { |
|
| 43 | 43 | |
| 44 | 44 | // List all registered tabs. |
| 45 | 45 | register_rest_route( |
@@ -48,8 +48,8 @@ discard block |
||
| 48 | 48 | array( |
| 49 | 49 | array( |
| 50 | 50 | 'methods' => WP_REST_Server::READABLE, |
| 51 | - 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 51 | + 'callback' => array($this, 'get_tabs'), |
|
| 52 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 53 | 53 | ), |
| 54 | 54 | 'schema' => '__return_empty_array', |
| 55 | 55 | ) |
@@ -62,23 +62,23 @@ discard block |
||
| 62 | 62 | array( |
| 63 | 63 | 'args' => array( |
| 64 | 64 | 'id' => array( |
| 65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 65 | + 'description' => __('Unique identifier for the setting.', 'invoicing'), |
|
| 66 | 66 | 'type' => 'string', |
| 67 | 67 | 'required' => true, |
| 68 | 68 | ), |
| 69 | 69 | ), |
| 70 | 70 | array( |
| 71 | 71 | 'methods' => WP_REST_Server::READABLE, |
| 72 | - 'callback' => array( $this, 'get_item' ), |
|
| 73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 72 | + 'callback' => array($this, 'get_item'), |
|
| 73 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 74 | 74 | ), |
| 75 | 75 | array( |
| 76 | 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 ), |
|
| 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 | 80 | ), |
| 81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 81 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 82 | 82 | ) |
| 83 | 83 | ); |
| 84 | 84 | |
@@ -89,16 +89,16 @@ discard block |
||
| 89 | 89 | array( |
| 90 | 90 | 'args' => array( |
| 91 | 91 | 'tab' => array( |
| 92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 92 | + 'description' => __('Unique identifier for the tab whose sections should be retrieved.', 'invoicing'), |
|
| 93 | 93 | 'type' => 'string', |
| 94 | 94 | 'required' => true, |
| 95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 95 | + 'enum' => array_keys(wpinv_get_settings_tabs()), |
|
| 96 | 96 | ), |
| 97 | 97 | ), |
| 98 | 98 | array( |
| 99 | 99 | 'methods' => WP_REST_Server::READABLE, |
| 100 | - 'callback' => array( $this, 'get_sections' ), |
|
| 101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 100 | + 'callback' => array($this, 'get_sections'), |
|
| 101 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 102 | 102 | ), |
| 103 | 103 | 'schema' => '__return_empty_array', |
| 104 | 104 | ) |
@@ -111,23 +111,23 @@ discard block |
||
| 111 | 111 | array( |
| 112 | 112 | 'args' => array( |
| 113 | 113 | 'tab' => array( |
| 114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 114 | + 'description' => __('Unique identifier for the tab whose settings should be retrieved.', 'invoicing'), |
|
| 115 | 115 | 'type' => 'string', |
| 116 | 116 | 'required' => true, |
| 117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 117 | + 'enum' => array_keys(wpinv_get_settings_tabs()), |
|
| 118 | 118 | ), |
| 119 | 119 | 'section' => array( |
| 120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 120 | + 'description' => __('The section in the tab whose settings should be retrieved.', 'invoicing'), |
|
| 121 | 121 | 'type' => 'string', |
| 122 | 122 | 'required' => true, |
| 123 | 123 | ), |
| 124 | 124 | ), |
| 125 | 125 | array( |
| 126 | 126 | 'methods' => WP_REST_Server::READABLE, |
| 127 | - 'callback' => array( $this, 'get_items' ), |
|
| 128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 127 | + 'callback' => array($this, 'get_items'), |
|
| 128 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 129 | 129 | ), |
| 130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 130 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 131 | 131 | ) |
| 132 | 132 | ); |
| 133 | 133 | |
@@ -137,17 +137,17 @@ discard block |
||
| 137 | 137 | array( |
| 138 | 138 | 'args' => array( |
| 139 | 139 | 'id' => array( |
| 140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 140 | + 'description' => __('Setting ID.', 'invoicing'), |
|
| 141 | 141 | 'type' => 'string', |
| 142 | 142 | ), |
| 143 | 143 | ), |
| 144 | 144 | array( |
| 145 | 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 ), |
|
| 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 | 149 | ), |
| 150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 150 | + 'schema' => array($this, 'get_public_batch_schema'), |
|
| 151 | 151 | ) |
| 152 | 152 | ); |
| 153 | 153 | |
@@ -160,34 +160,34 @@ discard block |
||
| 160 | 160 | * @param WP_REST_Request $request Request data. |
| 161 | 161 | * @return WP_Error|WP_REST_Response |
| 162 | 162 | */ |
| 163 | - public function get_items( $request ) { |
|
| 163 | + public function get_items($request) { |
|
| 164 | 164 | |
| 165 | 165 | $settings = $this->get_settings(); |
| 166 | 166 | |
| 167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 167 | + if (!isset($settings[$request['tab']])) { |
|
| 168 | + return new WP_Error('rest_invalid_tab', __('Invalid tab.', 'invoicing'), array('status' => 400)); |
|
| 169 | 169 | } |
| 170 | 170 | |
| 171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 171 | + if (!isset($settings[$request['tab']][$request['section']])) { |
|
| 172 | + return new WP_Error('rest_invalid_section', __('Invalid section.', 'invoicing'), array('status' => 400)); |
|
| 173 | 173 | } |
| 174 | 174 | |
| 175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 175 | + $settings = $settings[$request['tab']][$request['section']]; |
|
| 176 | 176 | $prepared = array(); |
| 177 | 177 | |
| 178 | - foreach ( $settings as $setting ) { |
|
| 178 | + foreach ($settings as $setting) { |
|
| 179 | 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 ); |
|
| 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 | 183 | |
| 184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | - $prepared[] = $setting_data; |
|
| 184 | + if ($this->is_setting_type_valid($setting['type'])) { |
|
| 185 | + $prepared[] = $setting_data; |
|
| 186 | 186 | } |
| 187 | 187 | |
| 188 | 188 | } |
| 189 | 189 | |
| 190 | - return rest_ensure_response( $prepared ); |
|
| 190 | + return rest_ensure_response($prepared); |
|
| 191 | 191 | } |
| 192 | 192 | |
| 193 | 193 | /** |
@@ -197,16 +197,16 @@ discard block |
||
| 197 | 197 | * @param WP_REST_Request $request Request data. |
| 198 | 198 | * @return WP_Error|WP_REST_Response |
| 199 | 199 | */ |
| 200 | - public function get_item( $request ) { |
|
| 201 | - $setting = $this->get_setting( $request['id'] ); |
|
| 200 | + public function get_item($request) { |
|
| 201 | + $setting = $this->get_setting($request['id']); |
|
| 202 | 202 | |
| 203 | - if ( is_wp_error( $setting ) ) { |
|
| 203 | + if (is_wp_error($setting)) { |
|
| 204 | 204 | return $setting; |
| 205 | 205 | } |
| 206 | 206 | |
| 207 | - $setting = $this->sanitize_setting( $setting ); |
|
| 208 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 209 | - return rest_ensure_response( $response ); |
|
| 207 | + $setting = $this->sanitize_setting($setting); |
|
| 208 | + $response = $this->prepare_item_for_response($setting, $request); |
|
| 209 | + return rest_ensure_response($response); |
|
| 210 | 210 | } |
| 211 | 211 | |
| 212 | 212 | /** |
@@ -216,29 +216,29 @@ discard block |
||
| 216 | 216 | * @param WP_REST_Request $request Request data. |
| 217 | 217 | * @return WP_Error|WP_REST_Response |
| 218 | 218 | */ |
| 219 | - public function update_item( $request ) { |
|
| 220 | - $setting = $this->get_setting( $request['id'] ); |
|
| 219 | + public function update_item($request) { |
|
| 220 | + $setting = $this->get_setting($request['id']); |
|
| 221 | 221 | |
| 222 | - if ( is_wp_error( $setting ) ) { |
|
| 222 | + if (is_wp_error($setting)) { |
|
| 223 | 223 | return $setting; |
| 224 | 224 | } |
| 225 | 225 | |
| 226 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 227 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 226 | + if (is_callable(array($this, 'validate_setting_' . $setting['type'] . '_field'))) { |
|
| 227 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}($request['value'], $setting); |
|
| 228 | 228 | } else { |
| 229 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 229 | + $value = $this->validate_setting_text_field($request['value'], $setting); |
|
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - if ( is_wp_error( $value ) ) { |
|
| 232 | + if (is_wp_error($value)) { |
|
| 233 | 233 | return $value; |
| 234 | 234 | } |
| 235 | 235 | |
| 236 | - wpinv_update_option( $request['id'], $value ); |
|
| 236 | + wpinv_update_option($request['id'], $value); |
|
| 237 | 237 | $setting['value'] = $value; |
| 238 | - $setting = $this->sanitize_setting( $setting ); |
|
| 239 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 238 | + $setting = $this->sanitize_setting($setting); |
|
| 239 | + $response = $this->prepare_item_for_response($setting, $request); |
|
| 240 | 240 | |
| 241 | - return rest_ensure_response( $response ); |
|
| 241 | + return rest_ensure_response($response); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
@@ -248,9 +248,9 @@ discard block |
||
| 248 | 248 | * @param WP_REST_Request $request Full data about the request. |
| 249 | 249 | * @return WP_Error|boolean |
| 250 | 250 | */ |
| 251 | - public function get_items_permissions_check( $request ) { |
|
| 252 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 253 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 251 | + public function get_items_permissions_check($request) { |
|
| 252 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 253 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 254 | 254 | } |
| 255 | 255 | |
| 256 | 256 | return true; |
@@ -263,9 +263,9 @@ discard block |
||
| 263 | 263 | * @param WP_REST_Request $request Full data about the request. |
| 264 | 264 | * @return WP_Error|boolean |
| 265 | 265 | */ |
| 266 | - public function update_items_permissions_check( $request ) { |
|
| 267 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 268 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 266 | + public function update_items_permissions_check($request) { |
|
| 267 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 268 | + return new WP_Error('rest_cannot_edit', __('Sorry, you cannot edit this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 269 | 269 | } |
| 270 | 270 | |
| 271 | 271 | return true; |
@@ -278,8 +278,8 @@ discard block |
||
| 278 | 278 | * |
| 279 | 279 | * @return boolean|WP_Error |
| 280 | 280 | */ |
| 281 | - public function batch_items_permissions_check( $request ) { |
|
| 282 | - 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() ) ); |
|
| 281 | + public function batch_items_permissions_check($request) { |
|
| 282 | + 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())); |
|
| 283 | 283 | } |
| 284 | 284 | |
| 285 | 285 | /** |
@@ -288,14 +288,14 @@ discard block |
||
| 288 | 288 | * @param string $setting_id Setting ID. |
| 289 | 289 | * @return array Links for the given setting. |
| 290 | 290 | */ |
| 291 | - protected function prepare_links( $setting_id ) { |
|
| 291 | + protected function prepare_links($setting_id) { |
|
| 292 | 292 | |
| 293 | 293 | $links = array( |
| 294 | 294 | 'self' => array( |
| 295 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 295 | + 'href' => rest_url(sprintf('/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id)), |
|
| 296 | 296 | ), |
| 297 | 297 | 'collection' => array( |
| 298 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 298 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 299 | 299 | ), |
| 300 | 300 | ); |
| 301 | 301 | |
@@ -310,14 +310,14 @@ discard block |
||
| 310 | 310 | * @param WP_REST_Request $request Request object. |
| 311 | 311 | * @return WP_REST_Response $response Response data. |
| 312 | 312 | */ |
| 313 | - public function prepare_item_for_response( $item, $request ) { |
|
| 314 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 315 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 316 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 313 | + public function prepare_item_for_response($item, $request) { |
|
| 314 | + $context = empty($request['context']) ? 'view' : $request['context']; |
|
| 315 | + $data = $this->add_additional_fields_to_object($item, $request); |
|
| 316 | + $data = $this->filter_response_by_context($data, $context); |
|
| 317 | 317 | |
| 318 | - $response = rest_ensure_response( $data ); |
|
| 318 | + $response = rest_ensure_response($data); |
|
| 319 | 319 | |
| 320 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 320 | + $response->add_links($this->prepare_links($item['id'])); |
|
| 321 | 321 | |
| 322 | 322 | return $response; |
| 323 | 323 | } |
@@ -330,10 +330,10 @@ discard block |
||
| 330 | 330 | * @param array $setting Setting. |
| 331 | 331 | * @return array |
| 332 | 332 | */ |
| 333 | - public function filter_setting( $setting ) { |
|
| 333 | + public function filter_setting($setting) { |
|
| 334 | 334 | return array_intersect_key( |
| 335 | 335 | $setting, |
| 336 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 336 | + array_flip(array_filter(array_keys($setting), array($this, 'allowed_setting_keys'))) |
|
| 337 | 337 | ); |
| 338 | 338 | } |
| 339 | 339 | |
@@ -343,8 +343,8 @@ discard block |
||
| 343 | 343 | * @param string $key Key to check. |
| 344 | 344 | * @return boolean |
| 345 | 345 | */ |
| 346 | - public function allowed_setting_keys( $key ) { |
|
| 347 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 346 | + public function allowed_setting_keys($key) { |
|
| 347 | + return in_array($key, array_keys($this->setting_defaults()), true); |
|
| 348 | 348 | } |
| 349 | 349 | |
| 350 | 350 | /** |
@@ -376,11 +376,11 @@ discard block |
||
| 376 | 376 | * @param array $setting The setting to sanitize. |
| 377 | 377 | * @return array |
| 378 | 378 | */ |
| 379 | - public function sanitize_setting( $setting ) { |
|
| 379 | + public function sanitize_setting($setting) { |
|
| 380 | 380 | |
| 381 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 382 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 383 | - return $this->filter_setting( $setting ); |
|
| 381 | + $setting = wp_parse_args($setting, $this->setting_defaults()); |
|
| 382 | + $setting['value'] = wpinv_get_option($setting['id'], $setting['std']); |
|
| 383 | + return $this->filter_setting($setting); |
|
| 384 | 384 | |
| 385 | 385 | } |
| 386 | 386 | |
@@ -391,31 +391,31 @@ discard block |
||
| 391 | 391 | * @param string $setting_id Setting ID. |
| 392 | 392 | * @return array|WP_Error |
| 393 | 393 | */ |
| 394 | - public function get_setting( $setting_id ) { |
|
| 394 | + public function get_setting($setting_id) { |
|
| 395 | 395 | |
| 396 | - if ( empty( $setting_id ) ) { |
|
| 397 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 396 | + if (empty($setting_id)) { |
|
| 397 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
| 398 | 398 | } |
| 399 | 399 | |
| 400 | - $settings = $this->get_settings(); |
|
| 400 | + $settings = $this->get_settings(); |
|
| 401 | 401 | |
| 402 | - foreach ( $settings as $tabs ) { |
|
| 402 | + foreach ($settings as $tabs) { |
|
| 403 | 403 | |
| 404 | - foreach ( $tabs as $sections ) { |
|
| 404 | + foreach ($tabs as $sections) { |
|
| 405 | 405 | |
| 406 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
| 407 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 408 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 406 | + if (isset($sections[$setting_id])) { |
|
| 407 | + if (!$this->is_setting_type_valid($sections[$setting_id]['type'])) { |
|
| 408 | + return new WP_Error('rest_setting_setting_type_invalid', __('Invalid setting type.', 'invoicing'), array('status' => 404)); |
|
| 409 | 409 | } |
| 410 | 410 | |
| 411 | - return $sections[ $setting_id ]; |
|
| 411 | + return $sections[$setting_id]; |
|
| 412 | 412 | } |
| 413 | 413 | |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | } |
| 417 | 417 | |
| 418 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 418 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
| 419 | 419 | } |
| 420 | 420 | |
| 421 | 421 | /** |
@@ -424,41 +424,41 @@ discard block |
||
| 424 | 424 | * @param WP_REST_Request $request Request data. |
| 425 | 425 | * @return array |
| 426 | 426 | */ |
| 427 | - public function get_tabs( $request ) { |
|
| 427 | + public function get_tabs($request) { |
|
| 428 | 428 | $tabs = wpinv_get_settings_tabs(); |
| 429 | 429 | $prepared = array(); |
| 430 | 430 | |
| 431 | - foreach ( $tabs as $id => $tab ) { |
|
| 431 | + foreach ($tabs as $id => $tab) { |
|
| 432 | 432 | |
| 433 | 433 | $_request = $request; |
| 434 | - $_request['tab'] = sanitize_title( $id ); |
|
| 434 | + $_request['tab'] = sanitize_title($id); |
|
| 435 | 435 | $data = array( |
| 436 | - 'id' => sanitize_title( $id ), |
|
| 437 | - 'label' => sanitize_text_field( $tab ), |
|
| 438 | - 'sections' => $this->get_sections( $_request ), |
|
| 436 | + 'id' => sanitize_title($id), |
|
| 437 | + 'label' => sanitize_text_field($tab), |
|
| 438 | + 'sections' => $this->get_sections($_request), |
|
| 439 | 439 | ); |
| 440 | 440 | |
| 441 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 442 | - $response = rest_ensure_response( $data ); |
|
| 441 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 442 | + $response = rest_ensure_response($data); |
|
| 443 | 443 | |
| 444 | - if ( ! is_wp_error( $response ) ) { |
|
| 444 | + if (!is_wp_error($response)) { |
|
| 445 | 445 | $links = array( |
| 446 | 446 | 'sections' => array( |
| 447 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 447 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $id)), |
|
| 448 | 448 | ), |
| 449 | 449 | 'collection' => array( |
| 450 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 450 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 451 | 451 | ), |
| 452 | 452 | ); |
| 453 | - $response->add_links( $links ); |
|
| 454 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 453 | + $response->add_links($links); |
|
| 454 | + $response = $this->prepare_response_for_collection($response); |
|
| 455 | 455 | } |
| 456 | 456 | |
| 457 | 457 | $prepared[] = $response; |
| 458 | 458 | |
| 459 | 459 | } |
| 460 | 460 | |
| 461 | - return rest_ensure_response( $prepared ); |
|
| 461 | + return rest_ensure_response($prepared); |
|
| 462 | 462 | } |
| 463 | 463 | |
| 464 | 464 | /** |
@@ -467,43 +467,43 @@ discard block |
||
| 467 | 467 | * @param WP_REST_Request $request Request data. |
| 468 | 468 | * @return array |
| 469 | 469 | */ |
| 470 | - public function get_sections( $request ) { |
|
| 470 | + public function get_sections($request) { |
|
| 471 | 471 | |
| 472 | - $tab = sanitize_title( $request['tab'] ); |
|
| 473 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 472 | + $tab = sanitize_title($request['tab']); |
|
| 473 | + $sections = wpinv_get_settings_tab_sections($tab); |
|
| 474 | 474 | $prepared = array(); |
| 475 | 475 | |
| 476 | - foreach ( $sections as $id => $section ) { |
|
| 476 | + foreach ($sections as $id => $section) { |
|
| 477 | 477 | |
| 478 | - $data = array( |
|
| 479 | - 'id' => sanitize_title( $id ), |
|
| 480 | - 'label' => sanitize_text_field( $section ), |
|
| 478 | + $data = array( |
|
| 479 | + 'id' => sanitize_title($id), |
|
| 480 | + 'label' => sanitize_text_field($section), |
|
| 481 | 481 | ); |
| 482 | 482 | |
| 483 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 484 | - $response = rest_ensure_response( $data ); |
|
| 483 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 484 | + $response = rest_ensure_response($data); |
|
| 485 | 485 | |
| 486 | - if ( ! is_wp_error( $response ) ) { |
|
| 486 | + if (!is_wp_error($response)) { |
|
| 487 | 487 | $links = array( |
| 488 | 488 | 'settings' => array( |
| 489 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 489 | + 'href' => rest_url(sprintf('/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id)), |
|
| 490 | 490 | ), |
| 491 | 491 | 'collection' => array( |
| 492 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 492 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $tab)), |
|
| 493 | 493 | ), |
| 494 | 494 | 'tabs' => array( |
| 495 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 495 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
| 496 | 496 | ), |
| 497 | 497 | ); |
| 498 | - $response->add_links( $links ); |
|
| 499 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 498 | + $response->add_links($links); |
|
| 499 | + $response = $this->prepare_response_for_collection($response); |
|
| 500 | 500 | } |
| 501 | 501 | |
| 502 | 502 | $prepared[] = $response; |
| 503 | 503 | |
| 504 | 504 | } |
| 505 | 505 | |
| 506 | - return rest_ensure_response( $prepared ); |
|
| 506 | + return rest_ensure_response($prepared); |
|
| 507 | 507 | } |
| 508 | 508 | |
| 509 | 509 | /** |
@@ -513,7 +513,7 @@ discard block |
||
| 513 | 513 | */ |
| 514 | 514 | public function get_settings() { |
| 515 | 515 | |
| 516 | - if ( empty( $this->settings ) ) { |
|
| 516 | + if (empty($this->settings)) { |
|
| 517 | 517 | $this->settings = wpinv_get_registered_settings(); |
| 518 | 518 | } |
| 519 | 519 | |
@@ -528,21 +528,21 @@ discard block |
||
| 528 | 528 | * @param string $type Type. |
| 529 | 529 | * @return bool |
| 530 | 530 | */ |
| 531 | - public function is_setting_type_valid( $type ) { |
|
| 531 | + public function is_setting_type_valid($type) { |
|
| 532 | 532 | |
| 533 | 533 | return in_array( |
| 534 | 534 | $type, array( |
| 535 | - 'text', // Validates with validate_setting_text_field. |
|
| 536 | - 'email', // Validates with validate_setting_text_field. |
|
| 537 | - 'number', // Validates with validate_setting_text_field. |
|
| 538 | - 'color', // Validates with validate_setting_text_field. |
|
| 539 | - 'password', // Validates with validate_setting_text_field. |
|
| 540 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | - 'select', // Validates with validate_setting_select_field. |
|
| 542 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | - 'header', // Validates with validate_setting_text_field. |
|
| 535 | + 'text', // Validates with validate_setting_text_field. |
|
| 536 | + 'email', // Validates with validate_setting_text_field. |
|
| 537 | + 'number', // Validates with validate_setting_text_field. |
|
| 538 | + 'color', // Validates with validate_setting_text_field. |
|
| 539 | + 'password', // Validates with validate_setting_text_field. |
|
| 540 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | + 'select', // Validates with validate_setting_select_field. |
|
| 542 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | + 'header', // Validates with validate_setting_text_field. |
|
| 546 | 546 | ) |
| 547 | 547 | ); |
| 548 | 548 | |
@@ -556,8 +556,8 @@ discard block |
||
| 556 | 556 | public function get_item_schema() { |
| 557 | 557 | |
| 558 | 558 | // Maybe retrieve the schema from cache. |
| 559 | - if ( ! empty( $this->schema ) ) { |
|
| 560 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 559 | + if (!empty($this->schema)) { |
|
| 560 | + return $this->add_additional_fields_schema($this->schema); |
|
| 561 | 561 | } |
| 562 | 562 | |
| 563 | 563 | $schema = array( |
@@ -566,105 +566,105 @@ discard block |
||
| 566 | 566 | 'type' => 'object', |
| 567 | 567 | 'properties' => array( |
| 568 | 568 | 'id' => array( |
| 569 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 569 | + 'description' => __('A unique identifier for the setting.', 'invoicing'), |
|
| 570 | 570 | 'type' => 'string', |
| 571 | 571 | 'arg_options' => array( |
| 572 | 572 | 'sanitize_callback' => 'sanitize_title', |
| 573 | 573 | ), |
| 574 | - 'context' => array( 'view', 'edit' ), |
|
| 574 | + 'context' => array('view', 'edit'), |
|
| 575 | 575 | 'readonly' => true, |
| 576 | 576 | ), |
| 577 | 577 | 'tab' => array( |
| 578 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 578 | + 'description' => __('An identifier for the tab this setting belongs to.', 'invoicing'), |
|
| 579 | 579 | 'type' => 'string', |
| 580 | 580 | 'arg_options' => array( |
| 581 | 581 | 'sanitize_callback' => 'sanitize_title', |
| 582 | 582 | ), |
| 583 | - 'context' => array( 'view', 'edit' ), |
|
| 583 | + 'context' => array('view', 'edit'), |
|
| 584 | 584 | 'readonly' => true, |
| 585 | 585 | ), |
| 586 | 586 | 'section' => array( |
| 587 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 587 | + 'description' => __('An identifier for the section this setting belongs to.', 'invoicing'), |
|
| 588 | 588 | 'type' => 'string', |
| 589 | 589 | 'arg_options' => array( |
| 590 | 590 | 'sanitize_callback' => 'sanitize_title', |
| 591 | 591 | ), |
| 592 | - 'context' => array( 'view', 'edit' ), |
|
| 592 | + 'context' => array('view', 'edit'), |
|
| 593 | 593 | 'readonly' => true, |
| 594 | 594 | ), |
| 595 | 595 | 'name' => array( |
| 596 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 596 | + 'description' => __('A human readable label for the setting used in interfaces.', 'invoicing'), |
|
| 597 | 597 | 'type' => 'string', |
| 598 | 598 | 'arg_options' => array( |
| 599 | 599 | 'sanitize_callback' => 'sanitize_text_field', |
| 600 | 600 | ), |
| 601 | - 'context' => array( 'view', 'edit' ), |
|
| 601 | + 'context' => array('view', 'edit'), |
|
| 602 | 602 | 'readonly' => true, |
| 603 | 603 | ), |
| 604 | 604 | 'desc' => array( |
| 605 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 605 | + 'description' => __('A human readable description for the setting used in interfaces.', 'invoicing'), |
|
| 606 | 606 | 'type' => 'string', |
| 607 | - 'context' => array( 'view', 'edit' ), |
|
| 607 | + 'context' => array('view', 'edit'), |
|
| 608 | 608 | 'readonly' => true, |
| 609 | 609 | ), |
| 610 | 610 | 'value' => array( |
| 611 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 611 | + 'description' => __('The current value of this setting.', 'invoicing'), |
|
| 612 | 612 | 'type' => 'mixed', |
| 613 | - 'context' => array( 'view', 'edit' ), |
|
| 613 | + 'context' => array('view', 'edit'), |
|
| 614 | 614 | ), |
| 615 | 615 | 'default' => array( |
| 616 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 616 | + 'description' => __('Default value for the setting.', 'invoicing'), |
|
| 617 | 617 | 'type' => 'mixed', |
| 618 | - 'context' => array( 'view', 'edit' ), |
|
| 618 | + 'context' => array('view', 'edit'), |
|
| 619 | 619 | 'readonly' => true, |
| 620 | 620 | ), |
| 621 | 621 | 'placeholder' => array( |
| 622 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 622 | + 'description' => __('Placeholder text to be displayed in text inputs.', 'invoicing'), |
|
| 623 | 623 | 'type' => 'string', |
| 624 | 624 | 'arg_options' => array( |
| 625 | 625 | 'sanitize_callback' => 'sanitize_text_field', |
| 626 | 626 | ), |
| 627 | - 'context' => array( 'view', 'edit' ), |
|
| 627 | + 'context' => array('view', 'edit'), |
|
| 628 | 628 | 'readonly' => true, |
| 629 | 629 | ), |
| 630 | 630 | 'type' => array( |
| 631 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 631 | + 'description' => __('Type of setting.', 'invoicing'), |
|
| 632 | 632 | 'type' => 'string', |
| 633 | 633 | 'arg_options' => array( |
| 634 | 634 | 'sanitize_callback' => 'sanitize_text_field', |
| 635 | 635 | ), |
| 636 | - 'context' => array( 'view', 'edit' ), |
|
| 637 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 636 | + 'context' => array('view', 'edit'), |
|
| 637 | + 'enum' => array('text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html'), |
|
| 638 | 638 | 'readonly' => true, |
| 639 | 639 | ), |
| 640 | 640 | 'options' => array( |
| 641 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 641 | + 'description' => __('Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing'), |
|
| 642 | 642 | 'type' => 'object', |
| 643 | - 'context' => array( 'view', 'edit' ), |
|
| 643 | + 'context' => array('view', 'edit'), |
|
| 644 | 644 | 'readonly' => true, |
| 645 | 645 | ), |
| 646 | 646 | 'readonly' => array( |
| 647 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 647 | + 'description' => __('Whether or not this setting is readonly', 'invoicing'), |
|
| 648 | 648 | 'type' => 'string', |
| 649 | - 'context' => array( 'view' ), |
|
| 649 | + 'context' => array('view'), |
|
| 650 | 650 | 'readonly' => true, |
| 651 | 651 | ), |
| 652 | 652 | 'faux' => array( |
| 653 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 653 | + 'description' => __('Whether or not this setting is readonly/faux', 'invoicing'), |
|
| 654 | 654 | 'type' => 'string', |
| 655 | - 'context' => array( 'view' ), |
|
| 655 | + 'context' => array('view'), |
|
| 656 | 656 | 'readonly' => true, |
| 657 | 657 | ), |
| 658 | 658 | ), |
| 659 | 659 | ); |
| 660 | 660 | |
| 661 | 661 | // Filters the settings schema for the REST API. |
| 662 | - $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
|
| 662 | + $schema = apply_filters('getpaid_rest_settings_schema', $schema); |
|
| 663 | 663 | |
| 664 | 664 | // Cache the settings schema. |
| 665 | 665 | $this->schema = $schema; |
| 666 | 666 | |
| 667 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 667 | + return $this->add_additional_fields_schema($this->schema); |
|
| 668 | 668 | |
| 669 | 669 | } |
| 670 | 670 | |
@@ -676,9 +676,9 @@ discard block |
||
| 676 | 676 | * @param array $setting Setting. |
| 677 | 677 | * @return string |
| 678 | 678 | */ |
| 679 | - public function validate_setting_text_field( $value ) { |
|
| 680 | - $value = is_null( $value ) ? '' : $value; |
|
| 681 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 679 | + public function validate_setting_text_field($value) { |
|
| 680 | + $value = is_null($value) ? '' : $value; |
|
| 681 | + return wp_kses_post(trim(stripslashes($value))); |
|
| 682 | 682 | } |
| 683 | 683 | |
| 684 | 684 | /** |
@@ -689,11 +689,11 @@ discard block |
||
| 689 | 689 | * @param array $setting Setting. |
| 690 | 690 | * @return string|WP_Error |
| 691 | 691 | */ |
| 692 | - public function validate_setting_select_field( $value, $setting ) { |
|
| 693 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 692 | + public function validate_setting_select_field($value, $setting) { |
|
| 693 | + if (array_key_exists($value, $setting['options'])) { |
|
| 694 | 694 | return $value; |
| 695 | 695 | } else { |
| 696 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 696 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
| 697 | 697 | } |
| 698 | 698 | } |
| 699 | 699 | |
@@ -705,18 +705,18 @@ discard block |
||
| 705 | 705 | * @param array $setting Setting. |
| 706 | 706 | * @return array|WP_Error |
| 707 | 707 | */ |
| 708 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 709 | - if ( empty( $values ) ) { |
|
| 708 | + public function validate_setting_multiselect_field($values, $setting) { |
|
| 709 | + if (empty($values)) { |
|
| 710 | 710 | return array(); |
| 711 | 711 | } |
| 712 | 712 | |
| 713 | - if ( ! is_array( $values ) ) { |
|
| 714 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 713 | + if (!is_array($values)) { |
|
| 714 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
| 715 | 715 | } |
| 716 | 716 | |
| 717 | 717 | $final_values = array(); |
| 718 | - foreach ( $values as $value ) { |
|
| 719 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 718 | + foreach ($values as $value) { |
|
| 719 | + if (array_key_exists($value, $setting['options'])) { |
|
| 720 | 720 | $final_values[] = $value; |
| 721 | 721 | } |
| 722 | 722 | } |
@@ -732,8 +732,8 @@ discard block |
||
| 732 | 732 | * @param array $setting Setting. |
| 733 | 733 | * @return string|WP_Error |
| 734 | 734 | */ |
| 735 | - public function validate_setting_radio_field( $value, $setting ) { |
|
| 736 | - return $this->validate_setting_select_field( $value, $setting ); |
|
| 735 | + public function validate_setting_radio_field($value, $setting) { |
|
| 736 | + return $this->validate_setting_select_field($value, $setting); |
|
| 737 | 737 | } |
| 738 | 738 | |
| 739 | 739 | /** |
@@ -743,8 +743,8 @@ discard block |
||
| 743 | 743 | * @param string $value Value. |
| 744 | 744 | * @return int |
| 745 | 745 | */ |
| 746 | - public function validate_setting_checkbox_field( $value ) { |
|
| 747 | - return (int) ! empty( $value ); |
|
| 746 | + public function validate_setting_checkbox_field($value) { |
|
| 747 | + return (int) !empty($value); |
|
| 748 | 748 | } |
| 749 | 749 | |
| 750 | 750 | /** |
@@ -754,10 +754,10 @@ discard block |
||
| 754 | 754 | * @param string $value Value. |
| 755 | 755 | * @return string |
| 756 | 756 | */ |
| 757 | - public function validate_setting_textarea_field( $value ) { |
|
| 758 | - $value = is_null( $value ) ? '' : $value; |
|
| 757 | + public function validate_setting_textarea_field($value) { |
|
| 758 | + $value = is_null($value) ? '' : $value; |
|
| 759 | 759 | return wp_kses( |
| 760 | - trim( stripslashes( $value ) ), |
|
| 760 | + trim(stripslashes($value)), |
|
| 761 | 761 | array_merge( |
| 762 | 762 | array( |
| 763 | 763 | 'iframe' => array( |
@@ -767,7 +767,7 @@ discard block |
||
| 767 | 767 | 'class' => true, |
| 768 | 768 | ), |
| 769 | 769 | ), |
| 770 | - wp_kses_allowed_html( 'post' ) |
|
| 770 | + wp_kses_allowed_html('post') |
|
| 771 | 771 | ) |
| 772 | 772 | ); |
| 773 | 773 | } |
@@ -18,50 +18,50 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/top_earners'; |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/top_earners'; |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Get all data needed for this report and store in the class. |
|
| 30 | - */ |
|
| 31 | - protected function query_report_data() { |
|
| 28 | + /** |
|
| 29 | + * Get all data needed for this report and store in the class. |
|
| 30 | + */ |
|
| 31 | + protected function query_report_data() { |
|
| 32 | 32 | |
| 33 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 34 | - array( |
|
| 35 | - 'data' => array( |
|
| 36 | - 'quantity' => array( |
|
| 37 | - 'type' => 'invoice_item', |
|
| 38 | - 'function' => 'SUM', |
|
| 39 | - 'name' => 'invoice_item_qty', |
|
| 40 | - ), |
|
| 41 | - 'item_id' => array( |
|
| 42 | - 'type' => 'invoice_item', |
|
| 43 | - 'function' => '', |
|
| 44 | - 'name' => 'invoice_item_id', |
|
| 45 | - ), |
|
| 46 | - 'item_name' => array( |
|
| 47 | - 'type' => 'invoice_item', |
|
| 48 | - 'function' => '', |
|
| 49 | - 'name' => 'invoice_item_name', |
|
| 50 | - ), |
|
| 51 | - 'price' => array( |
|
| 52 | - 'type' => 'invoice_item', |
|
| 53 | - 'function' => 'SUM', |
|
| 54 | - 'name' => 'invoice_item_price', |
|
| 55 | - ), |
|
| 56 | - ), |
|
| 57 | - 'group_by' => 'invoice_item_id', |
|
| 58 | - 'order_by' => 'invoice_item_price DESC', |
|
| 59 | - 'query_type' => 'get_results', |
|
| 60 | - 'limit' => 10, |
|
| 61 | - 'filter_range' => $this->report_range, |
|
| 62 | - ) |
|
| 63 | - ); |
|
| 33 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 34 | + array( |
|
| 35 | + 'data' => array( |
|
| 36 | + 'quantity' => array( |
|
| 37 | + 'type' => 'invoice_item', |
|
| 38 | + 'function' => 'SUM', |
|
| 39 | + 'name' => 'invoice_item_qty', |
|
| 40 | + ), |
|
| 41 | + 'item_id' => array( |
|
| 42 | + 'type' => 'invoice_item', |
|
| 43 | + 'function' => '', |
|
| 44 | + 'name' => 'invoice_item_id', |
|
| 45 | + ), |
|
| 46 | + 'item_name' => array( |
|
| 47 | + 'type' => 'invoice_item', |
|
| 48 | + 'function' => '', |
|
| 49 | + 'name' => 'invoice_item_name', |
|
| 50 | + ), |
|
| 51 | + 'price' => array( |
|
| 52 | + 'type' => 'invoice_item', |
|
| 53 | + 'function' => 'SUM', |
|
| 54 | + 'name' => 'invoice_item_price', |
|
| 55 | + ), |
|
| 56 | + ), |
|
| 57 | + 'group_by' => 'invoice_item_id', |
|
| 58 | + 'order_by' => 'invoice_item_price DESC', |
|
| 59 | + 'query_type' => 'get_results', |
|
| 60 | + 'limit' => 10, |
|
| 61 | + 'filter_range' => $this->report_range, |
|
| 62 | + ) |
|
| 63 | + ); |
|
| 64 | 64 | |
| 65 | - } |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | 67 | } |
@@ -9,7 +9,7 @@ |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST top earners controller class. |
@@ -6,7 +6,7 @@ discard block |
||
| 6 | 6 | * @since 1.0.19 |
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | -defined( 'ABSPATH' ) || exit; |
|
| 9 | +defined('ABSPATH') || exit; |
|
| 10 | 10 | |
| 11 | 11 | /** |
| 12 | 12 | * The main API class |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | $this->invoice_counts = new GetPaid_REST_Report_Invoice_Counts_Controller(); |
| 97 | 97 | |
| 98 | 98 | // Fires after loading the rest api. |
| 99 | - do_action( 'getpaid_rest_api_loaded', $this ); |
|
| 99 | + do_action('getpaid_rest_api_loaded', $this); |
|
| 100 | 100 | } |
| 101 | 101 | |
| 102 | 102 | } |
@@ -18,102 +18,102 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Invoice_Counts_Controller extends GetPaid_REST_Reports_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/invoices/counts'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Prepare a report object for serialization. |
|
| 30 | - * |
|
| 31 | - * @param stdClass $report Report data. |
|
| 32 | - * @param WP_REST_Request $request Request object. |
|
| 33 | - * @return WP_REST_Response $response Response data. |
|
| 34 | - */ |
|
| 35 | - public function prepare_item_for_response( $report, $request ) { |
|
| 36 | - |
|
| 37 | - $data = (array) $report; |
|
| 38 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 39 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 40 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 41 | - |
|
| 42 | - // Wrap the data in a response object. |
|
| 43 | - $response = rest_ensure_response( $data ); |
|
| 44 | - |
|
| 45 | - $response->add_links( |
|
| 46 | - array( |
|
| 47 | - 'about' => array( |
|
| 48 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 49 | - ), |
|
| 50 | - ) |
|
| 51 | - ); |
|
| 52 | - |
|
| 53 | - return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request ); |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Get reports list. |
|
| 58 | - * |
|
| 59 | - * @since 2.0.0 |
|
| 60 | - * @return array |
|
| 61 | - */ |
|
| 62 | - protected function get_reports() { |
|
| 63 | - |
|
| 64 | - $counts = wp_count_posts( 'wpi_invoice' ); |
|
| 65 | - $data = array(); |
|
| 66 | - |
|
| 67 | - foreach ( wpinv_get_invoice_statuses() as $slug => $name ) { |
|
| 68 | - |
|
| 69 | - if ( ! isset( $counts->$slug ) ) { |
|
| 70 | - continue; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - $data[] = array( |
|
| 74 | - 'slug' => $slug, |
|
| 75 | - 'name' => $name, |
|
| 76 | - 'count' => (int) $counts->$slug, |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return $data; |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 87 | - * |
|
| 88 | - * @return array |
|
| 89 | - */ |
|
| 90 | - public function get_item_schema() { |
|
| 91 | - $schema = array( |
|
| 92 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 93 | - 'title' => 'report_invoice_counts', |
|
| 94 | - 'type' => 'object', |
|
| 95 | - 'properties' => array( |
|
| 96 | - 'slug' => array( |
|
| 97 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 98 | - 'type' => 'string', |
|
| 99 | - 'context' => array( 'view' ), |
|
| 100 | - 'readonly' => true, |
|
| 101 | - ), |
|
| 102 | - 'name' => array( |
|
| 103 | - 'description' => __( 'Invoice status name.', 'invoicing' ), |
|
| 104 | - 'type' => 'string', |
|
| 105 | - 'context' => array( 'view' ), |
|
| 106 | - 'readonly' => true, |
|
| 107 | - ), |
|
| 108 | - 'count' => array( |
|
| 109 | - 'description' => __( 'Number of invoices.', 'invoicing' ), |
|
| 110 | - 'type' => 'string', |
|
| 111 | - 'context' => array( 'view' ), |
|
| 112 | - 'readonly' => true, |
|
| 113 | - ), |
|
| 114 | - ), |
|
| 115 | - ); |
|
| 116 | - |
|
| 117 | - return $this->add_additional_fields_schema( $schema ); |
|
| 118 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/invoices/counts'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Prepare a report object for serialization. |
|
| 30 | + * |
|
| 31 | + * @param stdClass $report Report data. |
|
| 32 | + * @param WP_REST_Request $request Request object. |
|
| 33 | + * @return WP_REST_Response $response Response data. |
|
| 34 | + */ |
|
| 35 | + public function prepare_item_for_response( $report, $request ) { |
|
| 36 | + |
|
| 37 | + $data = (array) $report; |
|
| 38 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 39 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 40 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 41 | + |
|
| 42 | + // Wrap the data in a response object. |
|
| 43 | + $response = rest_ensure_response( $data ); |
|
| 44 | + |
|
| 45 | + $response->add_links( |
|
| 46 | + array( |
|
| 47 | + 'about' => array( |
|
| 48 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 49 | + ), |
|
| 50 | + ) |
|
| 51 | + ); |
|
| 52 | + |
|
| 53 | + return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request ); |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Get reports list. |
|
| 58 | + * |
|
| 59 | + * @since 2.0.0 |
|
| 60 | + * @return array |
|
| 61 | + */ |
|
| 62 | + protected function get_reports() { |
|
| 63 | + |
|
| 64 | + $counts = wp_count_posts( 'wpi_invoice' ); |
|
| 65 | + $data = array(); |
|
| 66 | + |
|
| 67 | + foreach ( wpinv_get_invoice_statuses() as $slug => $name ) { |
|
| 68 | + |
|
| 69 | + if ( ! isset( $counts->$slug ) ) { |
|
| 70 | + continue; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + $data[] = array( |
|
| 74 | + 'slug' => $slug, |
|
| 75 | + 'name' => $name, |
|
| 76 | + 'count' => (int) $counts->$slug, |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return $data; |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 87 | + * |
|
| 88 | + * @return array |
|
| 89 | + */ |
|
| 90 | + public function get_item_schema() { |
|
| 91 | + $schema = array( |
|
| 92 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 93 | + 'title' => 'report_invoice_counts', |
|
| 94 | + 'type' => 'object', |
|
| 95 | + 'properties' => array( |
|
| 96 | + 'slug' => array( |
|
| 97 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 98 | + 'type' => 'string', |
|
| 99 | + 'context' => array( 'view' ), |
|
| 100 | + 'readonly' => true, |
|
| 101 | + ), |
|
| 102 | + 'name' => array( |
|
| 103 | + 'description' => __( 'Invoice status name.', 'invoicing' ), |
|
| 104 | + 'type' => 'string', |
|
| 105 | + 'context' => array( 'view' ), |
|
| 106 | + 'readonly' => true, |
|
| 107 | + ), |
|
| 108 | + 'count' => array( |
|
| 109 | + 'description' => __( 'Number of invoices.', 'invoicing' ), |
|
| 110 | + 'type' => 'string', |
|
| 111 | + 'context' => array( 'view' ), |
|
| 112 | + 'readonly' => true, |
|
| 113 | + ), |
|
| 114 | + ), |
|
| 115 | + ); |
|
| 116 | + |
|
| 117 | + return $this->add_additional_fields_schema( $schema ); |
|
| 118 | + } |
|
| 119 | 119 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST invoice counts controller class. |
@@ -32,25 +32,25 @@ discard block |
||
| 32 | 32 | * @param WP_REST_Request $request Request object. |
| 33 | 33 | * @return WP_REST_Response $response Response data. |
| 34 | 34 | */ |
| 35 | - public function prepare_item_for_response( $report, $request ) { |
|
| 35 | + public function prepare_item_for_response($report, $request) { |
|
| 36 | 36 | |
| 37 | 37 | $data = (array) $report; |
| 38 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 39 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 40 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 38 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 39 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 40 | + $data = $this->filter_response_by_context($data, $context); |
|
| 41 | 41 | |
| 42 | 42 | // Wrap the data in a response object. |
| 43 | - $response = rest_ensure_response( $data ); |
|
| 43 | + $response = rest_ensure_response($data); |
|
| 44 | 44 | |
| 45 | 45 | $response->add_links( |
| 46 | 46 | array( |
| 47 | 47 | 'about' => array( |
| 48 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 48 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
| 49 | 49 | ), |
| 50 | 50 | ) |
| 51 | 51 | ); |
| 52 | 52 | |
| 53 | - return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request ); |
|
| 53 | + return apply_filters('getpaid_rest_prepare_report_invoices_count', $response, $report, $request); |
|
| 54 | 54 | } |
| 55 | 55 | |
| 56 | 56 | /** |
@@ -61,12 +61,12 @@ discard block |
||
| 61 | 61 | */ |
| 62 | 62 | protected function get_reports() { |
| 63 | 63 | |
| 64 | - $counts = wp_count_posts( 'wpi_invoice' ); |
|
| 64 | + $counts = wp_count_posts('wpi_invoice'); |
|
| 65 | 65 | $data = array(); |
| 66 | 66 | |
| 67 | - foreach ( wpinv_get_invoice_statuses() as $slug => $name ) { |
|
| 67 | + foreach (wpinv_get_invoice_statuses() as $slug => $name) { |
|
| 68 | 68 | |
| 69 | - if ( ! isset( $counts->$slug ) ) { |
|
| 69 | + if (!isset($counts->$slug)) { |
|
| 70 | 70 | continue; |
| 71 | 71 | } |
| 72 | 72 | |
@@ -94,26 +94,26 @@ discard block |
||
| 94 | 94 | 'type' => 'object', |
| 95 | 95 | 'properties' => array( |
| 96 | 96 | 'slug' => array( |
| 97 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 97 | + 'description' => __('An alphanumeric identifier for the resource.', 'invoicing'), |
|
| 98 | 98 | 'type' => 'string', |
| 99 | - 'context' => array( 'view' ), |
|
| 99 | + 'context' => array('view'), |
|
| 100 | 100 | 'readonly' => true, |
| 101 | 101 | ), |
| 102 | 102 | 'name' => array( |
| 103 | - 'description' => __( 'Invoice status name.', 'invoicing' ), |
|
| 103 | + 'description' => __('Invoice status name.', 'invoicing'), |
|
| 104 | 104 | 'type' => 'string', |
| 105 | - 'context' => array( 'view' ), |
|
| 105 | + 'context' => array('view'), |
|
| 106 | 106 | 'readonly' => true, |
| 107 | 107 | ), |
| 108 | 108 | 'count' => array( |
| 109 | - 'description' => __( 'Number of invoices.', 'invoicing' ), |
|
| 109 | + 'description' => __('Number of invoices.', 'invoicing'), |
|
| 110 | 110 | 'type' => 'string', |
| 111 | - 'context' => array( 'view' ), |
|
| 111 | + 'context' => array('view'), |
|
| 112 | 112 | 'readonly' => true, |
| 113 | 113 | ), |
| 114 | 114 | ), |
| 115 | 115 | ); |
| 116 | 116 | |
| 117 | - return $this->add_additional_fields_schema( $schema ); |
|
| 117 | + return $this->add_additional_fields_schema($schema); |
|
| 118 | 118 | } |
| 119 | 119 | } |
@@ -18,176 +18,176 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the routes for the objects of the controller. |
|
| 30 | - * |
|
| 31 | - * @since 2.0.0 |
|
| 32 | - * |
|
| 33 | - * @see register_rest_route() |
|
| 34 | - */ |
|
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 36 | - |
|
| 37 | - // List all available reports. |
|
| 38 | - register_rest_route( |
|
| 39 | - $namespace, |
|
| 40 | - $this->rest_base, |
|
| 41 | - array( |
|
| 42 | - array( |
|
| 43 | - 'methods' => WP_REST_Server::READABLE, |
|
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | - 'args' => $this->get_collection_params(), |
|
| 47 | - ), |
|
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | - ) |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Makes sure the current user has access to READ the report APIs. |
|
| 56 | - * |
|
| 57 | - * @since 2.0.0 |
|
| 58 | - * @param WP_REST_Request $request Full data about the request. |
|
| 59 | - * @return WP_Error|boolean |
|
| 60 | - */ |
|
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 62 | - |
|
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - return true; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Get reports list. |
|
| 72 | - * |
|
| 73 | - * @since 2.0.0 |
|
| 74 | - * @return array |
|
| 75 | - */ |
|
| 76 | - protected function get_reports() { |
|
| 77 | - |
|
| 78 | - $reports = array( |
|
| 79 | - array( |
|
| 80 | - 'slug' => 'sales', |
|
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'slug' => 'top_sellers', |
|
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | - ), |
|
| 87 | - array( |
|
| 88 | - 'slug' => 'top_earners', |
|
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | - ), |
|
| 91 | - array( |
|
| 92 | - 'slug' => 'invoices/counts', |
|
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | - ), |
|
| 95 | - ); |
|
| 96 | - |
|
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | - |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Get all reports. |
|
| 103 | - * |
|
| 104 | - * @since 2.0.0 |
|
| 105 | - * @param WP_REST_Request $request |
|
| 106 | - * @return array|WP_Error |
|
| 107 | - */ |
|
| 108 | - public function get_items( $request ) { |
|
| 109 | - $data = array(); |
|
| 110 | - $reports = $this->get_reports(); |
|
| 111 | - |
|
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - return rest_ensure_response( $data ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Prepare a report object for serialization. |
|
| 122 | - * |
|
| 123 | - * @since 2.0.0 |
|
| 124 | - * @param stdClass $report Report data. |
|
| 125 | - * @param WP_REST_Request $request Request object. |
|
| 126 | - * @return WP_REST_Response $response Response data. |
|
| 127 | - */ |
|
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 129 | - $data = array( |
|
| 130 | - 'slug' => $report->slug, |
|
| 131 | - 'description' => $report->description, |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | - |
|
| 138 | - // Wrap the data in a response object. |
|
| 139 | - $response = rest_ensure_response( $data ); |
|
| 140 | - $response->add_links( array( |
|
| 141 | - 'self' => array( |
|
| 142 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | - ), |
|
| 144 | - 'collection' => array( |
|
| 145 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | - ), |
|
| 147 | - ) ); |
|
| 148 | - |
|
| 149 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | - * |
|
| 155 | - * @since 2.0.0 |
|
| 156 | - * @return array |
|
| 157 | - */ |
|
| 158 | - public function get_item_schema() { |
|
| 159 | - $schema = array( |
|
| 160 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | - 'title' => 'report', |
|
| 162 | - 'type' => 'object', |
|
| 163 | - 'properties' => array( |
|
| 164 | - 'slug' => array( |
|
| 165 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | - 'type' => 'string', |
|
| 167 | - 'context' => array( 'view' ), |
|
| 168 | - 'readonly' => true, |
|
| 169 | - ), |
|
| 170 | - 'description' => array( |
|
| 171 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | - 'type' => 'string', |
|
| 173 | - 'context' => array( 'view' ), |
|
| 174 | - 'readonly' => true, |
|
| 175 | - ), |
|
| 176 | - ), |
|
| 177 | - ); |
|
| 178 | - |
|
| 179 | - return $this->add_additional_fields_schema( $schema ); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * Get the query params for collections. |
|
| 184 | - * |
|
| 185 | - * @since 2.0.0 |
|
| 186 | - * @return array |
|
| 187 | - */ |
|
| 188 | - public function get_collection_params() { |
|
| 189 | - return array( |
|
| 190 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | - ); |
|
| 192 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the routes for the objects of the controller. |
|
| 30 | + * |
|
| 31 | + * @since 2.0.0 |
|
| 32 | + * |
|
| 33 | + * @see register_rest_route() |
|
| 34 | + */ |
|
| 35 | + public function register_namespace_routes( $namespace ) { |
|
| 36 | + |
|
| 37 | + // List all available reports. |
|
| 38 | + register_rest_route( |
|
| 39 | + $namespace, |
|
| 40 | + $this->rest_base, |
|
| 41 | + array( |
|
| 42 | + array( |
|
| 43 | + 'methods' => WP_REST_Server::READABLE, |
|
| 44 | + 'callback' => array( $this, 'get_items' ), |
|
| 45 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | + 'args' => $this->get_collection_params(), |
|
| 47 | + ), |
|
| 48 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | + ) |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Makes sure the current user has access to READ the report APIs. |
|
| 56 | + * |
|
| 57 | + * @since 2.0.0 |
|
| 58 | + * @param WP_REST_Request $request Full data about the request. |
|
| 59 | + * @return WP_Error|boolean |
|
| 60 | + */ |
|
| 61 | + public function get_items_permissions_check( $request ) { |
|
| 62 | + |
|
| 63 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + return true; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Get reports list. |
|
| 72 | + * |
|
| 73 | + * @since 2.0.0 |
|
| 74 | + * @return array |
|
| 75 | + */ |
|
| 76 | + protected function get_reports() { |
|
| 77 | + |
|
| 78 | + $reports = array( |
|
| 79 | + array( |
|
| 80 | + 'slug' => 'sales', |
|
| 81 | + 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'slug' => 'top_sellers', |
|
| 85 | + 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | + ), |
|
| 87 | + array( |
|
| 88 | + 'slug' => 'top_earners', |
|
| 89 | + 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | + ), |
|
| 91 | + array( |
|
| 92 | + 'slug' => 'invoices/counts', |
|
| 93 | + 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | + ), |
|
| 95 | + ); |
|
| 96 | + |
|
| 97 | + return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | + |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Get all reports. |
|
| 103 | + * |
|
| 104 | + * @since 2.0.0 |
|
| 105 | + * @param WP_REST_Request $request |
|
| 106 | + * @return array|WP_Error |
|
| 107 | + */ |
|
| 108 | + public function get_items( $request ) { |
|
| 109 | + $data = array(); |
|
| 110 | + $reports = $this->get_reports(); |
|
| 111 | + |
|
| 112 | + foreach ( $reports as $report ) { |
|
| 113 | + $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + return rest_ensure_response( $data ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Prepare a report object for serialization. |
|
| 122 | + * |
|
| 123 | + * @since 2.0.0 |
|
| 124 | + * @param stdClass $report Report data. |
|
| 125 | + * @param WP_REST_Request $request Request object. |
|
| 126 | + * @return WP_REST_Response $response Response data. |
|
| 127 | + */ |
|
| 128 | + public function prepare_item_for_response( $report, $request ) { |
|
| 129 | + $data = array( |
|
| 130 | + 'slug' => $report->slug, |
|
| 131 | + 'description' => $report->description, |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | + |
|
| 138 | + // Wrap the data in a response object. |
|
| 139 | + $response = rest_ensure_response( $data ); |
|
| 140 | + $response->add_links( array( |
|
| 141 | + 'self' => array( |
|
| 142 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | + ), |
|
| 144 | + 'collection' => array( |
|
| 145 | + 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | + ), |
|
| 147 | + ) ); |
|
| 148 | + |
|
| 149 | + return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | + * |
|
| 155 | + * @since 2.0.0 |
|
| 156 | + * @return array |
|
| 157 | + */ |
|
| 158 | + public function get_item_schema() { |
|
| 159 | + $schema = array( |
|
| 160 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | + 'title' => 'report', |
|
| 162 | + 'type' => 'object', |
|
| 163 | + 'properties' => array( |
|
| 164 | + 'slug' => array( |
|
| 165 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | + 'type' => 'string', |
|
| 167 | + 'context' => array( 'view' ), |
|
| 168 | + 'readonly' => true, |
|
| 169 | + ), |
|
| 170 | + 'description' => array( |
|
| 171 | + 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | + 'type' => 'string', |
|
| 173 | + 'context' => array( 'view' ), |
|
| 174 | + 'readonly' => true, |
|
| 175 | + ), |
|
| 176 | + ), |
|
| 177 | + ); |
|
| 178 | + |
|
| 179 | + return $this->add_additional_fields_schema( $schema ); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * Get the query params for collections. |
|
| 184 | + * |
|
| 185 | + * @since 2.0.0 |
|
| 186 | + * @return array |
|
| 187 | + */ |
|
| 188 | + public function get_collection_params() { |
|
| 189 | + return array( |
|
| 190 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | + ); |
|
| 192 | + } |
|
| 193 | 193 | } |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | * @since 2.0.0 |
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | -defined( 'ABSPATH' ) || exit; |
|
| 12 | +defined('ABSPATH') || exit; |
|
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * GetPaid REST reports controller class. |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * |
| 33 | 33 | * @see register_rest_route() |
| 34 | 34 | */ |
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 35 | + public function register_namespace_routes($namespace) { |
|
| 36 | 36 | |
| 37 | 37 | // List all available reports. |
| 38 | 38 | register_rest_route( |
@@ -41,11 +41,11 @@ discard block |
||
| 41 | 41 | array( |
| 42 | 42 | array( |
| 43 | 43 | 'methods' => WP_REST_Server::READABLE, |
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 44 | + 'callback' => array($this, 'get_items'), |
|
| 45 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
| 46 | 46 | 'args' => $this->get_collection_params(), |
| 47 | 47 | ), |
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 48 | + 'schema' => array($this, 'get_public_item_schema'), |
|
| 49 | 49 | ) |
| 50 | 50 | ); |
| 51 | 51 | |
@@ -58,10 +58,10 @@ discard block |
||
| 58 | 58 | * @param WP_REST_Request $request Full data about the request. |
| 59 | 59 | * @return WP_Error|boolean |
| 60 | 60 | */ |
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 61 | + public function get_items_permissions_check($request) { |
|
| 62 | 62 | |
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 63 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
| 64 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | return true; |
@@ -78,23 +78,23 @@ discard block |
||
| 78 | 78 | $reports = array( |
| 79 | 79 | array( |
| 80 | 80 | 'slug' => 'sales', |
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 81 | + 'description' => __('List of sales reports.', 'invoicing'), |
|
| 82 | 82 | ), |
| 83 | 83 | array( |
| 84 | 84 | 'slug' => 'top_sellers', |
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 85 | + 'description' => __('List of top selling items.', 'invoicing'), |
|
| 86 | 86 | ), |
| 87 | 87 | array( |
| 88 | 88 | 'slug' => 'top_earners', |
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 89 | + 'description' => __('List of top earning items.', 'invoicing'), |
|
| 90 | 90 | ), |
| 91 | 91 | array( |
| 92 | 92 | 'slug' => 'invoices/counts', |
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 93 | + 'description' => __('Invoice counts.', 'invoicing'), |
|
| 94 | 94 | ), |
| 95 | 95 | ); |
| 96 | 96 | |
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 97 | + return apply_filters('getpaid_available_api_reports', $reports); |
|
| 98 | 98 | |
| 99 | 99 | } |
| 100 | 100 | |
@@ -105,16 +105,16 @@ discard block |
||
| 105 | 105 | * @param WP_REST_Request $request |
| 106 | 106 | * @return array|WP_Error |
| 107 | 107 | */ |
| 108 | - public function get_items( $request ) { |
|
| 108 | + public function get_items($request) { |
|
| 109 | 109 | $data = array(); |
| 110 | 110 | $reports = $this->get_reports(); |
| 111 | 111 | |
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 112 | + foreach ($reports as $report) { |
|
| 113 | + $item = $this->prepare_item_for_response((object) $report, $request); |
|
| 114 | + $data[] = $this->prepare_response_for_collection($item); |
|
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - return rest_ensure_response( $data ); |
|
| 117 | + return rest_ensure_response($data); |
|
| 118 | 118 | } |
| 119 | 119 | |
| 120 | 120 | /** |
@@ -125,28 +125,28 @@ discard block |
||
| 125 | 125 | * @param WP_REST_Request $request Request object. |
| 126 | 126 | * @return WP_REST_Response $response Response data. |
| 127 | 127 | */ |
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 128 | + public function prepare_item_for_response($report, $request) { |
|
| 129 | 129 | $data = array( |
| 130 | 130 | 'slug' => $report->slug, |
| 131 | 131 | 'description' => $report->description, |
| 132 | 132 | ); |
| 133 | 133 | |
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 134 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
| 136 | + $data = $this->filter_response_by_context($data, $context); |
|
| 137 | 137 | |
| 138 | 138 | // Wrap the data in a response object. |
| 139 | - $response = rest_ensure_response( $data ); |
|
| 140 | - $response->add_links( array( |
|
| 139 | + $response = rest_ensure_response($data); |
|
| 140 | + $response->add_links(array( |
|
| 141 | 141 | 'self' => array( |
| 142 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 142 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug)), |
|
| 143 | 143 | ), |
| 144 | 144 | 'collection' => array( |
| 145 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 145 | + 'href' => rest_url(sprintf('%s/%s', $this->namespace, $this->rest_base)), |
|
| 146 | 146 | ), |
| 147 | - ) ); |
|
| 147 | + )); |
|
| 148 | 148 | |
| 149 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 149 | + return apply_filters('getpaid_rest_prepare_report', $response, $report, $request); |
|
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | /** |
@@ -162,21 +162,21 @@ discard block |
||
| 162 | 162 | 'type' => 'object', |
| 163 | 163 | 'properties' => array( |
| 164 | 164 | 'slug' => array( |
| 165 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 165 | + 'description' => __('An alphanumeric identifier for the resource.', 'invoicing'), |
|
| 166 | 166 | 'type' => 'string', |
| 167 | - 'context' => array( 'view' ), |
|
| 167 | + 'context' => array('view'), |
|
| 168 | 168 | 'readonly' => true, |
| 169 | 169 | ), |
| 170 | 170 | 'description' => array( |
| 171 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 171 | + 'description' => __('A human-readable description of the resource.', 'invoicing'), |
|
| 172 | 172 | 'type' => 'string', |
| 173 | - 'context' => array( 'view' ), |
|
| 173 | + 'context' => array('view'), |
|
| 174 | 174 | 'readonly' => true, |
| 175 | 175 | ), |
| 176 | 176 | ), |
| 177 | 177 | ); |
| 178 | 178 | |
| 179 | - return $this->add_additional_fields_schema( $schema ); |
|
| 179 | + return $this->add_additional_fields_schema($schema); |
|
| 180 | 180 | } |
| 181 | 181 | |
| 182 | 182 | /** |
@@ -187,7 +187,7 @@ discard block |
||
| 187 | 187 | */ |
| 188 | 188 | public function get_collection_params() { |
| 189 | 189 | return array( |
| 190 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 190 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
| 191 | 191 | ); |
| 192 | 192 | } |
| 193 | 193 | } |