@@ -6,7 +6,7 @@ discard block |
||
6 | 6 | * |
7 | 7 | */ |
8 | 8 | if ( ! defined( 'ABSPATH' ) ) { |
9 | - exit; |
|
9 | + exit; |
|
10 | 10 | } |
11 | 11 | |
12 | 12 | /** |
@@ -15,92 +15,92 @@ discard block |
||
15 | 15 | class WPInv_Admin_Addons extends Ayecode_Addons { |
16 | 16 | |
17 | 17 | |
18 | - /** |
|
19 | - * Get the extensions page tabs. |
|
20 | - * |
|
21 | - * @return array of tabs. |
|
22 | - */ |
|
23 | - public function get_tabs() { |
|
24 | - $tabs = array( |
|
25 | - 'addons' => __( 'Addons', 'invoicing' ), |
|
18 | + /** |
|
19 | + * Get the extensions page tabs. |
|
20 | + * |
|
21 | + * @return array of tabs. |
|
22 | + */ |
|
23 | + public function get_tabs() { |
|
24 | + $tabs = array( |
|
25 | + 'addons' => __( 'Addons', 'invoicing' ), |
|
26 | 26 | 'gateways' => __( 'Payment Gateways', 'invoicing' ), |
27 | 27 | 'recommended_plugins' => __( 'Recommended plugins', 'invoicing' ), |
28 | 28 | 'membership' => __( 'Membership', 'invoicing' ), |
29 | - ); |
|
30 | - |
|
31 | - return $tabs; |
|
32 | - } |
|
33 | - |
|
34 | - /** |
|
35 | - * Get section content for the addons screen. |
|
36 | - * |
|
37 | - * @param string $section_id |
|
38 | - * |
|
39 | - * @return array |
|
40 | - */ |
|
41 | - public function get_section_data( $section_id ) { |
|
42 | - $section = self::get_tab( $section_id ); |
|
43 | - $api_url = 'https://wpinvoicing.com/edd-api/v2/products/'; |
|
44 | - $section_data = new stdClass(); |
|
45 | - |
|
46 | - if ( $section_id == 'recommended_plugins' ) { |
|
47 | - $section_data->products = self::get_recommend_wp_plugins_edd_formatted(); |
|
48 | - } elseif ( ! empty( $section ) ) { |
|
49 | - if ( false === ( $section_data = get_transient( 'wpi_addons_section_' . $section_id ) ) ) { //@todo restore after testing |
|
50 | - //if ( 1==1) { |
|
51 | - |
|
52 | - $query_args = array( |
|
53 | - 'category' => $section_id, |
|
54 | - 'number' => 100, |
|
55 | - ); |
|
56 | - $query_args = apply_filters( 'wpeu_edd_api_query_args', $query_args, $api_url, $section_id ); |
|
57 | - |
|
58 | - $raw_section = wp_safe_remote_get( |
|
29 | + ); |
|
30 | + |
|
31 | + return $tabs; |
|
32 | + } |
|
33 | + |
|
34 | + /** |
|
35 | + * Get section content for the addons screen. |
|
36 | + * |
|
37 | + * @param string $section_id |
|
38 | + * |
|
39 | + * @return array |
|
40 | + */ |
|
41 | + public function get_section_data( $section_id ) { |
|
42 | + $section = self::get_tab( $section_id ); |
|
43 | + $api_url = 'https://wpinvoicing.com/edd-api/v2/products/'; |
|
44 | + $section_data = new stdClass(); |
|
45 | + |
|
46 | + if ( $section_id == 'recommended_plugins' ) { |
|
47 | + $section_data->products = self::get_recommend_wp_plugins_edd_formatted(); |
|
48 | + } elseif ( ! empty( $section ) ) { |
|
49 | + if ( false === ( $section_data = get_transient( 'wpi_addons_section_' . $section_id ) ) ) { //@todo restore after testing |
|
50 | + //if ( 1==1) { |
|
51 | + |
|
52 | + $query_args = array( |
|
53 | + 'category' => $section_id, |
|
54 | + 'number' => 100, |
|
55 | + ); |
|
56 | + $query_args = apply_filters( 'wpeu_edd_api_query_args', $query_args, $api_url, $section_id ); |
|
57 | + |
|
58 | + $raw_section = wp_safe_remote_get( |
|
59 | 59 | esc_url_raw( add_query_arg( $query_args, $api_url ) ), |
60 | 60 | array( |
61 | - 'user-agent' => 'Invoicing Addons Page', |
|
62 | - 'timeout' => 15, |
|
61 | + 'user-agent' => 'Invoicing Addons Page', |
|
62 | + 'timeout' => 15, |
|
63 | 63 | ) |
64 | 64 | ); |
65 | 65 | |
66 | - if ( ! is_wp_error( $raw_section ) ) { |
|
67 | - $section_data = json_decode( wp_remote_retrieve_body( $raw_section ) ); |
|
66 | + if ( ! is_wp_error( $raw_section ) ) { |
|
67 | + $section_data = json_decode( wp_remote_retrieve_body( $raw_section ) ); |
|
68 | 68 | |
69 | - if ( ! empty( $section_data->products ) ) { |
|
70 | - set_transient( 'wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS ); |
|
71 | - } |
|
72 | - } |
|
73 | - } |
|
69 | + if ( ! empty( $section_data->products ) ) { |
|
70 | + set_transient( 'wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS ); |
|
71 | + } |
|
72 | + } |
|
73 | + } |
|
74 | 74 | } |
75 | 75 | |
76 | - $products = isset( $section_data->products ) ? $section_data->products : array(); |
|
77 | - if ( 'addons' == $section_id ) { |
|
78 | - |
|
79 | - $quotes = new stdClass(); |
|
80 | - $quotes->info = new stdClass(); |
|
81 | - $quotes->info->id = ''; |
|
82 | - $quotes->info->slug = 'invoicing-quotes'; |
|
83 | - $quotes->info->title = __( 'Quotes', 'invoicing' ); |
|
84 | - $quotes->info->excerpt = __( 'Create quotes and estimates', 'invoicing' ); |
|
85 | - $quotes->info->link = 'https://wordpress.org/plugins/invoicing-quotes/'; |
|
86 | - $quotes->info->thumbnail = WPINV_PLUGIN_URL . 'assets/images/Quotes-1-768x384.png'; |
|
87 | - |
|
88 | - $products[] = $quotes; |
|
89 | - } |
|
90 | - |
|
91 | - return apply_filters( 'wpi_addons_section_data', $products, $section_id ); |
|
92 | - } |
|
93 | - |
|
94 | - /** |
|
95 | - * Outputs a button. |
|
96 | - *ccc |
|
97 | - * @param string $url |
|
98 | - * @param string $text |
|
99 | - * @param string $theme |
|
100 | - * @param string $plugin |
|
101 | - */ |
|
102 | - public function output_button( $addon ) { |
|
103 | - $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
76 | + $products = isset( $section_data->products ) ? $section_data->products : array(); |
|
77 | + if ( 'addons' == $section_id ) { |
|
78 | + |
|
79 | + $quotes = new stdClass(); |
|
80 | + $quotes->info = new stdClass(); |
|
81 | + $quotes->info->id = ''; |
|
82 | + $quotes->info->slug = 'invoicing-quotes'; |
|
83 | + $quotes->info->title = __( 'Quotes', 'invoicing' ); |
|
84 | + $quotes->info->excerpt = __( 'Create quotes and estimates', 'invoicing' ); |
|
85 | + $quotes->info->link = 'https://wordpress.org/plugins/invoicing-quotes/'; |
|
86 | + $quotes->info->thumbnail = WPINV_PLUGIN_URL . 'assets/images/Quotes-1-768x384.png'; |
|
87 | + |
|
88 | + $products[] = $quotes; |
|
89 | + } |
|
90 | + |
|
91 | + return apply_filters( 'wpi_addons_section_data', $products, $section_id ); |
|
92 | + } |
|
93 | + |
|
94 | + /** |
|
95 | + * Outputs a button. |
|
96 | + *ccc |
|
97 | + * @param string $url |
|
98 | + * @param string $text |
|
99 | + * @param string $theme |
|
100 | + * @param string $plugin |
|
101 | + */ |
|
102 | + public function output_button( $addon ) { |
|
103 | + $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
104 | 104 | // $button_text = __('Free','invoicing'); |
105 | 105 | // $licensing = false; |
106 | 106 | // $installed = false; |
@@ -112,128 +112,128 @@ discard block |
||
112 | 112 | // $install_status = 'get'; |
113 | 113 | // $onclick = ''; |
114 | 114 | |
115 | - $wp_org_themes = array( 'supreme-directory', 'directory-starter' ); |
|
116 | - |
|
117 | - $button_args = array( |
|
118 | - 'type' => ($current_tab == 'addons' || $current_tab == 'gateways') ? 'addons' : $current_tab, |
|
119 | - 'id' => isset( $addon->info->id ) ? absint( $addon->info->id ) : '', |
|
120 | - 'title' => isset( $addon->info->title ) ? $addon->info->title : '', |
|
121 | - 'button_text' => __( 'Free', 'invoicing' ), |
|
122 | - 'price_text' => __( 'Free', 'invoicing' ), |
|
123 | - 'link' => isset( $addon->info->link ) ? $addon->info->link : '', // link to product |
|
124 | - 'url' => isset( $addon->info->link ) ? $addon->info->link : '', // button url |
|
125 | - 'class' => 'button-primary', |
|
126 | - 'install_status' => 'get', |
|
127 | - 'installed' => false, |
|
128 | - 'price' => '', |
|
129 | - 'licensing' => isset( $addon->licensing->enabled ) && $addon->licensing->enabled ? true : false, |
|
130 | - 'license' => isset( $addon->licensing->license ) && $addon->licensing->license ? $addon->licensing->license : '', |
|
131 | - 'onclick' => '', |
|
132 | - 'slug' => isset( $addon->info->slug ) ? $addon->info->slug : '', |
|
133 | - 'active' => false, |
|
134 | - 'file' => '', |
|
135 | - 'update_url' => '', |
|
136 | - ); |
|
137 | - |
|
138 | - if ( 'invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ( $current_tab == 'recommended_plugins' && isset( $addon->info->slug ) && $addon->info->slug ) ) { |
|
139 | - include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
|
140 | - $status = install_plugin_install_status( |
|
115 | + $wp_org_themes = array( 'supreme-directory', 'directory-starter' ); |
|
116 | + |
|
117 | + $button_args = array( |
|
118 | + 'type' => ($current_tab == 'addons' || $current_tab == 'gateways') ? 'addons' : $current_tab, |
|
119 | + 'id' => isset( $addon->info->id ) ? absint( $addon->info->id ) : '', |
|
120 | + 'title' => isset( $addon->info->title ) ? $addon->info->title : '', |
|
121 | + 'button_text' => __( 'Free', 'invoicing' ), |
|
122 | + 'price_text' => __( 'Free', 'invoicing' ), |
|
123 | + 'link' => isset( $addon->info->link ) ? $addon->info->link : '', // link to product |
|
124 | + 'url' => isset( $addon->info->link ) ? $addon->info->link : '', // button url |
|
125 | + 'class' => 'button-primary', |
|
126 | + 'install_status' => 'get', |
|
127 | + 'installed' => false, |
|
128 | + 'price' => '', |
|
129 | + 'licensing' => isset( $addon->licensing->enabled ) && $addon->licensing->enabled ? true : false, |
|
130 | + 'license' => isset( $addon->licensing->license ) && $addon->licensing->license ? $addon->licensing->license : '', |
|
131 | + 'onclick' => '', |
|
132 | + 'slug' => isset( $addon->info->slug ) ? $addon->info->slug : '', |
|
133 | + 'active' => false, |
|
134 | + 'file' => '', |
|
135 | + 'update_url' => '', |
|
136 | + ); |
|
137 | + |
|
138 | + if ( 'invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ( $current_tab == 'recommended_plugins' && isset( $addon->info->slug ) && $addon->info->slug ) ) { |
|
139 | + include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
|
140 | + $status = install_plugin_install_status( |
|
141 | 141 | array( |
142 | - 'slug' => $button_args['slug'], |
|
143 | - 'version' => '', |
|
142 | + 'slug' => $button_args['slug'], |
|
143 | + 'version' => '', |
|
144 | 144 | ) |
145 | 145 | ); |
146 | - $button_args['install_status'] = isset( $status['status'] ) ? $status['status'] : 'install'; |
|
147 | - $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
148 | - } elseif ( ($current_tab == 'addons' || $current_tab == 'gateways') && isset( $addon->info->id ) && $addon->info->id ) { |
|
149 | - include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
|
150 | - if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
146 | + $button_args['install_status'] = isset( $status['status'] ) ? $status['status'] : 'install'; |
|
147 | + $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
148 | + } elseif ( ($current_tab == 'addons' || $current_tab == 'gateways') && isset( $addon->info->id ) && $addon->info->id ) { |
|
149 | + include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
|
150 | + if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
151 | 151 | $button_args['slug'] = $addon->licensing->edd_slug;} |
152 | - $status = self::install_plugin_install_status( $addon ); |
|
153 | - $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
154 | - if ( isset( $status['status'] ) ) { |
|
152 | + $status = self::install_plugin_install_status( $addon ); |
|
153 | + $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
154 | + if ( isset( $status['status'] ) ) { |
|
155 | 155 | $button_args['install_status'] = $status['status'];} |
156 | - $button_args['update_url'] = 'https://wpinvoicing.com'; |
|
157 | - } elseif ( $current_tab == 'themes' && isset( $addon->info->id ) && $addon->info->id ) { |
|
158 | - if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
156 | + $button_args['update_url'] = 'https://wpinvoicing.com'; |
|
157 | + } elseif ( $current_tab == 'themes' && isset( $addon->info->id ) && $addon->info->id ) { |
|
158 | + if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
159 | 159 | $button_args['slug'] = $addon->licensing->edd_slug;} |
160 | - $button_args['installed'] = self::is_theme_installed( $addon ); |
|
161 | - if ( ! in_array( $button_args['slug'], $wp_org_themes ) ) { |
|
162 | - $button_args['update_url'] = 'https://wpinvoicing.com'; |
|
163 | - } |
|
164 | - } |
|
165 | - |
|
166 | - // set price |
|
167 | - if ( isset( $addon->pricing ) && ! empty( $addon->pricing ) ) { |
|
168 | - if ( is_object( $addon->pricing ) ) { |
|
169 | - $prices = (array)$addon->pricing; |
|
170 | - $button_args['price'] = reset( $prices ); |
|
171 | - } elseif ( isset( $addon->pricing ) ) { |
|
172 | - $button_args['price'] = $addon->pricing; |
|
173 | - } |
|
174 | - } |
|
175 | - |
|
176 | - // set price text |
|
177 | - if ( $button_args['price'] && $button_args['price'] != '0.00' ) { |
|
178 | - $button_args['price_text'] = sprintf( __( 'From: $%d', 'invoicing' ), $button_args['price'] ); |
|
179 | - } |
|
180 | - |
|
181 | - // set if installed |
|
182 | - if ( in_array( $button_args['install_status'], array( 'installed', 'latest_installed', 'update_available', 'newer_installed' ) ) ) { |
|
183 | - $button_args['installed'] = true; |
|
184 | - } |
|
160 | + $button_args['installed'] = self::is_theme_installed( $addon ); |
|
161 | + if ( ! in_array( $button_args['slug'], $wp_org_themes ) ) { |
|
162 | + $button_args['update_url'] = 'https://wpinvoicing.com'; |
|
163 | + } |
|
164 | + } |
|
165 | + |
|
166 | + // set price |
|
167 | + if ( isset( $addon->pricing ) && ! empty( $addon->pricing ) ) { |
|
168 | + if ( is_object( $addon->pricing ) ) { |
|
169 | + $prices = (array)$addon->pricing; |
|
170 | + $button_args['price'] = reset( $prices ); |
|
171 | + } elseif ( isset( $addon->pricing ) ) { |
|
172 | + $button_args['price'] = $addon->pricing; |
|
173 | + } |
|
174 | + } |
|
175 | + |
|
176 | + // set price text |
|
177 | + if ( $button_args['price'] && $button_args['price'] != '0.00' ) { |
|
178 | + $button_args['price_text'] = sprintf( __( 'From: $%d', 'invoicing' ), $button_args['price'] ); |
|
179 | + } |
|
180 | + |
|
181 | + // set if installed |
|
182 | + if ( in_array( $button_args['install_status'], array( 'installed', 'latest_installed', 'update_available', 'newer_installed' ) ) ) { |
|
183 | + $button_args['installed'] = true; |
|
184 | + } |
|
185 | 185 | |
186 | 186 | // print_r($button_args); |
187 | - // set if active |
|
188 | - if ( $button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes') ) { |
|
189 | - if ( $button_args['type'] != 'themes' ) { |
|
190 | - $button_args['active'] = is_plugin_active( $button_args['file'] ); |
|
191 | - } else { |
|
192 | - $button_args['active'] = self::is_theme_active( $addon ); |
|
193 | - } |
|
194 | - } |
|
195 | - |
|
196 | - // set button text and class |
|
197 | - if ( $button_args['active'] ) { |
|
198 | - $button_args['button_text'] = __( 'Active', 'invoicing' ); |
|
199 | - $button_args['class'] = ' button-secondary disabled '; |
|
200 | - } elseif ( $button_args['installed'] ) { |
|
201 | - $button_args['button_text'] = __( 'Activate', 'invoicing' ); |
|
202 | - |
|
203 | - if ( $button_args['type'] != 'themes' ) { |
|
204 | - if ( current_user_can( 'manage_options' ) ) { |
|
205 | - $button_args['url'] = wp_nonce_url( admin_url( 'plugins.php?action=activate&plugin=' . $button_args['file'] ), 'activate-plugin_' . $button_args['file'] ); |
|
206 | - } else { |
|
207 | - $button_args['url'] = '#'; |
|
208 | - } |
|
209 | - } else { |
|
210 | - if ( current_user_can( 'switch_themes' ) ) { |
|
211 | - $button_args['url'] = self::get_theme_activation_url( $addon ); |
|
212 | - } else { |
|
213 | - $button_args['url'] = '#'; |
|
214 | - } |
|
215 | - } |
|
187 | + // set if active |
|
188 | + if ( $button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes') ) { |
|
189 | + if ( $button_args['type'] != 'themes' ) { |
|
190 | + $button_args['active'] = is_plugin_active( $button_args['file'] ); |
|
191 | + } else { |
|
192 | + $button_args['active'] = self::is_theme_active( $addon ); |
|
193 | + } |
|
194 | + } |
|
195 | + |
|
196 | + // set button text and class |
|
197 | + if ( $button_args['active'] ) { |
|
198 | + $button_args['button_text'] = __( 'Active', 'invoicing' ); |
|
199 | + $button_args['class'] = ' button-secondary disabled '; |
|
200 | + } elseif ( $button_args['installed'] ) { |
|
201 | + $button_args['button_text'] = __( 'Activate', 'invoicing' ); |
|
202 | + |
|
203 | + if ( $button_args['type'] != 'themes' ) { |
|
204 | + if ( current_user_can( 'manage_options' ) ) { |
|
205 | + $button_args['url'] = wp_nonce_url( admin_url( 'plugins.php?action=activate&plugin=' . $button_args['file'] ), 'activate-plugin_' . $button_args['file'] ); |
|
206 | + } else { |
|
207 | + $button_args['url'] = '#'; |
|
208 | + } |
|
209 | + } else { |
|
210 | + if ( current_user_can( 'switch_themes' ) ) { |
|
211 | + $button_args['url'] = self::get_theme_activation_url( $addon ); |
|
212 | + } else { |
|
213 | + $button_args['url'] = '#'; |
|
214 | + } |
|
215 | + } |
|
216 | 216 | } else { |
217 | - if ( $button_args['type'] == 'recommended_plugins' ) { |
|
218 | - $button_args['button_text'] = __( 'Install', 'invoicing' ); |
|
219 | - } else { |
|
220 | - $button_args['button_text'] = __( 'Get it', 'invoicing' ); |
|
217 | + if ( $button_args['type'] == 'recommended_plugins' ) { |
|
218 | + $button_args['button_text'] = __( 'Install', 'invoicing' ); |
|
219 | + } else { |
|
220 | + $button_args['button_text'] = __( 'Get it', 'invoicing' ); |
|
221 | 221 | |
222 | - /*if($button_args['type'] == 'themes' && in_array($button_args['slug'],$wp_org_themes) ){ |
|
222 | + /*if($button_args['type'] == 'themes' && in_array($button_args['slug'],$wp_org_themes) ){ |
|
223 | 223 | $button_args['button_text'] = __('Install','invoicing'); |
224 | 224 | $button_args['url'] = self::get_theme_install_url($button_args['slug']); |
225 | 225 | $button_args['onclick'] = 'gd_set_button_installing(this);'; |
226 | 226 | }*/ |
227 | 227 | |
228 | - } |
|
229 | - } |
|
228 | + } |
|
229 | + } |
|
230 | 230 | |
231 | - // filter the button arguments |
|
232 | - $button_args = apply_filters( 'edd_api_button_args', $button_args ); |
|
231 | + // filter the button arguments |
|
232 | + $button_args = apply_filters( 'edd_api_button_args', $button_args ); |
|
233 | 233 | // print_r($button_args); |
234 | - // set price text |
|
235 | - if ( isset( $button_args['price_text'] ) ) { |
|
236 | - ?> |
|
234 | + // set price text |
|
235 | + if ( isset( $button_args['price_text'] ) ) { |
|
236 | + ?> |
|
237 | 237 | <a |
238 | 238 | target="_blank" |
239 | 239 | class="addons-price-text" |
@@ -241,9 +241,9 @@ discard block |
||
241 | 241 | <?php echo esc_html( $button_args['price_text'] ); ?> |
242 | 242 | </a> |
243 | 243 | <?php |
244 | - } |
|
244 | + } |
|
245 | 245 | |
246 | - ?> |
|
246 | + ?> |
|
247 | 247 | <a |
248 | 248 | data-licence="<?php echo esc_attr( $button_args['license'] ); ?>" |
249 | 249 | data-licensing="<?php echo $button_args['licensing'] ? 1 : 0; ?>" |
@@ -267,33 +267,33 @@ discard block |
||
267 | 267 | </a> |
268 | 268 | <?php |
269 | 269 | |
270 | - } |
|
271 | - |
|
272 | - |
|
273 | - /** |
|
274 | - * Handles output of the addons page in admin. |
|
275 | - */ |
|
276 | - public function output() { |
|
277 | - $tabs = self::get_tabs(); |
|
278 | - $sections = self::get_sections(); |
|
279 | - $theme = wp_get_theme(); |
|
280 | - $section_keys = array_keys( $sections ); |
|
281 | - $current_section = isset( $_GET['section'] ) ? sanitize_text_field( $_GET['section'] ) : current( $section_keys ); |
|
282 | - $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
283 | - include_once WPINV_PLUGIN_DIR . '/includes/admin/html-admin-page-addons.php'; |
|
284 | - } |
|
285 | - |
|
286 | - /** |
|
287 | - * A list of recommended wp.org plugins. |
|
288 | - * @return array |
|
289 | - */ |
|
290 | - public function get_recommend_wp_plugins() { |
|
291 | - $plugins = array( |
|
270 | + } |
|
271 | + |
|
272 | + |
|
273 | + /** |
|
274 | + * Handles output of the addons page in admin. |
|
275 | + */ |
|
276 | + public function output() { |
|
277 | + $tabs = self::get_tabs(); |
|
278 | + $sections = self::get_sections(); |
|
279 | + $theme = wp_get_theme(); |
|
280 | + $section_keys = array_keys( $sections ); |
|
281 | + $current_section = isset( $_GET['section'] ) ? sanitize_text_field( $_GET['section'] ) : current( $section_keys ); |
|
282 | + $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
283 | + include_once WPINV_PLUGIN_DIR . '/includes/admin/html-admin-page-addons.php'; |
|
284 | + } |
|
285 | + |
|
286 | + /** |
|
287 | + * A list of recommended wp.org plugins. |
|
288 | + * @return array |
|
289 | + */ |
|
290 | + public function get_recommend_wp_plugins() { |
|
291 | + $plugins = array( |
|
292 | 292 | 'invoicing-quotes' => array( |
293 | 293 | 'url' => 'https://wordpress.org/plugins/invoicing-quotes/', |
294 | 294 | 'slug' => 'invoicing-quotes', |
295 | - 'name' => 'Quotes', |
|
296 | - 'thumbnail' => 'https://ps.w.org/invoicing-quotes/assets/banner-772x250.png', |
|
295 | + 'name' => 'Quotes', |
|
296 | + 'thumbnail' => 'https://ps.w.org/invoicing-quotes/assets/banner-772x250.png', |
|
297 | 297 | 'desc' => __( 'Allows you to create quotes, send them to clients and convert them to Invoices when accepted by the customer.', 'invoicing' ), |
298 | 298 | ), |
299 | 299 | 'geodirectory' => array( |
@@ -308,8 +308,8 @@ discard block |
||
308 | 308 | 'name' => 'UsersWP', |
309 | 309 | 'desc' => __( 'Allow frontend user login and registration as well as have slick profile pages.', 'invoicing' ), |
310 | 310 | ), |
311 | - ); |
|
311 | + ); |
|
312 | 312 | |
313 | - return $plugins; |
|
314 | - } |
|
313 | + return $plugins; |
|
314 | + } |
|
315 | 315 | } |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * All Invoicing extensions screen related functions can be found here. |
6 | 6 | * |
7 | 7 | */ |
8 | -if ( ! defined( 'ABSPATH' ) ) { |
|
8 | +if (!defined('ABSPATH')) { |
|
9 | 9 | exit; |
10 | 10 | } |
11 | 11 | |
@@ -22,10 +22,10 @@ discard block |
||
22 | 22 | */ |
23 | 23 | public function get_tabs() { |
24 | 24 | $tabs = array( |
25 | - 'addons' => __( 'Addons', 'invoicing' ), |
|
26 | - 'gateways' => __( 'Payment Gateways', 'invoicing' ), |
|
27 | - 'recommended_plugins' => __( 'Recommended plugins', 'invoicing' ), |
|
28 | - 'membership' => __( 'Membership', 'invoicing' ), |
|
25 | + 'addons' => __('Addons', 'invoicing'), |
|
26 | + 'gateways' => __('Payment Gateways', 'invoicing'), |
|
27 | + 'recommended_plugins' => __('Recommended plugins', 'invoicing'), |
|
28 | + 'membership' => __('Membership', 'invoicing'), |
|
29 | 29 | ); |
30 | 30 | |
31 | 31 | return $tabs; |
@@ -38,57 +38,57 @@ discard block |
||
38 | 38 | * |
39 | 39 | * @return array |
40 | 40 | */ |
41 | - public function get_section_data( $section_id ) { |
|
42 | - $section = self::get_tab( $section_id ); |
|
41 | + public function get_section_data($section_id) { |
|
42 | + $section = self::get_tab($section_id); |
|
43 | 43 | $api_url = 'https://wpinvoicing.com/edd-api/v2/products/'; |
44 | 44 | $section_data = new stdClass(); |
45 | 45 | |
46 | - if ( $section_id == 'recommended_plugins' ) { |
|
46 | + if ($section_id == 'recommended_plugins') { |
|
47 | 47 | $section_data->products = self::get_recommend_wp_plugins_edd_formatted(); |
48 | - } elseif ( ! empty( $section ) ) { |
|
49 | - if ( false === ( $section_data = get_transient( 'wpi_addons_section_' . $section_id ) ) ) { //@todo restore after testing |
|
48 | + } elseif (!empty($section)) { |
|
49 | + if (false === ($section_data = get_transient('wpi_addons_section_' . $section_id))) { //@todo restore after testing |
|
50 | 50 | //if ( 1==1) { |
51 | 51 | |
52 | 52 | $query_args = array( |
53 | 53 | 'category' => $section_id, |
54 | 54 | 'number' => 100, |
55 | 55 | ); |
56 | - $query_args = apply_filters( 'wpeu_edd_api_query_args', $query_args, $api_url, $section_id ); |
|
56 | + $query_args = apply_filters('wpeu_edd_api_query_args', $query_args, $api_url, $section_id); |
|
57 | 57 | |
58 | 58 | $raw_section = wp_safe_remote_get( |
59 | - esc_url_raw( add_query_arg( $query_args, $api_url ) ), |
|
59 | + esc_url_raw(add_query_arg($query_args, $api_url)), |
|
60 | 60 | array( |
61 | 61 | 'user-agent' => 'Invoicing Addons Page', |
62 | 62 | 'timeout' => 15, |
63 | 63 | ) |
64 | 64 | ); |
65 | 65 | |
66 | - if ( ! is_wp_error( $raw_section ) ) { |
|
67 | - $section_data = json_decode( wp_remote_retrieve_body( $raw_section ) ); |
|
66 | + if (!is_wp_error($raw_section)) { |
|
67 | + $section_data = json_decode(wp_remote_retrieve_body($raw_section)); |
|
68 | 68 | |
69 | - if ( ! empty( $section_data->products ) ) { |
|
70 | - set_transient( 'wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS ); |
|
69 | + if (!empty($section_data->products)) { |
|
70 | + set_transient('wpi_addons_section_' . $section_id, $section_data, DAY_IN_SECONDS); |
|
71 | 71 | } |
72 | 72 | } |
73 | 73 | } |
74 | 74 | } |
75 | 75 | |
76 | - $products = isset( $section_data->products ) ? $section_data->products : array(); |
|
77 | - if ( 'addons' == $section_id ) { |
|
76 | + $products = isset($section_data->products) ? $section_data->products : array(); |
|
77 | + if ('addons' == $section_id) { |
|
78 | 78 | |
79 | 79 | $quotes = new stdClass(); |
80 | 80 | $quotes->info = new stdClass(); |
81 | 81 | $quotes->info->id = ''; |
82 | 82 | $quotes->info->slug = 'invoicing-quotes'; |
83 | - $quotes->info->title = __( 'Quotes', 'invoicing' ); |
|
84 | - $quotes->info->excerpt = __( 'Create quotes and estimates', 'invoicing' ); |
|
83 | + $quotes->info->title = __('Quotes', 'invoicing'); |
|
84 | + $quotes->info->excerpt = __('Create quotes and estimates', 'invoicing'); |
|
85 | 85 | $quotes->info->link = 'https://wordpress.org/plugins/invoicing-quotes/'; |
86 | 86 | $quotes->info->thumbnail = WPINV_PLUGIN_URL . 'assets/images/Quotes-1-768x384.png'; |
87 | 87 | |
88 | 88 | $products[] = $quotes; |
89 | 89 | } |
90 | 90 | |
91 | - return apply_filters( 'wpi_addons_section_data', $products, $section_id ); |
|
91 | + return apply_filters('wpi_addons_section_data', $products, $section_id); |
|
92 | 92 | } |
93 | 93 | |
94 | 94 | /** |
@@ -99,8 +99,8 @@ discard block |
||
99 | 99 | * @param string $theme |
100 | 100 | * @param string $plugin |
101 | 101 | */ |
102 | - public function output_button( $addon ) { |
|
103 | - $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
102 | + public function output_button($addon) { |
|
103 | + $current_tab = empty($_GET['tab']) ? 'addons' : sanitize_title($_GET['tab']); |
|
104 | 104 | // $button_text = __('Free','invoicing'); |
105 | 105 | // $licensing = false; |
106 | 106 | // $installed = false; |
@@ -112,30 +112,30 @@ discard block |
||
112 | 112 | // $install_status = 'get'; |
113 | 113 | // $onclick = ''; |
114 | 114 | |
115 | - $wp_org_themes = array( 'supreme-directory', 'directory-starter' ); |
|
115 | + $wp_org_themes = array('supreme-directory', 'directory-starter'); |
|
116 | 116 | |
117 | 117 | $button_args = array( |
118 | 118 | 'type' => ($current_tab == 'addons' || $current_tab == 'gateways') ? 'addons' : $current_tab, |
119 | - 'id' => isset( $addon->info->id ) ? absint( $addon->info->id ) : '', |
|
120 | - 'title' => isset( $addon->info->title ) ? $addon->info->title : '', |
|
121 | - 'button_text' => __( 'Free', 'invoicing' ), |
|
122 | - 'price_text' => __( 'Free', 'invoicing' ), |
|
123 | - 'link' => isset( $addon->info->link ) ? $addon->info->link : '', // link to product |
|
124 | - 'url' => isset( $addon->info->link ) ? $addon->info->link : '', // button url |
|
119 | + 'id' => isset($addon->info->id) ? absint($addon->info->id) : '', |
|
120 | + 'title' => isset($addon->info->title) ? $addon->info->title : '', |
|
121 | + 'button_text' => __('Free', 'invoicing'), |
|
122 | + 'price_text' => __('Free', 'invoicing'), |
|
123 | + 'link' => isset($addon->info->link) ? $addon->info->link : '', // link to product |
|
124 | + 'url' => isset($addon->info->link) ? $addon->info->link : '', // button url |
|
125 | 125 | 'class' => 'button-primary', |
126 | 126 | 'install_status' => 'get', |
127 | 127 | 'installed' => false, |
128 | 128 | 'price' => '', |
129 | - 'licensing' => isset( $addon->licensing->enabled ) && $addon->licensing->enabled ? true : false, |
|
130 | - 'license' => isset( $addon->licensing->license ) && $addon->licensing->license ? $addon->licensing->license : '', |
|
129 | + 'licensing' => isset($addon->licensing->enabled) && $addon->licensing->enabled ? true : false, |
|
130 | + 'license' => isset($addon->licensing->license) && $addon->licensing->license ? $addon->licensing->license : '', |
|
131 | 131 | 'onclick' => '', |
132 | - 'slug' => isset( $addon->info->slug ) ? $addon->info->slug : '', |
|
132 | + 'slug' => isset($addon->info->slug) ? $addon->info->slug : '', |
|
133 | 133 | 'active' => false, |
134 | 134 | 'file' => '', |
135 | 135 | 'update_url' => '', |
136 | 136 | ); |
137 | 137 | |
138 | - if ( 'invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ( $current_tab == 'recommended_plugins' && isset( $addon->info->slug ) && $addon->info->slug ) ) { |
|
138 | + if ('invoicing-quotes' == $addon->info->slug || 'getpaid-stripe-payments' == $addon->info->slug || ($current_tab == 'recommended_plugins' && isset($addon->info->slug) && $addon->info->slug)) { |
|
139 | 139 | include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
140 | 140 | $status = install_plugin_install_status( |
141 | 141 | array( |
@@ -143,81 +143,81 @@ discard block |
||
143 | 143 | 'version' => '', |
144 | 144 | ) |
145 | 145 | ); |
146 | - $button_args['install_status'] = isset( $status['status'] ) ? $status['status'] : 'install'; |
|
147 | - $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
148 | - } elseif ( ($current_tab == 'addons' || $current_tab == 'gateways') && isset( $addon->info->id ) && $addon->info->id ) { |
|
146 | + $button_args['install_status'] = isset($status['status']) ? $status['status'] : 'install'; |
|
147 | + $button_args['file'] = isset($status['file']) ? $status['file'] : ''; |
|
148 | + } elseif (($current_tab == 'addons' || $current_tab == 'gateways') && isset($addon->info->id) && $addon->info->id) { |
|
149 | 149 | include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; //for plugins_api.. |
150 | - if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
151 | -$button_args['slug'] = $addon->licensing->edd_slug;} |
|
152 | - $status = self::install_plugin_install_status( $addon ); |
|
153 | - $button_args['file'] = isset( $status['file'] ) ? $status['file'] : ''; |
|
154 | - if ( isset( $status['status'] ) ) { |
|
155 | -$button_args['install_status'] = $status['status'];} |
|
150 | + if (!empty($addon->licensing->edd_slug)) { |
|
151 | +$button_args['slug'] = $addon->licensing->edd_slug; } |
|
152 | + $status = self::install_plugin_install_status($addon); |
|
153 | + $button_args['file'] = isset($status['file']) ? $status['file'] : ''; |
|
154 | + if (isset($status['status'])) { |
|
155 | +$button_args['install_status'] = $status['status']; } |
|
156 | 156 | $button_args['update_url'] = 'https://wpinvoicing.com'; |
157 | - } elseif ( $current_tab == 'themes' && isset( $addon->info->id ) && $addon->info->id ) { |
|
158 | - if ( ! empty( $addon->licensing->edd_slug ) ) { |
|
159 | -$button_args['slug'] = $addon->licensing->edd_slug;} |
|
160 | - $button_args['installed'] = self::is_theme_installed( $addon ); |
|
161 | - if ( ! in_array( $button_args['slug'], $wp_org_themes ) ) { |
|
157 | + } elseif ($current_tab == 'themes' && isset($addon->info->id) && $addon->info->id) { |
|
158 | + if (!empty($addon->licensing->edd_slug)) { |
|
159 | +$button_args['slug'] = $addon->licensing->edd_slug; } |
|
160 | + $button_args['installed'] = self::is_theme_installed($addon); |
|
161 | + if (!in_array($button_args['slug'], $wp_org_themes)) { |
|
162 | 162 | $button_args['update_url'] = 'https://wpinvoicing.com'; |
163 | 163 | } |
164 | 164 | } |
165 | 165 | |
166 | 166 | // set price |
167 | - if ( isset( $addon->pricing ) && ! empty( $addon->pricing ) ) { |
|
168 | - if ( is_object( $addon->pricing ) ) { |
|
169 | - $prices = (array)$addon->pricing; |
|
170 | - $button_args['price'] = reset( $prices ); |
|
171 | - } elseif ( isset( $addon->pricing ) ) { |
|
167 | + if (isset($addon->pricing) && !empty($addon->pricing)) { |
|
168 | + if (is_object($addon->pricing)) { |
|
169 | + $prices = (array) $addon->pricing; |
|
170 | + $button_args['price'] = reset($prices); |
|
171 | + } elseif (isset($addon->pricing)) { |
|
172 | 172 | $button_args['price'] = $addon->pricing; |
173 | 173 | } |
174 | 174 | } |
175 | 175 | |
176 | 176 | // set price text |
177 | - if ( $button_args['price'] && $button_args['price'] != '0.00' ) { |
|
178 | - $button_args['price_text'] = sprintf( __( 'From: $%d', 'invoicing' ), $button_args['price'] ); |
|
177 | + if ($button_args['price'] && $button_args['price'] != '0.00') { |
|
178 | + $button_args['price_text'] = sprintf(__('From: $%d', 'invoicing'), $button_args['price']); |
|
179 | 179 | } |
180 | 180 | |
181 | 181 | // set if installed |
182 | - if ( in_array( $button_args['install_status'], array( 'installed', 'latest_installed', 'update_available', 'newer_installed' ) ) ) { |
|
182 | + if (in_array($button_args['install_status'], array('installed', 'latest_installed', 'update_available', 'newer_installed'))) { |
|
183 | 183 | $button_args['installed'] = true; |
184 | 184 | } |
185 | 185 | |
186 | 186 | // print_r($button_args); |
187 | 187 | // set if active |
188 | - if ( $button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes') ) { |
|
189 | - if ( $button_args['type'] != 'themes' ) { |
|
190 | - $button_args['active'] = is_plugin_active( $button_args['file'] ); |
|
188 | + if ($button_args['installed'] && ($button_args['file'] || $button_args['type'] == 'themes')) { |
|
189 | + if ($button_args['type'] != 'themes') { |
|
190 | + $button_args['active'] = is_plugin_active($button_args['file']); |
|
191 | 191 | } else { |
192 | - $button_args['active'] = self::is_theme_active( $addon ); |
|
192 | + $button_args['active'] = self::is_theme_active($addon); |
|
193 | 193 | } |
194 | 194 | } |
195 | 195 | |
196 | 196 | // set button text and class |
197 | - if ( $button_args['active'] ) { |
|
198 | - $button_args['button_text'] = __( 'Active', 'invoicing' ); |
|
197 | + if ($button_args['active']) { |
|
198 | + $button_args['button_text'] = __('Active', 'invoicing'); |
|
199 | 199 | $button_args['class'] = ' button-secondary disabled '; |
200 | - } elseif ( $button_args['installed'] ) { |
|
201 | - $button_args['button_text'] = __( 'Activate', 'invoicing' ); |
|
200 | + } elseif ($button_args['installed']) { |
|
201 | + $button_args['button_text'] = __('Activate', 'invoicing'); |
|
202 | 202 | |
203 | - if ( $button_args['type'] != 'themes' ) { |
|
204 | - if ( current_user_can( 'manage_options' ) ) { |
|
205 | - $button_args['url'] = wp_nonce_url( admin_url( 'plugins.php?action=activate&plugin=' . $button_args['file'] ), 'activate-plugin_' . $button_args['file'] ); |
|
203 | + if ($button_args['type'] != 'themes') { |
|
204 | + if (current_user_can('manage_options')) { |
|
205 | + $button_args['url'] = wp_nonce_url(admin_url('plugins.php?action=activate&plugin=' . $button_args['file']), 'activate-plugin_' . $button_args['file']); |
|
206 | 206 | } else { |
207 | 207 | $button_args['url'] = '#'; |
208 | 208 | } |
209 | 209 | } else { |
210 | - if ( current_user_can( 'switch_themes' ) ) { |
|
211 | - $button_args['url'] = self::get_theme_activation_url( $addon ); |
|
210 | + if (current_user_can('switch_themes')) { |
|
211 | + $button_args['url'] = self::get_theme_activation_url($addon); |
|
212 | 212 | } else { |
213 | 213 | $button_args['url'] = '#'; |
214 | 214 | } |
215 | 215 | } |
216 | 216 | } else { |
217 | - if ( $button_args['type'] == 'recommended_plugins' ) { |
|
218 | - $button_args['button_text'] = __( 'Install', 'invoicing' ); |
|
217 | + if ($button_args['type'] == 'recommended_plugins') { |
|
218 | + $button_args['button_text'] = __('Install', 'invoicing'); |
|
219 | 219 | } else { |
220 | - $button_args['button_text'] = __( 'Get it', 'invoicing' ); |
|
220 | + $button_args['button_text'] = __('Get it', 'invoicing'); |
|
221 | 221 | |
222 | 222 | /*if($button_args['type'] == 'themes' && in_array($button_args['slug'],$wp_org_themes) ){ |
223 | 223 | $button_args['button_text'] = __('Install','invoicing'); |
@@ -229,41 +229,41 @@ discard block |
||
229 | 229 | } |
230 | 230 | |
231 | 231 | // filter the button arguments |
232 | - $button_args = apply_filters( 'edd_api_button_args', $button_args ); |
|
232 | + $button_args = apply_filters('edd_api_button_args', $button_args); |
|
233 | 233 | // print_r($button_args); |
234 | 234 | // set price text |
235 | - if ( isset( $button_args['price_text'] ) ) { |
|
235 | + if (isset($button_args['price_text'])) { |
|
236 | 236 | ?> |
237 | 237 | <a |
238 | 238 | target="_blank" |
239 | 239 | class="addons-price-text" |
240 | - href="<?php echo esc_url( $button_args['link'] ); ?>"> |
|
241 | - <?php echo esc_html( $button_args['price_text'] ); ?> |
|
240 | + href="<?php echo esc_url($button_args['link']); ?>"> |
|
241 | + <?php echo esc_html($button_args['price_text']); ?> |
|
242 | 242 | </a> |
243 | 243 | <?php |
244 | 244 | } |
245 | 245 | |
246 | 246 | ?> |
247 | 247 | <a |
248 | - data-licence="<?php echo esc_attr( $button_args['license'] ); ?>" |
|
248 | + data-licence="<?php echo esc_attr($button_args['license']); ?>" |
|
249 | 249 | data-licensing="<?php echo $button_args['licensing'] ? 1 : 0; ?>" |
250 | - data-title="<?php echo esc_attr( $button_args['title'] ); ?>" |
|
251 | - data-type="<?php echo esc_attr( $button_args['type'] ); ?>" |
|
252 | - data-text-error-message="<?php esc_attr_e( 'Something went wrong!', 'invoicing' ); ?>" |
|
253 | - data-text-activate="<?php esc_attr_e( 'Activate', 'invoicing' ); ?>" |
|
254 | - data-text-activating="<?php esc_attr_e( 'Activating', 'invoicing' ); ?>" |
|
255 | - data-text-deactivate="<?php esc_attr_e( 'Deactivate', 'invoicing' ); ?>" |
|
256 | - data-text-installed="<?php esc_attr_e( 'Installed', 'invoicing' ); ?>" |
|
257 | - data-text-install="<?php esc_attr_e( 'Install', 'invoicing' ); ?>" |
|
258 | - data-text-installing="<?php esc_attr_e( 'Installing', 'invoicing' ); ?>" |
|
259 | - data-text-error="<?php esc_attr_e( 'Error', 'invoicing' ); ?>" |
|
250 | + data-title="<?php echo esc_attr($button_args['title']); ?>" |
|
251 | + data-type="<?php echo esc_attr($button_args['type']); ?>" |
|
252 | + data-text-error-message="<?php esc_attr_e('Something went wrong!', 'invoicing'); ?>" |
|
253 | + data-text-activate="<?php esc_attr_e('Activate', 'invoicing'); ?>" |
|
254 | + data-text-activating="<?php esc_attr_e('Activating', 'invoicing'); ?>" |
|
255 | + data-text-deactivate="<?php esc_attr_e('Deactivate', 'invoicing'); ?>" |
|
256 | + data-text-installed="<?php esc_attr_e('Installed', 'invoicing'); ?>" |
|
257 | + data-text-install="<?php esc_attr_e('Install', 'invoicing'); ?>" |
|
258 | + data-text-installing="<?php esc_attr_e('Installing', 'invoicing'); ?>" |
|
259 | + data-text-error="<?php esc_attr_e('Error', 'invoicing'); ?>" |
|
260 | 260 | <?php |
261 | - if ( ! empty( $button_args['onclick'] ) ) { |
|
262 | -echo " onclick='" . esc_attr( $button_args['onclick'] ) . "' ";} |
|
261 | + if (!empty($button_args['onclick'])) { |
|
262 | +echo " onclick='" . esc_attr($button_args['onclick']) . "' "; } |
|
263 | 263 | ?> |
264 | - class="addons-button <?php echo esc_attr( $button_args['class'] ); ?>" |
|
265 | - href="<?php echo esc_url( $button_args['url'] ); ?>"> |
|
266 | - <?php echo esc_html( $button_args['button_text'] ); ?> |
|
264 | + class="addons-button <?php echo esc_attr($button_args['class']); ?>" |
|
265 | + href="<?php echo esc_url($button_args['url']); ?>"> |
|
266 | + <?php echo esc_html($button_args['button_text']); ?> |
|
267 | 267 | </a> |
268 | 268 | <?php |
269 | 269 | |
@@ -277,9 +277,9 @@ discard block |
||
277 | 277 | $tabs = self::get_tabs(); |
278 | 278 | $sections = self::get_sections(); |
279 | 279 | $theme = wp_get_theme(); |
280 | - $section_keys = array_keys( $sections ); |
|
281 | - $current_section = isset( $_GET['section'] ) ? sanitize_text_field( $_GET['section'] ) : current( $section_keys ); |
|
282 | - $current_tab = empty( $_GET['tab'] ) ? 'addons' : sanitize_title( $_GET['tab'] ); |
|
280 | + $section_keys = array_keys($sections); |
|
281 | + $current_section = isset($_GET['section']) ? sanitize_text_field($_GET['section']) : current($section_keys); |
|
282 | + $current_tab = empty($_GET['tab']) ? 'addons' : sanitize_title($_GET['tab']); |
|
283 | 283 | include_once WPINV_PLUGIN_DIR . '/includes/admin/html-admin-page-addons.php'; |
284 | 284 | } |
285 | 285 | |
@@ -294,19 +294,19 @@ discard block |
||
294 | 294 | 'slug' => 'invoicing-quotes', |
295 | 295 | 'name' => 'Quotes', |
296 | 296 | 'thumbnail' => 'https://ps.w.org/invoicing-quotes/assets/banner-772x250.png', |
297 | - 'desc' => __( 'Allows you to create quotes, send them to clients and convert them to Invoices when accepted by the customer.', 'invoicing' ), |
|
297 | + 'desc' => __('Allows you to create quotes, send them to clients and convert them to Invoices when accepted by the customer.', 'invoicing'), |
|
298 | 298 | ), |
299 | 299 | 'geodirectory' => array( |
300 | 300 | 'url' => 'https://wordpress.org/plugins/geodirectory/', |
301 | 301 | 'slug' => 'geodirectory', |
302 | 302 | 'name' => 'GeoDirectory', |
303 | - 'desc' => __( 'Turn any WordPress theme into a global business directory portal.', 'invoicing' ), |
|
303 | + 'desc' => __('Turn any WordPress theme into a global business directory portal.', 'invoicing'), |
|
304 | 304 | ), |
305 | 305 | 'userswp' => array( |
306 | 306 | 'url' => 'https://wordpress.org/plugins/userswp/', |
307 | 307 | 'slug' => 'userswp', |
308 | 308 | 'name' => 'UsersWP', |
309 | - 'desc' => __( 'Allow frontend user login and registration as well as have slick profile pages.', 'invoicing' ), |
|
309 | + 'desc' => __('Allow frontend user login and registration as well as have slick profile pages.', 'invoicing'), |
|
310 | 310 | ), |
311 | 311 | ); |
312 | 312 |
@@ -21,569 +21,569 @@ |
||
21 | 21 | */ |
22 | 22 | class GetPaid_REST_Controller extends WP_REST_Controller { |
23 | 23 | |
24 | - /** |
|
24 | + /** |
|
25 | 25 | * The namespaces of this controller's route. |
26 | 26 | * |
27 | 27 | * @since 1.0.19 |
28 | 28 | * @var array |
29 | 29 | */ |
30 | - protected $namespaces; |
|
30 | + protected $namespaces; |
|
31 | 31 | |
32 | - /** |
|
32 | + /** |
|
33 | 33 | * The official namespace of this controller's route. |
34 | 34 | * |
35 | 35 | * @since 1.0.19 |
36 | 36 | * @var string |
37 | 37 | */ |
38 | - protected $namespace = 'getpaid/v1'; |
|
38 | + protected $namespace = 'getpaid/v1'; |
|
39 | 39 | |
40 | - /** |
|
40 | + /** |
|
41 | 41 | * Cached results of get_item_schema. |
42 | 42 | * |
43 | 43 | * @since 1.0.19 |
44 | 44 | * @var array |
45 | 45 | */ |
46 | - protected $schema; |
|
46 | + protected $schema; |
|
47 | 47 | |
48 | 48 | /** |
49 | - * Constructor. |
|
50 | - * |
|
51 | - * @since 1.0.19 |
|
52 | - * |
|
53 | - */ |
|
54 | - public function __construct() { |
|
55 | - |
|
56 | - // Offer several namespaces for backwards compatibility. |
|
57 | - $this->namespaces = apply_filters( |
|
58 | - 'getpaid_rest_api_namespaces', |
|
59 | - array( |
|
60 | - 'getpaid/v1', |
|
61 | - 'invoicing/v1', |
|
62 | - 'wpi/v1', |
|
63 | - ) |
|
64 | - ); |
|
65 | - |
|
66 | - // Register REST routes. |
|
49 | + * Constructor. |
|
50 | + * |
|
51 | + * @since 1.0.19 |
|
52 | + * |
|
53 | + */ |
|
54 | + public function __construct() { |
|
55 | + |
|
56 | + // Offer several namespaces for backwards compatibility. |
|
57 | + $this->namespaces = apply_filters( |
|
58 | + 'getpaid_rest_api_namespaces', |
|
59 | + array( |
|
60 | + 'getpaid/v1', |
|
61 | + 'invoicing/v1', |
|
62 | + 'wpi/v1', |
|
63 | + ) |
|
64 | + ); |
|
65 | + |
|
66 | + // Register REST routes. |
|
67 | 67 | add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
68 | 68 | |
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Registers routes for each namespace. |
|
73 | - * |
|
74 | - * @since 1.0.19 |
|
75 | - * |
|
76 | - */ |
|
77 | - public function register_routes() { |
|
78 | - |
|
79 | - foreach ( $this->namespaces as $namespace ) { |
|
80 | - $this->register_namespace_routes( $namespace ); |
|
81 | - } |
|
82 | - |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * Registers routes for a namespace. |
|
87 | - * |
|
88 | - * @since 1.0.19 |
|
89 | - * |
|
90 | - * @param string $namespace |
|
91 | - */ |
|
92 | - public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
93 | - |
|
94 | - getpaid_doing_it_wrong( |
|
95 | - __CLASS__ . '::' . __METHOD__, |
|
96 | - /* translators: %s: register_namespace_routes() */ |
|
97 | - sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
98 | - '1.0.19' |
|
99 | - ); |
|
100 | - |
|
101 | - } |
|
102 | - |
|
103 | - /** |
|
104 | - * Get normalized rest base. |
|
105 | - * |
|
106 | - * @return string |
|
107 | - */ |
|
108 | - protected function get_normalized_rest_base() { |
|
109 | - return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Fill batches. |
|
114 | - * |
|
115 | - * @param array array of request items. |
|
116 | - * @return array |
|
117 | - */ |
|
118 | - protected function fill_batch_keys( $items ) { |
|
119 | - |
|
120 | - $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
121 | - $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
122 | - $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
123 | - return $items; |
|
124 | - |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * Check batch limit. |
|
129 | - * |
|
130 | - * @param array $items Request items. |
|
131 | - * @return bool|WP_Error |
|
132 | - */ |
|
133 | - protected function check_batch_limit( $items ) { |
|
134 | - $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
135 | - $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
136 | - |
|
137 | - if ( $total > $limit ) { |
|
138 | - /* translators: %s: items limit */ |
|
139 | - return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
140 | - } |
|
141 | - |
|
142 | - return true; |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Bulk create items. |
|
147 | - * |
|
148 | - * @param array $items Array of items to create. |
|
149 | - * @param WP_REST_Request $request Full details about the request. |
|
150 | - * @param WP_REST_Server $wp_rest_server |
|
151 | - * @return array() |
|
152 | - */ |
|
153 | - protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
154 | - |
|
155 | - $query = $request->get_query_params(); |
|
156 | - $create = array(); |
|
157 | - |
|
158 | - foreach ( $items as $item ) { |
|
159 | - $_item = new WP_REST_Request( 'POST' ); |
|
160 | - |
|
161 | - // Default parameters. |
|
162 | - $defaults = array(); |
|
163 | - $schema = $this->get_public_item_schema(); |
|
164 | - foreach ( $schema['properties'] as $arg => $options ) { |
|
165 | - if ( isset( $options['default'] ) ) { |
|
166 | - $defaults[ $arg ] = $options['default']; |
|
167 | - } |
|
168 | - } |
|
169 | - $_item->set_default_params( $defaults ); |
|
170 | - |
|
171 | - // Set request parameters. |
|
172 | - $_item->set_body_params( $item ); |
|
173 | - |
|
174 | - // Set query (GET) parameters. |
|
175 | - $_item->set_query_params( $query ); |
|
176 | - |
|
177 | - // Create the item. |
|
178 | - $_response = $this->create_item( $_item ); |
|
179 | - |
|
180 | - // If an error occured... |
|
181 | - if ( is_wp_error( $_response ) ) { |
|
182 | - |
|
183 | - $create[] = array( |
|
184 | - 'id' => 0, |
|
185 | - 'error' => array( |
|
186 | - 'code' => $_response->get_error_code(), |
|
187 | - 'message' => $_response->get_error_message(), |
|
188 | - 'data' => $_response->get_error_data(), |
|
189 | - ), |
|
190 | - ); |
|
191 | - |
|
192 | - continue; |
|
193 | - } |
|
194 | - |
|
195 | - $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
196 | - |
|
197 | - } |
|
198 | - |
|
199 | - return $create; |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Registers routes for each namespace. |
|
73 | + * |
|
74 | + * @since 1.0.19 |
|
75 | + * |
|
76 | + */ |
|
77 | + public function register_routes() { |
|
78 | + |
|
79 | + foreach ( $this->namespaces as $namespace ) { |
|
80 | + $this->register_namespace_routes( $namespace ); |
|
81 | + } |
|
82 | + |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * Registers routes for a namespace. |
|
87 | + * |
|
88 | + * @since 1.0.19 |
|
89 | + * |
|
90 | + * @param string $namespace |
|
91 | + */ |
|
92 | + public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
93 | + |
|
94 | + getpaid_doing_it_wrong( |
|
95 | + __CLASS__ . '::' . __METHOD__, |
|
96 | + /* translators: %s: register_namespace_routes() */ |
|
97 | + sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
98 | + '1.0.19' |
|
99 | + ); |
|
100 | + |
|
101 | + } |
|
102 | + |
|
103 | + /** |
|
104 | + * Get normalized rest base. |
|
105 | + * |
|
106 | + * @return string |
|
107 | + */ |
|
108 | + protected function get_normalized_rest_base() { |
|
109 | + return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Fill batches. |
|
114 | + * |
|
115 | + * @param array array of request items. |
|
116 | + * @return array |
|
117 | + */ |
|
118 | + protected function fill_batch_keys( $items ) { |
|
119 | + |
|
120 | + $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
121 | + $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
122 | + $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
123 | + return $items; |
|
124 | + |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * Check batch limit. |
|
129 | + * |
|
130 | + * @param array $items Request items. |
|
131 | + * @return bool|WP_Error |
|
132 | + */ |
|
133 | + protected function check_batch_limit( $items ) { |
|
134 | + $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
135 | + $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
136 | + |
|
137 | + if ( $total > $limit ) { |
|
138 | + /* translators: %s: items limit */ |
|
139 | + return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
140 | + } |
|
141 | + |
|
142 | + return true; |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Bulk create items. |
|
147 | + * |
|
148 | + * @param array $items Array of items to create. |
|
149 | + * @param WP_REST_Request $request Full details about the request. |
|
150 | + * @param WP_REST_Server $wp_rest_server |
|
151 | + * @return array() |
|
152 | + */ |
|
153 | + protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
154 | + |
|
155 | + $query = $request->get_query_params(); |
|
156 | + $create = array(); |
|
157 | + |
|
158 | + foreach ( $items as $item ) { |
|
159 | + $_item = new WP_REST_Request( 'POST' ); |
|
160 | + |
|
161 | + // Default parameters. |
|
162 | + $defaults = array(); |
|
163 | + $schema = $this->get_public_item_schema(); |
|
164 | + foreach ( $schema['properties'] as $arg => $options ) { |
|
165 | + if ( isset( $options['default'] ) ) { |
|
166 | + $defaults[ $arg ] = $options['default']; |
|
167 | + } |
|
168 | + } |
|
169 | + $_item->set_default_params( $defaults ); |
|
170 | + |
|
171 | + // Set request parameters. |
|
172 | + $_item->set_body_params( $item ); |
|
173 | + |
|
174 | + // Set query (GET) parameters. |
|
175 | + $_item->set_query_params( $query ); |
|
176 | + |
|
177 | + // Create the item. |
|
178 | + $_response = $this->create_item( $_item ); |
|
179 | + |
|
180 | + // If an error occured... |
|
181 | + if ( is_wp_error( $_response ) ) { |
|
182 | + |
|
183 | + $create[] = array( |
|
184 | + 'id' => 0, |
|
185 | + 'error' => array( |
|
186 | + 'code' => $_response->get_error_code(), |
|
187 | + 'message' => $_response->get_error_message(), |
|
188 | + 'data' => $_response->get_error_data(), |
|
189 | + ), |
|
190 | + ); |
|
191 | + |
|
192 | + continue; |
|
193 | + } |
|
194 | + |
|
195 | + $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
196 | + |
|
197 | + } |
|
198 | + |
|
199 | + return $create; |
|
200 | + |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * Bulk update items. |
|
205 | + * |
|
206 | + * @param array $items Array of items to update. |
|
207 | + * @param WP_REST_Request $request Full details about the request. |
|
208 | + * @param WP_REST_Server $wp_rest_server |
|
209 | + * @return array() |
|
210 | + */ |
|
211 | + protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
212 | + |
|
213 | + $query = $request->get_query_params(); |
|
214 | + $update = array(); |
|
215 | + |
|
216 | + foreach ( $items as $item ) { |
|
217 | + |
|
218 | + // Create a dummy request. |
|
219 | + $_item = new WP_REST_Request( 'PUT' ); |
|
220 | + |
|
221 | + // Add body params. |
|
222 | + $_item->set_body_params( $item ); |
|
223 | + |
|
224 | + // Set query (GET) parameters. |
|
225 | + $_item->set_query_params( $query ); |
|
226 | + |
|
227 | + // Update the item. |
|
228 | + $_response = $this->update_item( $_item ); |
|
229 | + |
|
230 | + // If an error occured... |
|
231 | + if ( is_wp_error( $_response ) ) { |
|
232 | + |
|
233 | + $update[] = array( |
|
234 | + 'id' => $item['id'], |
|
235 | + 'error' => array( |
|
236 | + 'code' => $_response->get_error_code(), |
|
237 | + 'message' => $_response->get_error_message(), |
|
238 | + 'data' => $_response->get_error_data(), |
|
239 | + ), |
|
240 | + ); |
|
241 | + |
|
242 | + continue; |
|
243 | + |
|
244 | + } |
|
245 | + |
|
246 | + $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
247 | + |
|
248 | + } |
|
249 | + |
|
250 | + return $update; |
|
251 | + |
|
252 | + } |
|
253 | + |
|
254 | + /** |
|
255 | + * Bulk delete items. |
|
256 | + * |
|
257 | + * @param array $items Array of items to delete. |
|
258 | + * @param WP_REST_Server $wp_rest_server |
|
259 | + * @return array() |
|
260 | + */ |
|
261 | + protected function batch_delete_items( $items, $wp_rest_server ) { |
|
262 | + |
|
263 | + $delete = array(); |
|
264 | + |
|
265 | + foreach ( array_filter( $items ) as $id ) { |
|
266 | + |
|
267 | + // Prepare the request. |
|
268 | + $_item = new WP_REST_Request( 'DELETE' ); |
|
269 | + $_item->set_query_params( |
|
270 | + array( |
|
271 | + 'id' => $id, |
|
272 | + 'force' => true, |
|
273 | + ) |
|
274 | + ); |
|
275 | + |
|
276 | + // Delete the item. |
|
277 | + $_response = $this->delete_item( $_item ); |
|
278 | + |
|
279 | + if ( is_wp_error( $_response ) ) { |
|
280 | + |
|
281 | + $delete[] = array( |
|
282 | + 'id' => $id, |
|
283 | + 'error' => array( |
|
284 | + 'code' => $_response->get_error_code(), |
|
285 | + 'message' => $_response->get_error_message(), |
|
286 | + 'data' => $_response->get_error_data(), |
|
287 | + ), |
|
288 | + ); |
|
289 | + |
|
290 | + continue; |
|
291 | + } |
|
200 | 292 | |
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * Bulk update items. |
|
205 | - * |
|
206 | - * @param array $items Array of items to update. |
|
207 | - * @param WP_REST_Request $request Full details about the request. |
|
208 | - * @param WP_REST_Server $wp_rest_server |
|
209 | - * @return array() |
|
210 | - */ |
|
211 | - protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
212 | - |
|
213 | - $query = $request->get_query_params(); |
|
214 | - $update = array(); |
|
215 | - |
|
216 | - foreach ( $items as $item ) { |
|
217 | - |
|
218 | - // Create a dummy request. |
|
219 | - $_item = new WP_REST_Request( 'PUT' ); |
|
220 | - |
|
221 | - // Add body params. |
|
222 | - $_item->set_body_params( $item ); |
|
223 | - |
|
224 | - // Set query (GET) parameters. |
|
225 | - $_item->set_query_params( $query ); |
|
226 | - |
|
227 | - // Update the item. |
|
228 | - $_response = $this->update_item( $_item ); |
|
229 | - |
|
230 | - // If an error occured... |
|
231 | - if ( is_wp_error( $_response ) ) { |
|
232 | - |
|
233 | - $update[] = array( |
|
234 | - 'id' => $item['id'], |
|
235 | - 'error' => array( |
|
236 | - 'code' => $_response->get_error_code(), |
|
237 | - 'message' => $_response->get_error_message(), |
|
238 | - 'data' => $_response->get_error_data(), |
|
239 | - ), |
|
240 | - ); |
|
241 | - |
|
242 | - continue; |
|
243 | - |
|
244 | - } |
|
245 | - |
|
246 | - $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
247 | - |
|
248 | - } |
|
249 | - |
|
250 | - return $update; |
|
251 | - |
|
252 | - } |
|
293 | + $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
253 | 294 | |
254 | - /** |
|
255 | - * Bulk delete items. |
|
256 | - * |
|
257 | - * @param array $items Array of items to delete. |
|
258 | - * @param WP_REST_Server $wp_rest_server |
|
259 | - * @return array() |
|
260 | - */ |
|
261 | - protected function batch_delete_items( $items, $wp_rest_server ) { |
|
262 | - |
|
263 | - $delete = array(); |
|
264 | - |
|
265 | - foreach ( array_filter( $items ) as $id ) { |
|
266 | - |
|
267 | - // Prepare the request. |
|
268 | - $_item = new WP_REST_Request( 'DELETE' ); |
|
269 | - $_item->set_query_params( |
|
270 | - array( |
|
271 | - 'id' => $id, |
|
272 | - 'force' => true, |
|
273 | - ) |
|
274 | - ); |
|
275 | - |
|
276 | - // Delete the item. |
|
277 | - $_response = $this->delete_item( $_item ); |
|
278 | - |
|
279 | - if ( is_wp_error( $_response ) ) { |
|
280 | - |
|
281 | - $delete[] = array( |
|
282 | - 'id' => $id, |
|
283 | - 'error' => array( |
|
284 | - 'code' => $_response->get_error_code(), |
|
285 | - 'message' => $_response->get_error_message(), |
|
286 | - 'data' => $_response->get_error_data(), |
|
287 | - ), |
|
288 | - ); |
|
289 | - |
|
290 | - continue; |
|
291 | - } |
|
292 | - |
|
293 | - $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
294 | - |
|
295 | - } |
|
296 | - |
|
297 | - return $delete; |
|
298 | - |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Bulk create, update and delete items. |
|
303 | - * |
|
304 | - * @param WP_REST_Request $request Full details about the request. |
|
305 | - * @return WP_Error|array. |
|
306 | - */ |
|
307 | - public function batch_items( $request ) { |
|
308 | - global $wp_rest_server; |
|
309 | - |
|
310 | - // Prepare the batch items. |
|
311 | - $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
312 | - |
|
313 | - // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
314 | - $limit = $this->check_batch_limit( $items ); |
|
315 | - if ( is_wp_error( $limit ) ) { |
|
316 | - return $limit; |
|
317 | - } |
|
318 | - |
|
319 | - // Process the items. |
|
320 | - return array( |
|
321 | - 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
322 | - 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
323 | - 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
324 | - ); |
|
325 | - |
|
326 | - } |
|
327 | - |
|
328 | - /** |
|
329 | - * Add meta query. |
|
330 | - * |
|
331 | - * @since 1.0.19 |
|
332 | - * @param array $args Query args. |
|
333 | - * @param array $meta_query Meta query. |
|
334 | - * @return array |
|
335 | - */ |
|
336 | - protected function add_meta_query( $args, $meta_query ) { |
|
337 | - if ( empty( $args['meta_query'] ) ) { |
|
338 | - $args['meta_query'] = array(); |
|
339 | - } |
|
340 | - |
|
341 | - $args['meta_query'][] = $meta_query; |
|
342 | - |
|
343 | - return $args['meta_query']; |
|
344 | - } |
|
345 | - |
|
346 | - /** |
|
347 | - * Get the batch schema, conforming to JSON Schema. |
|
348 | - * |
|
349 | - * @return array |
|
350 | - */ |
|
351 | - public function get_public_batch_schema() { |
|
352 | - |
|
353 | - return array( |
|
354 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
355 | - 'title' => 'batch', |
|
356 | - 'type' => 'object', |
|
357 | - 'properties' => array( |
|
358 | - 'create' => array( |
|
359 | - 'description' => __( 'List of created resources.', 'invoicing' ), |
|
360 | - 'type' => 'array', |
|
361 | - 'context' => array( 'view', 'edit' ), |
|
362 | - 'items' => array( |
|
363 | - 'type' => 'object', |
|
364 | - ), |
|
365 | - ), |
|
366 | - 'update' => array( |
|
367 | - 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
368 | - 'type' => 'array', |
|
369 | - 'context' => array( 'view', 'edit' ), |
|
370 | - 'items' => array( |
|
371 | - 'type' => 'object', |
|
372 | - ), |
|
373 | - ), |
|
374 | - 'delete' => array( |
|
375 | - 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
376 | - 'type' => 'array', |
|
377 | - 'context' => array( 'view', 'edit' ), |
|
378 | - 'items' => array( |
|
379 | - 'type' => 'integer', |
|
380 | - ), |
|
381 | - ), |
|
382 | - ), |
|
383 | - ); |
|
384 | - |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * Returns the value of schema['properties'] |
|
389 | - * |
|
390 | - * i.e Schema fields. |
|
391 | - * |
|
392 | - * @since 1.0.19 |
|
393 | - * @return array |
|
394 | - */ |
|
395 | - protected function get_schema_properties() { |
|
396 | - |
|
397 | - $schema = $this->get_item_schema(); |
|
398 | - $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
399 | - |
|
400 | - // For back-compat, include any field with an empty schema |
|
401 | - // because it won't be present in $this->get_item_schema(). |
|
402 | - foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
403 | - if ( is_null( $field_options['schema'] ) ) { |
|
404 | - $properties[ $field_name ] = $field_options; |
|
405 | - } |
|
406 | - } |
|
407 | - |
|
408 | - return $properties; |
|
409 | - } |
|
410 | - |
|
411 | - /** |
|
412 | - * Filters fields by context. |
|
413 | - * |
|
414 | - * @param array $fields Array of fields |
|
415 | - * @param string|null context view, edit or embed |
|
416 | - * @since 1.0.19 |
|
417 | - * @return array |
|
418 | - */ |
|
419 | - protected function filter_response_fields_by_context( $fields, $context ) { |
|
420 | - |
|
421 | - if ( empty( $context ) ) { |
|
422 | - return $fields; |
|
423 | - } |
|
424 | - |
|
425 | - foreach ( $fields as $name => $options ) { |
|
426 | - if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
427 | - unset( $fields[ $name ] ); |
|
428 | - } |
|
429 | - } |
|
430 | - |
|
431 | - return $fields; |
|
432 | - |
|
433 | - } |
|
434 | - |
|
435 | - /** |
|
436 | - * Filters fields by an array of requested fields. |
|
437 | - * |
|
438 | - * @param array $fields Array of available fields |
|
439 | - * @param array $requested array of requested fields. |
|
440 | - * @since 1.0.19 |
|
441 | - * @return array |
|
442 | - */ |
|
443 | - protected function filter_response_fields_by_array( $fields, $requested ) { |
|
444 | - |
|
445 | - // Trim off any whitespace from the list array. |
|
446 | - $requested = array_map( 'trim', $requested ); |
|
447 | - |
|
448 | - // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
449 | - if ( in_array( 'id', $fields, true ) ) { |
|
450 | - $requested[] = 'id'; |
|
451 | - } |
|
452 | - |
|
453 | - // Get rid of duplicate fields. |
|
454 | - $requested = array_unique( $requested ); |
|
455 | - |
|
456 | - // Return the list of all included fields which are available. |
|
457 | - return array_reduce( |
|
458 | - $requested, |
|
459 | - function( $response_fields, $field ) use ( $fields ) { |
|
460 | - |
|
461 | - if ( in_array( $field, $fields, true ) ) { |
|
462 | - $response_fields[] = $field; |
|
463 | - return $response_fields; |
|
464 | - } |
|
465 | - |
|
466 | - // Check for nested fields if $field is not a direct match. |
|
467 | - $nested_fields = explode( '.', $field ); |
|
468 | - |
|
469 | - // A nested field is included so long as its top-level property is |
|
470 | - // present in the schema. |
|
471 | - if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
472 | - $response_fields[] = $field; |
|
473 | - } |
|
474 | - |
|
475 | - return $response_fields; |
|
476 | - }, |
|
477 | - array() |
|
478 | - ); |
|
479 | - |
|
480 | - } |
|
481 | - |
|
482 | - /** |
|
483 | - * Gets an array of fields to be included on the response. |
|
484 | - * |
|
485 | - * Included fields are based on item schema and `_fields=` request argument. |
|
486 | - * Copied from WordPress 5.3 to support old versions. |
|
487 | - * |
|
488 | - * @since 1.0.19 |
|
489 | - * @param WP_REST_Request $request Full details about the request. |
|
490 | - * @return array Fields to be included in the response. |
|
491 | - */ |
|
492 | - public function get_fields_for_response( $request ) { |
|
493 | - |
|
494 | - // Retrieve fields in the schema. |
|
495 | - $properties = $this->get_schema_properties(); |
|
496 | - |
|
497 | - // Exclude fields that specify a different context than the request context. |
|
498 | - $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
499 | - |
|
500 | - // We only need the field keys. |
|
501 | - $fields = array_keys( $properties ); |
|
502 | - |
|
503 | - // Is the user filtering the response fields?? |
|
504 | - if ( empty( $request['_fields'] ) ) { |
|
505 | - return $fields; |
|
506 | - } |
|
507 | - |
|
508 | - return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
509 | - |
|
510 | - } |
|
511 | - |
|
512 | - /** |
|
513 | - * Limits an object to the requested fields. |
|
514 | - * |
|
515 | - * Included fields are based on the `_fields` request argument. |
|
516 | - * |
|
517 | - * @since 1.0.19 |
|
518 | - * @param array $data Fields to include in the response. |
|
519 | - * @param array $fields Requested fields. |
|
520 | - * @return array Fields to be included in the response. |
|
521 | - */ |
|
522 | - public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
523 | - |
|
524 | - // Is the user filtering the response fields?? |
|
525 | - if ( empty( $fields ) ) { |
|
526 | - return $data; |
|
527 | - } |
|
528 | - |
|
529 | - foreach ( $data as $key => $value ) { |
|
530 | - |
|
531 | - // Numeric arrays. |
|
532 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
533 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
534 | - continue; |
|
535 | - } |
|
536 | - |
|
537 | - // Generate a new prefix. |
|
538 | - $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
539 | - |
|
540 | - // Check if it was requested. |
|
541 | - if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
542 | - unset( $data[ $key ] ); |
|
543 | - continue; |
|
544 | - } |
|
545 | - |
|
546 | - if ( $key != 'meta_data' && is_array( $value ) ) { |
|
547 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
548 | - } |
|
295 | + } |
|
296 | + |
|
297 | + return $delete; |
|
298 | + |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Bulk create, update and delete items. |
|
303 | + * |
|
304 | + * @param WP_REST_Request $request Full details about the request. |
|
305 | + * @return WP_Error|array. |
|
306 | + */ |
|
307 | + public function batch_items( $request ) { |
|
308 | + global $wp_rest_server; |
|
309 | + |
|
310 | + // Prepare the batch items. |
|
311 | + $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
312 | + |
|
313 | + // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
314 | + $limit = $this->check_batch_limit( $items ); |
|
315 | + if ( is_wp_error( $limit ) ) { |
|
316 | + return $limit; |
|
317 | + } |
|
318 | + |
|
319 | + // Process the items. |
|
320 | + return array( |
|
321 | + 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
322 | + 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
323 | + 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
324 | + ); |
|
325 | + |
|
326 | + } |
|
327 | + |
|
328 | + /** |
|
329 | + * Add meta query. |
|
330 | + * |
|
331 | + * @since 1.0.19 |
|
332 | + * @param array $args Query args. |
|
333 | + * @param array $meta_query Meta query. |
|
334 | + * @return array |
|
335 | + */ |
|
336 | + protected function add_meta_query( $args, $meta_query ) { |
|
337 | + if ( empty( $args['meta_query'] ) ) { |
|
338 | + $args['meta_query'] = array(); |
|
339 | + } |
|
340 | + |
|
341 | + $args['meta_query'][] = $meta_query; |
|
342 | + |
|
343 | + return $args['meta_query']; |
|
344 | + } |
|
345 | + |
|
346 | + /** |
|
347 | + * Get the batch schema, conforming to JSON Schema. |
|
348 | + * |
|
349 | + * @return array |
|
350 | + */ |
|
351 | + public function get_public_batch_schema() { |
|
352 | + |
|
353 | + return array( |
|
354 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
355 | + 'title' => 'batch', |
|
356 | + 'type' => 'object', |
|
357 | + 'properties' => array( |
|
358 | + 'create' => array( |
|
359 | + 'description' => __( 'List of created resources.', 'invoicing' ), |
|
360 | + 'type' => 'array', |
|
361 | + 'context' => array( 'view', 'edit' ), |
|
362 | + 'items' => array( |
|
363 | + 'type' => 'object', |
|
364 | + ), |
|
365 | + ), |
|
366 | + 'update' => array( |
|
367 | + 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
368 | + 'type' => 'array', |
|
369 | + 'context' => array( 'view', 'edit' ), |
|
370 | + 'items' => array( |
|
371 | + 'type' => 'object', |
|
372 | + ), |
|
373 | + ), |
|
374 | + 'delete' => array( |
|
375 | + 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
376 | + 'type' => 'array', |
|
377 | + 'context' => array( 'view', 'edit' ), |
|
378 | + 'items' => array( |
|
379 | + 'type' => 'integer', |
|
380 | + ), |
|
381 | + ), |
|
382 | + ), |
|
383 | + ); |
|
384 | + |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * Returns the value of schema['properties'] |
|
389 | + * |
|
390 | + * i.e Schema fields. |
|
391 | + * |
|
392 | + * @since 1.0.19 |
|
393 | + * @return array |
|
394 | + */ |
|
395 | + protected function get_schema_properties() { |
|
396 | + |
|
397 | + $schema = $this->get_item_schema(); |
|
398 | + $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
399 | + |
|
400 | + // For back-compat, include any field with an empty schema |
|
401 | + // because it won't be present in $this->get_item_schema(). |
|
402 | + foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
403 | + if ( is_null( $field_options['schema'] ) ) { |
|
404 | + $properties[ $field_name ] = $field_options; |
|
405 | + } |
|
406 | + } |
|
407 | + |
|
408 | + return $properties; |
|
409 | + } |
|
410 | + |
|
411 | + /** |
|
412 | + * Filters fields by context. |
|
413 | + * |
|
414 | + * @param array $fields Array of fields |
|
415 | + * @param string|null context view, edit or embed |
|
416 | + * @since 1.0.19 |
|
417 | + * @return array |
|
418 | + */ |
|
419 | + protected function filter_response_fields_by_context( $fields, $context ) { |
|
420 | + |
|
421 | + if ( empty( $context ) ) { |
|
422 | + return $fields; |
|
423 | + } |
|
424 | + |
|
425 | + foreach ( $fields as $name => $options ) { |
|
426 | + if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
427 | + unset( $fields[ $name ] ); |
|
428 | + } |
|
429 | + } |
|
430 | + |
|
431 | + return $fields; |
|
432 | + |
|
433 | + } |
|
434 | + |
|
435 | + /** |
|
436 | + * Filters fields by an array of requested fields. |
|
437 | + * |
|
438 | + * @param array $fields Array of available fields |
|
439 | + * @param array $requested array of requested fields. |
|
440 | + * @since 1.0.19 |
|
441 | + * @return array |
|
442 | + */ |
|
443 | + protected function filter_response_fields_by_array( $fields, $requested ) { |
|
444 | + |
|
445 | + // Trim off any whitespace from the list array. |
|
446 | + $requested = array_map( 'trim', $requested ); |
|
447 | + |
|
448 | + // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
449 | + if ( in_array( 'id', $fields, true ) ) { |
|
450 | + $requested[] = 'id'; |
|
451 | + } |
|
452 | + |
|
453 | + // Get rid of duplicate fields. |
|
454 | + $requested = array_unique( $requested ); |
|
455 | + |
|
456 | + // Return the list of all included fields which are available. |
|
457 | + return array_reduce( |
|
458 | + $requested, |
|
459 | + function( $response_fields, $field ) use ( $fields ) { |
|
460 | + |
|
461 | + if ( in_array( $field, $fields, true ) ) { |
|
462 | + $response_fields[] = $field; |
|
463 | + return $response_fields; |
|
464 | + } |
|
465 | + |
|
466 | + // Check for nested fields if $field is not a direct match. |
|
467 | + $nested_fields = explode( '.', $field ); |
|
468 | + |
|
469 | + // A nested field is included so long as its top-level property is |
|
470 | + // present in the schema. |
|
471 | + if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
472 | + $response_fields[] = $field; |
|
473 | + } |
|
474 | + |
|
475 | + return $response_fields; |
|
476 | + }, |
|
477 | + array() |
|
478 | + ); |
|
479 | + |
|
480 | + } |
|
481 | + |
|
482 | + /** |
|
483 | + * Gets an array of fields to be included on the response. |
|
484 | + * |
|
485 | + * Included fields are based on item schema and `_fields=` request argument. |
|
486 | + * Copied from WordPress 5.3 to support old versions. |
|
487 | + * |
|
488 | + * @since 1.0.19 |
|
489 | + * @param WP_REST_Request $request Full details about the request. |
|
490 | + * @return array Fields to be included in the response. |
|
491 | + */ |
|
492 | + public function get_fields_for_response( $request ) { |
|
493 | + |
|
494 | + // Retrieve fields in the schema. |
|
495 | + $properties = $this->get_schema_properties(); |
|
496 | + |
|
497 | + // Exclude fields that specify a different context than the request context. |
|
498 | + $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
499 | + |
|
500 | + // We only need the field keys. |
|
501 | + $fields = array_keys( $properties ); |
|
502 | + |
|
503 | + // Is the user filtering the response fields?? |
|
504 | + if ( empty( $request['_fields'] ) ) { |
|
505 | + return $fields; |
|
506 | + } |
|
507 | + |
|
508 | + return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
509 | + |
|
510 | + } |
|
511 | + |
|
512 | + /** |
|
513 | + * Limits an object to the requested fields. |
|
514 | + * |
|
515 | + * Included fields are based on the `_fields` request argument. |
|
516 | + * |
|
517 | + * @since 1.0.19 |
|
518 | + * @param array $data Fields to include in the response. |
|
519 | + * @param array $fields Requested fields. |
|
520 | + * @return array Fields to be included in the response. |
|
521 | + */ |
|
522 | + public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
523 | + |
|
524 | + // Is the user filtering the response fields?? |
|
525 | + if ( empty( $fields ) ) { |
|
526 | + return $data; |
|
527 | + } |
|
528 | + |
|
529 | + foreach ( $data as $key => $value ) { |
|
530 | + |
|
531 | + // Numeric arrays. |
|
532 | + if ( is_numeric( $key ) && is_array( $value ) ) { |
|
533 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
534 | + continue; |
|
535 | + } |
|
536 | + |
|
537 | + // Generate a new prefix. |
|
538 | + $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
539 | + |
|
540 | + // Check if it was requested. |
|
541 | + if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
542 | + unset( $data[ $key ] ); |
|
543 | + continue; |
|
544 | + } |
|
545 | + |
|
546 | + if ( $key != 'meta_data' && is_array( $value ) ) { |
|
547 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
548 | + } |
|
549 | 549 | } |
550 | 550 | |
551 | - return $data; |
|
552 | - } |
|
553 | - |
|
554 | - /** |
|
555 | - * Given an array of fields to include in a response, some of which may be |
|
556 | - * `nested.fields`, determine whether the provided field should be included |
|
557 | - * in the response body. |
|
558 | - * |
|
559 | - * Copied from WordPress 5.3 to support old versions. |
|
560 | - * |
|
561 | - * @since 1.0.19 |
|
562 | - * |
|
563 | - * @param string $field A field to test for inclusion in the response body. |
|
564 | - * @param array $fields An array of string fields supported by the endpoint. |
|
565 | - * @return bool Whether to include the field or not. |
|
566 | - * @see rest_is_field_included() |
|
567 | - */ |
|
568 | - public function is_field_included( $field, $fields ) { |
|
569 | - if ( in_array( $field, $fields, true ) ) { |
|
570 | - return true; |
|
571 | - } |
|
572 | - |
|
573 | - foreach ( $fields as $accepted_field ) { |
|
574 | - // Check to see if $field is the parent of any item in $fields. |
|
575 | - // A field "parent" should be accepted if "parent.child" is accepted. |
|
576 | - if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
577 | - return true; |
|
578 | - } |
|
579 | - // Conversely, if "parent" is accepted, all "parent.child" fields |
|
580 | - // should also be accepted. |
|
581 | - if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
582 | - return true; |
|
583 | - } |
|
584 | - } |
|
585 | - |
|
586 | - return false; |
|
587 | - } |
|
551 | + return $data; |
|
552 | + } |
|
553 | + |
|
554 | + /** |
|
555 | + * Given an array of fields to include in a response, some of which may be |
|
556 | + * `nested.fields`, determine whether the provided field should be included |
|
557 | + * in the response body. |
|
558 | + * |
|
559 | + * Copied from WordPress 5.3 to support old versions. |
|
560 | + * |
|
561 | + * @since 1.0.19 |
|
562 | + * |
|
563 | + * @param string $field A field to test for inclusion in the response body. |
|
564 | + * @param array $fields An array of string fields supported by the endpoint. |
|
565 | + * @return bool Whether to include the field or not. |
|
566 | + * @see rest_is_field_included() |
|
567 | + */ |
|
568 | + public function is_field_included( $field, $fields ) { |
|
569 | + if ( in_array( $field, $fields, true ) ) { |
|
570 | + return true; |
|
571 | + } |
|
572 | + |
|
573 | + foreach ( $fields as $accepted_field ) { |
|
574 | + // Check to see if $field is the parent of any item in $fields. |
|
575 | + // A field "parent" should be accepted if "parent.child" is accepted. |
|
576 | + if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
577 | + return true; |
|
578 | + } |
|
579 | + // Conversely, if "parent" is accepted, all "parent.child" fields |
|
580 | + // should also be accepted. |
|
581 | + if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
582 | + return true; |
|
583 | + } |
|
584 | + } |
|
585 | + |
|
586 | + return false; |
|
587 | + } |
|
588 | 588 | |
589 | 589 | } |
@@ -8,7 +8,7 @@ discard block |
||
8 | 8 | * @version 1.0.19 |
9 | 9 | */ |
10 | 10 | |
11 | -defined( 'ABSPATH' ) || exit; |
|
11 | +defined('ABSPATH') || exit; |
|
12 | 12 | |
13 | 13 | /** |
14 | 14 | * Core class to access posts via the REST API. |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | ); |
65 | 65 | |
66 | 66 | // Register REST routes. |
67 | - add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
|
67 | + add_action('rest_api_init', array($this, 'register_routes')); |
|
68 | 68 | |
69 | 69 | } |
70 | 70 | |
@@ -76,8 +76,8 @@ discard block |
||
76 | 76 | */ |
77 | 77 | public function register_routes() { |
78 | 78 | |
79 | - foreach ( $this->namespaces as $namespace ) { |
|
80 | - $this->register_namespace_routes( $namespace ); |
|
79 | + foreach ($this->namespaces as $namespace) { |
|
80 | + $this->register_namespace_routes($namespace); |
|
81 | 81 | } |
82 | 82 | |
83 | 83 | } |
@@ -89,12 +89,12 @@ discard block |
||
89 | 89 | * |
90 | 90 | * @param string $namespace |
91 | 91 | */ |
92 | - public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
92 | + public function register_namespace_routes(/** @scrutinizer ignore-unused */ $namespace) { |
|
93 | 93 | |
94 | 94 | getpaid_doing_it_wrong( |
95 | 95 | __CLASS__ . '::' . __METHOD__, |
96 | 96 | /* translators: %s: register_namespace_routes() */ |
97 | - sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
97 | + sprintf(__("Method '%s' must be overridden."), __METHOD__), |
|
98 | 98 | '1.0.19' |
99 | 99 | ); |
100 | 100 | |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | * @return string |
107 | 107 | */ |
108 | 108 | protected function get_normalized_rest_base() { |
109 | - return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
109 | + return preg_replace('/\(.*\)\//i', '', $this->rest_base); |
|
110 | 110 | } |
111 | 111 | |
112 | 112 | /** |
@@ -115,11 +115,11 @@ discard block |
||
115 | 115 | * @param array array of request items. |
116 | 116 | * @return array |
117 | 117 | */ |
118 | - protected function fill_batch_keys( $items ) { |
|
118 | + protected function fill_batch_keys($items) { |
|
119 | 119 | |
120 | - $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
121 | - $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
122 | - $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
120 | + $items['create'] = empty($items['create']) ? array() : $items['create']; |
|
121 | + $items['update'] = empty($items['update']) ? array() : $items['update']; |
|
122 | + $items['delete'] = empty($items['delete']) ? array() : wp_parse_id_list($items['delete']); |
|
123 | 123 | return $items; |
124 | 124 | |
125 | 125 | } |
@@ -130,13 +130,13 @@ discard block |
||
130 | 130 | * @param array $items Request items. |
131 | 131 | * @return bool|WP_Error |
132 | 132 | */ |
133 | - protected function check_batch_limit( $items ) { |
|
134 | - $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
135 | - $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
133 | + protected function check_batch_limit($items) { |
|
134 | + $limit = apply_filters('getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base()); |
|
135 | + $total = count($items['create']) + count($items['update']) + count($items['delete']); |
|
136 | 136 | |
137 | - if ( $total > $limit ) { |
|
137 | + if ($total > $limit) { |
|
138 | 138 | /* translators: %s: items limit */ |
139 | - return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
139 | + return new WP_Error('getpaid_rest_request_entity_too_large', sprintf(__('Unable to accept more than %s items for this request.', 'invoicing'), $limit), array('status' => 413)); |
|
140 | 140 | } |
141 | 141 | |
142 | 142 | return true; |
@@ -150,37 +150,37 @@ discard block |
||
150 | 150 | * @param WP_REST_Server $wp_rest_server |
151 | 151 | * @return array() |
152 | 152 | */ |
153 | - protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
153 | + protected function batch_create_items($items, $request, $wp_rest_server) { |
|
154 | 154 | |
155 | 155 | $query = $request->get_query_params(); |
156 | 156 | $create = array(); |
157 | 157 | |
158 | - foreach ( $items as $item ) { |
|
159 | - $_item = new WP_REST_Request( 'POST' ); |
|
158 | + foreach ($items as $item) { |
|
159 | + $_item = new WP_REST_Request('POST'); |
|
160 | 160 | |
161 | 161 | // Default parameters. |
162 | 162 | $defaults = array(); |
163 | 163 | $schema = $this->get_public_item_schema(); |
164 | - foreach ( $schema['properties'] as $arg => $options ) { |
|
165 | - if ( isset( $options['default'] ) ) { |
|
166 | - $defaults[ $arg ] = $options['default']; |
|
164 | + foreach ($schema['properties'] as $arg => $options) { |
|
165 | + if (isset($options['default'])) { |
|
166 | + $defaults[$arg] = $options['default']; |
|
167 | 167 | } |
168 | 168 | } |
169 | - $_item->set_default_params( $defaults ); |
|
169 | + $_item->set_default_params($defaults); |
|
170 | 170 | |
171 | 171 | // Set request parameters. |
172 | - $_item->set_body_params( $item ); |
|
172 | + $_item->set_body_params($item); |
|
173 | 173 | |
174 | 174 | // Set query (GET) parameters. |
175 | - $_item->set_query_params( $query ); |
|
175 | + $_item->set_query_params($query); |
|
176 | 176 | |
177 | 177 | // Create the item. |
178 | - $_response = $this->create_item( $_item ); |
|
178 | + $_response = $this->create_item($_item); |
|
179 | 179 | |
180 | 180 | // If an error occured... |
181 | - if ( is_wp_error( $_response ) ) { |
|
181 | + if (is_wp_error($_response)) { |
|
182 | 182 | |
183 | - $create[] = array( |
|
183 | + $create[] = array( |
|
184 | 184 | 'id' => 0, |
185 | 185 | 'error' => array( |
186 | 186 | 'code' => $_response->get_error_code(), |
@@ -192,7 +192,7 @@ discard block |
||
192 | 192 | continue; |
193 | 193 | } |
194 | 194 | |
195 | - $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
195 | + $create[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
196 | 196 | |
197 | 197 | } |
198 | 198 | |
@@ -208,27 +208,27 @@ discard block |
||
208 | 208 | * @param WP_REST_Server $wp_rest_server |
209 | 209 | * @return array() |
210 | 210 | */ |
211 | - protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
211 | + protected function batch_update_items($items, $request, $wp_rest_server) { |
|
212 | 212 | |
213 | 213 | $query = $request->get_query_params(); |
214 | 214 | $update = array(); |
215 | 215 | |
216 | - foreach ( $items as $item ) { |
|
216 | + foreach ($items as $item) { |
|
217 | 217 | |
218 | 218 | // Create a dummy request. |
219 | - $_item = new WP_REST_Request( 'PUT' ); |
|
219 | + $_item = new WP_REST_Request('PUT'); |
|
220 | 220 | |
221 | 221 | // Add body params. |
222 | - $_item->set_body_params( $item ); |
|
222 | + $_item->set_body_params($item); |
|
223 | 223 | |
224 | 224 | // Set query (GET) parameters. |
225 | - $_item->set_query_params( $query ); |
|
225 | + $_item->set_query_params($query); |
|
226 | 226 | |
227 | 227 | // Update the item. |
228 | - $_response = $this->update_item( $_item ); |
|
228 | + $_response = $this->update_item($_item); |
|
229 | 229 | |
230 | 230 | // If an error occured... |
231 | - if ( is_wp_error( $_response ) ) { |
|
231 | + if (is_wp_error($_response)) { |
|
232 | 232 | |
233 | 233 | $update[] = array( |
234 | 234 | 'id' => $item['id'], |
@@ -243,7 +243,7 @@ discard block |
||
243 | 243 | |
244 | 244 | } |
245 | 245 | |
246 | - $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
246 | + $update[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
247 | 247 | |
248 | 248 | } |
249 | 249 | |
@@ -258,14 +258,14 @@ discard block |
||
258 | 258 | * @param WP_REST_Server $wp_rest_server |
259 | 259 | * @return array() |
260 | 260 | */ |
261 | - protected function batch_delete_items( $items, $wp_rest_server ) { |
|
261 | + protected function batch_delete_items($items, $wp_rest_server) { |
|
262 | 262 | |
263 | 263 | $delete = array(); |
264 | 264 | |
265 | - foreach ( array_filter( $items ) as $id ) { |
|
265 | + foreach (array_filter($items) as $id) { |
|
266 | 266 | |
267 | 267 | // Prepare the request. |
268 | - $_item = new WP_REST_Request( 'DELETE' ); |
|
268 | + $_item = new WP_REST_Request('DELETE'); |
|
269 | 269 | $_item->set_query_params( |
270 | 270 | array( |
271 | 271 | 'id' => $id, |
@@ -274,9 +274,9 @@ discard block |
||
274 | 274 | ); |
275 | 275 | |
276 | 276 | // Delete the item. |
277 | - $_response = $this->delete_item( $_item ); |
|
277 | + $_response = $this->delete_item($_item); |
|
278 | 278 | |
279 | - if ( is_wp_error( $_response ) ) { |
|
279 | + if (is_wp_error($_response)) { |
|
280 | 280 | |
281 | 281 | $delete[] = array( |
282 | 282 | 'id' => $id, |
@@ -290,7 +290,7 @@ discard block |
||
290 | 290 | continue; |
291 | 291 | } |
292 | 292 | |
293 | - $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
293 | + $delete[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false); |
|
294 | 294 | |
295 | 295 | } |
296 | 296 | |
@@ -304,23 +304,23 @@ discard block |
||
304 | 304 | * @param WP_REST_Request $request Full details about the request. |
305 | 305 | * @return WP_Error|array. |
306 | 306 | */ |
307 | - public function batch_items( $request ) { |
|
307 | + public function batch_items($request) { |
|
308 | 308 | global $wp_rest_server; |
309 | 309 | |
310 | 310 | // Prepare the batch items. |
311 | - $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
311 | + $items = $this->fill_batch_keys(array_filter($request->get_params())); |
|
312 | 312 | |
313 | 313 | // Ensure that the batch has not exceeded the limit to prevent abuse. |
314 | - $limit = $this->check_batch_limit( $items ); |
|
315 | - if ( is_wp_error( $limit ) ) { |
|
314 | + $limit = $this->check_batch_limit($items); |
|
315 | + if (is_wp_error($limit)) { |
|
316 | 316 | return $limit; |
317 | 317 | } |
318 | 318 | |
319 | 319 | // Process the items. |
320 | 320 | return array( |
321 | - 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
322 | - 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
323 | - 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
321 | + 'create' => $this->batch_create_items($items['create'], $request, $wp_rest_server), |
|
322 | + 'update' => $this->batch_update_items($items['update'], $request, $wp_rest_server), |
|
323 | + 'delete' => $this->batch_delete_items($items['delete'], $wp_rest_server), |
|
324 | 324 | ); |
325 | 325 | |
326 | 326 | } |
@@ -333,8 +333,8 @@ discard block |
||
333 | 333 | * @param array $meta_query Meta query. |
334 | 334 | * @return array |
335 | 335 | */ |
336 | - protected function add_meta_query( $args, $meta_query ) { |
|
337 | - if ( empty( $args['meta_query'] ) ) { |
|
336 | + protected function add_meta_query($args, $meta_query) { |
|
337 | + if (empty($args['meta_query'])) { |
|
338 | 338 | $args['meta_query'] = array(); |
339 | 339 | } |
340 | 340 | |
@@ -356,25 +356,25 @@ discard block |
||
356 | 356 | 'type' => 'object', |
357 | 357 | 'properties' => array( |
358 | 358 | 'create' => array( |
359 | - 'description' => __( 'List of created resources.', 'invoicing' ), |
|
359 | + 'description' => __('List of created resources.', 'invoicing'), |
|
360 | 360 | 'type' => 'array', |
361 | - 'context' => array( 'view', 'edit' ), |
|
361 | + 'context' => array('view', 'edit'), |
|
362 | 362 | 'items' => array( |
363 | 363 | 'type' => 'object', |
364 | 364 | ), |
365 | 365 | ), |
366 | 366 | 'update' => array( |
367 | - 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
367 | + 'description' => __('List of updated resources.', 'invoicing'), |
|
368 | 368 | 'type' => 'array', |
369 | - 'context' => array( 'view', 'edit' ), |
|
369 | + 'context' => array('view', 'edit'), |
|
370 | 370 | 'items' => array( |
371 | 371 | 'type' => 'object', |
372 | 372 | ), |
373 | 373 | ), |
374 | 374 | 'delete' => array( |
375 | - 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
375 | + 'description' => __('List of deleted resources.', 'invoicing'), |
|
376 | 376 | 'type' => 'array', |
377 | - 'context' => array( 'view', 'edit' ), |
|
377 | + 'context' => array('view', 'edit'), |
|
378 | 378 | 'items' => array( |
379 | 379 | 'type' => 'integer', |
380 | 380 | ), |
@@ -395,13 +395,13 @@ discard block |
||
395 | 395 | protected function get_schema_properties() { |
396 | 396 | |
397 | 397 | $schema = $this->get_item_schema(); |
398 | - $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
398 | + $properties = isset($schema['properties']) ? $schema['properties'] : array(); |
|
399 | 399 | |
400 | 400 | // For back-compat, include any field with an empty schema |
401 | 401 | // because it won't be present in $this->get_item_schema(). |
402 | - foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
403 | - if ( is_null( $field_options['schema'] ) ) { |
|
404 | - $properties[ $field_name ] = $field_options; |
|
402 | + foreach ($this->get_additional_fields() as $field_name => $field_options) { |
|
403 | + if (is_null($field_options['schema'])) { |
|
404 | + $properties[$field_name] = $field_options; |
|
405 | 405 | } |
406 | 406 | } |
407 | 407 | |
@@ -416,15 +416,15 @@ discard block |
||
416 | 416 | * @since 1.0.19 |
417 | 417 | * @return array |
418 | 418 | */ |
419 | - protected function filter_response_fields_by_context( $fields, $context ) { |
|
419 | + protected function filter_response_fields_by_context($fields, $context) { |
|
420 | 420 | |
421 | - if ( empty( $context ) ) { |
|
421 | + if (empty($context)) { |
|
422 | 422 | return $fields; |
423 | 423 | } |
424 | 424 | |
425 | - foreach ( $fields as $name => $options ) { |
|
426 | - if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
427 | - unset( $fields[ $name ] ); |
|
425 | + foreach ($fields as $name => $options) { |
|
426 | + if (!empty($options['context']) && !in_array($context, $options['context'], true)) { |
|
427 | + unset($fields[$name]); |
|
428 | 428 | } |
429 | 429 | } |
430 | 430 | |
@@ -440,35 +440,35 @@ discard block |
||
440 | 440 | * @since 1.0.19 |
441 | 441 | * @return array |
442 | 442 | */ |
443 | - protected function filter_response_fields_by_array( $fields, $requested ) { |
|
443 | + protected function filter_response_fields_by_array($fields, $requested) { |
|
444 | 444 | |
445 | 445 | // Trim off any whitespace from the list array. |
446 | - $requested = array_map( 'trim', $requested ); |
|
446 | + $requested = array_map('trim', $requested); |
|
447 | 447 | |
448 | 448 | // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
449 | - if ( in_array( 'id', $fields, true ) ) { |
|
449 | + if (in_array('id', $fields, true)) { |
|
450 | 450 | $requested[] = 'id'; |
451 | 451 | } |
452 | 452 | |
453 | 453 | // Get rid of duplicate fields. |
454 | - $requested = array_unique( $requested ); |
|
454 | + $requested = array_unique($requested); |
|
455 | 455 | |
456 | 456 | // Return the list of all included fields which are available. |
457 | 457 | return array_reduce( |
458 | 458 | $requested, |
459 | - function( $response_fields, $field ) use ( $fields ) { |
|
459 | + function($response_fields, $field) use ($fields) { |
|
460 | 460 | |
461 | - if ( in_array( $field, $fields, true ) ) { |
|
461 | + if (in_array($field, $fields, true)) { |
|
462 | 462 | $response_fields[] = $field; |
463 | 463 | return $response_fields; |
464 | 464 | } |
465 | 465 | |
466 | 466 | // Check for nested fields if $field is not a direct match. |
467 | - $nested_fields = explode( '.', $field ); |
|
467 | + $nested_fields = explode('.', $field); |
|
468 | 468 | |
469 | 469 | // A nested field is included so long as its top-level property is |
470 | 470 | // present in the schema. |
471 | - if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
471 | + if (in_array($nested_fields[0], $fields, true)) { |
|
472 | 472 | $response_fields[] = $field; |
473 | 473 | } |
474 | 474 | |
@@ -489,23 +489,23 @@ discard block |
||
489 | 489 | * @param WP_REST_Request $request Full details about the request. |
490 | 490 | * @return array Fields to be included in the response. |
491 | 491 | */ |
492 | - public function get_fields_for_response( $request ) { |
|
492 | + public function get_fields_for_response($request) { |
|
493 | 493 | |
494 | 494 | // Retrieve fields in the schema. |
495 | 495 | $properties = $this->get_schema_properties(); |
496 | 496 | |
497 | 497 | // Exclude fields that specify a different context than the request context. |
498 | - $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
498 | + $properties = $this->filter_response_fields_by_context($properties, $request['context']); |
|
499 | 499 | |
500 | 500 | // We only need the field keys. |
501 | - $fields = array_keys( $properties ); |
|
501 | + $fields = array_keys($properties); |
|
502 | 502 | |
503 | 503 | // Is the user filtering the response fields?? |
504 | - if ( empty( $request['_fields'] ) ) { |
|
504 | + if (empty($request['_fields'])) { |
|
505 | 505 | return $fields; |
506 | 506 | } |
507 | 507 | |
508 | - return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
508 | + return $this->filter_response_fields_by_array($fields, wpinv_parse_list($request['_fields'])); |
|
509 | 509 | |
510 | 510 | } |
511 | 511 | |
@@ -519,32 +519,32 @@ discard block |
||
519 | 519 | * @param array $fields Requested fields. |
520 | 520 | * @return array Fields to be included in the response. |
521 | 521 | */ |
522 | - public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
522 | + public function limit_object_to_requested_fields($data, $fields, $prefix = '') { |
|
523 | 523 | |
524 | 524 | // Is the user filtering the response fields?? |
525 | - if ( empty( $fields ) ) { |
|
525 | + if (empty($fields)) { |
|
526 | 526 | return $data; |
527 | 527 | } |
528 | 528 | |
529 | - foreach ( $data as $key => $value ) { |
|
529 | + foreach ($data as $key => $value) { |
|
530 | 530 | |
531 | 531 | // Numeric arrays. |
532 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
533 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
532 | + if (is_numeric($key) && is_array($value)) { |
|
533 | + $data[$key] = $this->limit_object_to_requested_fields($value, $fields, $prefix); |
|
534 | 534 | continue; |
535 | 535 | } |
536 | 536 | |
537 | 537 | // Generate a new prefix. |
538 | - $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
538 | + $new_prefix = empty($prefix) ? $key : "$prefix.$key"; |
|
539 | 539 | |
540 | 540 | // Check if it was requested. |
541 | - if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
542 | - unset( $data[ $key ] ); |
|
541 | + if (!empty($key) && !$this->is_field_included($new_prefix, $fields)) { |
|
542 | + unset($data[$key]); |
|
543 | 543 | continue; |
544 | 544 | } |
545 | 545 | |
546 | - if ( $key != 'meta_data' && is_array( $value ) ) { |
|
547 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
546 | + if ($key != 'meta_data' && is_array($value)) { |
|
547 | + $data[$key] = $this->limit_object_to_requested_fields($value, $fields, $new_prefix); |
|
548 | 548 | } |
549 | 549 | } |
550 | 550 | |
@@ -565,20 +565,20 @@ discard block |
||
565 | 565 | * @return bool Whether to include the field or not. |
566 | 566 | * @see rest_is_field_included() |
567 | 567 | */ |
568 | - public function is_field_included( $field, $fields ) { |
|
569 | - if ( in_array( $field, $fields, true ) ) { |
|
568 | + public function is_field_included($field, $fields) { |
|
569 | + if (in_array($field, $fields, true)) { |
|
570 | 570 | return true; |
571 | 571 | } |
572 | 572 | |
573 | - foreach ( $fields as $accepted_field ) { |
|
573 | + foreach ($fields as $accepted_field) { |
|
574 | 574 | // Check to see if $field is the parent of any item in $fields. |
575 | 575 | // A field "parent" should be accepted if "parent.child" is accepted. |
576 | - if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
576 | + if (strpos($accepted_field, "$field.") === 0) { |
|
577 | 577 | return true; |
578 | 578 | } |
579 | 579 | // Conversely, if "parent" is accepted, all "parent.child" fields |
580 | 580 | // should also be accepted. |
581 | - if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
581 | + if (strpos($field, "$accepted_field.") === 0) { |
|
582 | 582 | return true; |
583 | 583 | } |
584 | 584 | } |
@@ -18,756 +18,756 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * An array of available settings. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $settings; |
|
27 | - |
|
28 | - /** |
|
29 | - * Route base. |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $rest_base = 'settings'; |
|
34 | - |
|
35 | - /** |
|
36 | - * Registers the routes for the objects of the controller. |
|
37 | - * |
|
38 | - * @since 2.0.0 |
|
39 | - * |
|
40 | - * @see register_rest_route() |
|
41 | - */ |
|
42 | - public function register_namespace_routes( $namespace ) { |
|
43 | - |
|
44 | - // List all registered tabs. |
|
45 | - register_rest_route( |
|
46 | - $namespace, |
|
47 | - $this->rest_base, |
|
48 | - array( |
|
49 | - array( |
|
50 | - 'methods' => WP_REST_Server::READABLE, |
|
51 | - 'callback' => array( $this, 'get_tabs' ), |
|
52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | - ), |
|
54 | - 'schema' => '__return_empty_array', |
|
55 | - ) |
|
56 | - ); |
|
57 | - |
|
58 | - // View/Update a single setting. |
|
59 | - register_rest_route( |
|
60 | - $namespace, |
|
61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | - array( |
|
63 | - 'args' => array( |
|
64 | - 'id' => array( |
|
65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | - 'type' => 'string', |
|
67 | - 'required' => true, |
|
68 | - ), |
|
69 | - ), |
|
70 | - array( |
|
71 | - 'methods' => WP_REST_Server::READABLE, |
|
72 | - 'callback' => array( $this, 'get_item' ), |
|
73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | - ), |
|
75 | - array( |
|
76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
77 | - 'callback' => array( $this, 'update_item' ), |
|
78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | - ), |
|
81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | - ) |
|
83 | - ); |
|
84 | - |
|
85 | - // List registered sections for a given tab. |
|
86 | - register_rest_route( |
|
87 | - $namespace, |
|
88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | - array( |
|
90 | - 'args' => array( |
|
91 | - 'tab' => array( |
|
92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | - 'type' => 'string', |
|
94 | - 'required' => true, |
|
95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | - ), |
|
97 | - ), |
|
98 | - array( |
|
99 | - 'methods' => WP_REST_Server::READABLE, |
|
100 | - 'callback' => array( $this, 'get_sections' ), |
|
101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | - ), |
|
103 | - 'schema' => '__return_empty_array', |
|
104 | - ) |
|
105 | - ); |
|
106 | - |
|
107 | - // List all registered settings for a given tab. |
|
108 | - register_rest_route( |
|
109 | - $namespace, |
|
110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | - array( |
|
112 | - 'args' => array( |
|
113 | - 'tab' => array( |
|
114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'required' => true, |
|
117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | - ), |
|
119 | - 'section' => array( |
|
120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | - 'type' => 'string', |
|
122 | - 'required' => true, |
|
123 | - ), |
|
124 | - ), |
|
125 | - array( |
|
126 | - 'methods' => WP_REST_Server::READABLE, |
|
127 | - 'callback' => array( $this, 'get_items' ), |
|
128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | - ), |
|
130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | - ) |
|
132 | - ); |
|
133 | - |
|
134 | - register_rest_route( |
|
135 | - $namespace, |
|
136 | - '/' . $this->rest_base . '/batch', |
|
137 | - array( |
|
138 | - 'args' => array( |
|
139 | - 'id' => array( |
|
140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - ), |
|
143 | - ), |
|
144 | - array( |
|
145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
146 | - 'callback' => array( $this, 'batch_items' ), |
|
147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | - ), |
|
150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | - ) |
|
152 | - ); |
|
153 | - |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Return all settings. |
|
158 | - * |
|
159 | - * @since 2.0.0 |
|
160 | - * @param WP_REST_Request $request Request data. |
|
161 | - * @return WP_Error|WP_REST_Response |
|
162 | - */ |
|
163 | - public function get_items( $request ) { |
|
164 | - |
|
165 | - $settings = $this->get_settings(); |
|
166 | - |
|
167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | - } |
|
170 | - |
|
171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | - } |
|
174 | - |
|
175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | - $prepared = array(); |
|
177 | - |
|
178 | - foreach ( $settings as $setting ) { |
|
179 | - |
|
180 | - $setting = $this->sanitize_setting( $setting ); |
|
181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | - |
|
184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | - $prepared[] = $setting_data; |
|
186 | - } |
|
21 | + /** |
|
22 | + * An array of available settings. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $settings; |
|
27 | + |
|
28 | + /** |
|
29 | + * Route base. |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $rest_base = 'settings'; |
|
34 | + |
|
35 | + /** |
|
36 | + * Registers the routes for the objects of the controller. |
|
37 | + * |
|
38 | + * @since 2.0.0 |
|
39 | + * |
|
40 | + * @see register_rest_route() |
|
41 | + */ |
|
42 | + public function register_namespace_routes( $namespace ) { |
|
43 | + |
|
44 | + // List all registered tabs. |
|
45 | + register_rest_route( |
|
46 | + $namespace, |
|
47 | + $this->rest_base, |
|
48 | + array( |
|
49 | + array( |
|
50 | + 'methods' => WP_REST_Server::READABLE, |
|
51 | + 'callback' => array( $this, 'get_tabs' ), |
|
52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | + ), |
|
54 | + 'schema' => '__return_empty_array', |
|
55 | + ) |
|
56 | + ); |
|
57 | + |
|
58 | + // View/Update a single setting. |
|
59 | + register_rest_route( |
|
60 | + $namespace, |
|
61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | + array( |
|
63 | + 'args' => array( |
|
64 | + 'id' => array( |
|
65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | + 'type' => 'string', |
|
67 | + 'required' => true, |
|
68 | + ), |
|
69 | + ), |
|
70 | + array( |
|
71 | + 'methods' => WP_REST_Server::READABLE, |
|
72 | + 'callback' => array( $this, 'get_item' ), |
|
73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | + ), |
|
75 | + array( |
|
76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
77 | + 'callback' => array( $this, 'update_item' ), |
|
78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | + ), |
|
81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | + ) |
|
83 | + ); |
|
84 | + |
|
85 | + // List registered sections for a given tab. |
|
86 | + register_rest_route( |
|
87 | + $namespace, |
|
88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | + array( |
|
90 | + 'args' => array( |
|
91 | + 'tab' => array( |
|
92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | + 'type' => 'string', |
|
94 | + 'required' => true, |
|
95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | + ), |
|
97 | + ), |
|
98 | + array( |
|
99 | + 'methods' => WP_REST_Server::READABLE, |
|
100 | + 'callback' => array( $this, 'get_sections' ), |
|
101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | + ), |
|
103 | + 'schema' => '__return_empty_array', |
|
104 | + ) |
|
105 | + ); |
|
106 | + |
|
107 | + // List all registered settings for a given tab. |
|
108 | + register_rest_route( |
|
109 | + $namespace, |
|
110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | + array( |
|
112 | + 'args' => array( |
|
113 | + 'tab' => array( |
|
114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'required' => true, |
|
117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | + ), |
|
119 | + 'section' => array( |
|
120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | + 'type' => 'string', |
|
122 | + 'required' => true, |
|
123 | + ), |
|
124 | + ), |
|
125 | + array( |
|
126 | + 'methods' => WP_REST_Server::READABLE, |
|
127 | + 'callback' => array( $this, 'get_items' ), |
|
128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | + ), |
|
130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | + ) |
|
132 | + ); |
|
133 | + |
|
134 | + register_rest_route( |
|
135 | + $namespace, |
|
136 | + '/' . $this->rest_base . '/batch', |
|
137 | + array( |
|
138 | + 'args' => array( |
|
139 | + 'id' => array( |
|
140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + ), |
|
143 | + ), |
|
144 | + array( |
|
145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
146 | + 'callback' => array( $this, 'batch_items' ), |
|
147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | + ), |
|
150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | + ) |
|
152 | + ); |
|
153 | + |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Return all settings. |
|
158 | + * |
|
159 | + * @since 2.0.0 |
|
160 | + * @param WP_REST_Request $request Request data. |
|
161 | + * @return WP_Error|WP_REST_Response |
|
162 | + */ |
|
163 | + public function get_items( $request ) { |
|
164 | + |
|
165 | + $settings = $this->get_settings(); |
|
166 | + |
|
167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | + } |
|
170 | + |
|
171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | + } |
|
174 | + |
|
175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | + $prepared = array(); |
|
177 | + |
|
178 | + foreach ( $settings as $setting ) { |
|
179 | + |
|
180 | + $setting = $this->sanitize_setting( $setting ); |
|
181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | + |
|
184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | + $prepared[] = $setting_data; |
|
186 | + } |
|
187 | 187 | } |
188 | 188 | |
189 | - return rest_ensure_response( $prepared ); |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * Return a single setting. |
|
194 | - * |
|
195 | - * @since 2.0.0 |
|
196 | - * @param WP_REST_Request $request Request data. |
|
197 | - * @return WP_Error|WP_REST_Response |
|
198 | - */ |
|
199 | - public function get_item( $request ) { |
|
200 | - $setting = $this->get_setting( $request['id'] ); |
|
201 | - |
|
202 | - if ( is_wp_error( $setting ) ) { |
|
203 | - return $setting; |
|
204 | - } |
|
205 | - |
|
206 | - $setting = $this->sanitize_setting( $setting ); |
|
207 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
208 | - return rest_ensure_response( $response ); |
|
209 | - } |
|
210 | - |
|
211 | - /** |
|
212 | - * Update a single setting. |
|
213 | - * |
|
214 | - * @since 2.0.0 |
|
215 | - * @param WP_REST_Request $request Request data. |
|
216 | - * @return WP_Error|WP_REST_Response |
|
217 | - */ |
|
218 | - public function update_item( $request ) { |
|
219 | - $setting = $this->get_setting( $request['id'] ); |
|
220 | - |
|
221 | - if ( is_wp_error( $setting ) ) { |
|
222 | - return $setting; |
|
223 | - } |
|
224 | - |
|
225 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
226 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
227 | - } else { |
|
228 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
229 | - } |
|
230 | - |
|
231 | - if ( is_wp_error( $value ) ) { |
|
232 | - return $value; |
|
233 | - } |
|
234 | - |
|
235 | - wpinv_update_option( $request['id'], $value ); |
|
236 | - $setting['value'] = $value; |
|
237 | - $setting = $this->sanitize_setting( $setting ); |
|
238 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
239 | - |
|
240 | - return rest_ensure_response( $response ); |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Makes sure the current user has access to READ the settings APIs. |
|
245 | - * |
|
246 | - * @since 2.0.0 |
|
247 | - * @param WP_REST_Request $request Full data about the request. |
|
248 | - * @return WP_Error|boolean |
|
249 | - */ |
|
250 | - public function get_items_permissions_check( $request ) { |
|
251 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
252 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
253 | - } |
|
254 | - |
|
255 | - return true; |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
260 | - * |
|
261 | - * @since 2.0.0 |
|
262 | - * @param WP_REST_Request $request Full data about the request. |
|
263 | - * @return WP_Error|boolean |
|
264 | - */ |
|
265 | - public function update_items_permissions_check( $request ) { |
|
266 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
267 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
268 | - } |
|
269 | - |
|
270 | - return true; |
|
271 | - } |
|
272 | - |
|
273 | - /** |
|
274 | - * Check if a given request has access batch create, update and delete items. |
|
275 | - * |
|
276 | - * @param WP_REST_Request $request Full details about the request. |
|
277 | - * |
|
278 | - * @return boolean|WP_Error |
|
279 | - */ |
|
280 | - public function batch_items_permissions_check( $request ) { |
|
281 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
282 | - } |
|
283 | - |
|
284 | - /** |
|
285 | - * Prepare links for the request. |
|
286 | - * |
|
287 | - * @param string $setting_id Setting ID. |
|
288 | - * @return array Links for the given setting. |
|
289 | - */ |
|
290 | - protected function prepare_links( $setting_id ) { |
|
291 | - |
|
292 | - $links = array( |
|
293 | - 'self' => array( |
|
294 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
295 | - ), |
|
296 | - 'collection' => array( |
|
297 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
298 | - ), |
|
299 | - ); |
|
300 | - |
|
301 | - return $links; |
|
302 | - } |
|
303 | - |
|
304 | - /** |
|
305 | - * Prepare a settings object for serialization. |
|
306 | - * |
|
307 | - * @since 2.0.0 |
|
308 | - * @param array $item Setting object. |
|
309 | - * @param WP_REST_Request $request Request object. |
|
310 | - * @return WP_REST_Response $response Response data. |
|
311 | - */ |
|
312 | - public function prepare_item_for_response( $item, $request ) { |
|
313 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
314 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
315 | - $data = $this->filter_response_by_context( $data, $context ); |
|
316 | - |
|
317 | - $response = rest_ensure_response( $data ); |
|
318 | - |
|
319 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
320 | - |
|
321 | - return $response; |
|
322 | - } |
|
323 | - |
|
324 | - /** |
|
325 | - * Filters out bad values from the settings array/filter so we |
|
326 | - * only return known values via the API. |
|
327 | - * |
|
328 | - * @since 2.0.0 |
|
329 | - * @param array $setting Setting. |
|
330 | - * @return array |
|
331 | - */ |
|
332 | - public function filter_setting( $setting ) { |
|
333 | - return array_intersect_key( |
|
334 | - $setting, |
|
335 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
336 | - ); |
|
337 | - } |
|
338 | - |
|
339 | - /** |
|
340 | - * Callback for allowed keys for each setting response. |
|
341 | - * |
|
342 | - * @param string $key Key to check. |
|
343 | - * @return boolean |
|
344 | - */ |
|
345 | - public function allowed_setting_keys( $key ) { |
|
346 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Returns default options for a setting. null means the field is required. |
|
351 | - * |
|
352 | - * @since 2.0.0 |
|
353 | - * @return array |
|
354 | - */ |
|
355 | - protected function setting_defaults() { |
|
356 | - return array( |
|
357 | - 'id' => null, |
|
358 | - 'name' => null, |
|
359 | - 'desc' => '', |
|
360 | - 'options' => array(), |
|
361 | - 'std' => false, |
|
362 | - 'value' => false, |
|
363 | - 'placeholder' => '', |
|
364 | - 'readonly' => false, |
|
365 | - 'faux' => false, |
|
366 | - 'section' => 'main', |
|
367 | - 'tab' => 'general', |
|
368 | - 'type' => 'text', |
|
369 | - ); |
|
370 | - } |
|
371 | - |
|
372 | - /** |
|
373 | - * Sanitizes a setting's field. |
|
374 | - * |
|
375 | - * @param array $setting The setting to sanitize. |
|
376 | - * @return array |
|
377 | - */ |
|
378 | - public function sanitize_setting( $setting ) { |
|
379 | - |
|
380 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
381 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
382 | - return $this->filter_setting( $setting ); |
|
383 | - |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Get setting data. |
|
388 | - * |
|
389 | - * @since 2.0.0 |
|
390 | - * @param string $setting_id Setting ID. |
|
391 | - * @return array|WP_Error |
|
392 | - */ |
|
393 | - public function get_setting( $setting_id ) { |
|
394 | - |
|
395 | - if ( empty( $setting_id ) ) { |
|
396 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
397 | - } |
|
398 | - |
|
399 | - $settings = $this->get_settings(); |
|
400 | - |
|
401 | - foreach ( $settings as $tabs ) { |
|
402 | - |
|
403 | - foreach ( $tabs as $sections ) { |
|
404 | - |
|
405 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
406 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
407 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
408 | - } |
|
409 | - |
|
410 | - return $sections[ $setting_id ]; |
|
411 | - } |
|
189 | + return rest_ensure_response( $prepared ); |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * Return a single setting. |
|
194 | + * |
|
195 | + * @since 2.0.0 |
|
196 | + * @param WP_REST_Request $request Request data. |
|
197 | + * @return WP_Error|WP_REST_Response |
|
198 | + */ |
|
199 | + public function get_item( $request ) { |
|
200 | + $setting = $this->get_setting( $request['id'] ); |
|
201 | + |
|
202 | + if ( is_wp_error( $setting ) ) { |
|
203 | + return $setting; |
|
204 | + } |
|
205 | + |
|
206 | + $setting = $this->sanitize_setting( $setting ); |
|
207 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
208 | + return rest_ensure_response( $response ); |
|
209 | + } |
|
210 | + |
|
211 | + /** |
|
212 | + * Update a single setting. |
|
213 | + * |
|
214 | + * @since 2.0.0 |
|
215 | + * @param WP_REST_Request $request Request data. |
|
216 | + * @return WP_Error|WP_REST_Response |
|
217 | + */ |
|
218 | + public function update_item( $request ) { |
|
219 | + $setting = $this->get_setting( $request['id'] ); |
|
220 | + |
|
221 | + if ( is_wp_error( $setting ) ) { |
|
222 | + return $setting; |
|
223 | + } |
|
224 | + |
|
225 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
226 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
227 | + } else { |
|
228 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
229 | + } |
|
230 | + |
|
231 | + if ( is_wp_error( $value ) ) { |
|
232 | + return $value; |
|
233 | + } |
|
234 | + |
|
235 | + wpinv_update_option( $request['id'], $value ); |
|
236 | + $setting['value'] = $value; |
|
237 | + $setting = $this->sanitize_setting( $setting ); |
|
238 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
239 | + |
|
240 | + return rest_ensure_response( $response ); |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Makes sure the current user has access to READ the settings APIs. |
|
245 | + * |
|
246 | + * @since 2.0.0 |
|
247 | + * @param WP_REST_Request $request Full data about the request. |
|
248 | + * @return WP_Error|boolean |
|
249 | + */ |
|
250 | + public function get_items_permissions_check( $request ) { |
|
251 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
252 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
253 | + } |
|
254 | + |
|
255 | + return true; |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
260 | + * |
|
261 | + * @since 2.0.0 |
|
262 | + * @param WP_REST_Request $request Full data about the request. |
|
263 | + * @return WP_Error|boolean |
|
264 | + */ |
|
265 | + public function update_items_permissions_check( $request ) { |
|
266 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
267 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
268 | + } |
|
269 | + |
|
270 | + return true; |
|
271 | + } |
|
272 | + |
|
273 | + /** |
|
274 | + * Check if a given request has access batch create, update and delete items. |
|
275 | + * |
|
276 | + * @param WP_REST_Request $request Full details about the request. |
|
277 | + * |
|
278 | + * @return boolean|WP_Error |
|
279 | + */ |
|
280 | + public function batch_items_permissions_check( $request ) { |
|
281 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
282 | + } |
|
283 | + |
|
284 | + /** |
|
285 | + * Prepare links for the request. |
|
286 | + * |
|
287 | + * @param string $setting_id Setting ID. |
|
288 | + * @return array Links for the given setting. |
|
289 | + */ |
|
290 | + protected function prepare_links( $setting_id ) { |
|
291 | + |
|
292 | + $links = array( |
|
293 | + 'self' => array( |
|
294 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
295 | + ), |
|
296 | + 'collection' => array( |
|
297 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
298 | + ), |
|
299 | + ); |
|
300 | + |
|
301 | + return $links; |
|
302 | + } |
|
303 | + |
|
304 | + /** |
|
305 | + * Prepare a settings object for serialization. |
|
306 | + * |
|
307 | + * @since 2.0.0 |
|
308 | + * @param array $item Setting object. |
|
309 | + * @param WP_REST_Request $request Request object. |
|
310 | + * @return WP_REST_Response $response Response data. |
|
311 | + */ |
|
312 | + public function prepare_item_for_response( $item, $request ) { |
|
313 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
314 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
315 | + $data = $this->filter_response_by_context( $data, $context ); |
|
316 | + |
|
317 | + $response = rest_ensure_response( $data ); |
|
318 | + |
|
319 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
320 | + |
|
321 | + return $response; |
|
322 | + } |
|
323 | + |
|
324 | + /** |
|
325 | + * Filters out bad values from the settings array/filter so we |
|
326 | + * only return known values via the API. |
|
327 | + * |
|
328 | + * @since 2.0.0 |
|
329 | + * @param array $setting Setting. |
|
330 | + * @return array |
|
331 | + */ |
|
332 | + public function filter_setting( $setting ) { |
|
333 | + return array_intersect_key( |
|
334 | + $setting, |
|
335 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
336 | + ); |
|
337 | + } |
|
338 | + |
|
339 | + /** |
|
340 | + * Callback for allowed keys for each setting response. |
|
341 | + * |
|
342 | + * @param string $key Key to check. |
|
343 | + * @return boolean |
|
344 | + */ |
|
345 | + public function allowed_setting_keys( $key ) { |
|
346 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Returns default options for a setting. null means the field is required. |
|
351 | + * |
|
352 | + * @since 2.0.0 |
|
353 | + * @return array |
|
354 | + */ |
|
355 | + protected function setting_defaults() { |
|
356 | + return array( |
|
357 | + 'id' => null, |
|
358 | + 'name' => null, |
|
359 | + 'desc' => '', |
|
360 | + 'options' => array(), |
|
361 | + 'std' => false, |
|
362 | + 'value' => false, |
|
363 | + 'placeholder' => '', |
|
364 | + 'readonly' => false, |
|
365 | + 'faux' => false, |
|
366 | + 'section' => 'main', |
|
367 | + 'tab' => 'general', |
|
368 | + 'type' => 'text', |
|
369 | + ); |
|
370 | + } |
|
371 | + |
|
372 | + /** |
|
373 | + * Sanitizes a setting's field. |
|
374 | + * |
|
375 | + * @param array $setting The setting to sanitize. |
|
376 | + * @return array |
|
377 | + */ |
|
378 | + public function sanitize_setting( $setting ) { |
|
379 | + |
|
380 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
381 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
382 | + return $this->filter_setting( $setting ); |
|
383 | + |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Get setting data. |
|
388 | + * |
|
389 | + * @since 2.0.0 |
|
390 | + * @param string $setting_id Setting ID. |
|
391 | + * @return array|WP_Error |
|
392 | + */ |
|
393 | + public function get_setting( $setting_id ) { |
|
394 | + |
|
395 | + if ( empty( $setting_id ) ) { |
|
396 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
397 | + } |
|
398 | + |
|
399 | + $settings = $this->get_settings(); |
|
400 | + |
|
401 | + foreach ( $settings as $tabs ) { |
|
402 | + |
|
403 | + foreach ( $tabs as $sections ) { |
|
404 | + |
|
405 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
406 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
407 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
408 | + } |
|
409 | + |
|
410 | + return $sections[ $setting_id ]; |
|
411 | + } |
|
412 | 412 | } |
413 | 413 | } |
414 | 414 | |
415 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
416 | - } |
|
417 | - |
|
418 | - /** |
|
419 | - * Get all tabs. |
|
420 | - * |
|
421 | - * @param WP_REST_Request $request Request data. |
|
422 | - * @return array |
|
423 | - */ |
|
424 | - public function get_tabs( $request ) { |
|
425 | - $tabs = wpinv_get_settings_tabs(); |
|
426 | - $prepared = array(); |
|
427 | - |
|
428 | - foreach ( $tabs as $id => $tab ) { |
|
429 | - |
|
430 | - $_request = $request; |
|
431 | - $_request['tab'] = sanitize_title( $id ); |
|
432 | - $data = array( |
|
433 | - 'id' => sanitize_title( $id ), |
|
434 | - 'label' => sanitize_text_field( $tab ), |
|
435 | - 'sections' => $this->get_sections( $_request ), |
|
436 | - ); |
|
437 | - |
|
438 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
439 | - $response = rest_ensure_response( $data ); |
|
440 | - |
|
441 | - if ( ! is_wp_error( $response ) ) { |
|
442 | - $links = array( |
|
443 | - 'sections' => array( |
|
444 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
445 | - ), |
|
446 | - 'collection' => array( |
|
447 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
448 | - ), |
|
449 | - ); |
|
450 | - $response->add_links( $links ); |
|
451 | - $response = $this->prepare_response_for_collection( $response ); |
|
452 | - } |
|
453 | - |
|
454 | - $prepared[] = $response; |
|
455 | - |
|
456 | - } |
|
457 | - |
|
458 | - return rest_ensure_response( $prepared ); |
|
459 | - } |
|
460 | - |
|
461 | - /** |
|
462 | - * Get all sections. |
|
463 | - * |
|
464 | - * @param WP_REST_Request $request Request data. |
|
465 | - * @return array |
|
466 | - */ |
|
467 | - public function get_sections( $request ) { |
|
468 | - |
|
469 | - $tab = sanitize_title( $request['tab'] ); |
|
470 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
471 | - $prepared = array(); |
|
472 | - |
|
473 | - foreach ( $sections as $id => $section ) { |
|
474 | - |
|
475 | - $data = array( |
|
476 | - 'id' => sanitize_title( $id ), |
|
477 | - 'label' => sanitize_text_field( $section ), |
|
478 | - ); |
|
479 | - |
|
480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
481 | - $response = rest_ensure_response( $data ); |
|
482 | - |
|
483 | - if ( ! is_wp_error( $response ) ) { |
|
484 | - $links = array( |
|
485 | - 'settings' => array( |
|
486 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
487 | - ), |
|
488 | - 'collection' => array( |
|
489 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
490 | - ), |
|
491 | - 'tabs' => array( |
|
492 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
493 | - ), |
|
494 | - ); |
|
495 | - $response->add_links( $links ); |
|
496 | - $response = $this->prepare_response_for_collection( $response ); |
|
497 | - } |
|
498 | - |
|
499 | - $prepared[] = $response; |
|
500 | - |
|
501 | - } |
|
502 | - |
|
503 | - return rest_ensure_response( $prepared ); |
|
504 | - } |
|
505 | - |
|
506 | - /** |
|
507 | - * Get all settings. |
|
508 | - * |
|
509 | - * @return array |
|
510 | - */ |
|
511 | - public function get_settings() { |
|
512 | - |
|
513 | - if ( empty( $this->settings ) ) { |
|
514 | - $this->settings = wpinv_get_registered_settings(); |
|
515 | - } |
|
516 | - |
|
517 | - return $this->settings; |
|
518 | - |
|
519 | - } |
|
520 | - |
|
521 | - /** |
|
522 | - * Boolean for if a setting type is a valid supported setting type. |
|
523 | - * |
|
524 | - * @since 2.0.0 |
|
525 | - * @param string $type Type. |
|
526 | - * @return bool |
|
527 | - */ |
|
528 | - public function is_setting_type_valid( $type ) { |
|
529 | - |
|
530 | - return in_array( |
|
531 | - $type, |
|
415 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
416 | + } |
|
417 | + |
|
418 | + /** |
|
419 | + * Get all tabs. |
|
420 | + * |
|
421 | + * @param WP_REST_Request $request Request data. |
|
422 | + * @return array |
|
423 | + */ |
|
424 | + public function get_tabs( $request ) { |
|
425 | + $tabs = wpinv_get_settings_tabs(); |
|
426 | + $prepared = array(); |
|
427 | + |
|
428 | + foreach ( $tabs as $id => $tab ) { |
|
429 | + |
|
430 | + $_request = $request; |
|
431 | + $_request['tab'] = sanitize_title( $id ); |
|
432 | + $data = array( |
|
433 | + 'id' => sanitize_title( $id ), |
|
434 | + 'label' => sanitize_text_field( $tab ), |
|
435 | + 'sections' => $this->get_sections( $_request ), |
|
436 | + ); |
|
437 | + |
|
438 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
439 | + $response = rest_ensure_response( $data ); |
|
440 | + |
|
441 | + if ( ! is_wp_error( $response ) ) { |
|
442 | + $links = array( |
|
443 | + 'sections' => array( |
|
444 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
445 | + ), |
|
446 | + 'collection' => array( |
|
447 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
448 | + ), |
|
449 | + ); |
|
450 | + $response->add_links( $links ); |
|
451 | + $response = $this->prepare_response_for_collection( $response ); |
|
452 | + } |
|
453 | + |
|
454 | + $prepared[] = $response; |
|
455 | + |
|
456 | + } |
|
457 | + |
|
458 | + return rest_ensure_response( $prepared ); |
|
459 | + } |
|
460 | + |
|
461 | + /** |
|
462 | + * Get all sections. |
|
463 | + * |
|
464 | + * @param WP_REST_Request $request Request data. |
|
465 | + * @return array |
|
466 | + */ |
|
467 | + public function get_sections( $request ) { |
|
468 | + |
|
469 | + $tab = sanitize_title( $request['tab'] ); |
|
470 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
471 | + $prepared = array(); |
|
472 | + |
|
473 | + foreach ( $sections as $id => $section ) { |
|
474 | + |
|
475 | + $data = array( |
|
476 | + 'id' => sanitize_title( $id ), |
|
477 | + 'label' => sanitize_text_field( $section ), |
|
478 | + ); |
|
479 | + |
|
480 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
481 | + $response = rest_ensure_response( $data ); |
|
482 | + |
|
483 | + if ( ! is_wp_error( $response ) ) { |
|
484 | + $links = array( |
|
485 | + 'settings' => array( |
|
486 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
487 | + ), |
|
488 | + 'collection' => array( |
|
489 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
490 | + ), |
|
491 | + 'tabs' => array( |
|
492 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
493 | + ), |
|
494 | + ); |
|
495 | + $response->add_links( $links ); |
|
496 | + $response = $this->prepare_response_for_collection( $response ); |
|
497 | + } |
|
498 | + |
|
499 | + $prepared[] = $response; |
|
500 | + |
|
501 | + } |
|
502 | + |
|
503 | + return rest_ensure_response( $prepared ); |
|
504 | + } |
|
505 | + |
|
506 | + /** |
|
507 | + * Get all settings. |
|
508 | + * |
|
509 | + * @return array |
|
510 | + */ |
|
511 | + public function get_settings() { |
|
512 | + |
|
513 | + if ( empty( $this->settings ) ) { |
|
514 | + $this->settings = wpinv_get_registered_settings(); |
|
515 | + } |
|
516 | + |
|
517 | + return $this->settings; |
|
518 | + |
|
519 | + } |
|
520 | + |
|
521 | + /** |
|
522 | + * Boolean for if a setting type is a valid supported setting type. |
|
523 | + * |
|
524 | + * @since 2.0.0 |
|
525 | + * @param string $type Type. |
|
526 | + * @return bool |
|
527 | + */ |
|
528 | + public function is_setting_type_valid( $type ) { |
|
529 | + |
|
530 | + return in_array( |
|
531 | + $type, |
|
532 | 532 | array( |
533 | - 'text', // Validates with validate_setting_text_field. |
|
534 | - 'email', // Validates with validate_setting_text_field. |
|
535 | - 'number', // Validates with validate_setting_text_field. |
|
536 | - 'color', // Validates with validate_setting_text_field. |
|
537 | - 'password', // Validates with validate_setting_text_field. |
|
538 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | - 'select', // Validates with validate_setting_select_field. |
|
540 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | - 'header', // Validates with validate_setting_text_field. |
|
544 | - ) |
|
545 | - ); |
|
546 | - |
|
547 | - } |
|
548 | - |
|
549 | - /** |
|
550 | - * Get the settings schema, conforming to JSON Schema. |
|
551 | - * |
|
552 | - * @return array |
|
553 | - */ |
|
554 | - public function get_item_schema() { |
|
555 | - |
|
556 | - // Maybe retrieve the schema from cache. |
|
557 | - if ( ! empty( $this->schema ) ) { |
|
558 | - return $this->add_additional_fields_schema( $this->schema ); |
|
559 | - } |
|
560 | - |
|
561 | - $schema = array( |
|
562 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
563 | - 'title' => 'setting', |
|
564 | - 'type' => 'object', |
|
565 | - 'properties' => array( |
|
566 | - 'id' => array( |
|
567 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
568 | - 'type' => 'string', |
|
569 | - 'arg_options' => array( |
|
570 | - 'sanitize_callback' => 'sanitize_title', |
|
571 | - ), |
|
572 | - 'context' => array( 'view', 'edit' ), |
|
573 | - 'readonly' => true, |
|
574 | - ), |
|
575 | - 'tab' => array( |
|
576 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
577 | - 'type' => 'string', |
|
578 | - 'arg_options' => array( |
|
579 | - 'sanitize_callback' => 'sanitize_title', |
|
580 | - ), |
|
581 | - 'context' => array( 'view', 'edit' ), |
|
582 | - 'readonly' => true, |
|
583 | - ), |
|
584 | - 'section' => array( |
|
585 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
586 | - 'type' => 'string', |
|
587 | - 'arg_options' => array( |
|
588 | - 'sanitize_callback' => 'sanitize_title', |
|
589 | - ), |
|
590 | - 'context' => array( 'view', 'edit' ), |
|
591 | - 'readonly' => true, |
|
592 | - ), |
|
593 | - 'name' => array( |
|
594 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
595 | - 'type' => 'string', |
|
596 | - 'arg_options' => array( |
|
597 | - 'sanitize_callback' => 'sanitize_text_field', |
|
598 | - ), |
|
599 | - 'context' => array( 'view', 'edit' ), |
|
600 | - 'readonly' => true, |
|
601 | - ), |
|
602 | - 'desc' => array( |
|
603 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
604 | - 'type' => 'string', |
|
605 | - 'context' => array( 'view', 'edit' ), |
|
606 | - 'readonly' => true, |
|
607 | - ), |
|
608 | - 'value' => array( |
|
609 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
610 | - 'type' => 'mixed', |
|
611 | - 'context' => array( 'view', 'edit' ), |
|
612 | - ), |
|
613 | - 'default' => array( |
|
614 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
615 | - 'type' => 'mixed', |
|
616 | - 'context' => array( 'view', 'edit' ), |
|
617 | - 'readonly' => true, |
|
618 | - ), |
|
619 | - 'placeholder' => array( |
|
620 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
621 | - 'type' => 'string', |
|
622 | - 'arg_options' => array( |
|
623 | - 'sanitize_callback' => 'sanitize_text_field', |
|
624 | - ), |
|
625 | - 'context' => array( 'view', 'edit' ), |
|
626 | - 'readonly' => true, |
|
627 | - ), |
|
628 | - 'type' => array( |
|
629 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
630 | - 'type' => 'string', |
|
631 | - 'arg_options' => array( |
|
632 | - 'sanitize_callback' => 'sanitize_text_field', |
|
633 | - ), |
|
634 | - 'context' => array( 'view', 'edit' ), |
|
635 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
636 | - 'readonly' => true, |
|
637 | - ), |
|
638 | - 'options' => array( |
|
639 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
640 | - 'type' => 'object', |
|
641 | - 'context' => array( 'view', 'edit' ), |
|
642 | - 'readonly' => true, |
|
643 | - ), |
|
644 | - 'readonly' => array( |
|
645 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
646 | - 'type' => 'string', |
|
647 | - 'context' => array( 'view' ), |
|
648 | - 'readonly' => true, |
|
649 | - ), |
|
650 | - 'faux' => array( |
|
651 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
652 | - 'type' => 'string', |
|
653 | - 'context' => array( 'view' ), |
|
654 | - 'readonly' => true, |
|
655 | - ), |
|
656 | - ), |
|
657 | - ); |
|
658 | - |
|
659 | - // Filters the settings schema for the REST API. |
|
533 | + 'text', // Validates with validate_setting_text_field. |
|
534 | + 'email', // Validates with validate_setting_text_field. |
|
535 | + 'number', // Validates with validate_setting_text_field. |
|
536 | + 'color', // Validates with validate_setting_text_field. |
|
537 | + 'password', // Validates with validate_setting_text_field. |
|
538 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | + 'select', // Validates with validate_setting_select_field. |
|
540 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | + 'header', // Validates with validate_setting_text_field. |
|
544 | + ) |
|
545 | + ); |
|
546 | + |
|
547 | + } |
|
548 | + |
|
549 | + /** |
|
550 | + * Get the settings schema, conforming to JSON Schema. |
|
551 | + * |
|
552 | + * @return array |
|
553 | + */ |
|
554 | + public function get_item_schema() { |
|
555 | + |
|
556 | + // Maybe retrieve the schema from cache. |
|
557 | + if ( ! empty( $this->schema ) ) { |
|
558 | + return $this->add_additional_fields_schema( $this->schema ); |
|
559 | + } |
|
560 | + |
|
561 | + $schema = array( |
|
562 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
563 | + 'title' => 'setting', |
|
564 | + 'type' => 'object', |
|
565 | + 'properties' => array( |
|
566 | + 'id' => array( |
|
567 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
568 | + 'type' => 'string', |
|
569 | + 'arg_options' => array( |
|
570 | + 'sanitize_callback' => 'sanitize_title', |
|
571 | + ), |
|
572 | + 'context' => array( 'view', 'edit' ), |
|
573 | + 'readonly' => true, |
|
574 | + ), |
|
575 | + 'tab' => array( |
|
576 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
577 | + 'type' => 'string', |
|
578 | + 'arg_options' => array( |
|
579 | + 'sanitize_callback' => 'sanitize_title', |
|
580 | + ), |
|
581 | + 'context' => array( 'view', 'edit' ), |
|
582 | + 'readonly' => true, |
|
583 | + ), |
|
584 | + 'section' => array( |
|
585 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
586 | + 'type' => 'string', |
|
587 | + 'arg_options' => array( |
|
588 | + 'sanitize_callback' => 'sanitize_title', |
|
589 | + ), |
|
590 | + 'context' => array( 'view', 'edit' ), |
|
591 | + 'readonly' => true, |
|
592 | + ), |
|
593 | + 'name' => array( |
|
594 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
595 | + 'type' => 'string', |
|
596 | + 'arg_options' => array( |
|
597 | + 'sanitize_callback' => 'sanitize_text_field', |
|
598 | + ), |
|
599 | + 'context' => array( 'view', 'edit' ), |
|
600 | + 'readonly' => true, |
|
601 | + ), |
|
602 | + 'desc' => array( |
|
603 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
604 | + 'type' => 'string', |
|
605 | + 'context' => array( 'view', 'edit' ), |
|
606 | + 'readonly' => true, |
|
607 | + ), |
|
608 | + 'value' => array( |
|
609 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
610 | + 'type' => 'mixed', |
|
611 | + 'context' => array( 'view', 'edit' ), |
|
612 | + ), |
|
613 | + 'default' => array( |
|
614 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
615 | + 'type' => 'mixed', |
|
616 | + 'context' => array( 'view', 'edit' ), |
|
617 | + 'readonly' => true, |
|
618 | + ), |
|
619 | + 'placeholder' => array( |
|
620 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
621 | + 'type' => 'string', |
|
622 | + 'arg_options' => array( |
|
623 | + 'sanitize_callback' => 'sanitize_text_field', |
|
624 | + ), |
|
625 | + 'context' => array( 'view', 'edit' ), |
|
626 | + 'readonly' => true, |
|
627 | + ), |
|
628 | + 'type' => array( |
|
629 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
630 | + 'type' => 'string', |
|
631 | + 'arg_options' => array( |
|
632 | + 'sanitize_callback' => 'sanitize_text_field', |
|
633 | + ), |
|
634 | + 'context' => array( 'view', 'edit' ), |
|
635 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
636 | + 'readonly' => true, |
|
637 | + ), |
|
638 | + 'options' => array( |
|
639 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
640 | + 'type' => 'object', |
|
641 | + 'context' => array( 'view', 'edit' ), |
|
642 | + 'readonly' => true, |
|
643 | + ), |
|
644 | + 'readonly' => array( |
|
645 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
646 | + 'type' => 'string', |
|
647 | + 'context' => array( 'view' ), |
|
648 | + 'readonly' => true, |
|
649 | + ), |
|
650 | + 'faux' => array( |
|
651 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
652 | + 'type' => 'string', |
|
653 | + 'context' => array( 'view' ), |
|
654 | + 'readonly' => true, |
|
655 | + ), |
|
656 | + ), |
|
657 | + ); |
|
658 | + |
|
659 | + // Filters the settings schema for the REST API. |
|
660 | 660 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
661 | 661 | |
662 | - // Cache the settings schema. |
|
663 | - $this->schema = $schema; |
|
664 | - |
|
665 | - return $this->add_additional_fields_schema( $this->schema ); |
|
666 | - |
|
667 | - } |
|
668 | - |
|
669 | - /** |
|
670 | - * Validate a text value for a text based setting. |
|
671 | - * |
|
672 | - * @since 2.0.0 |
|
673 | - * @param string $value Value. |
|
674 | - * @param array $setting Setting. |
|
675 | - * @return string |
|
676 | - */ |
|
677 | - public function validate_setting_text_field( $value ) { |
|
678 | - $value = is_null( $value ) ? '' : $value; |
|
679 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
680 | - } |
|
681 | - |
|
682 | - /** |
|
683 | - * Validate select based settings. |
|
684 | - * |
|
685 | - * @since 2.0.0 |
|
686 | - * @param string $value Value. |
|
687 | - * @param array $setting Setting. |
|
688 | - * @return string|WP_Error |
|
689 | - */ |
|
690 | - public function validate_setting_select_field( $value, $setting ) { |
|
691 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
692 | - return $value; |
|
693 | - } else { |
|
694 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
695 | - } |
|
696 | - } |
|
697 | - |
|
698 | - /** |
|
699 | - * Validate multiselect based settings. |
|
700 | - * |
|
701 | - * @since 2.0.0 |
|
702 | - * @param array $values Values. |
|
703 | - * @param array $setting Setting. |
|
704 | - * @return array|WP_Error |
|
705 | - */ |
|
706 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
707 | - if ( empty( $values ) ) { |
|
708 | - return array(); |
|
709 | - } |
|
710 | - |
|
711 | - if ( ! is_array( $values ) ) { |
|
712 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
713 | - } |
|
714 | - |
|
715 | - $final_values = array(); |
|
716 | - foreach ( $values as $value ) { |
|
717 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
718 | - $final_values[] = $value; |
|
719 | - } |
|
720 | - } |
|
721 | - |
|
722 | - return $final_values; |
|
723 | - } |
|
724 | - |
|
725 | - /** |
|
726 | - * Validate radio based settings. |
|
727 | - * |
|
728 | - * @since 2.0.0 |
|
729 | - * @param string $value Value. |
|
730 | - * @param array $setting Setting. |
|
731 | - * @return string|WP_Error |
|
732 | - */ |
|
733 | - public function validate_setting_radio_field( $value, $setting ) { |
|
734 | - return $this->validate_setting_select_field( $value, $setting ); |
|
735 | - } |
|
736 | - |
|
737 | - /** |
|
738 | - * Validate checkbox based settings. |
|
739 | - * |
|
740 | - * @since 2.0.0 |
|
741 | - * @param string $value Value. |
|
742 | - * @return int |
|
743 | - */ |
|
744 | - public function validate_setting_checkbox_field( $value ) { |
|
745 | - return (int) ! empty( $value ); |
|
746 | - } |
|
747 | - |
|
748 | - /** |
|
749 | - * Validate textarea based settings. |
|
750 | - * |
|
751 | - * @since 2.0.0 |
|
752 | - * @param string $value Value. |
|
753 | - * @return string |
|
754 | - */ |
|
755 | - public function validate_setting_textarea_field( $value ) { |
|
756 | - $value = is_null( $value ) ? '' : $value; |
|
757 | - return wp_kses( |
|
758 | - trim( stripslashes( $value ) ), |
|
759 | - array_merge( |
|
760 | - array( |
|
761 | - 'iframe' => array( |
|
762 | - 'src' => true, |
|
763 | - 'style' => true, |
|
764 | - 'id' => true, |
|
765 | - 'class' => true, |
|
766 | - ), |
|
767 | - ), |
|
768 | - wp_kses_allowed_html( 'post' ) |
|
769 | - ) |
|
770 | - ); |
|
771 | - } |
|
662 | + // Cache the settings schema. |
|
663 | + $this->schema = $schema; |
|
664 | + |
|
665 | + return $this->add_additional_fields_schema( $this->schema ); |
|
666 | + |
|
667 | + } |
|
668 | + |
|
669 | + /** |
|
670 | + * Validate a text value for a text based setting. |
|
671 | + * |
|
672 | + * @since 2.0.0 |
|
673 | + * @param string $value Value. |
|
674 | + * @param array $setting Setting. |
|
675 | + * @return string |
|
676 | + */ |
|
677 | + public function validate_setting_text_field( $value ) { |
|
678 | + $value = is_null( $value ) ? '' : $value; |
|
679 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
680 | + } |
|
681 | + |
|
682 | + /** |
|
683 | + * Validate select based settings. |
|
684 | + * |
|
685 | + * @since 2.0.0 |
|
686 | + * @param string $value Value. |
|
687 | + * @param array $setting Setting. |
|
688 | + * @return string|WP_Error |
|
689 | + */ |
|
690 | + public function validate_setting_select_field( $value, $setting ) { |
|
691 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
692 | + return $value; |
|
693 | + } else { |
|
694 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
695 | + } |
|
696 | + } |
|
697 | + |
|
698 | + /** |
|
699 | + * Validate multiselect based settings. |
|
700 | + * |
|
701 | + * @since 2.0.0 |
|
702 | + * @param array $values Values. |
|
703 | + * @param array $setting Setting. |
|
704 | + * @return array|WP_Error |
|
705 | + */ |
|
706 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
707 | + if ( empty( $values ) ) { |
|
708 | + return array(); |
|
709 | + } |
|
710 | + |
|
711 | + if ( ! is_array( $values ) ) { |
|
712 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
713 | + } |
|
714 | + |
|
715 | + $final_values = array(); |
|
716 | + foreach ( $values as $value ) { |
|
717 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
718 | + $final_values[] = $value; |
|
719 | + } |
|
720 | + } |
|
721 | + |
|
722 | + return $final_values; |
|
723 | + } |
|
724 | + |
|
725 | + /** |
|
726 | + * Validate radio based settings. |
|
727 | + * |
|
728 | + * @since 2.0.0 |
|
729 | + * @param string $value Value. |
|
730 | + * @param array $setting Setting. |
|
731 | + * @return string|WP_Error |
|
732 | + */ |
|
733 | + public function validate_setting_radio_field( $value, $setting ) { |
|
734 | + return $this->validate_setting_select_field( $value, $setting ); |
|
735 | + } |
|
736 | + |
|
737 | + /** |
|
738 | + * Validate checkbox based settings. |
|
739 | + * |
|
740 | + * @since 2.0.0 |
|
741 | + * @param string $value Value. |
|
742 | + * @return int |
|
743 | + */ |
|
744 | + public function validate_setting_checkbox_field( $value ) { |
|
745 | + return (int) ! empty( $value ); |
|
746 | + } |
|
747 | + |
|
748 | + /** |
|
749 | + * Validate textarea based settings. |
|
750 | + * |
|
751 | + * @since 2.0.0 |
|
752 | + * @param string $value Value. |
|
753 | + * @return string |
|
754 | + */ |
|
755 | + public function validate_setting_textarea_field( $value ) { |
|
756 | + $value = is_null( $value ) ? '' : $value; |
|
757 | + return wp_kses( |
|
758 | + trim( stripslashes( $value ) ), |
|
759 | + array_merge( |
|
760 | + array( |
|
761 | + 'iframe' => array( |
|
762 | + 'src' => true, |
|
763 | + 'style' => true, |
|
764 | + 'id' => true, |
|
765 | + 'class' => true, |
|
766 | + ), |
|
767 | + ), |
|
768 | + wp_kses_allowed_html( 'post' ) |
|
769 | + ) |
|
770 | + ); |
|
771 | + } |
|
772 | 772 | |
773 | 773 | } |
@@ -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,33 +160,33 @@ 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 | - return rest_ensure_response( $prepared ); |
|
189 | + return rest_ensure_response($prepared); |
|
190 | 190 | } |
191 | 191 | |
192 | 192 | /** |
@@ -196,16 +196,16 @@ discard block |
||
196 | 196 | * @param WP_REST_Request $request Request data. |
197 | 197 | * @return WP_Error|WP_REST_Response |
198 | 198 | */ |
199 | - public function get_item( $request ) { |
|
200 | - $setting = $this->get_setting( $request['id'] ); |
|
199 | + public function get_item($request) { |
|
200 | + $setting = $this->get_setting($request['id']); |
|
201 | 201 | |
202 | - if ( is_wp_error( $setting ) ) { |
|
202 | + if (is_wp_error($setting)) { |
|
203 | 203 | return $setting; |
204 | 204 | } |
205 | 205 | |
206 | - $setting = $this->sanitize_setting( $setting ); |
|
207 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
208 | - return rest_ensure_response( $response ); |
|
206 | + $setting = $this->sanitize_setting($setting); |
|
207 | + $response = $this->prepare_item_for_response($setting, $request); |
|
208 | + return rest_ensure_response($response); |
|
209 | 209 | } |
210 | 210 | |
211 | 211 | /** |
@@ -215,29 +215,29 @@ discard block |
||
215 | 215 | * @param WP_REST_Request $request Request data. |
216 | 216 | * @return WP_Error|WP_REST_Response |
217 | 217 | */ |
218 | - public function update_item( $request ) { |
|
219 | - $setting = $this->get_setting( $request['id'] ); |
|
218 | + public function update_item($request) { |
|
219 | + $setting = $this->get_setting($request['id']); |
|
220 | 220 | |
221 | - if ( is_wp_error( $setting ) ) { |
|
221 | + if (is_wp_error($setting)) { |
|
222 | 222 | return $setting; |
223 | 223 | } |
224 | 224 | |
225 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
226 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
225 | + if (is_callable(array($this, 'validate_setting_' . $setting['type'] . '_field'))) { |
|
226 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}($request['value'], $setting); |
|
227 | 227 | } else { |
228 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
228 | + $value = $this->validate_setting_text_field($request['value'], $setting); |
|
229 | 229 | } |
230 | 230 | |
231 | - if ( is_wp_error( $value ) ) { |
|
231 | + if (is_wp_error($value)) { |
|
232 | 232 | return $value; |
233 | 233 | } |
234 | 234 | |
235 | - wpinv_update_option( $request['id'], $value ); |
|
235 | + wpinv_update_option($request['id'], $value); |
|
236 | 236 | $setting['value'] = $value; |
237 | - $setting = $this->sanitize_setting( $setting ); |
|
238 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
237 | + $setting = $this->sanitize_setting($setting); |
|
238 | + $response = $this->prepare_item_for_response($setting, $request); |
|
239 | 239 | |
240 | - return rest_ensure_response( $response ); |
|
240 | + return rest_ensure_response($response); |
|
241 | 241 | } |
242 | 242 | |
243 | 243 | /** |
@@ -247,9 +247,9 @@ discard block |
||
247 | 247 | * @param WP_REST_Request $request Full data about the request. |
248 | 248 | * @return WP_Error|boolean |
249 | 249 | */ |
250 | - public function get_items_permissions_check( $request ) { |
|
251 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
252 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
250 | + public function get_items_permissions_check($request) { |
|
251 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
252 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
253 | 253 | } |
254 | 254 | |
255 | 255 | return true; |
@@ -262,9 +262,9 @@ discard block |
||
262 | 262 | * @param WP_REST_Request $request Full data about the request. |
263 | 263 | * @return WP_Error|boolean |
264 | 264 | */ |
265 | - public function update_items_permissions_check( $request ) { |
|
266 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
267 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
265 | + public function update_items_permissions_check($request) { |
|
266 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
267 | + return new WP_Error('rest_cannot_edit', __('Sorry, you cannot edit this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
268 | 268 | } |
269 | 269 | |
270 | 270 | return true; |
@@ -277,8 +277,8 @@ discard block |
||
277 | 277 | * |
278 | 278 | * @return boolean|WP_Error |
279 | 279 | */ |
280 | - public function batch_items_permissions_check( $request ) { |
|
281 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
280 | + public function batch_items_permissions_check($request) { |
|
281 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error('rest_cannot_batch', __('Sorry, you are not allowed to batch manipulate this resource.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
282 | 282 | } |
283 | 283 | |
284 | 284 | /** |
@@ -287,14 +287,14 @@ discard block |
||
287 | 287 | * @param string $setting_id Setting ID. |
288 | 288 | * @return array Links for the given setting. |
289 | 289 | */ |
290 | - protected function prepare_links( $setting_id ) { |
|
290 | + protected function prepare_links($setting_id) { |
|
291 | 291 | |
292 | 292 | $links = array( |
293 | 293 | 'self' => array( |
294 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
294 | + 'href' => rest_url(sprintf('/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id)), |
|
295 | 295 | ), |
296 | 296 | 'collection' => array( |
297 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
297 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
298 | 298 | ), |
299 | 299 | ); |
300 | 300 | |
@@ -309,14 +309,14 @@ discard block |
||
309 | 309 | * @param WP_REST_Request $request Request object. |
310 | 310 | * @return WP_REST_Response $response Response data. |
311 | 311 | */ |
312 | - public function prepare_item_for_response( $item, $request ) { |
|
313 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
314 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
315 | - $data = $this->filter_response_by_context( $data, $context ); |
|
312 | + public function prepare_item_for_response($item, $request) { |
|
313 | + $context = empty($request['context']) ? 'view' : $request['context']; |
|
314 | + $data = $this->add_additional_fields_to_object($item, $request); |
|
315 | + $data = $this->filter_response_by_context($data, $context); |
|
316 | 316 | |
317 | - $response = rest_ensure_response( $data ); |
|
317 | + $response = rest_ensure_response($data); |
|
318 | 318 | |
319 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
319 | + $response->add_links($this->prepare_links($item['id'])); |
|
320 | 320 | |
321 | 321 | return $response; |
322 | 322 | } |
@@ -329,10 +329,10 @@ discard block |
||
329 | 329 | * @param array $setting Setting. |
330 | 330 | * @return array |
331 | 331 | */ |
332 | - public function filter_setting( $setting ) { |
|
332 | + public function filter_setting($setting) { |
|
333 | 333 | return array_intersect_key( |
334 | 334 | $setting, |
335 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
335 | + array_flip(array_filter(array_keys($setting), array($this, 'allowed_setting_keys'))) |
|
336 | 336 | ); |
337 | 337 | } |
338 | 338 | |
@@ -342,8 +342,8 @@ discard block |
||
342 | 342 | * @param string $key Key to check. |
343 | 343 | * @return boolean |
344 | 344 | */ |
345 | - public function allowed_setting_keys( $key ) { |
|
346 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
345 | + public function allowed_setting_keys($key) { |
|
346 | + return in_array($key, array_keys($this->setting_defaults()), true); |
|
347 | 347 | } |
348 | 348 | |
349 | 349 | /** |
@@ -375,11 +375,11 @@ discard block |
||
375 | 375 | * @param array $setting The setting to sanitize. |
376 | 376 | * @return array |
377 | 377 | */ |
378 | - public function sanitize_setting( $setting ) { |
|
378 | + public function sanitize_setting($setting) { |
|
379 | 379 | |
380 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
381 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
382 | - return $this->filter_setting( $setting ); |
|
380 | + $setting = wp_parse_args($setting, $this->setting_defaults()); |
|
381 | + $setting['value'] = wpinv_get_option($setting['id'], $setting['std']); |
|
382 | + return $this->filter_setting($setting); |
|
383 | 383 | |
384 | 384 | } |
385 | 385 | |
@@ -390,29 +390,29 @@ discard block |
||
390 | 390 | * @param string $setting_id Setting ID. |
391 | 391 | * @return array|WP_Error |
392 | 392 | */ |
393 | - public function get_setting( $setting_id ) { |
|
393 | + public function get_setting($setting_id) { |
|
394 | 394 | |
395 | - if ( empty( $setting_id ) ) { |
|
396 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
395 | + if (empty($setting_id)) { |
|
396 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
397 | 397 | } |
398 | 398 | |
399 | - $settings = $this->get_settings(); |
|
399 | + $settings = $this->get_settings(); |
|
400 | 400 | |
401 | - foreach ( $settings as $tabs ) { |
|
401 | + foreach ($settings as $tabs) { |
|
402 | 402 | |
403 | - foreach ( $tabs as $sections ) { |
|
403 | + foreach ($tabs as $sections) { |
|
404 | 404 | |
405 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
406 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
407 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
405 | + if (isset($sections[$setting_id])) { |
|
406 | + if (!$this->is_setting_type_valid($sections[$setting_id]['type'])) { |
|
407 | + return new WP_Error('rest_setting_setting_type_invalid', __('Invalid setting type.', 'invoicing'), array('status' => 404)); |
|
408 | 408 | } |
409 | 409 | |
410 | - return $sections[ $setting_id ]; |
|
410 | + return $sections[$setting_id]; |
|
411 | 411 | } |
412 | 412 | } |
413 | 413 | } |
414 | 414 | |
415 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
415 | + return new WP_Error('rest_setting_setting_invalid', __('Invalid setting.', 'invoicing'), array('status' => 404)); |
|
416 | 416 | } |
417 | 417 | |
418 | 418 | /** |
@@ -421,41 +421,41 @@ discard block |
||
421 | 421 | * @param WP_REST_Request $request Request data. |
422 | 422 | * @return array |
423 | 423 | */ |
424 | - public function get_tabs( $request ) { |
|
424 | + public function get_tabs($request) { |
|
425 | 425 | $tabs = wpinv_get_settings_tabs(); |
426 | 426 | $prepared = array(); |
427 | 427 | |
428 | - foreach ( $tabs as $id => $tab ) { |
|
428 | + foreach ($tabs as $id => $tab) { |
|
429 | 429 | |
430 | 430 | $_request = $request; |
431 | - $_request['tab'] = sanitize_title( $id ); |
|
431 | + $_request['tab'] = sanitize_title($id); |
|
432 | 432 | $data = array( |
433 | - 'id' => sanitize_title( $id ), |
|
434 | - 'label' => sanitize_text_field( $tab ), |
|
435 | - 'sections' => $this->get_sections( $_request ), |
|
433 | + 'id' => sanitize_title($id), |
|
434 | + 'label' => sanitize_text_field($tab), |
|
435 | + 'sections' => $this->get_sections($_request), |
|
436 | 436 | ); |
437 | 437 | |
438 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
439 | - $response = rest_ensure_response( $data ); |
|
438 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
439 | + $response = rest_ensure_response($data); |
|
440 | 440 | |
441 | - if ( ! is_wp_error( $response ) ) { |
|
441 | + if (!is_wp_error($response)) { |
|
442 | 442 | $links = array( |
443 | 443 | 'sections' => array( |
444 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
444 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $id)), |
|
445 | 445 | ), |
446 | 446 | 'collection' => array( |
447 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
447 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
448 | 448 | ), |
449 | 449 | ); |
450 | - $response->add_links( $links ); |
|
451 | - $response = $this->prepare_response_for_collection( $response ); |
|
450 | + $response->add_links($links); |
|
451 | + $response = $this->prepare_response_for_collection($response); |
|
452 | 452 | } |
453 | 453 | |
454 | 454 | $prepared[] = $response; |
455 | 455 | |
456 | 456 | } |
457 | 457 | |
458 | - return rest_ensure_response( $prepared ); |
|
458 | + return rest_ensure_response($prepared); |
|
459 | 459 | } |
460 | 460 | |
461 | 461 | /** |
@@ -464,43 +464,43 @@ discard block |
||
464 | 464 | * @param WP_REST_Request $request Request data. |
465 | 465 | * @return array |
466 | 466 | */ |
467 | - public function get_sections( $request ) { |
|
467 | + public function get_sections($request) { |
|
468 | 468 | |
469 | - $tab = sanitize_title( $request['tab'] ); |
|
470 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
469 | + $tab = sanitize_title($request['tab']); |
|
470 | + $sections = wpinv_get_settings_tab_sections($tab); |
|
471 | 471 | $prepared = array(); |
472 | 472 | |
473 | - foreach ( $sections as $id => $section ) { |
|
473 | + foreach ($sections as $id => $section) { |
|
474 | 474 | |
475 | - $data = array( |
|
476 | - 'id' => sanitize_title( $id ), |
|
477 | - 'label' => sanitize_text_field( $section ), |
|
475 | + $data = array( |
|
476 | + 'id' => sanitize_title($id), |
|
477 | + 'label' => sanitize_text_field($section), |
|
478 | 478 | ); |
479 | 479 | |
480 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
481 | - $response = rest_ensure_response( $data ); |
|
480 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
481 | + $response = rest_ensure_response($data); |
|
482 | 482 | |
483 | - if ( ! is_wp_error( $response ) ) { |
|
483 | + if (!is_wp_error($response)) { |
|
484 | 484 | $links = array( |
485 | 485 | 'settings' => array( |
486 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
486 | + 'href' => rest_url(sprintf('/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id)), |
|
487 | 487 | ), |
488 | 488 | 'collection' => array( |
489 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
489 | + 'href' => rest_url(sprintf('/%s/%s/%s', $this->namespace, $this->rest_base, $tab)), |
|
490 | 490 | ), |
491 | 491 | 'tabs' => array( |
492 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
492 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
493 | 493 | ), |
494 | 494 | ); |
495 | - $response->add_links( $links ); |
|
496 | - $response = $this->prepare_response_for_collection( $response ); |
|
495 | + $response->add_links($links); |
|
496 | + $response = $this->prepare_response_for_collection($response); |
|
497 | 497 | } |
498 | 498 | |
499 | 499 | $prepared[] = $response; |
500 | 500 | |
501 | 501 | } |
502 | 502 | |
503 | - return rest_ensure_response( $prepared ); |
|
503 | + return rest_ensure_response($prepared); |
|
504 | 504 | } |
505 | 505 | |
506 | 506 | /** |
@@ -510,7 +510,7 @@ discard block |
||
510 | 510 | */ |
511 | 511 | public function get_settings() { |
512 | 512 | |
513 | - if ( empty( $this->settings ) ) { |
|
513 | + if (empty($this->settings)) { |
|
514 | 514 | $this->settings = wpinv_get_registered_settings(); |
515 | 515 | } |
516 | 516 | |
@@ -525,22 +525,22 @@ discard block |
||
525 | 525 | * @param string $type Type. |
526 | 526 | * @return bool |
527 | 527 | */ |
528 | - public function is_setting_type_valid( $type ) { |
|
528 | + public function is_setting_type_valid($type) { |
|
529 | 529 | |
530 | 530 | return in_array( |
531 | 531 | $type, |
532 | 532 | array( |
533 | - 'text', // Validates with validate_setting_text_field. |
|
534 | - 'email', // Validates with validate_setting_text_field. |
|
535 | - 'number', // Validates with validate_setting_text_field. |
|
536 | - 'color', // Validates with validate_setting_text_field. |
|
537 | - 'password', // Validates with validate_setting_text_field. |
|
538 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | - 'select', // Validates with validate_setting_select_field. |
|
540 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | - 'header', // Validates with validate_setting_text_field. |
|
533 | + 'text', // Validates with validate_setting_text_field. |
|
534 | + 'email', // Validates with validate_setting_text_field. |
|
535 | + 'number', // Validates with validate_setting_text_field. |
|
536 | + 'color', // Validates with validate_setting_text_field. |
|
537 | + 'password', // Validates with validate_setting_text_field. |
|
538 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
539 | + 'select', // Validates with validate_setting_select_field. |
|
540 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
541 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
542 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
543 | + 'header', // Validates with validate_setting_text_field. |
|
544 | 544 | ) |
545 | 545 | ); |
546 | 546 | |
@@ -554,8 +554,8 @@ discard block |
||
554 | 554 | public function get_item_schema() { |
555 | 555 | |
556 | 556 | // Maybe retrieve the schema from cache. |
557 | - if ( ! empty( $this->schema ) ) { |
|
558 | - return $this->add_additional_fields_schema( $this->schema ); |
|
557 | + if (!empty($this->schema)) { |
|
558 | + return $this->add_additional_fields_schema($this->schema); |
|
559 | 559 | } |
560 | 560 | |
561 | 561 | $schema = array( |
@@ -564,105 +564,105 @@ discard block |
||
564 | 564 | 'type' => 'object', |
565 | 565 | 'properties' => array( |
566 | 566 | 'id' => array( |
567 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
567 | + 'description' => __('A unique identifier for the setting.', 'invoicing'), |
|
568 | 568 | 'type' => 'string', |
569 | 569 | 'arg_options' => array( |
570 | 570 | 'sanitize_callback' => 'sanitize_title', |
571 | 571 | ), |
572 | - 'context' => array( 'view', 'edit' ), |
|
572 | + 'context' => array('view', 'edit'), |
|
573 | 573 | 'readonly' => true, |
574 | 574 | ), |
575 | 575 | 'tab' => array( |
576 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
576 | + 'description' => __('An identifier for the tab this setting belongs to.', 'invoicing'), |
|
577 | 577 | 'type' => 'string', |
578 | 578 | 'arg_options' => array( |
579 | 579 | 'sanitize_callback' => 'sanitize_title', |
580 | 580 | ), |
581 | - 'context' => array( 'view', 'edit' ), |
|
581 | + 'context' => array('view', 'edit'), |
|
582 | 582 | 'readonly' => true, |
583 | 583 | ), |
584 | 584 | 'section' => array( |
585 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
585 | + 'description' => __('An identifier for the section this setting belongs to.', 'invoicing'), |
|
586 | 586 | 'type' => 'string', |
587 | 587 | 'arg_options' => array( |
588 | 588 | 'sanitize_callback' => 'sanitize_title', |
589 | 589 | ), |
590 | - 'context' => array( 'view', 'edit' ), |
|
590 | + 'context' => array('view', 'edit'), |
|
591 | 591 | 'readonly' => true, |
592 | 592 | ), |
593 | 593 | 'name' => array( |
594 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
594 | + 'description' => __('A human readable label for the setting used in interfaces.', 'invoicing'), |
|
595 | 595 | 'type' => 'string', |
596 | 596 | 'arg_options' => array( |
597 | 597 | 'sanitize_callback' => 'sanitize_text_field', |
598 | 598 | ), |
599 | - 'context' => array( 'view', 'edit' ), |
|
599 | + 'context' => array('view', 'edit'), |
|
600 | 600 | 'readonly' => true, |
601 | 601 | ), |
602 | 602 | 'desc' => array( |
603 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
603 | + 'description' => __('A human readable description for the setting used in interfaces.', 'invoicing'), |
|
604 | 604 | 'type' => 'string', |
605 | - 'context' => array( 'view', 'edit' ), |
|
605 | + 'context' => array('view', 'edit'), |
|
606 | 606 | 'readonly' => true, |
607 | 607 | ), |
608 | 608 | 'value' => array( |
609 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
609 | + 'description' => __('The current value of this setting.', 'invoicing'), |
|
610 | 610 | 'type' => 'mixed', |
611 | - 'context' => array( 'view', 'edit' ), |
|
611 | + 'context' => array('view', 'edit'), |
|
612 | 612 | ), |
613 | 613 | 'default' => array( |
614 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
614 | + 'description' => __('Default value for the setting.', 'invoicing'), |
|
615 | 615 | 'type' => 'mixed', |
616 | - 'context' => array( 'view', 'edit' ), |
|
616 | + 'context' => array('view', 'edit'), |
|
617 | 617 | 'readonly' => true, |
618 | 618 | ), |
619 | 619 | 'placeholder' => array( |
620 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
620 | + 'description' => __('Placeholder text to be displayed in text inputs.', 'invoicing'), |
|
621 | 621 | 'type' => 'string', |
622 | 622 | 'arg_options' => array( |
623 | 623 | 'sanitize_callback' => 'sanitize_text_field', |
624 | 624 | ), |
625 | - 'context' => array( 'view', 'edit' ), |
|
625 | + 'context' => array('view', 'edit'), |
|
626 | 626 | 'readonly' => true, |
627 | 627 | ), |
628 | 628 | 'type' => array( |
629 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
629 | + 'description' => __('Type of setting.', 'invoicing'), |
|
630 | 630 | 'type' => 'string', |
631 | 631 | 'arg_options' => array( |
632 | 632 | 'sanitize_callback' => 'sanitize_text_field', |
633 | 633 | ), |
634 | - 'context' => array( 'view', 'edit' ), |
|
635 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
634 | + 'context' => array('view', 'edit'), |
|
635 | + 'enum' => array('text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html'), |
|
636 | 636 | 'readonly' => true, |
637 | 637 | ), |
638 | 638 | 'options' => array( |
639 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
639 | + 'description' => __('Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing'), |
|
640 | 640 | 'type' => 'object', |
641 | - 'context' => array( 'view', 'edit' ), |
|
641 | + 'context' => array('view', 'edit'), |
|
642 | 642 | 'readonly' => true, |
643 | 643 | ), |
644 | 644 | 'readonly' => array( |
645 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
645 | + 'description' => __('Whether or not this setting is readonly', 'invoicing'), |
|
646 | 646 | 'type' => 'string', |
647 | - 'context' => array( 'view' ), |
|
647 | + 'context' => array('view'), |
|
648 | 648 | 'readonly' => true, |
649 | 649 | ), |
650 | 650 | 'faux' => array( |
651 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
651 | + 'description' => __('Whether or not this setting is readonly/faux', 'invoicing'), |
|
652 | 652 | 'type' => 'string', |
653 | - 'context' => array( 'view' ), |
|
653 | + 'context' => array('view'), |
|
654 | 654 | 'readonly' => true, |
655 | 655 | ), |
656 | 656 | ), |
657 | 657 | ); |
658 | 658 | |
659 | 659 | // Filters the settings schema for the REST API. |
660 | - $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
|
660 | + $schema = apply_filters('getpaid_rest_settings_schema', $schema); |
|
661 | 661 | |
662 | 662 | // Cache the settings schema. |
663 | 663 | $this->schema = $schema; |
664 | 664 | |
665 | - return $this->add_additional_fields_schema( $this->schema ); |
|
665 | + return $this->add_additional_fields_schema($this->schema); |
|
666 | 666 | |
667 | 667 | } |
668 | 668 | |
@@ -674,9 +674,9 @@ discard block |
||
674 | 674 | * @param array $setting Setting. |
675 | 675 | * @return string |
676 | 676 | */ |
677 | - public function validate_setting_text_field( $value ) { |
|
678 | - $value = is_null( $value ) ? '' : $value; |
|
679 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
677 | + public function validate_setting_text_field($value) { |
|
678 | + $value = is_null($value) ? '' : $value; |
|
679 | + return wp_kses_post(trim(stripslashes($value))); |
|
680 | 680 | } |
681 | 681 | |
682 | 682 | /** |
@@ -687,11 +687,11 @@ discard block |
||
687 | 687 | * @param array $setting Setting. |
688 | 688 | * @return string|WP_Error |
689 | 689 | */ |
690 | - public function validate_setting_select_field( $value, $setting ) { |
|
691 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
690 | + public function validate_setting_select_field($value, $setting) { |
|
691 | + if (array_key_exists($value, $setting['options'])) { |
|
692 | 692 | return $value; |
693 | 693 | } else { |
694 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
694 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
695 | 695 | } |
696 | 696 | } |
697 | 697 | |
@@ -703,18 +703,18 @@ discard block |
||
703 | 703 | * @param array $setting Setting. |
704 | 704 | * @return array|WP_Error |
705 | 705 | */ |
706 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
707 | - if ( empty( $values ) ) { |
|
706 | + public function validate_setting_multiselect_field($values, $setting) { |
|
707 | + if (empty($values)) { |
|
708 | 708 | return array(); |
709 | 709 | } |
710 | 710 | |
711 | - if ( ! is_array( $values ) ) { |
|
712 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
711 | + if (!is_array($values)) { |
|
712 | + return new WP_Error('rest_setting_value_invalid', __('An invalid setting value was passed.', 'invoicing'), array('status' => 400)); |
|
713 | 713 | } |
714 | 714 | |
715 | 715 | $final_values = array(); |
716 | - foreach ( $values as $value ) { |
|
717 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
716 | + foreach ($values as $value) { |
|
717 | + if (array_key_exists($value, $setting['options'])) { |
|
718 | 718 | $final_values[] = $value; |
719 | 719 | } |
720 | 720 | } |
@@ -730,8 +730,8 @@ discard block |
||
730 | 730 | * @param array $setting Setting. |
731 | 731 | * @return string|WP_Error |
732 | 732 | */ |
733 | - public function validate_setting_radio_field( $value, $setting ) { |
|
734 | - return $this->validate_setting_select_field( $value, $setting ); |
|
733 | + public function validate_setting_radio_field($value, $setting) { |
|
734 | + return $this->validate_setting_select_field($value, $setting); |
|
735 | 735 | } |
736 | 736 | |
737 | 737 | /** |
@@ -741,8 +741,8 @@ discard block |
||
741 | 741 | * @param string $value Value. |
742 | 742 | * @return int |
743 | 743 | */ |
744 | - public function validate_setting_checkbox_field( $value ) { |
|
745 | - return (int) ! empty( $value ); |
|
744 | + public function validate_setting_checkbox_field($value) { |
|
745 | + return (int) !empty($value); |
|
746 | 746 | } |
747 | 747 | |
748 | 748 | /** |
@@ -752,10 +752,10 @@ discard block |
||
752 | 752 | * @param string $value Value. |
753 | 753 | * @return string |
754 | 754 | */ |
755 | - public function validate_setting_textarea_field( $value ) { |
|
756 | - $value = is_null( $value ) ? '' : $value; |
|
755 | + public function validate_setting_textarea_field($value) { |
|
756 | + $value = is_null($value) ? '' : $value; |
|
757 | 757 | return wp_kses( |
758 | - trim( stripslashes( $value ) ), |
|
758 | + trim(stripslashes($value)), |
|
759 | 759 | array_merge( |
760 | 760 | array( |
761 | 761 | 'iframe' => array( |
@@ -765,7 +765,7 @@ discard block |
||
765 | 765 | 'class' => true, |
766 | 766 | ), |
767 | 767 | ), |
768 | - wp_kses_allowed_html( 'post' ) |
|
768 | + wp_kses_allowed_html('post') |
|
769 | 769 | ) |
770 | 770 | ); |
771 | 771 | } |
@@ -18,179 +18,179 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * Route base. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $rest_base = 'reports/top_sellers'; |
|
27 | - |
|
28 | - /** |
|
29 | - * Get top sellers report. |
|
30 | - * |
|
31 | - * @param WP_REST_Request $request |
|
32 | - * @return array|WP_Error |
|
33 | - */ |
|
34 | - public function get_items( $request ) { |
|
35 | - |
|
36 | - // Prepare items. |
|
37 | - $this->report_range = $this->get_date_range( $request ); |
|
38 | - $report_data = $this->get_report_data(); |
|
39 | - |
|
40 | - $top_sellers = array(); |
|
41 | - |
|
42 | - foreach ( $report_data as $item ) { |
|
43 | - |
|
44 | - $item_obj = new WPInv_Item( $item ); |
|
45 | - $item_name = $item->invoice_item_name; |
|
46 | - $item_qty = floatval( $item->invoice_item_qty ); |
|
47 | - $item_id = absint( $item->invoice_item_id ); |
|
48 | - $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
49 | - |
|
50 | - $item_obj = new WPInv_Item( $item_id ); |
|
51 | - |
|
52 | - if ( $item_obj->exists() ) { |
|
53 | - $item_name = $item_obj->get_name(); |
|
54 | - } else { |
|
55 | - $item_id = 0; |
|
56 | - } |
|
57 | - |
|
58 | - $top_sellers[] = array( |
|
59 | - 'name' => sanitize_text_field( $item_name ), |
|
60 | - 'item_id' => $item_id, |
|
61 | - 'quantity' => $item_qty, |
|
62 | - 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
63 | - 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
64 | - ); |
|
65 | - |
|
66 | - } |
|
67 | - |
|
68 | - $data = array(); |
|
69 | - foreach ( $top_sellers as $top_seller ) { |
|
70 | - $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
71 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
72 | - } |
|
73 | - |
|
74 | - return rest_ensure_response( $data ); |
|
75 | - |
|
76 | - } |
|
77 | - |
|
78 | - /** |
|
79 | - * Prepare a report sales object for serialization. |
|
80 | - * |
|
81 | - * @param stdClass $top_seller |
|
82 | - * @param WP_REST_Request $request Request object. |
|
83 | - * @return WP_REST_Response $response Response data. |
|
84 | - */ |
|
85 | - public function prepare_item_for_response( $top_seller, $request ) { |
|
86 | - $data = (array) $top_seller; |
|
87 | - |
|
88 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
89 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
90 | - $data = $this->filter_response_by_context( $data, $context ); |
|
91 | - |
|
92 | - // Wrap the data in a response object. |
|
93 | - $response = rest_ensure_response( $data ); |
|
94 | - $links = array( |
|
95 | - 'about' => array( |
|
96 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
97 | - ), |
|
98 | - ); |
|
99 | - |
|
100 | - if ( ! empty( $top_seller->item_id ) ) { |
|
101 | - $links['item'] = array( |
|
102 | - 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
103 | - 'embeddable' => true, |
|
104 | - ); |
|
105 | - } |
|
106 | - |
|
107 | - $response->add_links( $links ); |
|
108 | - return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Get all data needed for this report and store in the class. |
|
113 | - */ |
|
114 | - protected function query_report_data() { |
|
115 | - |
|
116 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
117 | - array( |
|
118 | - 'data' => array( |
|
119 | - 'quantity' => array( |
|
120 | - 'type' => 'invoice_item', |
|
121 | - 'function' => 'SUM', |
|
122 | - 'name' => 'invoice_item_qty', |
|
123 | - ), |
|
124 | - 'item_id' => array( |
|
125 | - 'type' => 'invoice_item', |
|
126 | - 'function' => '', |
|
127 | - 'name' => 'invoice_item_id', |
|
128 | - ), |
|
129 | - 'item_name' => array( |
|
130 | - 'type' => 'invoice_item', |
|
131 | - 'function' => '', |
|
132 | - 'name' => 'invoice_item_name', |
|
133 | - ), |
|
134 | - 'price' => array( |
|
135 | - 'type' => 'invoice_item', |
|
136 | - 'function' => 'SUM', |
|
137 | - 'name' => 'invoice_item_price', |
|
138 | - ), |
|
139 | - ), |
|
140 | - 'group_by' => 'invoice_item_id', |
|
141 | - 'order_by' => 'invoice_item_qty DESC', |
|
142 | - 'query_type' => 'get_results', |
|
143 | - 'limit' => 10, |
|
144 | - 'filter_range' => $this->report_range, |
|
145 | - ) |
|
146 | - ); |
|
147 | - |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Get the Report's schema, conforming to JSON Schema. |
|
152 | - * |
|
153 | - * @return array |
|
154 | - */ |
|
155 | - public function get_item_schema() { |
|
156 | - $schema = array( |
|
157 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
158 | - 'title' => $this->rest_base, |
|
159 | - 'type' => 'object', |
|
160 | - 'properties' => array( |
|
161 | - 'name' => array( |
|
162 | - 'description' => __( 'Item name.', 'invoicing' ), |
|
163 | - 'type' => 'string', |
|
164 | - 'context' => array( 'view' ), |
|
165 | - 'readonly' => true, |
|
166 | - ), |
|
167 | - 'item_id' => array( |
|
168 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
169 | - 'type' => 'integer', |
|
170 | - 'context' => array( 'view' ), |
|
171 | - 'readonly' => true, |
|
172 | - ), |
|
173 | - 'quantity' => array( |
|
174 | - 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
175 | - 'type' => 'number', |
|
176 | - 'context' => array( 'view' ), |
|
177 | - 'readonly' => true, |
|
178 | - ), |
|
179 | - 'earnings' => array( |
|
180 | - 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
181 | - 'type' => 'number', |
|
182 | - 'context' => array( 'view' ), |
|
183 | - 'readonly' => true, |
|
184 | - ), |
|
185 | - 'earnings_formatted"' => array( |
|
186 | - 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
187 | - 'type' => 'string', |
|
188 | - 'context' => array( 'view' ), |
|
189 | - 'readonly' => true, |
|
190 | - ), |
|
191 | - ), |
|
192 | - ); |
|
193 | - |
|
194 | - return $this->add_additional_fields_schema( $schema ); |
|
195 | - } |
|
21 | + /** |
|
22 | + * Route base. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $rest_base = 'reports/top_sellers'; |
|
27 | + |
|
28 | + /** |
|
29 | + * Get top sellers report. |
|
30 | + * |
|
31 | + * @param WP_REST_Request $request |
|
32 | + * @return array|WP_Error |
|
33 | + */ |
|
34 | + public function get_items( $request ) { |
|
35 | + |
|
36 | + // Prepare items. |
|
37 | + $this->report_range = $this->get_date_range( $request ); |
|
38 | + $report_data = $this->get_report_data(); |
|
39 | + |
|
40 | + $top_sellers = array(); |
|
41 | + |
|
42 | + foreach ( $report_data as $item ) { |
|
43 | + |
|
44 | + $item_obj = new WPInv_Item( $item ); |
|
45 | + $item_name = $item->invoice_item_name; |
|
46 | + $item_qty = floatval( $item->invoice_item_qty ); |
|
47 | + $item_id = absint( $item->invoice_item_id ); |
|
48 | + $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
49 | + |
|
50 | + $item_obj = new WPInv_Item( $item_id ); |
|
51 | + |
|
52 | + if ( $item_obj->exists() ) { |
|
53 | + $item_name = $item_obj->get_name(); |
|
54 | + } else { |
|
55 | + $item_id = 0; |
|
56 | + } |
|
57 | + |
|
58 | + $top_sellers[] = array( |
|
59 | + 'name' => sanitize_text_field( $item_name ), |
|
60 | + 'item_id' => $item_id, |
|
61 | + 'quantity' => $item_qty, |
|
62 | + 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
63 | + 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
64 | + ); |
|
65 | + |
|
66 | + } |
|
67 | + |
|
68 | + $data = array(); |
|
69 | + foreach ( $top_sellers as $top_seller ) { |
|
70 | + $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
71 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
72 | + } |
|
73 | + |
|
74 | + return rest_ensure_response( $data ); |
|
75 | + |
|
76 | + } |
|
77 | + |
|
78 | + /** |
|
79 | + * Prepare a report sales object for serialization. |
|
80 | + * |
|
81 | + * @param stdClass $top_seller |
|
82 | + * @param WP_REST_Request $request Request object. |
|
83 | + * @return WP_REST_Response $response Response data. |
|
84 | + */ |
|
85 | + public function prepare_item_for_response( $top_seller, $request ) { |
|
86 | + $data = (array) $top_seller; |
|
87 | + |
|
88 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
89 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
90 | + $data = $this->filter_response_by_context( $data, $context ); |
|
91 | + |
|
92 | + // Wrap the data in a response object. |
|
93 | + $response = rest_ensure_response( $data ); |
|
94 | + $links = array( |
|
95 | + 'about' => array( |
|
96 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
97 | + ), |
|
98 | + ); |
|
99 | + |
|
100 | + if ( ! empty( $top_seller->item_id ) ) { |
|
101 | + $links['item'] = array( |
|
102 | + 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
103 | + 'embeddable' => true, |
|
104 | + ); |
|
105 | + } |
|
106 | + |
|
107 | + $response->add_links( $links ); |
|
108 | + return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Get all data needed for this report and store in the class. |
|
113 | + */ |
|
114 | + protected function query_report_data() { |
|
115 | + |
|
116 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
117 | + array( |
|
118 | + 'data' => array( |
|
119 | + 'quantity' => array( |
|
120 | + 'type' => 'invoice_item', |
|
121 | + 'function' => 'SUM', |
|
122 | + 'name' => 'invoice_item_qty', |
|
123 | + ), |
|
124 | + 'item_id' => array( |
|
125 | + 'type' => 'invoice_item', |
|
126 | + 'function' => '', |
|
127 | + 'name' => 'invoice_item_id', |
|
128 | + ), |
|
129 | + 'item_name' => array( |
|
130 | + 'type' => 'invoice_item', |
|
131 | + 'function' => '', |
|
132 | + 'name' => 'invoice_item_name', |
|
133 | + ), |
|
134 | + 'price' => array( |
|
135 | + 'type' => 'invoice_item', |
|
136 | + 'function' => 'SUM', |
|
137 | + 'name' => 'invoice_item_price', |
|
138 | + ), |
|
139 | + ), |
|
140 | + 'group_by' => 'invoice_item_id', |
|
141 | + 'order_by' => 'invoice_item_qty DESC', |
|
142 | + 'query_type' => 'get_results', |
|
143 | + 'limit' => 10, |
|
144 | + 'filter_range' => $this->report_range, |
|
145 | + ) |
|
146 | + ); |
|
147 | + |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Get the Report's schema, conforming to JSON Schema. |
|
152 | + * |
|
153 | + * @return array |
|
154 | + */ |
|
155 | + public function get_item_schema() { |
|
156 | + $schema = array( |
|
157 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
158 | + 'title' => $this->rest_base, |
|
159 | + 'type' => 'object', |
|
160 | + 'properties' => array( |
|
161 | + 'name' => array( |
|
162 | + 'description' => __( 'Item name.', 'invoicing' ), |
|
163 | + 'type' => 'string', |
|
164 | + 'context' => array( 'view' ), |
|
165 | + 'readonly' => true, |
|
166 | + ), |
|
167 | + 'item_id' => array( |
|
168 | + 'description' => __( 'Item ID.', 'invoicing' ), |
|
169 | + 'type' => 'integer', |
|
170 | + 'context' => array( 'view' ), |
|
171 | + 'readonly' => true, |
|
172 | + ), |
|
173 | + 'quantity' => array( |
|
174 | + 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
175 | + 'type' => 'number', |
|
176 | + 'context' => array( 'view' ), |
|
177 | + 'readonly' => true, |
|
178 | + ), |
|
179 | + 'earnings' => array( |
|
180 | + 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
181 | + 'type' => 'number', |
|
182 | + 'context' => array( 'view' ), |
|
183 | + 'readonly' => true, |
|
184 | + ), |
|
185 | + 'earnings_formatted"' => array( |
|
186 | + 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
187 | + 'type' => 'string', |
|
188 | + 'context' => array( 'view' ), |
|
189 | + 'readonly' => true, |
|
190 | + ), |
|
191 | + ), |
|
192 | + ); |
|
193 | + |
|
194 | + return $this->add_additional_fields_schema( $schema ); |
|
195 | + } |
|
196 | 196 | } |
@@ -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 top sellers controller class. |
@@ -31,47 +31,47 @@ discard block |
||
31 | 31 | * @param WP_REST_Request $request |
32 | 32 | * @return array|WP_Error |
33 | 33 | */ |
34 | - public function get_items( $request ) { |
|
34 | + public function get_items($request) { |
|
35 | 35 | |
36 | 36 | // Prepare items. |
37 | - $this->report_range = $this->get_date_range( $request ); |
|
37 | + $this->report_range = $this->get_date_range($request); |
|
38 | 38 | $report_data = $this->get_report_data(); |
39 | 39 | |
40 | 40 | $top_sellers = array(); |
41 | 41 | |
42 | - foreach ( $report_data as $item ) { |
|
42 | + foreach ($report_data as $item) { |
|
43 | 43 | |
44 | - $item_obj = new WPInv_Item( $item ); |
|
44 | + $item_obj = new WPInv_Item($item); |
|
45 | 45 | $item_name = $item->invoice_item_name; |
46 | - $item_qty = floatval( $item->invoice_item_qty ); |
|
47 | - $item_id = absint( $item->invoice_item_id ); |
|
48 | - $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
46 | + $item_qty = floatval($item->invoice_item_qty); |
|
47 | + $item_id = absint($item->invoice_item_id); |
|
48 | + $price = sanitize_text_field(wpinv_price($item->invoice_item_price)); |
|
49 | 49 | |
50 | - $item_obj = new WPInv_Item( $item_id ); |
|
50 | + $item_obj = new WPInv_Item($item_id); |
|
51 | 51 | |
52 | - if ( $item_obj->exists() ) { |
|
52 | + if ($item_obj->exists()) { |
|
53 | 53 | $item_name = $item_obj->get_name(); |
54 | 54 | } else { |
55 | 55 | $item_id = 0; |
56 | 56 | } |
57 | 57 | |
58 | 58 | $top_sellers[] = array( |
59 | - 'name' => sanitize_text_field( $item_name ), |
|
59 | + 'name' => sanitize_text_field($item_name), |
|
60 | 60 | 'item_id' => $item_id, |
61 | 61 | 'quantity' => $item_qty, |
62 | - 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
63 | - 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
62 | + 'earnings' => wpinv_round_amount($item->invoice_item_price), |
|
63 | + 'earnings_formatted' => sanitize_text_field(wpinv_price($price)), |
|
64 | 64 | ); |
65 | 65 | |
66 | 66 | } |
67 | 67 | |
68 | 68 | $data = array(); |
69 | - foreach ( $top_sellers as $top_seller ) { |
|
70 | - $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
71 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
69 | + foreach ($top_sellers as $top_seller) { |
|
70 | + $item = $this->prepare_item_for_response((object) $top_seller, $request); |
|
71 | + $data[] = $this->prepare_response_for_collection($item); |
|
72 | 72 | } |
73 | 73 | |
74 | - return rest_ensure_response( $data ); |
|
74 | + return rest_ensure_response($data); |
|
75 | 75 | |
76 | 76 | } |
77 | 77 | |
@@ -82,30 +82,30 @@ discard block |
||
82 | 82 | * @param WP_REST_Request $request Request object. |
83 | 83 | * @return WP_REST_Response $response Response data. |
84 | 84 | */ |
85 | - public function prepare_item_for_response( $top_seller, $request ) { |
|
85 | + public function prepare_item_for_response($top_seller, $request) { |
|
86 | 86 | $data = (array) $top_seller; |
87 | 87 | |
88 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
89 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
90 | - $data = $this->filter_response_by_context( $data, $context ); |
|
88 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
89 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
90 | + $data = $this->filter_response_by_context($data, $context); |
|
91 | 91 | |
92 | 92 | // Wrap the data in a response object. |
93 | - $response = rest_ensure_response( $data ); |
|
93 | + $response = rest_ensure_response($data); |
|
94 | 94 | $links = array( |
95 | 95 | 'about' => array( |
96 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
96 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
97 | 97 | ), |
98 | 98 | ); |
99 | 99 | |
100 | - if ( ! empty( $top_seller->item_id ) ) { |
|
101 | - $links['item'] = array( |
|
102 | - 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
100 | + if (!empty($top_seller->item_id)) { |
|
101 | + $links['item'] = array( |
|
102 | + 'href' => rest_url(sprintf('/%s/items/%s', $this->namespace, $top_seller->item_id)), |
|
103 | 103 | 'embeddable' => true, |
104 | 104 | ); |
105 | 105 | } |
106 | 106 | |
107 | - $response->add_links( $links ); |
|
108 | - return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
107 | + $response->add_links($links); |
|
108 | + return apply_filters('getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request); |
|
109 | 109 | } |
110 | 110 | |
111 | 111 | /** |
@@ -159,38 +159,38 @@ discard block |
||
159 | 159 | 'type' => 'object', |
160 | 160 | 'properties' => array( |
161 | 161 | 'name' => array( |
162 | - 'description' => __( 'Item name.', 'invoicing' ), |
|
162 | + 'description' => __('Item name.', 'invoicing'), |
|
163 | 163 | 'type' => 'string', |
164 | - 'context' => array( 'view' ), |
|
164 | + 'context' => array('view'), |
|
165 | 165 | 'readonly' => true, |
166 | 166 | ), |
167 | 167 | 'item_id' => array( |
168 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
168 | + 'description' => __('Item ID.', 'invoicing'), |
|
169 | 169 | 'type' => 'integer', |
170 | - 'context' => array( 'view' ), |
|
170 | + 'context' => array('view'), |
|
171 | 171 | 'readonly' => true, |
172 | 172 | ), |
173 | 173 | 'quantity' => array( |
174 | - 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
174 | + 'description' => __('Total number of purchases.', 'invoicing'), |
|
175 | 175 | 'type' => 'number', |
176 | - 'context' => array( 'view' ), |
|
176 | + 'context' => array('view'), |
|
177 | 177 | 'readonly' => true, |
178 | 178 | ), |
179 | 179 | 'earnings' => array( |
180 | - 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
180 | + 'description' => __('Total earnings for the item.', 'invoicing'), |
|
181 | 181 | 'type' => 'number', |
182 | - 'context' => array( 'view' ), |
|
182 | + 'context' => array('view'), |
|
183 | 183 | 'readonly' => true, |
184 | 184 | ), |
185 | 185 | 'earnings_formatted"' => array( |
186 | - 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
186 | + 'description' => __('Total earnings (formatted) for the item.', 'invoicing'), |
|
187 | 187 | 'type' => 'string', |
188 | - 'context' => array( 'view' ), |
|
188 | + 'context' => array('view'), |
|
189 | 189 | 'readonly' => true, |
190 | 190 | ), |
191 | 191 | ), |
192 | 192 | ); |
193 | 193 | |
194 | - return $this->add_additional_fields_schema( $schema ); |
|
194 | + return $this->add_additional_fields_schema($schema); |
|
195 | 195 | } |
196 | 196 | } |
@@ -15,168 +15,168 @@ |
||
15 | 15 | class WPInv_REST_Items_Controller extends GetPaid_REST_Posts_Controller { |
16 | 16 | |
17 | 17 | /** |
18 | - * Post type. |
|
19 | - * |
|
20 | - * @var string |
|
21 | - */ |
|
22 | - protected $post_type = 'wpi_item'; |
|
23 | - |
|
24 | - /** |
|
25 | - * The base of this controller's route. |
|
26 | - * |
|
27 | - * @since 1.0.13 |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $rest_base = 'items'; |
|
31 | - |
|
32 | - /** Contains this controller's class name. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public $crud_class = 'WPInv_Item'; |
|
37 | - |
|
38 | - /** |
|
39 | - * Registers the routes for the objects of the controller. |
|
40 | - * |
|
41 | - * @since 1.0.19 |
|
42 | - * |
|
43 | - * @see register_rest_route() |
|
44 | - */ |
|
45 | - public function register_namespace_routes( $namespace ) { |
|
46 | - |
|
47 | - parent::register_namespace_routes( $namespace ); |
|
48 | - |
|
49 | - register_rest_route( |
|
50 | - $this->namespace, |
|
51 | - '/' . $this->rest_base . '/item-types', |
|
52 | - array( |
|
53 | - array( |
|
54 | - 'methods' => WP_REST_Server::READABLE, |
|
55 | - 'callback' => array( $this, 'get_item_types' ), |
|
56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | - ), |
|
58 | - ) |
|
59 | - ); |
|
60 | - |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Handles rest requests for item types. |
|
65 | - * |
|
66 | - * @since 1.0.13 |
|
67 | - * |
|
68 | - * |
|
69 | - * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | - */ |
|
71 | - public function get_item_types() { |
|
72 | - return rest_ensure_response( wpinv_get_item_types() ); |
|
73 | - } |
|
18 | + * Post type. |
|
19 | + * |
|
20 | + * @var string |
|
21 | + */ |
|
22 | + protected $post_type = 'wpi_item'; |
|
74 | 23 | |
75 | 24 | /** |
76 | - * Retrieves the query params for the items collection. |
|
77 | - * |
|
78 | - * @since 1.0.13 |
|
79 | - * |
|
80 | - * @return array Collection parameters. |
|
81 | - */ |
|
82 | - public function get_collection_params() { |
|
83 | - |
|
84 | - $params = array_merge( |
|
85 | - parent::get_collection_params(), |
|
86 | - array( |
|
87 | - |
|
88 | - // Item types |
|
89 | - 'type' => array( |
|
90 | - 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
91 | - 'type' => array( 'array', 'string' ), |
|
92 | - 'default' => 'any', |
|
93 | - 'validate_callback' => 'rest_validate_request_arg', |
|
94 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
95 | - 'items' => array( |
|
96 | - 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
97 | - 'type' => 'string', |
|
98 | - ), |
|
99 | - ), |
|
100 | - |
|
101 | - ) |
|
102 | - ); |
|
103 | - |
|
104 | - // Filter collection parameters for the items controller. |
|
105 | - return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
106 | - |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * Determine the allowed query_vars for a get_items() response and |
|
111 | - * prepare for WP_Query. |
|
112 | - * |
|
113 | - * @param array $prepared_args Prepared arguments. |
|
114 | - * @param WP_REST_Request $request Request object. |
|
115 | - * @return array $query_args |
|
116 | - */ |
|
117 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
118 | - |
|
119 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
120 | - |
|
121 | - // Retrieve items by type. |
|
122 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
123 | - |
|
124 | - if ( empty( $query_args['meta_query'] ) ) { |
|
125 | - $query_args['meta_query'] = array(); |
|
126 | - } |
|
127 | - |
|
128 | - $query_args['meta_query'][] = array( |
|
129 | - 'key' => '_wpinv_type', |
|
130 | - 'value' => implode( ',', $request['type'] ), |
|
131 | - 'compare' => 'IN', |
|
132 | - ); |
|
133 | - |
|
134 | - } |
|
135 | - |
|
136 | - return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
137 | - |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Retrieves a valid list of post statuses. |
|
142 | - * |
|
143 | - * @since 1.0.15 |
|
144 | - * |
|
145 | - * @return array A list of registered item statuses. |
|
146 | - */ |
|
147 | - public function get_post_statuses() { |
|
148 | - return array( 'draft', 'pending', 'publish' ); |
|
149 | - } |
|
150 | - |
|
151 | - /** |
|
152 | - * Checks if a key should be included in a response. |
|
153 | - * |
|
154 | - * @since 1.0.19 |
|
155 | - * @param WPInv_Item $item Item object. |
|
156 | - * @param string $field_key The key to check for. |
|
157 | - * @return bool |
|
158 | - */ |
|
159 | - public function object_supports_field( $item, $field_key ) { |
|
160 | - |
|
161 | - if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
162 | - return false; |
|
163 | - } |
|
164 | - |
|
165 | - foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
166 | - |
|
167 | - if ( $key == $field_key && ! $item->is_recurring() ) { |
|
168 | - return false; |
|
169 | - } |
|
25 | + * The base of this controller's route. |
|
26 | + * |
|
27 | + * @since 1.0.13 |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $rest_base = 'items'; |
|
31 | + |
|
32 | + /** Contains this controller's class name. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public $crud_class = 'WPInv_Item'; |
|
37 | + |
|
38 | + /** |
|
39 | + * Registers the routes for the objects of the controller. |
|
40 | + * |
|
41 | + * @since 1.0.19 |
|
42 | + * |
|
43 | + * @see register_rest_route() |
|
44 | + */ |
|
45 | + public function register_namespace_routes( $namespace ) { |
|
46 | + |
|
47 | + parent::register_namespace_routes( $namespace ); |
|
48 | + |
|
49 | + register_rest_route( |
|
50 | + $this->namespace, |
|
51 | + '/' . $this->rest_base . '/item-types', |
|
52 | + array( |
|
53 | + array( |
|
54 | + 'methods' => WP_REST_Server::READABLE, |
|
55 | + 'callback' => array( $this, 'get_item_types' ), |
|
56 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | + ), |
|
58 | + ) |
|
59 | + ); |
|
60 | + |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Handles rest requests for item types. |
|
65 | + * |
|
66 | + * @since 1.0.13 |
|
67 | + * |
|
68 | + * |
|
69 | + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | + */ |
|
71 | + public function get_item_types() { |
|
72 | + return rest_ensure_response( wpinv_get_item_types() ); |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * Retrieves the query params for the items collection. |
|
77 | + * |
|
78 | + * @since 1.0.13 |
|
79 | + * |
|
80 | + * @return array Collection parameters. |
|
81 | + */ |
|
82 | + public function get_collection_params() { |
|
83 | + |
|
84 | + $params = array_merge( |
|
85 | + parent::get_collection_params(), |
|
86 | + array( |
|
87 | + |
|
88 | + // Item types |
|
89 | + 'type' => array( |
|
90 | + 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
91 | + 'type' => array( 'array', 'string' ), |
|
92 | + 'default' => 'any', |
|
93 | + 'validate_callback' => 'rest_validate_request_arg', |
|
94 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
95 | + 'items' => array( |
|
96 | + 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
97 | + 'type' => 'string', |
|
98 | + ), |
|
99 | + ), |
|
100 | + |
|
101 | + ) |
|
102 | + ); |
|
103 | + |
|
104 | + // Filter collection parameters for the items controller. |
|
105 | + return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
106 | + |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * Determine the allowed query_vars for a get_items() response and |
|
111 | + * prepare for WP_Query. |
|
112 | + * |
|
113 | + * @param array $prepared_args Prepared arguments. |
|
114 | + * @param WP_REST_Request $request Request object. |
|
115 | + * @return array $query_args |
|
116 | + */ |
|
117 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
118 | + |
|
119 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
120 | + |
|
121 | + // Retrieve items by type. |
|
122 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
123 | + |
|
124 | + if ( empty( $query_args['meta_query'] ) ) { |
|
125 | + $query_args['meta_query'] = array(); |
|
126 | + } |
|
127 | + |
|
128 | + $query_args['meta_query'][] = array( |
|
129 | + 'key' => '_wpinv_type', |
|
130 | + 'value' => implode( ',', $request['type'] ), |
|
131 | + 'compare' => 'IN', |
|
132 | + ); |
|
133 | + |
|
134 | + } |
|
135 | + |
|
136 | + return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
137 | + |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Retrieves a valid list of post statuses. |
|
142 | + * |
|
143 | + * @since 1.0.15 |
|
144 | + * |
|
145 | + * @return array A list of registered item statuses. |
|
146 | + */ |
|
147 | + public function get_post_statuses() { |
|
148 | + return array( 'draft', 'pending', 'publish' ); |
|
149 | + } |
|
150 | + |
|
151 | + /** |
|
152 | + * Checks if a key should be included in a response. |
|
153 | + * |
|
154 | + * @since 1.0.19 |
|
155 | + * @param WPInv_Item $item Item object. |
|
156 | + * @param string $field_key The key to check for. |
|
157 | + * @return bool |
|
158 | + */ |
|
159 | + public function object_supports_field( $item, $field_key ) { |
|
160 | + |
|
161 | + if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
162 | + return false; |
|
163 | + } |
|
164 | + |
|
165 | + foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
166 | + |
|
167 | + if ( $key == $field_key && ! $item->is_recurring() ) { |
|
168 | + return false; |
|
169 | + } |
|
170 | 170 | } |
171 | 171 | |
172 | - foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
172 | + foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
173 | 173 | |
174 | - if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
175 | - return false; |
|
176 | - } |
|
174 | + if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
175 | + return false; |
|
176 | + } |
|
177 | 177 | } |
178 | 178 | |
179 | - return parent::object_supports_field( $item, $field_key ); |
|
180 | - } |
|
179 | + return parent::object_supports_field( $item, $field_key ); |
|
180 | + } |
|
181 | 181 | |
182 | 182 | } |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * @version 1.0.19 |
6 | 6 | */ |
7 | 7 | |
8 | -defined( 'ABSPATH' ) || exit; |
|
8 | +defined('ABSPATH') || exit; |
|
9 | 9 | |
10 | 10 | /** |
11 | 11 | * REST API items controller class. |
@@ -42,9 +42,9 @@ discard block |
||
42 | 42 | * |
43 | 43 | * @see register_rest_route() |
44 | 44 | */ |
45 | - public function register_namespace_routes( $namespace ) { |
|
45 | + public function register_namespace_routes($namespace) { |
|
46 | 46 | |
47 | - parent::register_namespace_routes( $namespace ); |
|
47 | + parent::register_namespace_routes($namespace); |
|
48 | 48 | |
49 | 49 | register_rest_route( |
50 | 50 | $this->namespace, |
@@ -52,8 +52,8 @@ discard block |
||
52 | 52 | array( |
53 | 53 | array( |
54 | 54 | 'methods' => WP_REST_Server::READABLE, |
55 | - 'callback' => array( $this, 'get_item_types' ), |
|
56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
55 | + 'callback' => array($this, 'get_item_types'), |
|
56 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
57 | 57 | ), |
58 | 58 | ) |
59 | 59 | ); |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
70 | 70 | */ |
71 | 71 | public function get_item_types() { |
72 | - return rest_ensure_response( wpinv_get_item_types() ); |
|
72 | + return rest_ensure_response(wpinv_get_item_types()); |
|
73 | 73 | } |
74 | 74 | |
75 | 75 | /** |
@@ -87,13 +87,13 @@ discard block |
||
87 | 87 | |
88 | 88 | // Item types |
89 | 89 | 'type' => array( |
90 | - 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
91 | - 'type' => array( 'array', 'string' ), |
|
90 | + 'description' => __('Type of items to fetch.', 'invoicing'), |
|
91 | + 'type' => array('array', 'string'), |
|
92 | 92 | 'default' => 'any', |
93 | 93 | 'validate_callback' => 'rest_validate_request_arg', |
94 | 94 | 'sanitize_callback' => 'wpinv_parse_list', |
95 | 95 | 'items' => array( |
96 | - 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
96 | + 'enum' => array_merge(array('any'), wpinv_item_types()), |
|
97 | 97 | 'type' => 'string', |
98 | 98 | ), |
99 | 99 | ), |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | ); |
103 | 103 | |
104 | 104 | // Filter collection parameters for the items controller. |
105 | - return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
105 | + return apply_filters('getpaid_rest_items_collection_params', $params, $this); |
|
106 | 106 | |
107 | 107 | } |
108 | 108 | |
@@ -114,26 +114,26 @@ discard block |
||
114 | 114 | * @param WP_REST_Request $request Request object. |
115 | 115 | * @return array $query_args |
116 | 116 | */ |
117 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
117 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
118 | 118 | |
119 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
119 | + $query_args = parent::prepare_items_query($prepared_args); |
|
120 | 120 | |
121 | 121 | // Retrieve items by type. |
122 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
122 | + if (!in_array('any', $request['type'])) { |
|
123 | 123 | |
124 | - if ( empty( $query_args['meta_query'] ) ) { |
|
124 | + if (empty($query_args['meta_query'])) { |
|
125 | 125 | $query_args['meta_query'] = array(); |
126 | 126 | } |
127 | 127 | |
128 | 128 | $query_args['meta_query'][] = array( |
129 | 129 | 'key' => '_wpinv_type', |
130 | - 'value' => implode( ',', $request['type'] ), |
|
130 | + 'value' => implode(',', $request['type']), |
|
131 | 131 | 'compare' => 'IN', |
132 | 132 | ); |
133 | 133 | |
134 | 134 | } |
135 | 135 | |
136 | - return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
136 | + return apply_filters('getpaid_rest_items_prepare_items_query', $query_args, $request, $this); |
|
137 | 137 | |
138 | 138 | } |
139 | 139 | |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | * @return array A list of registered item statuses. |
146 | 146 | */ |
147 | 147 | public function get_post_statuses() { |
148 | - return array( 'draft', 'pending', 'publish' ); |
|
148 | + return array('draft', 'pending', 'publish'); |
|
149 | 149 | } |
150 | 150 | |
151 | 151 | /** |
@@ -156,27 +156,27 @@ discard block |
||
156 | 156 | * @param string $field_key The key to check for. |
157 | 157 | * @return bool |
158 | 158 | */ |
159 | - public function object_supports_field( $item, $field_key ) { |
|
159 | + public function object_supports_field($item, $field_key) { |
|
160 | 160 | |
161 | - if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
161 | + if ('minimum_price' == $field_key && !$item->user_can_set_their_price()) { |
|
162 | 162 | return false; |
163 | 163 | } |
164 | 164 | |
165 | - foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
165 | + foreach (wpinv_parse_list('initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date') as $key) { |
|
166 | 166 | |
167 | - if ( $key == $field_key && ! $item->is_recurring() ) { |
|
167 | + if ($key == $field_key && !$item->is_recurring()) { |
|
168 | 168 | return false; |
169 | 169 | } |
170 | 170 | } |
171 | 171 | |
172 | - foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
172 | + foreach (wpinv_parse_list('trial_period trial_interval') as $key) { |
|
173 | 173 | |
174 | - if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
174 | + if ($key == $field_key && !$item->has_free_trial()) { |
|
175 | 175 | return false; |
176 | 176 | } |
177 | 177 | } |
178 | 178 | |
179 | - return parent::object_supports_field( $item, $field_key ); |
|
179 | + return parent::object_supports_field($item, $field_key); |
|
180 | 180 | } |
181 | 181 | |
182 | 182 | } |
@@ -18,688 +18,688 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * Route base. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $rest_base = 'reports/sales'; |
|
27 | - |
|
28 | - /** |
|
29 | - * The report data. |
|
30 | - * |
|
31 | - * @var stdClass |
|
32 | - */ |
|
33 | - public $report_data; |
|
34 | - |
|
35 | - /** |
|
36 | - * The report range. |
|
37 | - * |
|
38 | - * @var array |
|
39 | - */ |
|
40 | - public $report_range; |
|
41 | - |
|
42 | - /** |
|
43 | - * Registers the routes for the objects of the controller. |
|
44 | - * |
|
45 | - * @since 2.0.0 |
|
46 | - * |
|
47 | - * @see register_rest_route() |
|
48 | - */ |
|
49 | - public function register_namespace_routes( $namespace ) { |
|
50 | - |
|
51 | - // Get sales report. |
|
52 | - register_rest_route( |
|
53 | - $namespace, |
|
54 | - $this->rest_base, |
|
55 | - array( |
|
56 | - array( |
|
57 | - 'methods' => WP_REST_Server::READABLE, |
|
58 | - 'callback' => array( $this, 'get_items' ), |
|
59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | - 'args' => $this->get_collection_params(), |
|
61 | - ), |
|
62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
63 | - ) |
|
64 | - ); |
|
65 | - |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Makes sure the current user has access to READ the report APIs. |
|
70 | - * |
|
71 | - * @since 2.0.0 |
|
72 | - * @param WP_REST_Request $request Full data about the request. |
|
73 | - * @return WP_Error|boolean |
|
74 | - */ |
|
75 | - public function get_items_permissions_check( $request ) { |
|
76 | - |
|
77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | - } |
|
80 | - |
|
81 | - return true; |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * Get sales reports. |
|
86 | - * |
|
87 | - * @param WP_REST_Request $request |
|
88 | - * @return array|WP_Error |
|
89 | - */ |
|
90 | - public function get_items( $request ) { |
|
91 | - $data = array(); |
|
92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | - |
|
95 | - return rest_ensure_response( $data ); |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Prepare a report sales object for serialization. |
|
100 | - * |
|
101 | - * @param null $_ |
|
102 | - * @param WP_REST_Request $request Request object. |
|
103 | - * @return WP_REST_Response $response Response data. |
|
104 | - */ |
|
105 | - public function prepare_item_for_response( $_, $request ) { |
|
106 | - |
|
107 | - // Set report range. |
|
108 | - $this->report_range = $this->get_date_range( $request ); |
|
109 | - |
|
110 | - $report_data = $this->get_report_data(); |
|
111 | - $period_totals = array(); |
|
112 | - |
|
113 | - // Setup period totals by ensuring each period in the interval has data. |
|
114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
115 | - |
|
116 | - if ( 'month' === $this->groupby ) { |
|
117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
118 | - } |
|
119 | - |
|
120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | - |
|
122 | - switch ( $this->groupby ) { |
|
123 | - case 'day': |
|
124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | - break; |
|
126 | - default: |
|
127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | - break; |
|
129 | - } |
|
130 | - |
|
131 | - // Set the defaults for each period. |
|
132 | - $period_totals[ $time ] = array( |
|
133 | - 'invoices' => 0, |
|
134 | - 'items' => 0, |
|
135 | - 'refunded_items' => 0, |
|
136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | - ); |
|
142 | - |
|
143 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | - } |
|
147 | - } |
|
21 | + /** |
|
22 | + * Route base. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $rest_base = 'reports/sales'; |
|
27 | + |
|
28 | + /** |
|
29 | + * The report data. |
|
30 | + * |
|
31 | + * @var stdClass |
|
32 | + */ |
|
33 | + public $report_data; |
|
34 | + |
|
35 | + /** |
|
36 | + * The report range. |
|
37 | + * |
|
38 | + * @var array |
|
39 | + */ |
|
40 | + public $report_range; |
|
41 | + |
|
42 | + /** |
|
43 | + * Registers the routes for the objects of the controller. |
|
44 | + * |
|
45 | + * @since 2.0.0 |
|
46 | + * |
|
47 | + * @see register_rest_route() |
|
48 | + */ |
|
49 | + public function register_namespace_routes( $namespace ) { |
|
50 | + |
|
51 | + // Get sales report. |
|
52 | + register_rest_route( |
|
53 | + $namespace, |
|
54 | + $this->rest_base, |
|
55 | + array( |
|
56 | + array( |
|
57 | + 'methods' => WP_REST_Server::READABLE, |
|
58 | + 'callback' => array( $this, 'get_items' ), |
|
59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | + 'args' => $this->get_collection_params(), |
|
61 | + ), |
|
62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
63 | + ) |
|
64 | + ); |
|
65 | + |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Makes sure the current user has access to READ the report APIs. |
|
70 | + * |
|
71 | + * @since 2.0.0 |
|
72 | + * @param WP_REST_Request $request Full data about the request. |
|
73 | + * @return WP_Error|boolean |
|
74 | + */ |
|
75 | + public function get_items_permissions_check( $request ) { |
|
76 | + |
|
77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | + } |
|
80 | + |
|
81 | + return true; |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * Get sales reports. |
|
86 | + * |
|
87 | + * @param WP_REST_Request $request |
|
88 | + * @return array|WP_Error |
|
89 | + */ |
|
90 | + public function get_items( $request ) { |
|
91 | + $data = array(); |
|
92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | + |
|
95 | + return rest_ensure_response( $data ); |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Prepare a report sales object for serialization. |
|
100 | + * |
|
101 | + * @param null $_ |
|
102 | + * @param WP_REST_Request $request Request object. |
|
103 | + * @return WP_REST_Response $response Response data. |
|
104 | + */ |
|
105 | + public function prepare_item_for_response( $_, $request ) { |
|
106 | + |
|
107 | + // Set report range. |
|
108 | + $this->report_range = $this->get_date_range( $request ); |
|
109 | + |
|
110 | + $report_data = $this->get_report_data(); |
|
111 | + $period_totals = array(); |
|
112 | + |
|
113 | + // Setup period totals by ensuring each period in the interval has data. |
|
114 | + $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
115 | + |
|
116 | + if ( 'month' === $this->groupby ) { |
|
117 | + $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
118 | + } |
|
119 | + |
|
120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | + |
|
122 | + switch ( $this->groupby ) { |
|
123 | + case 'day': |
|
124 | + $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | + break; |
|
126 | + default: |
|
127 | + $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | + break; |
|
129 | + } |
|
130 | + |
|
131 | + // Set the defaults for each period. |
|
132 | + $period_totals[ $time ] = array( |
|
133 | + 'invoices' => 0, |
|
134 | + 'items' => 0, |
|
135 | + 'refunded_items' => 0, |
|
136 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | + ); |
|
142 | + |
|
143 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | + if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | + } |
|
147 | + } |
|
148 | 148 | } |
149 | 149 | |
150 | - // add total sales, total invoice count, total tax for each period |
|
151 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | - foreach ( $report_data->invoices as $invoice ) { |
|
153 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
150 | + // add total sales, total invoice count, total tax for each period |
|
151 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | + foreach ( $report_data->invoices as $invoice ) { |
|
153 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
154 | 154 | |
155 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | - continue; |
|
157 | - } |
|
155 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | + continue; |
|
157 | + } |
|
158 | 158 | |
159 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
159 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
163 | 163 | |
164 | - } |
|
164 | + } |
|
165 | 165 | |
166 | - foreach ( $report_data->refunds as $invoice ) { |
|
167 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
166 | + foreach ( $report_data->refunds as $invoice ) { |
|
167 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
168 | 168 | |
169 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | - continue; |
|
171 | - } |
|
169 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | + continue; |
|
171 | + } |
|
172 | 172 | |
173 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
173 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
177 | 177 | |
178 | - } |
|
178 | + } |
|
179 | 179 | |
180 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
180 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
182 | 182 | |
183 | - if ( isset( $period_totals[ $time ] ) ) { |
|
184 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | - } |
|
183 | + if ( isset( $period_totals[ $time ] ) ) { |
|
184 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | + } |
|
186 | 186 | } |
187 | 187 | |
188 | - // Add total invoice items for each period. |
|
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
188 | + // Add total invoice items for each period. |
|
189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | 191 | |
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | - } |
|
192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | + } |
|
195 | 195 | } |
196 | 196 | |
197 | - // Add total discount for each period. |
|
198 | - foreach ( $report_data->coupons as $discount ) { |
|
199 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
197 | + // Add total discount for each period. |
|
198 | + foreach ( $report_data->coupons as $discount ) { |
|
199 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
200 | 200 | |
201 | - if ( isset( $period_totals[ $time ] ) ) { |
|
202 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | - } |
|
201 | + if ( isset( $period_totals[ $time ] ) ) { |
|
202 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | + } |
|
204 | 204 | } |
205 | 205 | |
206 | - // Extra fields. |
|
207 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | - |
|
209 | - // Abort unprepared. |
|
210 | - if ( ! isset( $report_data->$key ) ) { |
|
211 | - continue; |
|
212 | - } |
|
213 | - |
|
214 | - // Abort defaults. |
|
215 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | - continue; |
|
217 | - } |
|
218 | - |
|
219 | - // Set values. |
|
220 | - foreach ( $report_data->$key as $item ) { |
|
221 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $item->date ) ) : date( 'Y-m', strtotime( $item->date ) ); |
|
222 | - |
|
223 | - if ( isset( $period_totals[ $time ] ) ) { |
|
224 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - unset( $report_data->$key ); |
|
229 | - } |
|
230 | - |
|
231 | - $report_data->totals = $period_totals; |
|
232 | - $report_data->grouped_by = $this->groupby; |
|
233 | - $report_data->interval = max( $this->interval, 1 ); |
|
234 | - $report_data->currency = wpinv_get_currency(); |
|
235 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | - $report_data->currency_position = wpinv_currency_position(); |
|
237 | - $report_data->decimal_places = wpinv_decimals(); |
|
238 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
241 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
242 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
243 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
244 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | - |
|
246 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | - $data = $report_data; |
|
248 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | - $data = $this->filter_response_by_context( $data, $context ); |
|
251 | - |
|
252 | - // Wrap the data in a response object. |
|
253 | - $response = rest_ensure_response( $data ); |
|
254 | - $response->add_links( |
|
206 | + // Extra fields. |
|
207 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | + |
|
209 | + // Abort unprepared. |
|
210 | + if ( ! isset( $report_data->$key ) ) { |
|
211 | + continue; |
|
212 | + } |
|
213 | + |
|
214 | + // Abort defaults. |
|
215 | + if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | + continue; |
|
217 | + } |
|
218 | + |
|
219 | + // Set values. |
|
220 | + foreach ( $report_data->$key as $item ) { |
|
221 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $item->date ) ) : date( 'Y-m', strtotime( $item->date ) ); |
|
222 | + |
|
223 | + if ( isset( $period_totals[ $time ] ) ) { |
|
224 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + unset( $report_data->$key ); |
|
229 | + } |
|
230 | + |
|
231 | + $report_data->totals = $period_totals; |
|
232 | + $report_data->grouped_by = $this->groupby; |
|
233 | + $report_data->interval = max( $this->interval, 1 ); |
|
234 | + $report_data->currency = wpinv_get_currency(); |
|
235 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | + $report_data->currency_position = wpinv_currency_position(); |
|
237 | + $report_data->decimal_places = wpinv_decimals(); |
|
238 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
241 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
242 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
243 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
244 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | + |
|
246 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | + $data = $report_data; |
|
248 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | + $data = $this->filter_response_by_context( $data, $context ); |
|
251 | + |
|
252 | + // Wrap the data in a response object. |
|
253 | + $response = rest_ensure_response( $data ); |
|
254 | + $response->add_links( |
|
255 | + array( |
|
256 | + 'about' => array( |
|
257 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | + ), |
|
259 | + ) |
|
260 | + ); |
|
261 | + |
|
262 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Get report data. |
|
267 | + * |
|
268 | + * @return stdClass |
|
269 | + */ |
|
270 | + public function get_report_data() { |
|
271 | + if ( empty( $this->report_data ) ) { |
|
272 | + $this->query_report_data(); |
|
273 | + } |
|
274 | + return $this->report_data; |
|
275 | + } |
|
276 | + |
|
277 | + /** |
|
278 | + * Get all data needed for this report and store in the class. |
|
279 | + */ |
|
280 | + protected function query_report_data() { |
|
281 | + |
|
282 | + // Prepare reports. |
|
283 | + $this->report_data = (object) array( |
|
284 | + 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | + 'previous_range' => $this->previous_range, |
|
291 | + ); |
|
292 | + |
|
293 | + // Calculated totals. |
|
294 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | + |
|
307 | + // Calculate average based on net. |
|
308 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | + |
|
311 | + // Total invoices in this period, even if refunded. |
|
312 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | + |
|
314 | + // Items invoiced in this period, even if refunded. |
|
315 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | + |
|
317 | + // 3rd party filtering of report data |
|
318 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | + } |
|
320 | + |
|
321 | + /** |
|
322 | + * Prepares invoice counts. |
|
323 | + * |
|
324 | + * @return array. |
|
325 | + */ |
|
326 | + protected function query_invoice_counts() { |
|
327 | + |
|
328 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | + array( |
|
330 | + 'data' => array( |
|
331 | + 'ID' => array( |
|
332 | + 'type' => 'post_data', |
|
333 | + 'function' => 'COUNT', |
|
334 | + 'name' => 'count', |
|
335 | + 'distinct' => true, |
|
336 | + ), |
|
337 | + 'post_date' => array( |
|
338 | + 'type' => 'post_data', |
|
339 | + 'function' => '', |
|
340 | + 'name' => 'post_date', |
|
341 | + ), |
|
342 | + ), |
|
343 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | + 'order_by' => 'post_date ASC', |
|
345 | + 'query_type' => 'get_results', |
|
346 | + 'filter_range' => $this->report_range, |
|
347 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | + ) |
|
349 | + ); |
|
350 | + |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * Prepares coupon counts. |
|
355 | + * |
|
356 | + * @return array. |
|
357 | + */ |
|
358 | + protected function query_coupon_counts() { |
|
359 | + |
|
360 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | + array( |
|
362 | + 'data' => array( |
|
363 | + 'discount' => array( |
|
364 | + 'type' => 'invoice_data', |
|
365 | + 'function' => 'SUM', |
|
366 | + 'name' => 'discount_amount', |
|
367 | + ), |
|
368 | + 'post_date' => array( |
|
369 | + 'type' => 'post_data', |
|
370 | + 'function' => '', |
|
371 | + 'name' => 'post_date', |
|
372 | + ), |
|
373 | + ), |
|
374 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | + 'order_by' => 'post_date ASC', |
|
376 | + 'query_type' => 'get_results', |
|
377 | + 'filter_range' => $this->report_range, |
|
378 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | + ) |
|
380 | + ); |
|
381 | + |
|
382 | + } |
|
383 | + |
|
384 | + /** |
|
385 | + * Prepares item counts. |
|
386 | + * |
|
387 | + * @return array. |
|
388 | + */ |
|
389 | + protected function query_item_counts() { |
|
390 | + |
|
391 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
255 | 392 | array( |
256 | - 'about' => array( |
|
257 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | - ), |
|
393 | + 'data' => array( |
|
394 | + 'quantity' => array( |
|
395 | + 'type' => 'invoice_item', |
|
396 | + 'function' => 'SUM', |
|
397 | + 'name' => 'invoice_item_count', |
|
398 | + ), |
|
399 | + 'post_date' => array( |
|
400 | + 'type' => 'post_data', |
|
401 | + 'function' => '', |
|
402 | + 'name' => 'post_date', |
|
403 | + ), |
|
404 | + ), |
|
405 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | + 'order_by' => 'post_date ASC', |
|
407 | + 'query_type' => 'get_results', |
|
408 | + 'filter_range' => $this->report_range, |
|
409 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
259 | 410 | ) |
260 | 411 | ); |
261 | 412 | |
262 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Get report data. |
|
267 | - * |
|
268 | - * @return stdClass |
|
269 | - */ |
|
270 | - public function get_report_data() { |
|
271 | - if ( empty( $this->report_data ) ) { |
|
272 | - $this->query_report_data(); |
|
273 | - } |
|
274 | - return $this->report_data; |
|
275 | - } |
|
276 | - |
|
277 | - /** |
|
278 | - * Get all data needed for this report and store in the class. |
|
279 | - */ |
|
280 | - protected function query_report_data() { |
|
281 | - |
|
282 | - // Prepare reports. |
|
283 | - $this->report_data = (object) array( |
|
284 | - 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | - 'previous_range' => $this->previous_range, |
|
291 | - ); |
|
292 | - |
|
293 | - // Calculated totals. |
|
294 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | - |
|
307 | - // Calculate average based on net. |
|
308 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | - |
|
311 | - // Total invoices in this period, even if refunded. |
|
312 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | - |
|
314 | - // Items invoiced in this period, even if refunded. |
|
315 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | - |
|
317 | - // 3rd party filtering of report data |
|
318 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | - } |
|
320 | - |
|
321 | - /** |
|
322 | - * Prepares invoice counts. |
|
323 | - * |
|
324 | - * @return array. |
|
325 | - */ |
|
326 | - protected function query_invoice_counts() { |
|
327 | - |
|
328 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | - array( |
|
330 | - 'data' => array( |
|
331 | - 'ID' => array( |
|
332 | - 'type' => 'post_data', |
|
333 | - 'function' => 'COUNT', |
|
334 | - 'name' => 'count', |
|
335 | - 'distinct' => true, |
|
336 | - ), |
|
337 | - 'post_date' => array( |
|
338 | - 'type' => 'post_data', |
|
339 | - 'function' => '', |
|
340 | - 'name' => 'post_date', |
|
341 | - ), |
|
342 | - ), |
|
343 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | - 'order_by' => 'post_date ASC', |
|
345 | - 'query_type' => 'get_results', |
|
346 | - 'filter_range' => $this->report_range, |
|
347 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | - ) |
|
349 | - ); |
|
350 | - |
|
351 | - } |
|
352 | - |
|
353 | - /** |
|
354 | - * Prepares coupon counts. |
|
355 | - * |
|
356 | - * @return array. |
|
357 | - */ |
|
358 | - protected function query_coupon_counts() { |
|
359 | - |
|
360 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | - array( |
|
362 | - 'data' => array( |
|
363 | - 'discount' => array( |
|
364 | - 'type' => 'invoice_data', |
|
365 | - 'function' => 'SUM', |
|
366 | - 'name' => 'discount_amount', |
|
367 | - ), |
|
368 | - 'post_date' => array( |
|
369 | - 'type' => 'post_data', |
|
370 | - 'function' => '', |
|
371 | - 'name' => 'post_date', |
|
372 | - ), |
|
373 | - ), |
|
374 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | - 'order_by' => 'post_date ASC', |
|
376 | - 'query_type' => 'get_results', |
|
377 | - 'filter_range' => $this->report_range, |
|
378 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | - ) |
|
380 | - ); |
|
381 | - |
|
382 | - } |
|
383 | - |
|
384 | - /** |
|
385 | - * Prepares item counts. |
|
386 | - * |
|
387 | - * @return array. |
|
388 | - */ |
|
389 | - protected function query_item_counts() { |
|
390 | - |
|
391 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
392 | - array( |
|
393 | - 'data' => array( |
|
394 | - 'quantity' => array( |
|
395 | - 'type' => 'invoice_item', |
|
396 | - 'function' => 'SUM', |
|
397 | - 'name' => 'invoice_item_count', |
|
398 | - ), |
|
399 | - 'post_date' => array( |
|
400 | - 'type' => 'post_data', |
|
401 | - 'function' => '', |
|
402 | - 'name' => 'post_date', |
|
403 | - ), |
|
404 | - ), |
|
405 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | - 'order_by' => 'post_date ASC', |
|
407 | - 'query_type' => 'get_results', |
|
408 | - 'filter_range' => $this->report_range, |
|
409 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
410 | - ) |
|
411 | - ); |
|
412 | - |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * Prepares refunded item counts. |
|
417 | - * |
|
418 | - * @return array. |
|
419 | - */ |
|
420 | - protected function count_refunded_items() { |
|
421 | - |
|
422 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | - array( |
|
424 | - 'data' => array( |
|
425 | - 'quantity' => array( |
|
426 | - 'type' => 'invoice_item', |
|
427 | - 'function' => 'SUM', |
|
428 | - 'name' => 'invoice_item_count', |
|
429 | - ), |
|
430 | - ), |
|
431 | - 'query_type' => 'get_var', |
|
432 | - 'filter_range' => $this->report_range, |
|
433 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | - ) |
|
435 | - ); |
|
436 | - |
|
437 | - } |
|
438 | - |
|
439 | - /** |
|
440 | - * Prepares daily invoice totals. |
|
441 | - * |
|
442 | - * @return array. |
|
443 | - */ |
|
444 | - protected function query_invoice_totals() { |
|
445 | - |
|
446 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | - array( |
|
448 | - 'data' => array( |
|
449 | - 'total' => array( |
|
450 | - 'type' => 'invoice_data', |
|
451 | - 'function' => 'SUM', |
|
452 | - 'name' => 'total_sales', |
|
453 | - ), |
|
454 | - 'tax' => array( |
|
455 | - 'type' => 'invoice_data', |
|
456 | - 'function' => 'SUM', |
|
457 | - 'name' => 'total_tax', |
|
458 | - ), |
|
459 | - 'discount' => array( |
|
460 | - 'type' => 'invoice_data', |
|
461 | - 'function' => 'SUM', |
|
462 | - 'name' => 'total_discount', |
|
463 | - ), |
|
464 | - 'fees_total' => array( |
|
465 | - 'type' => 'invoice_data', |
|
466 | - 'function' => 'SUM', |
|
467 | - 'name' => 'total_fees', |
|
468 | - ), |
|
469 | - 'subtotal' => array( |
|
470 | - 'type' => 'invoice_data', |
|
471 | - 'function' => 'SUM', |
|
472 | - 'name' => 'subtotal', |
|
473 | - ), |
|
474 | - 'post_date' => array( |
|
475 | - 'type' => 'post_data', |
|
476 | - 'function' => '', |
|
477 | - 'name' => 'post_date', |
|
478 | - ), |
|
479 | - ), |
|
480 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | - 'order_by' => 'post_date ASC', |
|
482 | - 'query_type' => 'get_results', |
|
483 | - 'filter_range' => $this->report_range, |
|
484 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | - ) |
|
486 | - ); |
|
487 | - |
|
488 | - } |
|
489 | - |
|
490 | - /** |
|
491 | - * Prepares daily invoice totals. |
|
492 | - * |
|
493 | - * @return array. |
|
494 | - */ |
|
495 | - protected function query_refunded_totals() { |
|
496 | - |
|
497 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | - array( |
|
499 | - 'data' => array( |
|
500 | - 'total' => array( |
|
501 | - 'type' => 'invoice_data', |
|
502 | - 'function' => 'SUM', |
|
503 | - 'name' => 'total_sales', |
|
504 | - ), |
|
505 | - 'tax' => array( |
|
506 | - 'type' => 'invoice_data', |
|
507 | - 'function' => 'SUM', |
|
508 | - 'name' => 'total_tax', |
|
509 | - ), |
|
510 | - 'discount' => array( |
|
511 | - 'type' => 'invoice_data', |
|
512 | - 'function' => 'SUM', |
|
513 | - 'name' => 'total_discount', |
|
514 | - ), |
|
515 | - 'fees_total' => array( |
|
516 | - 'type' => 'invoice_data', |
|
517 | - 'function' => 'SUM', |
|
518 | - 'name' => 'total_fees', |
|
519 | - ), |
|
520 | - 'subtotal' => array( |
|
521 | - 'type' => 'invoice_data', |
|
522 | - 'function' => 'SUM', |
|
523 | - 'name' => 'subtotal', |
|
524 | - ), |
|
525 | - 'post_date' => array( |
|
526 | - 'type' => 'post_data', |
|
527 | - 'function' => '', |
|
528 | - 'name' => 'post_date', |
|
529 | - ), |
|
530 | - ), |
|
531 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | - 'order_by' => 'post_date ASC', |
|
533 | - 'query_type' => 'get_results', |
|
534 | - 'filter_range' => $this->report_range, |
|
535 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | - ) |
|
537 | - ); |
|
538 | - |
|
539 | - } |
|
540 | - |
|
541 | - /** |
|
542 | - * Get the Report's schema, conforming to JSON Schema. |
|
543 | - * |
|
544 | - * @return array |
|
545 | - */ |
|
546 | - public function get_item_schema() { |
|
547 | - |
|
548 | - $schema = array( |
|
549 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | - 'title' => 'sales_report', |
|
551 | - 'type' => 'object', |
|
552 | - 'properties' => array( |
|
553 | - 'total_sales' => array( |
|
554 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | - 'type' => 'string', |
|
556 | - 'context' => array( 'view' ), |
|
557 | - 'readonly' => true, |
|
558 | - ), |
|
559 | - 'net_sales' => array( |
|
560 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | - 'type' => 'string', |
|
562 | - 'context' => array( 'view' ), |
|
563 | - 'readonly' => true, |
|
564 | - ), |
|
565 | - 'average_sales' => array( |
|
566 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | - 'type' => 'string', |
|
568 | - 'context' => array( 'view' ), |
|
569 | - 'readonly' => true, |
|
570 | - ), |
|
571 | - 'average_total_sales' => array( |
|
572 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | - 'type' => 'string', |
|
574 | - 'context' => array( 'view' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'total_invoices' => array( |
|
578 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | - 'type' => 'integer', |
|
580 | - 'context' => array( 'view' ), |
|
581 | - 'readonly' => true, |
|
582 | - ), |
|
583 | - 'total_items' => array( |
|
584 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | - 'type' => 'integer', |
|
586 | - 'context' => array( 'view' ), |
|
587 | - 'readonly' => true, |
|
588 | - ), |
|
589 | - 'refunded_items' => array( |
|
590 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | - 'type' => 'integer', |
|
592 | - 'context' => array( 'view' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'total_tax' => array( |
|
596 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | - 'type' => 'string', |
|
598 | - 'context' => array( 'view' ), |
|
599 | - 'readonly' => true, |
|
600 | - ), |
|
601 | - 'total_refunded_tax' => array( |
|
602 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | - 'type' => 'string', |
|
604 | - 'context' => array( 'view' ), |
|
605 | - 'readonly' => true, |
|
606 | - ), |
|
607 | - 'total_fees' => array( |
|
608 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | - 'type' => 'string', |
|
610 | - 'context' => array( 'view' ), |
|
611 | - 'readonly' => true, |
|
612 | - ), |
|
613 | - 'total_refunds' => array( |
|
614 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | - 'type' => 'integer', |
|
616 | - 'context' => array( 'view' ), |
|
617 | - 'readonly' => true, |
|
618 | - ), |
|
619 | - 'net_refunds' => array( |
|
620 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | - 'type' => 'integer', |
|
622 | - 'context' => array( 'view' ), |
|
623 | - 'readonly' => true, |
|
624 | - ), |
|
625 | - 'total_discount' => array( |
|
626 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | - 'type' => 'integer', |
|
628 | - 'context' => array( 'view' ), |
|
629 | - 'readonly' => true, |
|
630 | - ), |
|
631 | - 'totals' => array( |
|
632 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | - 'type' => 'array', |
|
634 | - 'items' => array( |
|
635 | - 'type' => 'array', |
|
636 | - ), |
|
637 | - 'context' => array( 'view' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
640 | - 'interval' => array( |
|
641 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | - 'type' => 'integer', |
|
643 | - 'context' => array( 'view' ), |
|
644 | - 'readonly' => true, |
|
645 | - ), |
|
646 | - 'previous_range' => array( |
|
647 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | - 'type' => 'array', |
|
649 | - 'items' => array( |
|
650 | - 'type' => 'string', |
|
651 | - ), |
|
652 | - 'context' => array( 'view' ), |
|
653 | - 'readonly' => true, |
|
654 | - ), |
|
655 | - 'grouped_by' => array( |
|
656 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | - 'type' => 'string', |
|
658 | - 'context' => array( 'view' ), |
|
659 | - 'enum' => array( 'day', 'month' ), |
|
660 | - 'readonly' => true, |
|
661 | - ), |
|
662 | - 'currency' => array( |
|
663 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | - 'type' => 'string', |
|
665 | - 'context' => array( 'view' ), |
|
666 | - 'readonly' => true, |
|
667 | - ), |
|
668 | - 'currency_symbol' => array( |
|
669 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | - 'type' => 'string', |
|
671 | - 'context' => array( 'view' ), |
|
672 | - 'readonly' => true, |
|
673 | - ), |
|
674 | - 'currency_position' => array( |
|
675 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | - 'type' => 'string', |
|
677 | - 'context' => array( 'view' ), |
|
678 | - 'readonly' => true, |
|
679 | - ), |
|
680 | - 'decimal_places' => array( |
|
681 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | - 'type' => 'string', |
|
683 | - 'context' => array( 'view' ), |
|
684 | - 'readonly' => true, |
|
685 | - ), |
|
686 | - 'thousands_sep' => array( |
|
687 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | - 'type' => 'string', |
|
689 | - 'context' => array( 'view' ), |
|
690 | - 'readonly' => true, |
|
691 | - ), |
|
692 | - 'decimals_sep' => array( |
|
693 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | - 'type' => 'string', |
|
695 | - 'context' => array( 'view' ), |
|
696 | - 'readonly' => true, |
|
697 | - ), |
|
698 | - ), |
|
699 | - ); |
|
700 | - |
|
701 | - return $this->add_additional_fields_schema( $schema ); |
|
702 | - |
|
703 | - } |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * Prepares refunded item counts. |
|
417 | + * |
|
418 | + * @return array. |
|
419 | + */ |
|
420 | + protected function count_refunded_items() { |
|
421 | + |
|
422 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | + array( |
|
424 | + 'data' => array( |
|
425 | + 'quantity' => array( |
|
426 | + 'type' => 'invoice_item', |
|
427 | + 'function' => 'SUM', |
|
428 | + 'name' => 'invoice_item_count', |
|
429 | + ), |
|
430 | + ), |
|
431 | + 'query_type' => 'get_var', |
|
432 | + 'filter_range' => $this->report_range, |
|
433 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | + ) |
|
435 | + ); |
|
436 | + |
|
437 | + } |
|
438 | + |
|
439 | + /** |
|
440 | + * Prepares daily invoice totals. |
|
441 | + * |
|
442 | + * @return array. |
|
443 | + */ |
|
444 | + protected function query_invoice_totals() { |
|
445 | + |
|
446 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | + array( |
|
448 | + 'data' => array( |
|
449 | + 'total' => array( |
|
450 | + 'type' => 'invoice_data', |
|
451 | + 'function' => 'SUM', |
|
452 | + 'name' => 'total_sales', |
|
453 | + ), |
|
454 | + 'tax' => array( |
|
455 | + 'type' => 'invoice_data', |
|
456 | + 'function' => 'SUM', |
|
457 | + 'name' => 'total_tax', |
|
458 | + ), |
|
459 | + 'discount' => array( |
|
460 | + 'type' => 'invoice_data', |
|
461 | + 'function' => 'SUM', |
|
462 | + 'name' => 'total_discount', |
|
463 | + ), |
|
464 | + 'fees_total' => array( |
|
465 | + 'type' => 'invoice_data', |
|
466 | + 'function' => 'SUM', |
|
467 | + 'name' => 'total_fees', |
|
468 | + ), |
|
469 | + 'subtotal' => array( |
|
470 | + 'type' => 'invoice_data', |
|
471 | + 'function' => 'SUM', |
|
472 | + 'name' => 'subtotal', |
|
473 | + ), |
|
474 | + 'post_date' => array( |
|
475 | + 'type' => 'post_data', |
|
476 | + 'function' => '', |
|
477 | + 'name' => 'post_date', |
|
478 | + ), |
|
479 | + ), |
|
480 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | + 'order_by' => 'post_date ASC', |
|
482 | + 'query_type' => 'get_results', |
|
483 | + 'filter_range' => $this->report_range, |
|
484 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | + ) |
|
486 | + ); |
|
487 | + |
|
488 | + } |
|
489 | + |
|
490 | + /** |
|
491 | + * Prepares daily invoice totals. |
|
492 | + * |
|
493 | + * @return array. |
|
494 | + */ |
|
495 | + protected function query_refunded_totals() { |
|
496 | + |
|
497 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | + array( |
|
499 | + 'data' => array( |
|
500 | + 'total' => array( |
|
501 | + 'type' => 'invoice_data', |
|
502 | + 'function' => 'SUM', |
|
503 | + 'name' => 'total_sales', |
|
504 | + ), |
|
505 | + 'tax' => array( |
|
506 | + 'type' => 'invoice_data', |
|
507 | + 'function' => 'SUM', |
|
508 | + 'name' => 'total_tax', |
|
509 | + ), |
|
510 | + 'discount' => array( |
|
511 | + 'type' => 'invoice_data', |
|
512 | + 'function' => 'SUM', |
|
513 | + 'name' => 'total_discount', |
|
514 | + ), |
|
515 | + 'fees_total' => array( |
|
516 | + 'type' => 'invoice_data', |
|
517 | + 'function' => 'SUM', |
|
518 | + 'name' => 'total_fees', |
|
519 | + ), |
|
520 | + 'subtotal' => array( |
|
521 | + 'type' => 'invoice_data', |
|
522 | + 'function' => 'SUM', |
|
523 | + 'name' => 'subtotal', |
|
524 | + ), |
|
525 | + 'post_date' => array( |
|
526 | + 'type' => 'post_data', |
|
527 | + 'function' => '', |
|
528 | + 'name' => 'post_date', |
|
529 | + ), |
|
530 | + ), |
|
531 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | + 'order_by' => 'post_date ASC', |
|
533 | + 'query_type' => 'get_results', |
|
534 | + 'filter_range' => $this->report_range, |
|
535 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | + ) |
|
537 | + ); |
|
538 | + |
|
539 | + } |
|
540 | + |
|
541 | + /** |
|
542 | + * Get the Report's schema, conforming to JSON Schema. |
|
543 | + * |
|
544 | + * @return array |
|
545 | + */ |
|
546 | + public function get_item_schema() { |
|
547 | + |
|
548 | + $schema = array( |
|
549 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | + 'title' => 'sales_report', |
|
551 | + 'type' => 'object', |
|
552 | + 'properties' => array( |
|
553 | + 'total_sales' => array( |
|
554 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | + 'type' => 'string', |
|
556 | + 'context' => array( 'view' ), |
|
557 | + 'readonly' => true, |
|
558 | + ), |
|
559 | + 'net_sales' => array( |
|
560 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | + 'type' => 'string', |
|
562 | + 'context' => array( 'view' ), |
|
563 | + 'readonly' => true, |
|
564 | + ), |
|
565 | + 'average_sales' => array( |
|
566 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | + 'type' => 'string', |
|
568 | + 'context' => array( 'view' ), |
|
569 | + 'readonly' => true, |
|
570 | + ), |
|
571 | + 'average_total_sales' => array( |
|
572 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | + 'type' => 'string', |
|
574 | + 'context' => array( 'view' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'total_invoices' => array( |
|
578 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | + 'type' => 'integer', |
|
580 | + 'context' => array( 'view' ), |
|
581 | + 'readonly' => true, |
|
582 | + ), |
|
583 | + 'total_items' => array( |
|
584 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | + 'type' => 'integer', |
|
586 | + 'context' => array( 'view' ), |
|
587 | + 'readonly' => true, |
|
588 | + ), |
|
589 | + 'refunded_items' => array( |
|
590 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | + 'type' => 'integer', |
|
592 | + 'context' => array( 'view' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'total_tax' => array( |
|
596 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | + 'type' => 'string', |
|
598 | + 'context' => array( 'view' ), |
|
599 | + 'readonly' => true, |
|
600 | + ), |
|
601 | + 'total_refunded_tax' => array( |
|
602 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | + 'type' => 'string', |
|
604 | + 'context' => array( 'view' ), |
|
605 | + 'readonly' => true, |
|
606 | + ), |
|
607 | + 'total_fees' => array( |
|
608 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | + 'type' => 'string', |
|
610 | + 'context' => array( 'view' ), |
|
611 | + 'readonly' => true, |
|
612 | + ), |
|
613 | + 'total_refunds' => array( |
|
614 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | + 'type' => 'integer', |
|
616 | + 'context' => array( 'view' ), |
|
617 | + 'readonly' => true, |
|
618 | + ), |
|
619 | + 'net_refunds' => array( |
|
620 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | + 'type' => 'integer', |
|
622 | + 'context' => array( 'view' ), |
|
623 | + 'readonly' => true, |
|
624 | + ), |
|
625 | + 'total_discount' => array( |
|
626 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | + 'type' => 'integer', |
|
628 | + 'context' => array( 'view' ), |
|
629 | + 'readonly' => true, |
|
630 | + ), |
|
631 | + 'totals' => array( |
|
632 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | + 'type' => 'array', |
|
634 | + 'items' => array( |
|
635 | + 'type' => 'array', |
|
636 | + ), |
|
637 | + 'context' => array( 'view' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | + 'interval' => array( |
|
641 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | + 'type' => 'integer', |
|
643 | + 'context' => array( 'view' ), |
|
644 | + 'readonly' => true, |
|
645 | + ), |
|
646 | + 'previous_range' => array( |
|
647 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | + 'type' => 'array', |
|
649 | + 'items' => array( |
|
650 | + 'type' => 'string', |
|
651 | + ), |
|
652 | + 'context' => array( 'view' ), |
|
653 | + 'readonly' => true, |
|
654 | + ), |
|
655 | + 'grouped_by' => array( |
|
656 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | + 'type' => 'string', |
|
658 | + 'context' => array( 'view' ), |
|
659 | + 'enum' => array( 'day', 'month' ), |
|
660 | + 'readonly' => true, |
|
661 | + ), |
|
662 | + 'currency' => array( |
|
663 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | + 'type' => 'string', |
|
665 | + 'context' => array( 'view' ), |
|
666 | + 'readonly' => true, |
|
667 | + ), |
|
668 | + 'currency_symbol' => array( |
|
669 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | + 'type' => 'string', |
|
671 | + 'context' => array( 'view' ), |
|
672 | + 'readonly' => true, |
|
673 | + ), |
|
674 | + 'currency_position' => array( |
|
675 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | + 'type' => 'string', |
|
677 | + 'context' => array( 'view' ), |
|
678 | + 'readonly' => true, |
|
679 | + ), |
|
680 | + 'decimal_places' => array( |
|
681 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | + 'type' => 'string', |
|
683 | + 'context' => array( 'view' ), |
|
684 | + 'readonly' => true, |
|
685 | + ), |
|
686 | + 'thousands_sep' => array( |
|
687 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | + 'type' => 'string', |
|
689 | + 'context' => array( 'view' ), |
|
690 | + 'readonly' => true, |
|
691 | + ), |
|
692 | + 'decimals_sep' => array( |
|
693 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | + 'type' => 'string', |
|
695 | + 'context' => array( 'view' ), |
|
696 | + 'readonly' => true, |
|
697 | + ), |
|
698 | + ), |
|
699 | + ); |
|
700 | + |
|
701 | + return $this->add_additional_fields_schema( $schema ); |
|
702 | + |
|
703 | + } |
|
704 | 704 | |
705 | 705 | } |
@@ -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. |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * |
47 | 47 | * @see register_rest_route() |
48 | 48 | */ |
49 | - public function register_namespace_routes( $namespace ) { |
|
49 | + public function register_namespace_routes($namespace) { |
|
50 | 50 | |
51 | 51 | // Get sales report. |
52 | 52 | register_rest_route( |
@@ -55,11 +55,11 @@ discard block |
||
55 | 55 | array( |
56 | 56 | array( |
57 | 57 | 'methods' => WP_REST_Server::READABLE, |
58 | - 'callback' => array( $this, 'get_items' ), |
|
59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
58 | + 'callback' => array($this, 'get_items'), |
|
59 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
60 | 60 | 'args' => $this->get_collection_params(), |
61 | 61 | ), |
62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
62 | + 'schema' => array($this, 'get_public_item_schema'), |
|
63 | 63 | ) |
64 | 64 | ); |
65 | 65 | |
@@ -72,10 +72,10 @@ discard block |
||
72 | 72 | * @param WP_REST_Request $request Full data about the request. |
73 | 73 | * @return WP_Error|boolean |
74 | 74 | */ |
75 | - public function get_items_permissions_check( $request ) { |
|
75 | + public function get_items_permissions_check($request) { |
|
76 | 76 | |
77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
77 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
78 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
79 | 79 | } |
80 | 80 | |
81 | 81 | return true; |
@@ -87,12 +87,12 @@ discard block |
||
87 | 87 | * @param WP_REST_Request $request |
88 | 88 | * @return array|WP_Error |
89 | 89 | */ |
90 | - public function get_items( $request ) { |
|
90 | + public function get_items($request) { |
|
91 | 91 | $data = array(); |
92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
92 | + $item = $this->prepare_item_for_response(null, $request); |
|
93 | + $data[] = $this->prepare_response_for_collection($item); |
|
94 | 94 | |
95 | - return rest_ensure_response( $data ); |
|
95 | + return rest_ensure_response($data); |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | /** |
@@ -102,164 +102,164 @@ discard block |
||
102 | 102 | * @param WP_REST_Request $request Request object. |
103 | 103 | * @return WP_REST_Response $response Response data. |
104 | 104 | */ |
105 | - public function prepare_item_for_response( $_, $request ) { |
|
105 | + public function prepare_item_for_response($_, $request) { |
|
106 | 106 | |
107 | 107 | // Set report range. |
108 | - $this->report_range = $this->get_date_range( $request ); |
|
108 | + $this->report_range = $this->get_date_range($request); |
|
109 | 109 | |
110 | 110 | $report_data = $this->get_report_data(); |
111 | 111 | $period_totals = array(); |
112 | 112 | |
113 | 113 | // Setup period totals by ensuring each period in the interval has data. |
114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
114 | + $start_date = strtotime($this->report_range['after']) + DAY_IN_SECONDS; |
|
115 | 115 | |
116 | - if ( 'month' === $this->groupby ) { |
|
117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
116 | + if ('month' === $this->groupby) { |
|
117 | + $start_date = strtotime(date('Y-m-01', $start_date)); |
|
118 | 118 | } |
119 | 119 | |
120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
120 | + for ($i = 0; $i < $this->interval; $i++) { |
|
121 | 121 | |
122 | - switch ( $this->groupby ) { |
|
122 | + switch ($this->groupby) { |
|
123 | 123 | case 'day': |
124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
124 | + $time = date('Y-m-d', strtotime("+{$i} DAY", $start_date)); |
|
125 | 125 | break; |
126 | 126 | default: |
127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
127 | + $time = date('Y-m', strtotime("+{$i} MONTH", $start_date)); |
|
128 | 128 | break; |
129 | 129 | } |
130 | 130 | |
131 | 131 | // Set the defaults for each period. |
132 | - $period_totals[ $time ] = array( |
|
132 | + $period_totals[$time] = array( |
|
133 | 133 | 'invoices' => 0, |
134 | 134 | 'items' => 0, |
135 | 135 | 'refunded_items' => 0, |
136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
136 | + 'refunded_tax' => wpinv_round_amount(0.00), |
|
137 | + 'subtotal' => wpinv_round_amount(0.00), |
|
138 | + 'refunded_subtotal' => wpinv_round_amount(0.00), |
|
139 | + 'refunded_fees' => wpinv_round_amount(0.00), |
|
140 | + 'discount' => wpinv_round_amount(0.00), |
|
141 | 141 | ); |
142 | 142 | |
143 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
143 | + foreach (array_keys(wpinv_get_report_graphs()) as $key) { |
|
144 | + if (!isset($period_totals[$time][$key])) { |
|
145 | + $period_totals[$time][$key] = wpinv_round_amount(0.00); |
|
146 | 146 | } |
147 | 147 | } |
148 | 148 | } |
149 | 149 | |
150 | 150 | // add total sales, total invoice count, total tax for each period |
151 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | - foreach ( $report_data->invoices as $invoice ) { |
|
153 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
151 | + $date_format = ('day' === $this->groupby) ? 'Y-m-d' : 'Y-m'; |
|
152 | + foreach ($report_data->invoices as $invoice) { |
|
153 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
154 | 154 | |
155 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
155 | + if (!isset($period_totals[$time])) { |
|
156 | 156 | continue; |
157 | 157 | } |
158 | 158 | |
159 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
159 | + $period_totals[$time]['sales'] = wpinv_round_amount($invoice->total_sales); |
|
160 | + $period_totals[$time]['tax'] = wpinv_round_amount($invoice->total_tax); |
|
161 | + $period_totals[$time]['subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
162 | + $period_totals[$time]['fees'] = wpinv_round_amount($invoice->total_fees); |
|
163 | 163 | |
164 | 164 | } |
165 | 165 | |
166 | - foreach ( $report_data->refunds as $invoice ) { |
|
167 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
166 | + foreach ($report_data->refunds as $invoice) { |
|
167 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
168 | 168 | |
169 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
169 | + if (!isset($period_totals[$time])) { |
|
170 | 170 | continue; |
171 | 171 | } |
172 | 172 | |
173 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
173 | + $period_totals[$time]['refunds'] = wpinv_round_amount($invoice->total_sales); |
|
174 | + $period_totals[$time]['refunded_tax'] = wpinv_round_amount($invoice->total_tax); |
|
175 | + $period_totals[$time]['refunded_subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
176 | + $period_totals[$time]['refunded_fees'] = wpinv_round_amount($invoice->total_fees); |
|
177 | 177 | |
178 | 178 | } |
179 | 179 | |
180 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
180 | + foreach ($report_data->invoice_counts as $invoice) { |
|
181 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
182 | 182 | |
183 | - if ( isset( $period_totals[ $time ] ) ) { |
|
184 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
183 | + if (isset($period_totals[$time])) { |
|
184 | + $period_totals[$time]['invoices'] = (int) $invoice->count; |
|
185 | 185 | } |
186 | 186 | } |
187 | 187 | |
188 | 188 | // Add total invoice items for each period. |
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
189 | + foreach ($report_data->invoice_items as $invoice_item) { |
|
190 | + $time = ('day' === $this->groupby) ? date('Y-m-d', strtotime($invoice_item->post_date)) : date('Y-m', strtotime($invoice_item->post_date)); |
|
191 | 191 | |
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
192 | + if (isset($period_totals[$time])) { |
|
193 | + $period_totals[$time]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | 194 | } |
195 | 195 | } |
196 | 196 | |
197 | 197 | // Add total discount for each period. |
198 | - foreach ( $report_data->coupons as $discount ) { |
|
199 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
198 | + foreach ($report_data->coupons as $discount) { |
|
199 | + $time = ('day' === $this->groupby) ? date('Y-m-d', strtotime($discount->post_date)) : date('Y-m', strtotime($discount->post_date)); |
|
200 | 200 | |
201 | - if ( isset( $period_totals[ $time ] ) ) { |
|
202 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
201 | + if (isset($period_totals[$time])) { |
|
202 | + $period_totals[$time]['discount'] = wpinv_round_amount($discount->discount_amount); |
|
203 | 203 | } |
204 | 204 | } |
205 | 205 | |
206 | 206 | // Extra fields. |
207 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
207 | + foreach (array_keys(wpinv_get_report_graphs()) as $key) { |
|
208 | 208 | |
209 | 209 | // Abort unprepared. |
210 | - if ( ! isset( $report_data->$key ) ) { |
|
210 | + if (!isset($report_data->$key)) { |
|
211 | 211 | continue; |
212 | 212 | } |
213 | 213 | |
214 | 214 | // Abort defaults. |
215 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
215 | + if (in_array($key, array('sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items'))) { |
|
216 | 216 | continue; |
217 | 217 | } |
218 | 218 | |
219 | 219 | // Set values. |
220 | - foreach ( $report_data->$key as $item ) { |
|
221 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $item->date ) ) : date( 'Y-m', strtotime( $item->date ) ); |
|
220 | + foreach ($report_data->$key as $item) { |
|
221 | + $time = ('day' === $this->groupby) ? date('Y-m-d', strtotime($item->date)) : date('Y-m', strtotime($item->date)); |
|
222 | 222 | |
223 | - if ( isset( $period_totals[ $time ] ) ) { |
|
224 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
223 | + if (isset($period_totals[$time])) { |
|
224 | + $period_totals[$time][$key] = wpinv_round_amount($item->val); |
|
225 | 225 | } |
226 | 226 | } |
227 | 227 | |
228 | - unset( $report_data->$key ); |
|
228 | + unset($report_data->$key); |
|
229 | 229 | } |
230 | 230 | |
231 | 231 | $report_data->totals = $period_totals; |
232 | 232 | $report_data->grouped_by = $this->groupby; |
233 | - $report_data->interval = max( $this->interval, 1 ); |
|
233 | + $report_data->interval = max($this->interval, 1); |
|
234 | 234 | $report_data->currency = wpinv_get_currency(); |
235 | 235 | $report_data->currency_symbol = wpinv_currency_symbol(); |
236 | 236 | $report_data->currency_position = wpinv_currency_position(); |
237 | 237 | $report_data->decimal_places = wpinv_decimals(); |
238 | 238 | $report_data->thousands_sep = wpinv_thousands_separator(); |
239 | 239 | $report_data->decimals_sep = wpinv_decimal_separator(); |
240 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
241 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
242 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
243 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
240 | + $report_data->start_date = date('Y-m-d', strtotime($this->report_range['after']) + DAY_IN_SECONDS); |
|
241 | + $report_data->end_date = date('Y-m-d', strtotime($this->report_range['before']) - DAY_IN_SECONDS); |
|
242 | + $report_data->start_date_locale = getpaid_format_date(date('Y-m-d', strtotime($this->report_range['after']) + DAY_IN_SECONDS)); |
|
243 | + $report_data->end_date_locale = getpaid_format_date(date('Y-m-d', strtotime($this->report_range['before']) - DAY_IN_SECONDS)); |
|
244 | 244 | $report_data->decimals_sep = wpinv_decimal_separator(); |
245 | 245 | |
246 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
246 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
247 | 247 | $data = $report_data; |
248 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | - $data = $this->filter_response_by_context( $data, $context ); |
|
248 | + unset($data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items); |
|
249 | + $data = $this->add_additional_fields_to_object((array) $data, $request); |
|
250 | + $data = $this->filter_response_by_context($data, $context); |
|
251 | 251 | |
252 | 252 | // Wrap the data in a response object. |
253 | - $response = rest_ensure_response( $data ); |
|
253 | + $response = rest_ensure_response($data); |
|
254 | 254 | $response->add_links( |
255 | 255 | array( |
256 | 256 | 'about' => array( |
257 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
257 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
258 | 258 | ), |
259 | 259 | ) |
260 | 260 | ); |
261 | 261 | |
262 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
262 | + return apply_filters('getpaid_rest_prepare_report_sales', $response, $report_data, $request); |
|
263 | 263 | } |
264 | 264 | |
265 | 265 | /** |
@@ -268,7 +268,7 @@ discard block |
||
268 | 268 | * @return stdClass |
269 | 269 | */ |
270 | 270 | public function get_report_data() { |
271 | - if ( empty( $this->report_data ) ) { |
|
271 | + if (empty($this->report_data)) { |
|
272 | 272 | $this->query_report_data(); |
273 | 273 | } |
274 | 274 | return $this->report_data; |
@@ -291,31 +291,31 @@ discard block |
||
291 | 291 | ); |
292 | 292 | |
293 | 293 | // Calculated totals. |
294 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
294 | + $this->report_data->total_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_tax'))); |
|
295 | + $this->report_data->total_sales = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_sales'))); |
|
296 | + $this->report_data->total_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_discount'))); |
|
297 | + $this->report_data->total_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_fees'))); |
|
298 | + $this->report_data->subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'subtotal'))); |
|
299 | + $this->report_data->net_sales = wpinv_round_amount($this->report_data->total_sales - max(0, $this->report_data->total_tax)); |
|
300 | + $this->report_data->total_refunded_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_tax'))); |
|
301 | + $this->report_data->total_refunds = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_sales'))); |
|
302 | + $this->report_data->refunded_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_discount'))); |
|
303 | + $this->report_data->refunded_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_fees'))); |
|
304 | + $this->report_data->refunded_subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'subtotal'))); |
|
305 | + $this->report_data->net_refunds = wpinv_round_amount($this->report_data->total_refunds + max(0, $this->report_data->total_refunded_tax)); |
|
306 | 306 | |
307 | 307 | // Calculate average based on net. |
308 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
308 | + $this->report_data->average_sales = wpinv_round_amount($this->report_data->net_sales / max($this->interval, 1), 2); |
|
309 | + $this->report_data->average_total_sales = wpinv_round_amount($this->report_data->total_sales / max($this->interval, 1), 2); |
|
310 | 310 | |
311 | 311 | // Total invoices in this period, even if refunded. |
312 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
312 | + $this->report_data->total_invoices = absint(array_sum(wp_list_pluck($this->report_data->invoice_counts, 'count'))); |
|
313 | 313 | |
314 | 314 | // Items invoiced in this period, even if refunded. |
315 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
315 | + $this->report_data->total_items = absint(array_sum(wp_list_pluck($this->report_data->invoice_items, 'invoice_item_count'))); |
|
316 | 316 | |
317 | 317 | // 3rd party filtering of report data |
318 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
318 | + $this->report_data = apply_filters('getpaid_rest_api_filter_report_data', $this->report_data, $this); |
|
319 | 319 | } |
320 | 320 | |
321 | 321 | /** |
@@ -340,11 +340,11 @@ discard block |
||
340 | 340 | 'name' => 'post_date', |
341 | 341 | ), |
342 | 342 | ), |
343 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
343 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
344 | 344 | 'order_by' => 'post_date ASC', |
345 | 345 | 'query_type' => 'get_results', |
346 | 346 | 'filter_range' => $this->report_range, |
347 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
347 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
348 | 348 | ) |
349 | 349 | ); |
350 | 350 | |
@@ -371,11 +371,11 @@ discard block |
||
371 | 371 | 'name' => 'post_date', |
372 | 372 | ), |
373 | 373 | ), |
374 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
374 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
375 | 375 | 'order_by' => 'post_date ASC', |
376 | 376 | 'query_type' => 'get_results', |
377 | 377 | 'filter_range' => $this->report_range, |
378 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
378 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
379 | 379 | ) |
380 | 380 | ); |
381 | 381 | |
@@ -402,11 +402,11 @@ discard block |
||
402 | 402 | 'name' => 'post_date', |
403 | 403 | ), |
404 | 404 | ), |
405 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
405 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
406 | 406 | 'order_by' => 'post_date ASC', |
407 | 407 | 'query_type' => 'get_results', |
408 | 408 | 'filter_range' => $this->report_range, |
409 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
409 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
410 | 410 | ) |
411 | 411 | ); |
412 | 412 | |
@@ -430,7 +430,7 @@ discard block |
||
430 | 430 | ), |
431 | 431 | 'query_type' => 'get_var', |
432 | 432 | 'filter_range' => $this->report_range, |
433 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
433 | + 'invoice_status' => array('wpi-refunded'), |
|
434 | 434 | ) |
435 | 435 | ); |
436 | 436 | |
@@ -477,11 +477,11 @@ discard block |
||
477 | 477 | 'name' => 'post_date', |
478 | 478 | ), |
479 | 479 | ), |
480 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
480 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
481 | 481 | 'order_by' => 'post_date ASC', |
482 | 482 | 'query_type' => 'get_results', |
483 | 483 | 'filter_range' => $this->report_range, |
484 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
484 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal'), |
|
485 | 485 | ) |
486 | 486 | ); |
487 | 487 | |
@@ -528,11 +528,11 @@ discard block |
||
528 | 528 | 'name' => 'post_date', |
529 | 529 | ), |
530 | 530 | ), |
531 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
531 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
532 | 532 | 'order_by' => 'post_date ASC', |
533 | 533 | 'query_type' => 'get_results', |
534 | 534 | 'filter_range' => $this->report_range, |
535 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
535 | + 'invoice_status' => array('wpi-refunded'), |
|
536 | 536 | ) |
537 | 537 | ); |
538 | 538 | |
@@ -551,154 +551,154 @@ discard block |
||
551 | 551 | 'type' => 'object', |
552 | 552 | 'properties' => array( |
553 | 553 | 'total_sales' => array( |
554 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
554 | + 'description' => __('Gross sales in the period.', 'invoicing'), |
|
555 | 555 | 'type' => 'string', |
556 | - 'context' => array( 'view' ), |
|
556 | + 'context' => array('view'), |
|
557 | 557 | 'readonly' => true, |
558 | 558 | ), |
559 | 559 | 'net_sales' => array( |
560 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
560 | + 'description' => __('Net sales in the period.', 'invoicing'), |
|
561 | 561 | 'type' => 'string', |
562 | - 'context' => array( 'view' ), |
|
562 | + 'context' => array('view'), |
|
563 | 563 | 'readonly' => true, |
564 | 564 | ), |
565 | 565 | 'average_sales' => array( |
566 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
566 | + 'description' => __('Average net daily sales.', 'invoicing'), |
|
567 | 567 | 'type' => 'string', |
568 | - 'context' => array( 'view' ), |
|
568 | + 'context' => array('view'), |
|
569 | 569 | 'readonly' => true, |
570 | 570 | ), |
571 | 571 | 'average_total_sales' => array( |
572 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
572 | + 'description' => __('Average gross daily sales.', 'invoicing'), |
|
573 | 573 | 'type' => 'string', |
574 | - 'context' => array( 'view' ), |
|
574 | + 'context' => array('view'), |
|
575 | 575 | 'readonly' => true, |
576 | 576 | ), |
577 | 577 | 'total_invoices' => array( |
578 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
578 | + 'description' => __('Number of paid invoices.', 'invoicing'), |
|
579 | 579 | 'type' => 'integer', |
580 | - 'context' => array( 'view' ), |
|
580 | + 'context' => array('view'), |
|
581 | 581 | 'readonly' => true, |
582 | 582 | ), |
583 | 583 | 'total_items' => array( |
584 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
584 | + 'description' => __('Number of items purchased.', 'invoicing'), |
|
585 | 585 | 'type' => 'integer', |
586 | - 'context' => array( 'view' ), |
|
586 | + 'context' => array('view'), |
|
587 | 587 | 'readonly' => true, |
588 | 588 | ), |
589 | 589 | 'refunded_items' => array( |
590 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
590 | + 'description' => __('Number of items refunded.', 'invoicing'), |
|
591 | 591 | 'type' => 'integer', |
592 | - 'context' => array( 'view' ), |
|
592 | + 'context' => array('view'), |
|
593 | 593 | 'readonly' => true, |
594 | 594 | ), |
595 | 595 | 'total_tax' => array( |
596 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
596 | + 'description' => __('Total charged for taxes.', 'invoicing'), |
|
597 | 597 | 'type' => 'string', |
598 | - 'context' => array( 'view' ), |
|
598 | + 'context' => array('view'), |
|
599 | 599 | 'readonly' => true, |
600 | 600 | ), |
601 | 601 | 'total_refunded_tax' => array( |
602 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
602 | + 'description' => __('Total refunded for taxes.', 'invoicing'), |
|
603 | 603 | 'type' => 'string', |
604 | - 'context' => array( 'view' ), |
|
604 | + 'context' => array('view'), |
|
605 | 605 | 'readonly' => true, |
606 | 606 | ), |
607 | 607 | 'total_fees' => array( |
608 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
608 | + 'description' => __('Total fees charged.', 'invoicing'), |
|
609 | 609 | 'type' => 'string', |
610 | - 'context' => array( 'view' ), |
|
610 | + 'context' => array('view'), |
|
611 | 611 | 'readonly' => true, |
612 | 612 | ), |
613 | 613 | 'total_refunds' => array( |
614 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
614 | + 'description' => __('Total of refunded invoices.', 'invoicing'), |
|
615 | 615 | 'type' => 'integer', |
616 | - 'context' => array( 'view' ), |
|
616 | + 'context' => array('view'), |
|
617 | 617 | 'readonly' => true, |
618 | 618 | ), |
619 | 619 | 'net_refunds' => array( |
620 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
620 | + 'description' => __('Net of refunded invoices.', 'invoicing'), |
|
621 | 621 | 'type' => 'integer', |
622 | - 'context' => array( 'view' ), |
|
622 | + 'context' => array('view'), |
|
623 | 623 | 'readonly' => true, |
624 | 624 | ), |
625 | 625 | 'total_discount' => array( |
626 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
626 | + 'description' => __('Total of discounts used.', 'invoicing'), |
|
627 | 627 | 'type' => 'integer', |
628 | - 'context' => array( 'view' ), |
|
628 | + 'context' => array('view'), |
|
629 | 629 | 'readonly' => true, |
630 | 630 | ), |
631 | 631 | 'totals' => array( |
632 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
632 | + 'description' => __('Totals.', 'invoicing'), |
|
633 | 633 | 'type' => 'array', |
634 | 634 | 'items' => array( |
635 | 635 | 'type' => 'array', |
636 | 636 | ), |
637 | - 'context' => array( 'view' ), |
|
637 | + 'context' => array('view'), |
|
638 | 638 | 'readonly' => true, |
639 | 639 | ), |
640 | 640 | 'interval' => array( |
641 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
641 | + 'description' => __('Number of months/days in the report period.', 'invoicing'), |
|
642 | 642 | 'type' => 'integer', |
643 | - 'context' => array( 'view' ), |
|
643 | + 'context' => array('view'), |
|
644 | 644 | 'readonly' => true, |
645 | 645 | ), |
646 | 646 | 'previous_range' => array( |
647 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
647 | + 'description' => __('The previous report period.', 'invoicing'), |
|
648 | 648 | 'type' => 'array', |
649 | 649 | 'items' => array( |
650 | 650 | 'type' => 'string', |
651 | 651 | ), |
652 | - 'context' => array( 'view' ), |
|
652 | + 'context' => array('view'), |
|
653 | 653 | 'readonly' => true, |
654 | 654 | ), |
655 | 655 | 'grouped_by' => array( |
656 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
656 | + 'description' => __('The period used to group the totals.', 'invoicing'), |
|
657 | 657 | 'type' => 'string', |
658 | - 'context' => array( 'view' ), |
|
659 | - 'enum' => array( 'day', 'month' ), |
|
658 | + 'context' => array('view'), |
|
659 | + 'enum' => array('day', 'month'), |
|
660 | 660 | 'readonly' => true, |
661 | 661 | ), |
662 | 662 | 'currency' => array( |
663 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
663 | + 'description' => __('The default store currency.', 'invoicing'), |
|
664 | 664 | 'type' => 'string', |
665 | - 'context' => array( 'view' ), |
|
665 | + 'context' => array('view'), |
|
666 | 666 | 'readonly' => true, |
667 | 667 | ), |
668 | 668 | 'currency_symbol' => array( |
669 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
669 | + 'description' => __('The default store currency symbol.', 'invoicing'), |
|
670 | 670 | 'type' => 'string', |
671 | - 'context' => array( 'view' ), |
|
671 | + 'context' => array('view'), |
|
672 | 672 | 'readonly' => true, |
673 | 673 | ), |
674 | 674 | 'currency_position' => array( |
675 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
675 | + 'description' => __('The default store currency position.', 'invoicing'), |
|
676 | 676 | 'type' => 'string', |
677 | - 'context' => array( 'view' ), |
|
677 | + 'context' => array('view'), |
|
678 | 678 | 'readonly' => true, |
679 | 679 | ), |
680 | 680 | 'decimal_places' => array( |
681 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
681 | + 'description' => __('The default store decimal places.', 'invoicing'), |
|
682 | 682 | 'type' => 'string', |
683 | - 'context' => array( 'view' ), |
|
683 | + 'context' => array('view'), |
|
684 | 684 | 'readonly' => true, |
685 | 685 | ), |
686 | 686 | 'thousands_sep' => array( |
687 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
687 | + 'description' => __('The default store thousands separator.', 'invoicing'), |
|
688 | 688 | 'type' => 'string', |
689 | - 'context' => array( 'view' ), |
|
689 | + 'context' => array('view'), |
|
690 | 690 | 'readonly' => true, |
691 | 691 | ), |
692 | 692 | 'decimals_sep' => array( |
693 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
693 | + 'description' => __('The default store decimals separator.', 'invoicing'), |
|
694 | 694 | 'type' => 'string', |
695 | - 'context' => array( 'view' ), |
|
695 | + 'context' => array('view'), |
|
696 | 696 | 'readonly' => true, |
697 | 697 | ), |
698 | 698 | ), |
699 | 699 | ); |
700 | 700 | |
701 | - return $this->add_additional_fields_schema( $schema ); |
|
701 | + return $this->add_additional_fields_schema($schema); |
|
702 | 702 | |
703 | 703 | } |
704 | 704 |
@@ -15,136 +15,136 @@ |
||
15 | 15 | class WPInv_REST_Discounts_Controller extends GetPaid_REST_Posts_Controller { |
16 | 16 | |
17 | 17 | /** |
18 | - * Post type. |
|
19 | - * |
|
20 | - * @var string |
|
21 | - */ |
|
22 | - protected $post_type = 'wpi_discount'; |
|
23 | - |
|
24 | - /** |
|
25 | - * The base of this controller's route. |
|
26 | - * |
|
27 | - * @since 1.0.13 |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $rest_base = 'discounts'; |
|
31 | - |
|
32 | - /** Contains this controller's class name. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public $crud_class = 'WPInv_Discount'; |
|
37 | - |
|
38 | - /** |
|
39 | - * Registers the routes for the objects of the controller. |
|
40 | - * |
|
41 | - * @since 1.0.19 |
|
42 | - * |
|
43 | - * @see register_rest_route() |
|
44 | - */ |
|
45 | - public function register_namespace_routes( $namespace ) { |
|
46 | - |
|
47 | - parent::register_namespace_routes( $namespace ); |
|
48 | - |
|
49 | - register_rest_route( |
|
50 | - $this->namespace, |
|
51 | - '/' . $this->rest_base . '/discount-types', |
|
52 | - array( |
|
53 | - array( |
|
54 | - 'methods' => WP_REST_Server::READABLE, |
|
55 | - 'callback' => array( $this, 'get_discount_types' ), |
|
56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | - ), |
|
58 | - ) |
|
59 | - ); |
|
60 | - |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Handles rest requests for discount types. |
|
65 | - * |
|
66 | - * @since 1.0.13 |
|
67 | - * |
|
68 | - * |
|
69 | - * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | - */ |
|
71 | - public function get_discount_types() { |
|
72 | - return rest_ensure_response( wpinv_get_discount_types() ); |
|
73 | - } |
|
18 | + * Post type. |
|
19 | + * |
|
20 | + * @var string |
|
21 | + */ |
|
22 | + protected $post_type = 'wpi_discount'; |
|
74 | 23 | |
75 | 24 | /** |
76 | - * Retrieves the query params for the discount collection. |
|
77 | - * |
|
78 | - * @since 1.0.13 |
|
79 | - * |
|
80 | - * @return array Collection parameters. |
|
81 | - */ |
|
82 | - public function get_collection_params() { |
|
83 | - |
|
84 | - $params = array_merge( |
|
85 | - parent::get_collection_params(), |
|
86 | - array( |
|
87 | - |
|
88 | - // Discount types |
|
89 | - 'type' => array( |
|
90 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
91 | - 'type' => array( 'array', 'string' ), |
|
92 | - 'default' => 'any', |
|
93 | - 'validate_callback' => 'rest_validate_request_arg', |
|
94 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
95 | - 'items' => array( |
|
96 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
97 | - 'type' => 'string', |
|
98 | - ), |
|
99 | - ), |
|
100 | - |
|
101 | - ) |
|
102 | - ); |
|
103 | - |
|
104 | - // Filter collection parameters for the discounts controller. |
|
105 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Determine the allowed query_vars for a get_items() response and |
|
110 | - * prepare for WP_Query. |
|
111 | - * |
|
112 | - * @param array $prepared_args Prepared arguments. |
|
113 | - * @param WP_REST_Request $request Request object. |
|
114 | - * @return array $query_args |
|
115 | - */ |
|
116 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
117 | - |
|
118 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
119 | - |
|
120 | - // Retrieve items by type. |
|
121 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
122 | - |
|
123 | - if ( empty( $query_args['meta_query'] ) ) { |
|
124 | - $query_args['meta_query'] = array(); |
|
125 | - } |
|
126 | - |
|
127 | - $query_args['meta_query'][] = array( |
|
128 | - 'key' => '_wpi_discount_type', |
|
129 | - 'value' => implode( ',', $request['type'] ), |
|
130 | - 'compare' => 'IN', |
|
131 | - ); |
|
132 | - |
|
133 | - } |
|
134 | - |
|
135 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
136 | - |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * Retrieves a valid list of post statuses. |
|
141 | - * |
|
142 | - * @since 1.0.15 |
|
143 | - * |
|
144 | - * @return array A list of registered item statuses. |
|
145 | - */ |
|
146 | - public function get_post_statuses() { |
|
147 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
148 | - } |
|
25 | + * The base of this controller's route. |
|
26 | + * |
|
27 | + * @since 1.0.13 |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $rest_base = 'discounts'; |
|
31 | + |
|
32 | + /** Contains this controller's class name. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public $crud_class = 'WPInv_Discount'; |
|
37 | + |
|
38 | + /** |
|
39 | + * Registers the routes for the objects of the controller. |
|
40 | + * |
|
41 | + * @since 1.0.19 |
|
42 | + * |
|
43 | + * @see register_rest_route() |
|
44 | + */ |
|
45 | + public function register_namespace_routes( $namespace ) { |
|
46 | + |
|
47 | + parent::register_namespace_routes( $namespace ); |
|
48 | + |
|
49 | + register_rest_route( |
|
50 | + $this->namespace, |
|
51 | + '/' . $this->rest_base . '/discount-types', |
|
52 | + array( |
|
53 | + array( |
|
54 | + 'methods' => WP_REST_Server::READABLE, |
|
55 | + 'callback' => array( $this, 'get_discount_types' ), |
|
56 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | + ), |
|
58 | + ) |
|
59 | + ); |
|
60 | + |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Handles rest requests for discount types. |
|
65 | + * |
|
66 | + * @since 1.0.13 |
|
67 | + * |
|
68 | + * |
|
69 | + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | + */ |
|
71 | + public function get_discount_types() { |
|
72 | + return rest_ensure_response( wpinv_get_discount_types() ); |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * Retrieves the query params for the discount collection. |
|
77 | + * |
|
78 | + * @since 1.0.13 |
|
79 | + * |
|
80 | + * @return array Collection parameters. |
|
81 | + */ |
|
82 | + public function get_collection_params() { |
|
83 | + |
|
84 | + $params = array_merge( |
|
85 | + parent::get_collection_params(), |
|
86 | + array( |
|
87 | + |
|
88 | + // Discount types |
|
89 | + 'type' => array( |
|
90 | + 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
91 | + 'type' => array( 'array', 'string' ), |
|
92 | + 'default' => 'any', |
|
93 | + 'validate_callback' => 'rest_validate_request_arg', |
|
94 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
95 | + 'items' => array( |
|
96 | + 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
97 | + 'type' => 'string', |
|
98 | + ), |
|
99 | + ), |
|
100 | + |
|
101 | + ) |
|
102 | + ); |
|
103 | + |
|
104 | + // Filter collection parameters for the discounts controller. |
|
105 | + return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Determine the allowed query_vars for a get_items() response and |
|
110 | + * prepare for WP_Query. |
|
111 | + * |
|
112 | + * @param array $prepared_args Prepared arguments. |
|
113 | + * @param WP_REST_Request $request Request object. |
|
114 | + * @return array $query_args |
|
115 | + */ |
|
116 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
117 | + |
|
118 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
119 | + |
|
120 | + // Retrieve items by type. |
|
121 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
122 | + |
|
123 | + if ( empty( $query_args['meta_query'] ) ) { |
|
124 | + $query_args['meta_query'] = array(); |
|
125 | + } |
|
126 | + |
|
127 | + $query_args['meta_query'][] = array( |
|
128 | + 'key' => '_wpi_discount_type', |
|
129 | + 'value' => implode( ',', $request['type'] ), |
|
130 | + 'compare' => 'IN', |
|
131 | + ); |
|
132 | + |
|
133 | + } |
|
134 | + |
|
135 | + return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
136 | + |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * Retrieves a valid list of post statuses. |
|
141 | + * |
|
142 | + * @since 1.0.15 |
|
143 | + * |
|
144 | + * @return array A list of registered item statuses. |
|
145 | + */ |
|
146 | + public function get_post_statuses() { |
|
147 | + return array( 'publish', 'pending', 'draft', 'expired' ); |
|
148 | + } |
|
149 | 149 | |
150 | 150 | } |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * @version 1.0.19 |
6 | 6 | */ |
7 | 7 | |
8 | -defined( 'ABSPATH' ) || exit; |
|
8 | +defined('ABSPATH') || exit; |
|
9 | 9 | |
10 | 10 | /** |
11 | 11 | * REST API discounts controller class. |
@@ -42,9 +42,9 @@ discard block |
||
42 | 42 | * |
43 | 43 | * @see register_rest_route() |
44 | 44 | */ |
45 | - public function register_namespace_routes( $namespace ) { |
|
45 | + public function register_namespace_routes($namespace) { |
|
46 | 46 | |
47 | - parent::register_namespace_routes( $namespace ); |
|
47 | + parent::register_namespace_routes($namespace); |
|
48 | 48 | |
49 | 49 | register_rest_route( |
50 | 50 | $this->namespace, |
@@ -52,8 +52,8 @@ discard block |
||
52 | 52 | array( |
53 | 53 | array( |
54 | 54 | 'methods' => WP_REST_Server::READABLE, |
55 | - 'callback' => array( $this, 'get_discount_types' ), |
|
56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
55 | + 'callback' => array($this, 'get_discount_types'), |
|
56 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
57 | 57 | ), |
58 | 58 | ) |
59 | 59 | ); |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
70 | 70 | */ |
71 | 71 | public function get_discount_types() { |
72 | - return rest_ensure_response( wpinv_get_discount_types() ); |
|
72 | + return rest_ensure_response(wpinv_get_discount_types()); |
|
73 | 73 | } |
74 | 74 | |
75 | 75 | /** |
@@ -87,13 +87,13 @@ discard block |
||
87 | 87 | |
88 | 88 | // Discount types |
89 | 89 | 'type' => array( |
90 | - 'description' => __( 'Type of discounts to fetch.', 'invoicing' ), |
|
91 | - 'type' => array( 'array', 'string' ), |
|
90 | + 'description' => __('Type of discounts to fetch.', 'invoicing'), |
|
91 | + 'type' => array('array', 'string'), |
|
92 | 92 | 'default' => 'any', |
93 | 93 | 'validate_callback' => 'rest_validate_request_arg', |
94 | 94 | 'sanitize_callback' => 'wpinv_parse_list', |
95 | 95 | 'items' => array( |
96 | - 'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ), |
|
96 | + 'enum' => array_merge(array('any'), array_keys(wpinv_get_discount_types())), |
|
97 | 97 | 'type' => 'string', |
98 | 98 | ), |
99 | 99 | ), |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | ); |
103 | 103 | |
104 | 104 | // Filter collection parameters for the discounts controller. |
105 | - return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this ); |
|
105 | + return apply_filters('getpaid_rest_discounts_collection_params', $params, $this); |
|
106 | 106 | } |
107 | 107 | |
108 | 108 | /** |
@@ -113,26 +113,26 @@ discard block |
||
113 | 113 | * @param WP_REST_Request $request Request object. |
114 | 114 | * @return array $query_args |
115 | 115 | */ |
116 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
116 | + protected function prepare_items_query($prepared_args = array(), $request = null) { |
|
117 | 117 | |
118 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
118 | + $query_args = parent::prepare_items_query($prepared_args); |
|
119 | 119 | |
120 | 120 | // Retrieve items by type. |
121 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
121 | + if (!in_array('any', $request['type'])) { |
|
122 | 122 | |
123 | - if ( empty( $query_args['meta_query'] ) ) { |
|
123 | + if (empty($query_args['meta_query'])) { |
|
124 | 124 | $query_args['meta_query'] = array(); |
125 | 125 | } |
126 | 126 | |
127 | 127 | $query_args['meta_query'][] = array( |
128 | 128 | 'key' => '_wpi_discount_type', |
129 | - 'value' => implode( ',', $request['type'] ), |
|
129 | + 'value' => implode(',', $request['type']), |
|
130 | 130 | 'compare' => 'IN', |
131 | 131 | ); |
132 | 132 | |
133 | 133 | } |
134 | 134 | |
135 | - return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this ); |
|
135 | + return apply_filters('getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this); |
|
136 | 136 | |
137 | 137 | } |
138 | 138 | |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | * @return array A list of registered item statuses. |
145 | 145 | */ |
146 | 146 | public function get_post_statuses() { |
147 | - return array( 'publish', 'pending', 'draft', 'expired' ); |
|
147 | + return array('publish', 'pending', 'draft', 'expired'); |
|
148 | 148 | } |
149 | 149 | |
150 | 150 | } |
@@ -17,474 +17,474 @@ |
||
17 | 17 | */ |
18 | 18 | class GetPaid_REST_CRUD_Controller extends GetPaid_REST_Controller { |
19 | 19 | |
20 | - /** |
|
21 | - * Contains this controller's class name. |
|
22 | - * |
|
23 | - * @var string |
|
24 | - */ |
|
25 | - public $crud_class; |
|
26 | - |
|
27 | - /** |
|
28 | - * Contains the current CRUD object. |
|
29 | - * |
|
30 | - * @var GetPaid_Data |
|
31 | - */ |
|
32 | - protected $data_object; |
|
33 | - |
|
34 | - /** |
|
35 | - * Registers the routes for the objects of the controller. |
|
36 | - * |
|
37 | - * @since 1.0.19 |
|
38 | - * |
|
39 | - * @see register_rest_route() |
|
40 | - */ |
|
41 | - public function register_namespace_routes( $namespace ) { |
|
42 | - |
|
43 | - register_rest_route( |
|
44 | - $namespace, |
|
45 | - '/' . $this->rest_base, |
|
46 | - array( |
|
47 | - array( |
|
48 | - 'methods' => WP_REST_Server::READABLE, |
|
49 | - 'callback' => array( $this, 'get_items' ), |
|
50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
51 | - 'args' => $this->get_collection_params(), |
|
52 | - ), |
|
53 | - array( |
|
54 | - 'methods' => WP_REST_Server::CREATABLE, |
|
55 | - 'callback' => array( $this, 'create_item' ), |
|
56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
58 | - ), |
|
59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
60 | - ) |
|
61 | - ); |
|
62 | - |
|
63 | - $get_item_args = array( |
|
64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
65 | - ); |
|
66 | - |
|
67 | - register_rest_route( |
|
68 | - $namespace, |
|
69 | - '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
70 | - array( |
|
71 | - 'args' => array( |
|
72 | - 'id' => array( |
|
73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
74 | - 'type' => 'integer', |
|
75 | - ), |
|
76 | - ), |
|
77 | - array( |
|
78 | - 'methods' => WP_REST_Server::READABLE, |
|
79 | - 'callback' => array( $this, 'get_item' ), |
|
80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
81 | - 'args' => $get_item_args, |
|
82 | - ), |
|
83 | - array( |
|
84 | - 'methods' => WP_REST_Server::EDITABLE, |
|
85 | - 'callback' => array( $this, 'update_item' ), |
|
86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
88 | - ), |
|
89 | - array( |
|
90 | - 'methods' => WP_REST_Server::DELETABLE, |
|
91 | - 'callback' => array( $this, 'delete_item' ), |
|
92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
93 | - 'args' => array( |
|
94 | - 'force' => array( |
|
95 | - 'type' => 'boolean', |
|
96 | - 'default' => false, |
|
97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
98 | - ), |
|
99 | - ), |
|
100 | - ), |
|
101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
102 | - ) |
|
103 | - ); |
|
104 | - |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Saves a single object. |
|
109 | - * |
|
110 | - * @param GetPaid_Data $object Object to save. |
|
111 | - * @return WP_Error|GetPaid_Data |
|
112 | - */ |
|
113 | - protected function save_object( $object ) { |
|
114 | - $object->save(); |
|
115 | - |
|
116 | - if ( ! empty( $object->last_error ) ) { |
|
117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
118 | - } |
|
119 | - |
|
120 | - return new $this->crud_class( $object->get_id() ); |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Retrieves a single object. |
|
125 | - * |
|
126 | - * @since 1.0.13 |
|
127 | - * |
|
128 | - * @param int|WP_Post $object_id Supplied ID. |
|
129 | - * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
130 | - */ |
|
131 | - protected function get_object( $object_id ) { |
|
132 | - |
|
133 | - // Do we have an object? |
|
134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
136 | - } |
|
137 | - |
|
138 | - // Fetch the object. |
|
139 | - $object = new $this->crud_class( $object_id ); |
|
140 | - if ( ! empty( $object->last_error ) ) { |
|
141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
142 | - } |
|
143 | - |
|
144 | - $this->data_object = $object; |
|
145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
146 | - |
|
147 | - } |
|
148 | - |
|
149 | - /** |
|
150 | - * Get a single object. |
|
151 | - * |
|
152 | - * @param WP_REST_Request $request Full details about the request. |
|
153 | - * @return WP_Error|WP_REST_Response |
|
154 | - */ |
|
155 | - public function get_item( $request ) { |
|
156 | - |
|
157 | - // Fetch the item. |
|
158 | - $object = $this->get_object( $request['id'] ); |
|
159 | - |
|
160 | - if ( is_wp_error( $object ) ) { |
|
161 | - return $object; |
|
162 | - } |
|
163 | - |
|
164 | - // Generate a response. |
|
165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
166 | - |
|
167 | - } |
|
168 | - |
|
169 | - /** |
|
170 | - * Create a single object. |
|
171 | - * |
|
172 | - * @param WP_REST_Request $request Full details about the request. |
|
173 | - * @return WP_Error|WP_REST_Response |
|
174 | - */ |
|
175 | - public function create_item( $request ) { |
|
176 | - |
|
177 | - // Can not create an existing item. |
|
178 | - if ( ! empty( $request['id'] ) ) { |
|
179 | - /* translators: %s: post type */ |
|
180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
181 | - } |
|
182 | - |
|
183 | - // Generate a GetPaid_Data object from the request. |
|
184 | - $object = $this->prepare_item_for_database( $request ); |
|
185 | - if ( is_wp_error( $object ) ) { |
|
186 | - return $object; |
|
187 | - } |
|
188 | - |
|
189 | - // Save the object. |
|
190 | - $object = $this->save_object( $object ); |
|
191 | - if ( is_wp_error( $object ) ) { |
|
192 | - return $object; |
|
193 | - } |
|
194 | - |
|
195 | - // Save special fields. |
|
196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
197 | - if ( is_wp_error( $save_special ) ) { |
|
198 | - $object->delete( true ); |
|
199 | - return $save_special; |
|
200 | - } |
|
201 | - |
|
202 | - $request->set_param( 'context', 'edit' ); |
|
203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
204 | - $response = rest_ensure_response( $response ); |
|
205 | - $response->set_status( 201 ); |
|
206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
207 | - |
|
208 | - return $response; |
|
209 | - } |
|
210 | - |
|
211 | - /** |
|
212 | - * Update a single object. |
|
213 | - * |
|
214 | - * @param WP_REST_Request $request Full details about the request. |
|
215 | - * @return WP_Error|WP_REST_Response |
|
216 | - */ |
|
217 | - public function update_item( $request ) { |
|
218 | - |
|
219 | - // Fetch the item. |
|
220 | - $object = $this->get_object( $request['id'] ); |
|
221 | - if ( is_wp_error( $object ) ) { |
|
222 | - return $object; |
|
223 | - } |
|
224 | - |
|
225 | - // Prepare the item for saving. |
|
226 | - $object = $this->prepare_item_for_database( $request ); |
|
227 | - if ( is_wp_error( $object ) ) { |
|
228 | - return $object; |
|
229 | - } |
|
230 | - |
|
231 | - // Save the item. |
|
232 | - $object = $this->save_object( $object ); |
|
233 | - if ( is_wp_error( $object ) ) { |
|
234 | - return $object; |
|
235 | - } |
|
236 | - |
|
237 | - // Save special fields (those added via hooks). |
|
238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
239 | - if ( is_wp_error( $save_special ) ) { |
|
240 | - return $save_special; |
|
241 | - } |
|
242 | - |
|
243 | - $request->set_param( 'context', 'edit' ); |
|
244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
245 | - return rest_ensure_response( $response ); |
|
246 | - } |
|
247 | - |
|
248 | - /** |
|
249 | - * Prepare links for the request. |
|
250 | - * |
|
251 | - * @param GetPaid_Data $object GetPaid_Data object. |
|
252 | - * @return array Links for the given object. |
|
253 | - */ |
|
254 | - protected function prepare_links( $object ) { |
|
255 | - |
|
256 | - $links = array( |
|
257 | - 'self' => array( |
|
258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
259 | - ), |
|
260 | - 'collection' => array( |
|
261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
262 | - ), |
|
263 | - ); |
|
264 | - |
|
265 | - return $links; |
|
266 | - } |
|
267 | - |
|
268 | - /** |
|
269 | - * Get the query params for collections of attachments. |
|
270 | - * |
|
271 | - * @return array |
|
272 | - */ |
|
273 | - public function get_collection_params() { |
|
274 | - $params = parent::get_collection_params(); |
|
275 | - $params['context']['default'] = 'view'; |
|
276 | - return $params; |
|
277 | - } |
|
278 | - |
|
279 | - /** |
|
280 | - * Only return writable props from schema. |
|
281 | - * |
|
282 | - * @param array $schema Schema. |
|
283 | - * @return bool |
|
284 | - */ |
|
285 | - public function filter_writable_props( $schema ) { |
|
286 | - return empty( $schema['readonly'] ); |
|
287 | - } |
|
288 | - |
|
289 | - /** |
|
290 | - * Prepare a single object for create or update. |
|
291 | - * |
|
292 | - * @since 1.0.19 |
|
293 | - * @param WP_REST_Request $request Request object. |
|
294 | - * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
295 | - */ |
|
296 | - protected function prepare_item_for_database( $request ) { |
|
297 | - |
|
298 | - // Do we have an object? |
|
299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
301 | - } |
|
302 | - |
|
303 | - // Prepare the object. |
|
304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
305 | - $object = new $this->crud_class( $id ); |
|
306 | - |
|
307 | - // Abort if an error exists. |
|
308 | - if ( ! empty( $object->last_error ) ) { |
|
309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
310 | - } |
|
311 | - |
|
312 | - $schema = $this->get_item_schema(); |
|
313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
314 | - |
|
315 | - // Handle all writable props. |
|
316 | - foreach ( $data_keys as $key ) { |
|
317 | - $value = $request[ $key ]; |
|
318 | - |
|
319 | - if ( ! is_null( $value ) ) { |
|
320 | - switch ( $key ) { |
|
321 | - |
|
322 | - case 'meta_data': |
|
323 | - if ( is_array( $value ) ) { |
|
324 | - foreach ( $value as $meta ) { |
|
325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
326 | - } |
|
327 | - } |
|
328 | - break; |
|
329 | - |
|
330 | - default: |
|
331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
332 | - $object->{"set_{$key}"}( $value ); |
|
333 | - } |
|
334 | - break; |
|
335 | - } |
|
336 | - } |
|
20 | + /** |
|
21 | + * Contains this controller's class name. |
|
22 | + * |
|
23 | + * @var string |
|
24 | + */ |
|
25 | + public $crud_class; |
|
26 | + |
|
27 | + /** |
|
28 | + * Contains the current CRUD object. |
|
29 | + * |
|
30 | + * @var GetPaid_Data |
|
31 | + */ |
|
32 | + protected $data_object; |
|
33 | + |
|
34 | + /** |
|
35 | + * Registers the routes for the objects of the controller. |
|
36 | + * |
|
37 | + * @since 1.0.19 |
|
38 | + * |
|
39 | + * @see register_rest_route() |
|
40 | + */ |
|
41 | + public function register_namespace_routes( $namespace ) { |
|
42 | + |
|
43 | + register_rest_route( |
|
44 | + $namespace, |
|
45 | + '/' . $this->rest_base, |
|
46 | + array( |
|
47 | + array( |
|
48 | + 'methods' => WP_REST_Server::READABLE, |
|
49 | + 'callback' => array( $this, 'get_items' ), |
|
50 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
51 | + 'args' => $this->get_collection_params(), |
|
52 | + ), |
|
53 | + array( |
|
54 | + 'methods' => WP_REST_Server::CREATABLE, |
|
55 | + 'callback' => array( $this, 'create_item' ), |
|
56 | + 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
57 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
58 | + ), |
|
59 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
60 | + ) |
|
61 | + ); |
|
62 | + |
|
63 | + $get_item_args = array( |
|
64 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
65 | + ); |
|
66 | + |
|
67 | + register_rest_route( |
|
68 | + $namespace, |
|
69 | + '/' . $this->rest_base . '/(?P<id>[\d]+)', |
|
70 | + array( |
|
71 | + 'args' => array( |
|
72 | + 'id' => array( |
|
73 | + 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
74 | + 'type' => 'integer', |
|
75 | + ), |
|
76 | + ), |
|
77 | + array( |
|
78 | + 'methods' => WP_REST_Server::READABLE, |
|
79 | + 'callback' => array( $this, 'get_item' ), |
|
80 | + 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
81 | + 'args' => $get_item_args, |
|
82 | + ), |
|
83 | + array( |
|
84 | + 'methods' => WP_REST_Server::EDITABLE, |
|
85 | + 'callback' => array( $this, 'update_item' ), |
|
86 | + 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
87 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
88 | + ), |
|
89 | + array( |
|
90 | + 'methods' => WP_REST_Server::DELETABLE, |
|
91 | + 'callback' => array( $this, 'delete_item' ), |
|
92 | + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
93 | + 'args' => array( |
|
94 | + 'force' => array( |
|
95 | + 'type' => 'boolean', |
|
96 | + 'default' => false, |
|
97 | + 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
98 | + ), |
|
99 | + ), |
|
100 | + ), |
|
101 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
102 | + ) |
|
103 | + ); |
|
104 | + |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Saves a single object. |
|
109 | + * |
|
110 | + * @param GetPaid_Data $object Object to save. |
|
111 | + * @return WP_Error|GetPaid_Data |
|
112 | + */ |
|
113 | + protected function save_object( $object ) { |
|
114 | + $object->save(); |
|
115 | + |
|
116 | + if ( ! empty( $object->last_error ) ) { |
|
117 | + return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
118 | + } |
|
119 | + |
|
120 | + return new $this->crud_class( $object->get_id() ); |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Retrieves a single object. |
|
125 | + * |
|
126 | + * @since 1.0.13 |
|
127 | + * |
|
128 | + * @param int|WP_Post $object_id Supplied ID. |
|
129 | + * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
|
130 | + */ |
|
131 | + protected function get_object( $object_id ) { |
|
132 | + |
|
133 | + // Do we have an object? |
|
134 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
135 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
136 | + } |
|
137 | + |
|
138 | + // Fetch the object. |
|
139 | + $object = new $this->crud_class( $object_id ); |
|
140 | + if ( ! empty( $object->last_error ) ) { |
|
141 | + return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
142 | + } |
|
143 | + |
|
144 | + $this->data_object = $object; |
|
145 | + return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
146 | + |
|
147 | + } |
|
148 | + |
|
149 | + /** |
|
150 | + * Get a single object. |
|
151 | + * |
|
152 | + * @param WP_REST_Request $request Full details about the request. |
|
153 | + * @return WP_Error|WP_REST_Response |
|
154 | + */ |
|
155 | + public function get_item( $request ) { |
|
156 | + |
|
157 | + // Fetch the item. |
|
158 | + $object = $this->get_object( $request['id'] ); |
|
159 | + |
|
160 | + if ( is_wp_error( $object ) ) { |
|
161 | + return $object; |
|
162 | + } |
|
163 | + |
|
164 | + // Generate a response. |
|
165 | + return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
166 | + |
|
167 | + } |
|
168 | + |
|
169 | + /** |
|
170 | + * Create a single object. |
|
171 | + * |
|
172 | + * @param WP_REST_Request $request Full details about the request. |
|
173 | + * @return WP_Error|WP_REST_Response |
|
174 | + */ |
|
175 | + public function create_item( $request ) { |
|
176 | + |
|
177 | + // Can not create an existing item. |
|
178 | + if ( ! empty( $request['id'] ) ) { |
|
179 | + /* translators: %s: post type */ |
|
180 | + return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
181 | + } |
|
182 | + |
|
183 | + // Generate a GetPaid_Data object from the request. |
|
184 | + $object = $this->prepare_item_for_database( $request ); |
|
185 | + if ( is_wp_error( $object ) ) { |
|
186 | + return $object; |
|
187 | + } |
|
188 | + |
|
189 | + // Save the object. |
|
190 | + $object = $this->save_object( $object ); |
|
191 | + if ( is_wp_error( $object ) ) { |
|
192 | + return $object; |
|
193 | + } |
|
194 | + |
|
195 | + // Save special fields. |
|
196 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
197 | + if ( is_wp_error( $save_special ) ) { |
|
198 | + $object->delete( true ); |
|
199 | + return $save_special; |
|
200 | + } |
|
201 | + |
|
202 | + $request->set_param( 'context', 'edit' ); |
|
203 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
204 | + $response = rest_ensure_response( $response ); |
|
205 | + $response->set_status( 201 ); |
|
206 | + $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
207 | + |
|
208 | + return $response; |
|
209 | + } |
|
210 | + |
|
211 | + /** |
|
212 | + * Update a single object. |
|
213 | + * |
|
214 | + * @param WP_REST_Request $request Full details about the request. |
|
215 | + * @return WP_Error|WP_REST_Response |
|
216 | + */ |
|
217 | + public function update_item( $request ) { |
|
218 | + |
|
219 | + // Fetch the item. |
|
220 | + $object = $this->get_object( $request['id'] ); |
|
221 | + if ( is_wp_error( $object ) ) { |
|
222 | + return $object; |
|
223 | + } |
|
224 | + |
|
225 | + // Prepare the item for saving. |
|
226 | + $object = $this->prepare_item_for_database( $request ); |
|
227 | + if ( is_wp_error( $object ) ) { |
|
228 | + return $object; |
|
229 | + } |
|
230 | + |
|
231 | + // Save the item. |
|
232 | + $object = $this->save_object( $object ); |
|
233 | + if ( is_wp_error( $object ) ) { |
|
234 | + return $object; |
|
235 | + } |
|
236 | + |
|
237 | + // Save special fields (those added via hooks). |
|
238 | + $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
239 | + if ( is_wp_error( $save_special ) ) { |
|
240 | + return $save_special; |
|
241 | + } |
|
242 | + |
|
243 | + $request->set_param( 'context', 'edit' ); |
|
244 | + $response = $this->prepare_item_for_response( $object, $request ); |
|
245 | + return rest_ensure_response( $response ); |
|
246 | + } |
|
247 | + |
|
248 | + /** |
|
249 | + * Prepare links for the request. |
|
250 | + * |
|
251 | + * @param GetPaid_Data $object GetPaid_Data object. |
|
252 | + * @return array Links for the given object. |
|
253 | + */ |
|
254 | + protected function prepare_links( $object ) { |
|
255 | + |
|
256 | + $links = array( |
|
257 | + 'self' => array( |
|
258 | + 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
259 | + ), |
|
260 | + 'collection' => array( |
|
261 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
262 | + ), |
|
263 | + ); |
|
264 | + |
|
265 | + return $links; |
|
266 | + } |
|
267 | + |
|
268 | + /** |
|
269 | + * Get the query params for collections of attachments. |
|
270 | + * |
|
271 | + * @return array |
|
272 | + */ |
|
273 | + public function get_collection_params() { |
|
274 | + $params = parent::get_collection_params(); |
|
275 | + $params['context']['default'] = 'view'; |
|
276 | + return $params; |
|
277 | + } |
|
278 | + |
|
279 | + /** |
|
280 | + * Only return writable props from schema. |
|
281 | + * |
|
282 | + * @param array $schema Schema. |
|
283 | + * @return bool |
|
284 | + */ |
|
285 | + public function filter_writable_props( $schema ) { |
|
286 | + return empty( $schema['readonly'] ); |
|
287 | + } |
|
288 | + |
|
289 | + /** |
|
290 | + * Prepare a single object for create or update. |
|
291 | + * |
|
292 | + * @since 1.0.19 |
|
293 | + * @param WP_REST_Request $request Request object. |
|
294 | + * @return GetPaid_Data|WP_Error Data object or WP_Error. |
|
295 | + */ |
|
296 | + protected function prepare_item_for_database( $request ) { |
|
297 | + |
|
298 | + // Do we have an object? |
|
299 | + if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
300 | + return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
301 | + } |
|
302 | + |
|
303 | + // Prepare the object. |
|
304 | + $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
305 | + $object = new $this->crud_class( $id ); |
|
306 | + |
|
307 | + // Abort if an error exists. |
|
308 | + if ( ! empty( $object->last_error ) ) { |
|
309 | + return new WP_Error( 'invalid_item', $object->last_error ); |
|
310 | + } |
|
311 | + |
|
312 | + $schema = $this->get_item_schema(); |
|
313 | + $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
314 | + |
|
315 | + // Handle all writable props. |
|
316 | + foreach ( $data_keys as $key ) { |
|
317 | + $value = $request[ $key ]; |
|
318 | + |
|
319 | + if ( ! is_null( $value ) ) { |
|
320 | + switch ( $key ) { |
|
321 | + |
|
322 | + case 'meta_data': |
|
323 | + if ( is_array( $value ) ) { |
|
324 | + foreach ( $value as $meta ) { |
|
325 | + $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
326 | + } |
|
327 | + } |
|
328 | + break; |
|
329 | + |
|
330 | + default: |
|
331 | + if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
332 | + $object->{"set_{$key}"}( $value ); |
|
333 | + } |
|
334 | + break; |
|
335 | + } |
|
336 | + } |
|
337 | 337 | } |
338 | 338 | |
339 | - // Filters an object before it is inserted via the REST API.. |
|
340 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
341 | - } |
|
342 | - |
|
343 | - /** |
|
344 | - * Retrieves data from a GetPaid class. |
|
345 | - * |
|
346 | - * @since 1.0.19 |
|
347 | - * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
348 | - * @return array |
|
349 | - */ |
|
350 | - protected function prepare_object_meta_data( $meta_data ) { |
|
351 | - $meta = array(); |
|
352 | - |
|
353 | - foreach ( $meta_data as $object ) { |
|
354 | - $meta[] = $object->get_data(); |
|
355 | - } |
|
356 | - |
|
357 | - return $meta; |
|
358 | - } |
|
359 | - |
|
360 | - /** |
|
361 | - * Retrieves invoice items. |
|
362 | - * |
|
363 | - * @since 1.0.19 |
|
364 | - * @param WPInv_Invoice $invoice Invoice items. |
|
365 | - * @param array $fields Fields to include. |
|
366 | - * @return array |
|
367 | - */ |
|
368 | - protected function prepare_invoice_items( $invoice ) { |
|
369 | - $items = array(); |
|
370 | - |
|
371 | - foreach ( $invoice->get_items() as $item ) { |
|
372 | - |
|
373 | - $item_data = $item->prepare_data_for_saving(); |
|
374 | - |
|
375 | - if ( 'amount' == $invoice->get_template() ) { |
|
376 | - $item_data['quantity'] = 1; |
|
377 | - } |
|
378 | - |
|
379 | - $items[] = $item_data; |
|
380 | - } |
|
381 | - |
|
382 | - return $items; |
|
383 | - } |
|
384 | - |
|
385 | - /** |
|
386 | - * Retrieves data from a GetPaid class. |
|
387 | - * |
|
388 | - * @since 1.0.19 |
|
389 | - * @param GetPaid_Data $object Data object. |
|
390 | - * @param array $fields Fields to include. |
|
391 | - * @param string $context either view or edit. |
|
392 | - * @return array |
|
393 | - */ |
|
394 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
395 | - |
|
396 | - $data = array(); |
|
397 | - |
|
398 | - // Handle all writable props. |
|
399 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
400 | - |
|
401 | - // Abort if it is not included. |
|
402 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
403 | - continue; |
|
404 | - } |
|
405 | - |
|
406 | - // Or this current object does not support the field. |
|
407 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
408 | - continue; |
|
409 | - } |
|
410 | - |
|
411 | - // Handle meta data. |
|
412 | - if ( $key == 'meta_data' ) { |
|
413 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
414 | - continue; |
|
415 | - } |
|
416 | - |
|
417 | - // Handle items. |
|
418 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
419 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
420 | - continue; |
|
421 | - } |
|
422 | - |
|
423 | - // Booleans. |
|
424 | - if ( is_callable( array( $object, $key ) ) ) { |
|
425 | - $data[ $key ] = $object->$key( $context ); |
|
426 | - continue; |
|
427 | - } |
|
428 | - |
|
429 | - // Get object value. |
|
430 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
431 | - $value = $object->{"get_{$key}"}( $context ); |
|
432 | - |
|
433 | - // If the value is an instance of GetPaid_Data... |
|
434 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
435 | - $value = $value->get_data( $context ); |
|
436 | - } |
|
437 | - |
|
438 | - // For objects, retrieves it's properties. |
|
439 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
440 | - continue; |
|
441 | - } |
|
339 | + // Filters an object before it is inserted via the REST API.. |
|
340 | + return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
341 | + } |
|
342 | + |
|
343 | + /** |
|
344 | + * Retrieves data from a GetPaid class. |
|
345 | + * |
|
346 | + * @since 1.0.19 |
|
347 | + * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
|
348 | + * @return array |
|
349 | + */ |
|
350 | + protected function prepare_object_meta_data( $meta_data ) { |
|
351 | + $meta = array(); |
|
352 | + |
|
353 | + foreach ( $meta_data as $object ) { |
|
354 | + $meta[] = $object->get_data(); |
|
355 | + } |
|
356 | + |
|
357 | + return $meta; |
|
358 | + } |
|
359 | + |
|
360 | + /** |
|
361 | + * Retrieves invoice items. |
|
362 | + * |
|
363 | + * @since 1.0.19 |
|
364 | + * @param WPInv_Invoice $invoice Invoice items. |
|
365 | + * @param array $fields Fields to include. |
|
366 | + * @return array |
|
367 | + */ |
|
368 | + protected function prepare_invoice_items( $invoice ) { |
|
369 | + $items = array(); |
|
370 | + |
|
371 | + foreach ( $invoice->get_items() as $item ) { |
|
372 | + |
|
373 | + $item_data = $item->prepare_data_for_saving(); |
|
374 | + |
|
375 | + if ( 'amount' == $invoice->get_template() ) { |
|
376 | + $item_data['quantity'] = 1; |
|
377 | + } |
|
378 | + |
|
379 | + $items[] = $item_data; |
|
380 | + } |
|
381 | + |
|
382 | + return $items; |
|
383 | + } |
|
384 | + |
|
385 | + /** |
|
386 | + * Retrieves data from a GetPaid class. |
|
387 | + * |
|
388 | + * @since 1.0.19 |
|
389 | + * @param GetPaid_Data $object Data object. |
|
390 | + * @param array $fields Fields to include. |
|
391 | + * @param string $context either view or edit. |
|
392 | + * @return array |
|
393 | + */ |
|
394 | + protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
395 | + |
|
396 | + $data = array(); |
|
397 | + |
|
398 | + // Handle all writable props. |
|
399 | + foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
400 | + |
|
401 | + // Abort if it is not included. |
|
402 | + if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
403 | + continue; |
|
404 | + } |
|
405 | + |
|
406 | + // Or this current object does not support the field. |
|
407 | + if ( ! $this->object_supports_field( $object, $key ) ) { |
|
408 | + continue; |
|
409 | + } |
|
410 | + |
|
411 | + // Handle meta data. |
|
412 | + if ( $key == 'meta_data' ) { |
|
413 | + $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
414 | + continue; |
|
415 | + } |
|
416 | + |
|
417 | + // Handle items. |
|
418 | + if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
419 | + $data['items'] = $this->prepare_invoice_items( $object ); |
|
420 | + continue; |
|
421 | + } |
|
422 | + |
|
423 | + // Booleans. |
|
424 | + if ( is_callable( array( $object, $key ) ) ) { |
|
425 | + $data[ $key ] = $object->$key( $context ); |
|
426 | + continue; |
|
427 | + } |
|
428 | + |
|
429 | + // Get object value. |
|
430 | + if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
431 | + $value = $object->{"get_{$key}"}( $context ); |
|
432 | + |
|
433 | + // If the value is an instance of GetPaid_Data... |
|
434 | + if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
435 | + $value = $value->get_data( $context ); |
|
436 | + } |
|
437 | + |
|
438 | + // For objects, retrieves it's properties. |
|
439 | + $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
440 | + continue; |
|
441 | + } |
|
442 | 442 | } |
443 | 443 | |
444 | - return $data; |
|
445 | - } |
|
446 | - |
|
447 | - /** |
|
448 | - * Checks if a key should be included in a response. |
|
449 | - * |
|
450 | - * @since 1.0.19 |
|
451 | - * @param GetPaid_Data $object Data object. |
|
452 | - * @param string $field_key The key to check for. |
|
453 | - * @return bool |
|
454 | - */ |
|
455 | - public function object_supports_field( $object, $field_key ) { |
|
456 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
457 | - } |
|
458 | - |
|
459 | - /** |
|
460 | - * Prepare a single object output for response. |
|
461 | - * |
|
462 | - * @since 1.0.19 |
|
463 | - * @param GetPaid_Data $object Data object. |
|
464 | - * @param WP_REST_Request $request Request object. |
|
465 | - * @return WP_REST_Response |
|
466 | - */ |
|
467 | - public function prepare_item_for_response( $object, $request ) { |
|
468 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
469 | - |
|
470 | - $this->data_object = $object; |
|
471 | - |
|
472 | - // Fetch the fields to include in this response. |
|
473 | - $fields = $this->get_fields_for_response( $request ); |
|
474 | - |
|
475 | - // Prepare object data. |
|
476 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
477 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
478 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
479 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
480 | - $data = $this->filter_response_by_context( $data, $context ); |
|
481 | - |
|
482 | - // Prepare the response. |
|
483 | - $response = rest_ensure_response( $data ); |
|
484 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
485 | - |
|
486 | - // Filter item response. |
|
487 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
488 | - } |
|
444 | + return $data; |
|
445 | + } |
|
446 | + |
|
447 | + /** |
|
448 | + * Checks if a key should be included in a response. |
|
449 | + * |
|
450 | + * @since 1.0.19 |
|
451 | + * @param GetPaid_Data $object Data object. |
|
452 | + * @param string $field_key The key to check for. |
|
453 | + * @return bool |
|
454 | + */ |
|
455 | + public function object_supports_field( $object, $field_key ) { |
|
456 | + return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
457 | + } |
|
458 | + |
|
459 | + /** |
|
460 | + * Prepare a single object output for response. |
|
461 | + * |
|
462 | + * @since 1.0.19 |
|
463 | + * @param GetPaid_Data $object Data object. |
|
464 | + * @param WP_REST_Request $request Request object. |
|
465 | + * @return WP_REST_Response |
|
466 | + */ |
|
467 | + public function prepare_item_for_response( $object, $request ) { |
|
468 | + remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
469 | + |
|
470 | + $this->data_object = $object; |
|
471 | + |
|
472 | + // Fetch the fields to include in this response. |
|
473 | + $fields = $this->get_fields_for_response( $request ); |
|
474 | + |
|
475 | + // Prepare object data. |
|
476 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
477 | + $data = $this->prepare_object_data( $object, $fields, $context ); |
|
478 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
479 | + $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
480 | + $data = $this->filter_response_by_context( $data, $context ); |
|
481 | + |
|
482 | + // Prepare the response. |
|
483 | + $response = rest_ensure_response( $data ); |
|
484 | + $response->add_links( $this->prepare_links( $object, $request ) ); |
|
485 | + |
|
486 | + // Filter item response. |
|
487 | + return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
488 | + } |
|
489 | 489 | |
490 | 490 | } |
@@ -8,7 +8,7 @@ discard block |
||
8 | 8 | * @version 1.0.19 |
9 | 9 | */ |
10 | 10 | |
11 | -defined( 'ABSPATH' ) || exit; |
|
11 | +defined('ABSPATH') || exit; |
|
12 | 12 | |
13 | 13 | /** |
14 | 14 | * GetPaid REST CRUD controller class. |
@@ -38,7 +38,7 @@ discard block |
||
38 | 38 | * |
39 | 39 | * @see register_rest_route() |
40 | 40 | */ |
41 | - public function register_namespace_routes( $namespace ) { |
|
41 | + public function register_namespace_routes($namespace) { |
|
42 | 42 | |
43 | 43 | register_rest_route( |
44 | 44 | $namespace, |
@@ -46,22 +46,22 @@ discard block |
||
46 | 46 | array( |
47 | 47 | array( |
48 | 48 | 'methods' => WP_REST_Server::READABLE, |
49 | - 'callback' => array( $this, 'get_items' ), |
|
50 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
49 | + 'callback' => array($this, 'get_items'), |
|
50 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
51 | 51 | 'args' => $this->get_collection_params(), |
52 | 52 | ), |
53 | 53 | array( |
54 | 54 | 'methods' => WP_REST_Server::CREATABLE, |
55 | - 'callback' => array( $this, 'create_item' ), |
|
56 | - 'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
57 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), |
|
55 | + 'callback' => array($this, 'create_item'), |
|
56 | + 'permission_callback' => array($this, 'create_item_permissions_check'), |
|
57 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::CREATABLE), |
|
58 | 58 | ), |
59 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
59 | + 'schema' => array($this, 'get_public_item_schema'), |
|
60 | 60 | ) |
61 | 61 | ); |
62 | 62 | |
63 | 63 | $get_item_args = array( |
64 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
64 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
65 | 65 | ); |
66 | 66 | |
67 | 67 | register_rest_route( |
@@ -70,35 +70,35 @@ discard block |
||
70 | 70 | array( |
71 | 71 | 'args' => array( |
72 | 72 | 'id' => array( |
73 | - 'description' => __( 'Unique identifier for the object.', 'invoicing' ), |
|
73 | + 'description' => __('Unique identifier for the object.', 'invoicing'), |
|
74 | 74 | 'type' => 'integer', |
75 | 75 | ), |
76 | 76 | ), |
77 | 77 | array( |
78 | 78 | 'methods' => WP_REST_Server::READABLE, |
79 | - 'callback' => array( $this, 'get_item' ), |
|
80 | - 'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
79 | + 'callback' => array($this, 'get_item'), |
|
80 | + 'permission_callback' => array($this, 'get_item_permissions_check'), |
|
81 | 81 | 'args' => $get_item_args, |
82 | 82 | ), |
83 | 83 | array( |
84 | 84 | 'methods' => WP_REST_Server::EDITABLE, |
85 | - 'callback' => array( $this, 'update_item' ), |
|
86 | - 'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
87 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
85 | + 'callback' => array($this, 'update_item'), |
|
86 | + 'permission_callback' => array($this, 'update_item_permissions_check'), |
|
87 | + 'args' => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE), |
|
88 | 88 | ), |
89 | 89 | array( |
90 | 90 | 'methods' => WP_REST_Server::DELETABLE, |
91 | - 'callback' => array( $this, 'delete_item' ), |
|
92 | - 'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
91 | + 'callback' => array($this, 'delete_item'), |
|
92 | + 'permission_callback' => array($this, 'delete_item_permissions_check'), |
|
93 | 93 | 'args' => array( |
94 | 94 | 'force' => array( |
95 | 95 | 'type' => 'boolean', |
96 | 96 | 'default' => false, |
97 | - 'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ), |
|
97 | + 'description' => __('Whether to bypass Trash and force deletion.', 'invoicing'), |
|
98 | 98 | ), |
99 | 99 | ), |
100 | 100 | ), |
101 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
101 | + 'schema' => array($this, 'get_public_item_schema'), |
|
102 | 102 | ) |
103 | 103 | ); |
104 | 104 | |
@@ -110,14 +110,14 @@ discard block |
||
110 | 110 | * @param GetPaid_Data $object Object to save. |
111 | 111 | * @return WP_Error|GetPaid_Data |
112 | 112 | */ |
113 | - protected function save_object( $object ) { |
|
113 | + protected function save_object($object) { |
|
114 | 114 | $object->save(); |
115 | 115 | |
116 | - if ( ! empty( $object->last_error ) ) { |
|
117 | - return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) ); |
|
116 | + if (!empty($object->last_error)) { |
|
117 | + return new WP_Error('rest_cannot_save', $object->last_error, array('status' => 400)); |
|
118 | 118 | } |
119 | 119 | |
120 | - return new $this->crud_class( $object->get_id() ); |
|
120 | + return new $this->crud_class($object->get_id()); |
|
121 | 121 | } |
122 | 122 | |
123 | 123 | /** |
@@ -128,21 +128,21 @@ discard block |
||
128 | 128 | * @param int|WP_Post $object_id Supplied ID. |
129 | 129 | * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise. |
130 | 130 | */ |
131 | - protected function get_object( $object_id ) { |
|
131 | + protected function get_object($object_id) { |
|
132 | 132 | |
133 | 133 | // Do we have an object? |
134 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
135 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
134 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
135 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
136 | 136 | } |
137 | 137 | |
138 | 138 | // Fetch the object. |
139 | - $object = new $this->crud_class( $object_id ); |
|
140 | - if ( ! empty( $object->last_error ) ) { |
|
141 | - return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) ); |
|
139 | + $object = new $this->crud_class($object_id); |
|
140 | + if (!empty($object->last_error)) { |
|
141 | + return new WP_Error('rest_object_invalid_id', $object->last_error, array('status' => 404)); |
|
142 | 142 | } |
143 | 143 | |
144 | 144 | $this->data_object = $object; |
145 | - return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) ); |
|
145 | + return $object->get_id() ? $object : new WP_Error('rest_object_invalid_id', __('Invalid ID.', 'invoicing'), array('status' => 404)); |
|
146 | 146 | |
147 | 147 | } |
148 | 148 | |
@@ -152,17 +152,17 @@ discard block |
||
152 | 152 | * @param WP_REST_Request $request Full details about the request. |
153 | 153 | * @return WP_Error|WP_REST_Response |
154 | 154 | */ |
155 | - public function get_item( $request ) { |
|
155 | + public function get_item($request) { |
|
156 | 156 | |
157 | 157 | // Fetch the item. |
158 | - $object = $this->get_object( $request['id'] ); |
|
158 | + $object = $this->get_object($request['id']); |
|
159 | 159 | |
160 | - if ( is_wp_error( $object ) ) { |
|
160 | + if (is_wp_error($object)) { |
|
161 | 161 | return $object; |
162 | 162 | } |
163 | 163 | |
164 | 164 | // Generate a response. |
165 | - return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) ); |
|
165 | + return rest_ensure_response($this->prepare_item_for_response($object, $request)); |
|
166 | 166 | |
167 | 167 | } |
168 | 168 | |
@@ -172,38 +172,38 @@ discard block |
||
172 | 172 | * @param WP_REST_Request $request Full details about the request. |
173 | 173 | * @return WP_Error|WP_REST_Response |
174 | 174 | */ |
175 | - public function create_item( $request ) { |
|
175 | + public function create_item($request) { |
|
176 | 176 | |
177 | 177 | // Can not create an existing item. |
178 | - if ( ! empty( $request['id'] ) ) { |
|
178 | + if (!empty($request['id'])) { |
|
179 | 179 | /* translators: %s: post type */ |
180 | - return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) ); |
|
180 | + return new WP_Error("getpaid_rest_{$this->rest_base}_exists", __('Cannot create existing resource.', 'invoicing'), array('status' => 400)); |
|
181 | 181 | } |
182 | 182 | |
183 | 183 | // Generate a GetPaid_Data object from the request. |
184 | - $object = $this->prepare_item_for_database( $request ); |
|
185 | - if ( is_wp_error( $object ) ) { |
|
184 | + $object = $this->prepare_item_for_database($request); |
|
185 | + if (is_wp_error($object)) { |
|
186 | 186 | return $object; |
187 | 187 | } |
188 | 188 | |
189 | 189 | // Save the object. |
190 | - $object = $this->save_object( $object ); |
|
191 | - if ( is_wp_error( $object ) ) { |
|
190 | + $object = $this->save_object($object); |
|
191 | + if (is_wp_error($object)) { |
|
192 | 192 | return $object; |
193 | 193 | } |
194 | 194 | |
195 | 195 | // Save special fields. |
196 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
197 | - if ( is_wp_error( $save_special ) ) { |
|
198 | - $object->delete( true ); |
|
196 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
197 | + if (is_wp_error($save_special)) { |
|
198 | + $object->delete(true); |
|
199 | 199 | return $save_special; |
200 | 200 | } |
201 | 201 | |
202 | - $request->set_param( 'context', 'edit' ); |
|
203 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
204 | - $response = rest_ensure_response( $response ); |
|
205 | - $response->set_status( 201 ); |
|
206 | - $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) ); |
|
202 | + $request->set_param('context', 'edit'); |
|
203 | + $response = $this->prepare_item_for_response($object, $request); |
|
204 | + $response = rest_ensure_response($response); |
|
205 | + $response->set_status(201); |
|
206 | + $response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id()))); |
|
207 | 207 | |
208 | 208 | return $response; |
209 | 209 | } |
@@ -214,35 +214,35 @@ discard block |
||
214 | 214 | * @param WP_REST_Request $request Full details about the request. |
215 | 215 | * @return WP_Error|WP_REST_Response |
216 | 216 | */ |
217 | - public function update_item( $request ) { |
|
217 | + public function update_item($request) { |
|
218 | 218 | |
219 | 219 | // Fetch the item. |
220 | - $object = $this->get_object( $request['id'] ); |
|
221 | - if ( is_wp_error( $object ) ) { |
|
220 | + $object = $this->get_object($request['id']); |
|
221 | + if (is_wp_error($object)) { |
|
222 | 222 | return $object; |
223 | 223 | } |
224 | 224 | |
225 | 225 | // Prepare the item for saving. |
226 | - $object = $this->prepare_item_for_database( $request ); |
|
227 | - if ( is_wp_error( $object ) ) { |
|
226 | + $object = $this->prepare_item_for_database($request); |
|
227 | + if (is_wp_error($object)) { |
|
228 | 228 | return $object; |
229 | 229 | } |
230 | 230 | |
231 | 231 | // Save the item. |
232 | - $object = $this->save_object( $object ); |
|
233 | - if ( is_wp_error( $object ) ) { |
|
232 | + $object = $this->save_object($object); |
|
233 | + if (is_wp_error($object)) { |
|
234 | 234 | return $object; |
235 | 235 | } |
236 | 236 | |
237 | 237 | // Save special fields (those added via hooks). |
238 | - $save_special = $this->update_additional_fields_for_object( $object, $request ); |
|
239 | - if ( is_wp_error( $save_special ) ) { |
|
238 | + $save_special = $this->update_additional_fields_for_object($object, $request); |
|
239 | + if (is_wp_error($save_special)) { |
|
240 | 240 | return $save_special; |
241 | 241 | } |
242 | 242 | |
243 | - $request->set_param( 'context', 'edit' ); |
|
244 | - $response = $this->prepare_item_for_response( $object, $request ); |
|
245 | - return rest_ensure_response( $response ); |
|
243 | + $request->set_param('context', 'edit'); |
|
244 | + $response = $this->prepare_item_for_response($object, $request); |
|
245 | + return rest_ensure_response($response); |
|
246 | 246 | } |
247 | 247 | |
248 | 248 | /** |
@@ -251,14 +251,14 @@ discard block |
||
251 | 251 | * @param GetPaid_Data $object GetPaid_Data object. |
252 | 252 | * @return array Links for the given object. |
253 | 253 | */ |
254 | - protected function prepare_links( $object ) { |
|
254 | + protected function prepare_links($object) { |
|
255 | 255 | |
256 | 256 | $links = array( |
257 | 257 | 'self' => array( |
258 | - 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ), |
|
258 | + 'href' => rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())), |
|
259 | 259 | ), |
260 | 260 | 'collection' => array( |
261 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
261 | + 'href' => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)), |
|
262 | 262 | ), |
263 | 263 | ); |
264 | 264 | |
@@ -282,8 +282,8 @@ discard block |
||
282 | 282 | * @param array $schema Schema. |
283 | 283 | * @return bool |
284 | 284 | */ |
285 | - public function filter_writable_props( $schema ) { |
|
286 | - return empty( $schema['readonly'] ); |
|
285 | + public function filter_writable_props($schema) { |
|
286 | + return empty($schema['readonly']); |
|
287 | 287 | } |
288 | 288 | |
289 | 289 | /** |
@@ -293,43 +293,43 @@ discard block |
||
293 | 293 | * @param WP_REST_Request $request Request object. |
294 | 294 | * @return GetPaid_Data|WP_Error Data object or WP_Error. |
295 | 295 | */ |
296 | - protected function prepare_item_for_database( $request ) { |
|
296 | + protected function prepare_item_for_database($request) { |
|
297 | 297 | |
298 | 298 | // Do we have an object? |
299 | - if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) { |
|
300 | - return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) ); |
|
299 | + if (empty($this->crud_class) || !class_exists($this->crud_class)) { |
|
300 | + return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing')); |
|
301 | 301 | } |
302 | 302 | |
303 | 303 | // Prepare the object. |
304 | - $id = isset( $request['id'] ) ? absint( $request['id'] ) : 0; |
|
305 | - $object = new $this->crud_class( $id ); |
|
304 | + $id = isset($request['id']) ? absint($request['id']) : 0; |
|
305 | + $object = new $this->crud_class($id); |
|
306 | 306 | |
307 | 307 | // Abort if an error exists. |
308 | - if ( ! empty( $object->last_error ) ) { |
|
309 | - return new WP_Error( 'invalid_item', $object->last_error ); |
|
308 | + if (!empty($object->last_error)) { |
|
309 | + return new WP_Error('invalid_item', $object->last_error); |
|
310 | 310 | } |
311 | 311 | |
312 | 312 | $schema = $this->get_item_schema(); |
313 | - $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) ); |
|
313 | + $data_keys = array_keys(array_filter($schema['properties'], array($this, 'filter_writable_props'))); |
|
314 | 314 | |
315 | 315 | // Handle all writable props. |
316 | - foreach ( $data_keys as $key ) { |
|
317 | - $value = $request[ $key ]; |
|
316 | + foreach ($data_keys as $key) { |
|
317 | + $value = $request[$key]; |
|
318 | 318 | |
319 | - if ( ! is_null( $value ) ) { |
|
320 | - switch ( $key ) { |
|
319 | + if (!is_null($value)) { |
|
320 | + switch ($key) { |
|
321 | 321 | |
322 | 322 | case 'meta_data': |
323 | - if ( is_array( $value ) ) { |
|
324 | - foreach ( $value as $meta ) { |
|
325 | - $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' ); |
|
323 | + if (is_array($value)) { |
|
324 | + foreach ($value as $meta) { |
|
325 | + $object->update_meta_data($meta['key'], $meta['value'], isset($meta['id']) ? $meta['id'] : ''); |
|
326 | 326 | } |
327 | 327 | } |
328 | 328 | break; |
329 | 329 | |
330 | 330 | default: |
331 | - if ( is_callable( array( $object, "set_{$key}" ) ) ) { |
|
332 | - $object->{"set_{$key}"}( $value ); |
|
331 | + if (is_callable(array($object, "set_{$key}"))) { |
|
332 | + $object->{"set_{$key}"}($value); |
|
333 | 333 | } |
334 | 334 | break; |
335 | 335 | } |
@@ -337,7 +337,7 @@ discard block |
||
337 | 337 | } |
338 | 338 | |
339 | 339 | // Filters an object before it is inserted via the REST API.. |
340 | - return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request ); |
|
340 | + return apply_filters("getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request); |
|
341 | 341 | } |
342 | 342 | |
343 | 343 | /** |
@@ -347,10 +347,10 @@ discard block |
||
347 | 347 | * @param GetPaid_Meta_Data[] $meta_data meta data objects. |
348 | 348 | * @return array |
349 | 349 | */ |
350 | - protected function prepare_object_meta_data( $meta_data ) { |
|
350 | + protected function prepare_object_meta_data($meta_data) { |
|
351 | 351 | $meta = array(); |
352 | 352 | |
353 | - foreach ( $meta_data as $object ) { |
|
353 | + foreach ($meta_data as $object) { |
|
354 | 354 | $meta[] = $object->get_data(); |
355 | 355 | } |
356 | 356 | |
@@ -365,14 +365,14 @@ discard block |
||
365 | 365 | * @param array $fields Fields to include. |
366 | 366 | * @return array |
367 | 367 | */ |
368 | - protected function prepare_invoice_items( $invoice ) { |
|
368 | + protected function prepare_invoice_items($invoice) { |
|
369 | 369 | $items = array(); |
370 | 370 | |
371 | - foreach ( $invoice->get_items() as $item ) { |
|
371 | + foreach ($invoice->get_items() as $item) { |
|
372 | 372 | |
373 | 373 | $item_data = $item->prepare_data_for_saving(); |
374 | 374 | |
375 | - if ( 'amount' == $invoice->get_template() ) { |
|
375 | + if ('amount' == $invoice->get_template()) { |
|
376 | 376 | $item_data['quantity'] = 1; |
377 | 377 | } |
378 | 378 | |
@@ -391,52 +391,52 @@ discard block |
||
391 | 391 | * @param string $context either view or edit. |
392 | 392 | * @return array |
393 | 393 | */ |
394 | - protected function prepare_object_data( $object, $fields, $context = 'view' ) { |
|
394 | + protected function prepare_object_data($object, $fields, $context = 'view') { |
|
395 | 395 | |
396 | 396 | $data = array(); |
397 | 397 | |
398 | 398 | // Handle all writable props. |
399 | - foreach ( array_keys( $this->get_schema_properties() ) as $key ) { |
|
399 | + foreach (array_keys($this->get_schema_properties()) as $key) { |
|
400 | 400 | |
401 | 401 | // Abort if it is not included. |
402 | - if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) { |
|
402 | + if (!empty($fields) && !$this->is_field_included($key, $fields)) { |
|
403 | 403 | continue; |
404 | 404 | } |
405 | 405 | |
406 | 406 | // Or this current object does not support the field. |
407 | - if ( ! $this->object_supports_field( $object, $key ) ) { |
|
407 | + if (!$this->object_supports_field($object, $key)) { |
|
408 | 408 | continue; |
409 | 409 | } |
410 | 410 | |
411 | 411 | // Handle meta data. |
412 | - if ( $key == 'meta_data' ) { |
|
413 | - $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() ); |
|
412 | + if ($key == 'meta_data') { |
|
413 | + $data['meta_data'] = $this->prepare_object_meta_data($object->get_meta_data()); |
|
414 | 414 | continue; |
415 | 415 | } |
416 | 416 | |
417 | 417 | // Handle items. |
418 | - if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' ) ) { |
|
419 | - $data['items'] = $this->prepare_invoice_items( $object ); |
|
418 | + if ($key == 'items' && is_a($object, 'WPInv_Invoice')) { |
|
419 | + $data['items'] = $this->prepare_invoice_items($object); |
|
420 | 420 | continue; |
421 | 421 | } |
422 | 422 | |
423 | 423 | // Booleans. |
424 | - if ( is_callable( array( $object, $key ) ) ) { |
|
425 | - $data[ $key ] = $object->$key( $context ); |
|
424 | + if (is_callable(array($object, $key))) { |
|
425 | + $data[$key] = $object->$key($context); |
|
426 | 426 | continue; |
427 | 427 | } |
428 | 428 | |
429 | 429 | // Get object value. |
430 | - if ( is_callable( array( $object, "get_{$key}" ) ) ) { |
|
431 | - $value = $object->{"get_{$key}"}( $context ); |
|
430 | + if (is_callable(array($object, "get_{$key}"))) { |
|
431 | + $value = $object->{"get_{$key}"}($context); |
|
432 | 432 | |
433 | 433 | // If the value is an instance of GetPaid_Data... |
434 | - if ( is_a( $value, 'GetPaid_Data' ) ) { |
|
435 | - $value = $value->get_data( $context ); |
|
434 | + if (is_a($value, 'GetPaid_Data')) { |
|
435 | + $value = $value->get_data($context); |
|
436 | 436 | } |
437 | 437 | |
438 | 438 | // For objects, retrieves it's properties. |
439 | - $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) : $value; |
|
439 | + $data[$key] = is_object($value) ? get_object_vars($value) : $value; |
|
440 | 440 | continue; |
441 | 441 | } |
442 | 442 | } |
@@ -452,8 +452,8 @@ discard block |
||
452 | 452 | * @param string $field_key The key to check for. |
453 | 453 | * @return bool |
454 | 454 | */ |
455 | - public function object_supports_field( $object, $field_key ) { |
|
456 | - return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key ); |
|
455 | + public function object_supports_field($object, $field_key) { |
|
456 | + return apply_filters('getpaid_rest_object_supports_key', true, $object, $field_key); |
|
457 | 457 | } |
458 | 458 | |
459 | 459 | /** |
@@ -464,27 +464,27 @@ discard block |
||
464 | 464 | * @param WP_REST_Request $request Request object. |
465 | 465 | * @return WP_REST_Response |
466 | 466 | */ |
467 | - public function prepare_item_for_response( $object, $request ) { |
|
468 | - remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 ); |
|
467 | + public function prepare_item_for_response($object, $request) { |
|
468 | + remove_filter('rest_post_dispatch', 'rest_filter_response_fields', 10); |
|
469 | 469 | |
470 | 470 | $this->data_object = $object; |
471 | 471 | |
472 | 472 | // Fetch the fields to include in this response. |
473 | - $fields = $this->get_fields_for_response( $request ); |
|
473 | + $fields = $this->get_fields_for_response($request); |
|
474 | 474 | |
475 | 475 | // Prepare object data. |
476 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
477 | - $data = $this->prepare_object_data( $object, $fields, $context ); |
|
478 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
479 | - $data = $this->limit_object_to_requested_fields( $data, $fields ); |
|
480 | - $data = $this->filter_response_by_context( $data, $context ); |
|
476 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
477 | + $data = $this->prepare_object_data($object, $fields, $context); |
|
478 | + $data = $this->add_additional_fields_to_object($data, $request); |
|
479 | + $data = $this->limit_object_to_requested_fields($data, $fields); |
|
480 | + $data = $this->filter_response_by_context($data, $context); |
|
481 | 481 | |
482 | 482 | // Prepare the response. |
483 | - $response = rest_ensure_response( $data ); |
|
484 | - $response->add_links( $this->prepare_links( $object, $request ) ); |
|
483 | + $response = rest_ensure_response($data); |
|
484 | + $response->add_links($this->prepare_links($object, $request)); |
|
485 | 485 | |
486 | 486 | // Filter item response. |
487 | - return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request ); |
|
487 | + return apply_filters("getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request); |
|
488 | 488 | } |
489 | 489 | |
490 | 490 | } |
@@ -16,577 +16,577 @@ |
||
16 | 16 | */ |
17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
18 | 18 | |
19 | - /** |
|
20 | - * Group response items by day or month. |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - public $groupby = 'day'; |
|
25 | - |
|
26 | - /** |
|
27 | - * Returns an array with arguments to request the previous report. |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - public $previous_range = array(); |
|
32 | - |
|
33 | - /** |
|
34 | - * The period interval. |
|
35 | - * |
|
36 | - * @var int |
|
37 | - */ |
|
38 | - public $interval; |
|
39 | - |
|
40 | - /** |
|
41 | - * Retrieves the before and after dates. |
|
42 | - * |
|
43 | - * @param WP_REST_Request $request Request object. |
|
44 | - * @return array The appropriate date range. |
|
45 | - */ |
|
46 | - public function get_date_range( $request ) { |
|
47 | - |
|
48 | - // If not supported, assume all time. |
|
49 | - if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
50 | - $request['period'] = '7_days'; |
|
51 | - } |
|
52 | - |
|
53 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
54 | - $this->prepare_interval( $date_range ); |
|
55 | - |
|
56 | - return $date_range; |
|
57 | - |
|
58 | - } |
|
59 | - |
|
60 | - /** |
|
61 | - * Groups by month or days. |
|
62 | - * |
|
63 | - * @param array $range Date range. |
|
64 | - * @return array The appropriate date range. |
|
65 | - */ |
|
66 | - public function prepare_interval( $range ) { |
|
67 | - |
|
68 | - $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
69 | - $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
70 | - if ( 'day' === $this->groupby ) { |
|
71 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
72 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
73 | - return; |
|
74 | - } |
|
75 | - |
|
76 | - $this->interval = 0; |
|
77 | - $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
78 | - |
|
79 | - while ( $min_date <= $before ) { |
|
80 | - $this->interval ++; |
|
81 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
82 | - } |
|
83 | - |
|
84 | - $this->interval = max( 1, $this->interval ); |
|
85 | - |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * Retrieves a custom date range. |
|
90 | - * |
|
91 | - * @param WP_REST_Request $request Request object. |
|
92 | - * @return array The appropriate date range. |
|
93 | - */ |
|
94 | - public function get_custom_date_range( $request ) { |
|
95 | - |
|
96 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
97 | - $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
98 | - |
|
99 | - if ( ! empty( $request['before'] ) ) { |
|
100 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
101 | - } |
|
102 | - |
|
103 | - // 3 months max for day view |
|
104 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
105 | - $this->groupby = 'month'; |
|
106 | - } |
|
107 | - |
|
108 | - // Set the previous date range. |
|
109 | - $difference = $before - $after; |
|
110 | - $this->previous_range = array( |
|
111 | - 'period' => 'custom', |
|
112 | - 'before' => date( 'Y-m-d', $before - $difference ), |
|
113 | - 'after' => date( 'Y-m-d', $after - $difference ), |
|
114 | - ); |
|
115 | - |
|
116 | - // Generate the report. |
|
117 | - return array( |
|
118 | - 'before' => date( 'Y-m-d', $before ), |
|
119 | - 'after' => date( 'Y-m-d', $after ), |
|
120 | - ); |
|
121 | - |
|
122 | - } |
|
123 | - |
|
124 | - /** |
|
125 | - * Retrieves todays date range. |
|
126 | - * |
|
127 | - * @return array The appropriate date range. |
|
128 | - */ |
|
129 | - public function get_today_date_range() { |
|
130 | - |
|
131 | - // Set the previous date range. |
|
132 | - $this->previous_range = array( |
|
133 | - 'period' => 'yesterday', |
|
134 | - ); |
|
135 | - |
|
136 | - // Generate the report. |
|
137 | - return array( |
|
138 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
139 | - 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
140 | - ); |
|
141 | - |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Retrieves yesterdays date range. |
|
146 | - * |
|
147 | - * @return array The appropriate date range. |
|
148 | - */ |
|
149 | - public function get_yesterday_date_range() { |
|
150 | - |
|
151 | - // Set the previous date range. |
|
152 | - $this->previous_range = array( |
|
153 | - 'period' => 'custom', |
|
154 | - 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
155 | - 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
156 | - ); |
|
157 | - |
|
158 | - // Generate the report. |
|
159 | - return array( |
|
160 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
161 | - 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
162 | - ); |
|
163 | - |
|
164 | - } |
|
165 | - |
|
166 | - /** |
|
167 | - * Retrieves this week's date range. |
|
168 | - * |
|
169 | - * @return array The appropriate date range. |
|
170 | - */ |
|
171 | - public function get_week_date_range() { |
|
172 | - |
|
173 | - // Set the previous date range. |
|
174 | - $this->previous_range = array( |
|
175 | - 'period' => 'last_week', |
|
176 | - ); |
|
177 | - |
|
178 | - // Generate the report. |
|
179 | - return array( |
|
180 | - 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
182 | - ); |
|
183 | - |
|
184 | - } |
|
185 | - |
|
186 | - /** |
|
187 | - * Retrieves last week's date range. |
|
188 | - * |
|
189 | - * @return array The appropriate date range. |
|
190 | - */ |
|
191 | - public function get_last_week_date_range() { |
|
192 | - |
|
193 | - // Set the previous date range. |
|
194 | - $this->previous_range = array( |
|
195 | - 'period' => 'custom', |
|
196 | - 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
197 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
198 | - ); |
|
199 | - |
|
200 | - // Generate the report. |
|
201 | - return array( |
|
202 | - 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
203 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
204 | - ); |
|
205 | - |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * Retrieves last 7 days date range. |
|
210 | - * |
|
211 | - * @return array The appropriate date range. |
|
212 | - */ |
|
213 | - public function get_7_days_date_range() { |
|
214 | - |
|
215 | - // Set the previous date range. |
|
216 | - $this->previous_range = array( |
|
217 | - 'period' => 'custom', |
|
218 | - 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
219 | - 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
220 | - ); |
|
221 | - |
|
222 | - // Generate the report. |
|
223 | - return array( |
|
224 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
225 | - 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
226 | - ); |
|
227 | - |
|
228 | - } |
|
229 | - |
|
230 | - /** |
|
231 | - * Retrieves last 30 days date range. |
|
232 | - * |
|
233 | - * @return array The appropriate date range. |
|
234 | - */ |
|
235 | - public function get_30_days_date_range() { |
|
236 | - |
|
237 | - // Set the previous date range. |
|
238 | - $this->previous_range = array( |
|
239 | - 'period' => 'custom', |
|
240 | - 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
241 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
242 | - ); |
|
243 | - |
|
244 | - // Generate the report. |
|
245 | - return array( |
|
246 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
247 | - 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
248 | - ); |
|
249 | - |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * Retrieves last 90 days date range. |
|
254 | - * |
|
255 | - * @return array The appropriate date range. |
|
256 | - */ |
|
257 | - public function get_90_days_date_range() { |
|
258 | - |
|
259 | - $this->groupby = 'month'; |
|
260 | - |
|
261 | - // Set the previous date range. |
|
262 | - $this->previous_range = array( |
|
263 | - 'period' => 'custom', |
|
264 | - 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
265 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
266 | - ); |
|
267 | - |
|
268 | - // Generate the report. |
|
269 | - return array( |
|
270 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
271 | - 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
272 | - ); |
|
273 | - |
|
274 | - } |
|
275 | - |
|
276 | - /** |
|
277 | - * Retrieves last 180 days date range. |
|
278 | - * |
|
279 | - * @return array The appropriate date range. |
|
280 | - */ |
|
281 | - public function get_180_days_date_range() { |
|
282 | - |
|
283 | - $this->groupby = 'month'; |
|
284 | - |
|
285 | - // Set the previous date range. |
|
286 | - $this->previous_range = array( |
|
287 | - 'period' => 'custom', |
|
288 | - 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
289 | - 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
290 | - ); |
|
291 | - |
|
292 | - // Generate the report. |
|
293 | - return array( |
|
294 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
295 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
296 | - ); |
|
297 | - |
|
298 | - } |
|
299 | - |
|
300 | - /** |
|
301 | - * Retrieves last 60 days date range. |
|
302 | - * |
|
303 | - * @return array The appropriate date range. |
|
304 | - */ |
|
305 | - public function get_60_days_date_range() { |
|
306 | - |
|
307 | - // Set the previous date range. |
|
308 | - $this->previous_range = array( |
|
309 | - 'period' => 'custom', |
|
310 | - 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
311 | - 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
312 | - ); |
|
313 | - |
|
314 | - // Generate the report. |
|
315 | - return array( |
|
316 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
317 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
318 | - ); |
|
319 | - |
|
320 | - } |
|
321 | - |
|
322 | - /** |
|
323 | - * Retrieves this month date range. |
|
324 | - * |
|
325 | - * @return array The appropriate date range. |
|
326 | - */ |
|
327 | - public function get_month_date_range() { |
|
328 | - |
|
329 | - // Set the previous date range. |
|
330 | - $this->previous_range = array( |
|
331 | - 'period' => 'last_month', |
|
332 | - ); |
|
333 | - |
|
334 | - // Generate the report. |
|
335 | - return array( |
|
336 | - 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
338 | - ); |
|
339 | - |
|
340 | - } |
|
341 | - |
|
342 | - /** |
|
343 | - * Retrieves last month's date range. |
|
344 | - * |
|
345 | - * @return array The appropriate date range. |
|
346 | - */ |
|
347 | - public function get_last_month_date_range() { |
|
348 | - |
|
349 | - // Set the previous date range. |
|
350 | - $this->previous_range = array( |
|
351 | - 'period' => 'custom', |
|
352 | - 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
353 | - 'after' => date( 'Y-m-t', strtotime( '-3 months', current_time( 'timestamp' ) ) ), |
|
354 | - ); |
|
355 | - |
|
356 | - // Generate the report. |
|
357 | - return array( |
|
358 | - 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
359 | - 'after' => date( 'Y-m-t', strtotime( '-2 months', current_time( 'timestamp' ) ) ), |
|
360 | - ); |
|
361 | - |
|
362 | - } |
|
363 | - |
|
364 | - /** |
|
365 | - * Retrieves this quarter date range. |
|
366 | - * |
|
367 | - * @return array The available quarters. |
|
368 | - */ |
|
369 | - public function get_quarters() { |
|
370 | - |
|
371 | - $last_year = (int) date( 'Y' ) - 1; |
|
372 | - $next_year = (int) date( 'Y' ) + 1; |
|
373 | - $year = (int) date( 'Y' ); |
|
374 | - return array( |
|
375 | - |
|
376 | - array( |
|
377 | - 'after' => "$last_year-06-30", |
|
378 | - 'before' => "$last_year-10-01", |
|
379 | - ), |
|
380 | - |
|
381 | - array( |
|
382 | - 'before' => "$year-01-01", |
|
383 | - 'after' => "$last_year-09-30", |
|
384 | - ), |
|
385 | - |
|
386 | - array( |
|
387 | - 'before' => "$year-04-01", |
|
388 | - 'after' => "$last_year-12-31", |
|
389 | - ), |
|
390 | - |
|
391 | - array( |
|
392 | - 'before' => "$year-07-01", |
|
393 | - 'after' => "$year-03-31", |
|
394 | - ), |
|
395 | - |
|
396 | - array( |
|
397 | - 'after' => "$year-06-30", |
|
398 | - 'before' => "$year-10-01", |
|
399 | - ), |
|
400 | - |
|
401 | - array( |
|
402 | - 'before' => "$next_year-01-01", |
|
403 | - 'after' => "$year-09-30", |
|
404 | - ), |
|
405 | - |
|
406 | - ); |
|
407 | - |
|
408 | - } |
|
409 | - |
|
410 | - /** |
|
411 | - * Retrieves the current quater. |
|
412 | - * |
|
413 | - * @return int The current quarter. |
|
414 | - */ |
|
415 | - public function get_quarter() { |
|
416 | - |
|
417 | - $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
418 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
419 | - return $quarters[ $month - 1 ]; |
|
420 | - |
|
421 | - } |
|
422 | - |
|
423 | - /** |
|
424 | - * Retrieves this quarter date range. |
|
425 | - * |
|
426 | - * @return array The appropriate date range. |
|
427 | - */ |
|
428 | - public function get_quarter_date_range() { |
|
429 | - |
|
430 | - // Set the previous date range. |
|
431 | - $this->previous_range = array( |
|
432 | - 'period' => 'last_quarter', |
|
433 | - ); |
|
434 | - |
|
435 | - // Generate the report. |
|
436 | - $quarters = $this->get_quarters(); |
|
437 | - return $quarters[ $this->get_quarter() + 1 ]; |
|
438 | - |
|
439 | - } |
|
440 | - |
|
441 | - /** |
|
442 | - * Retrieves last quarter's date range. |
|
443 | - * |
|
444 | - * @return array The appropriate date range. |
|
445 | - */ |
|
446 | - public function get_last_quarter_date_range() { |
|
447 | - |
|
448 | - $quarters = $this->get_quarters(); |
|
449 | - $quarter = $this->get_quarter(); |
|
450 | - |
|
451 | - // Set the previous date range. |
|
452 | - $this->previous_range = array_merge( |
|
453 | - $quarters[ $quarter - 1 ], |
|
454 | - array( 'period' => 'custom' ) |
|
455 | - ); |
|
456 | - |
|
457 | - // Generate the report. |
|
458 | - return $quarters[ $quarter ]; |
|
459 | - |
|
460 | - } |
|
461 | - |
|
462 | - /** |
|
463 | - * Retrieves this year date range. |
|
464 | - * |
|
465 | - * @return array The appropriate date range. |
|
466 | - */ |
|
467 | - public function get_year_date_range() { |
|
468 | - |
|
469 | - $this->groupby = 'month'; |
|
470 | - |
|
471 | - // Set the previous date range. |
|
472 | - $this->previous_range = array( |
|
473 | - 'period' => 'last_year', |
|
474 | - ); |
|
475 | - |
|
476 | - // Generate the report. |
|
477 | - return array( |
|
478 | - 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
479 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
480 | - ); |
|
481 | - |
|
482 | - } |
|
483 | - |
|
484 | - /** |
|
485 | - * Retrieves last year date range. |
|
486 | - * |
|
487 | - * @return array The appropriate date range. |
|
488 | - */ |
|
489 | - public function get_last_year_date_range() { |
|
490 | - |
|
491 | - $this->groupby = 'month'; |
|
492 | - |
|
493 | - // Set the previous date range. |
|
494 | - $year = (int) date( 'Y' ) - 3; |
|
495 | - $this->previous_range = array( |
|
496 | - 'period' => 'custom', |
|
497 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
498 | - 'after' => "$year-12-31", |
|
499 | - ); |
|
500 | - |
|
501 | - // Generate the report. |
|
502 | - $year = (int) date( 'Y' ) - 2; |
|
503 | - return array( |
|
504 | - 'after' => "$year-12-31", |
|
505 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
506 | - ); |
|
507 | - |
|
508 | - } |
|
509 | - |
|
510 | - /** |
|
511 | - * Prepare a the request date for SQL usage. |
|
512 | - * |
|
513 | - * @param WP_REST_Request $request Request object. |
|
514 | - * @param string $date_field The date field. |
|
515 | - * @return string The appropriate SQL. |
|
516 | - */ |
|
517 | - public function get_date_range_sql( $request, $date_field ) { |
|
518 | - global $wpdb; |
|
519 | - |
|
520 | - $sql = '1=1'; |
|
521 | - $range = $this->get_date_range( $request ); |
|
522 | - |
|
523 | - if ( ! empty( $range['after'] ) ) { |
|
524 | - $sql .= ' AND ' . $wpdb->prepare( |
|
525 | - "$date_field > %s", |
|
526 | - $range['after'] |
|
527 | - ); |
|
528 | - } |
|
529 | - |
|
530 | - if ( ! empty( $range['before'] ) ) { |
|
531 | - $sql .= ' AND ' . $wpdb->prepare( |
|
532 | - "$date_field < %s", |
|
533 | - $range['before'] |
|
534 | - ); |
|
535 | - } |
|
536 | - |
|
537 | - return $sql; |
|
538 | - |
|
539 | - } |
|
540 | - |
|
541 | - /** |
|
542 | - * Prepares a group by query. |
|
543 | - * |
|
544 | - * @param string $date_field The date field. |
|
545 | - * @return string The appropriate SQL. |
|
546 | - */ |
|
547 | - public function get_group_by_sql( $date_field ) { |
|
548 | - |
|
549 | - if ( 'day' === $this->groupby ) { |
|
550 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
551 | - } |
|
552 | - |
|
553 | - return "YEAR($date_field), MONTH($date_field)"; |
|
554 | - } |
|
555 | - |
|
556 | - /** |
|
557 | - * Get the query params for collections. |
|
558 | - * |
|
559 | - * @return array |
|
560 | - */ |
|
561 | - public function get_collection_params() { |
|
562 | - return array( |
|
563 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
564 | - 'period' => array( |
|
565 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
566 | - 'type' => 'string', |
|
567 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
568 | - 'validate_callback' => 'rest_validate_request_arg', |
|
569 | - 'sanitize_callback' => 'sanitize_text_field', |
|
570 | - 'default' => '7_days', |
|
571 | - ), |
|
572 | - 'after' => array( |
|
573 | - /* translators: %s: date format */ |
|
574 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
575 | - 'type' => 'string', |
|
576 | - 'format' => 'date', |
|
577 | - 'validate_callback' => 'rest_validate_request_arg', |
|
578 | - 'sanitize_callback' => 'sanitize_text_field', |
|
579 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
580 | - ), |
|
581 | - 'before' => array( |
|
582 | - /* translators: %s: date format */ |
|
583 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
584 | - 'type' => 'string', |
|
585 | - 'format' => 'date', |
|
586 | - 'validate_callback' => 'rest_validate_request_arg', |
|
587 | - 'sanitize_callback' => 'sanitize_text_field', |
|
588 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
589 | - ), |
|
590 | - ); |
|
591 | - } |
|
19 | + /** |
|
20 | + * Group response items by day or month. |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + public $groupby = 'day'; |
|
25 | + |
|
26 | + /** |
|
27 | + * Returns an array with arguments to request the previous report. |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + public $previous_range = array(); |
|
32 | + |
|
33 | + /** |
|
34 | + * The period interval. |
|
35 | + * |
|
36 | + * @var int |
|
37 | + */ |
|
38 | + public $interval; |
|
39 | + |
|
40 | + /** |
|
41 | + * Retrieves the before and after dates. |
|
42 | + * |
|
43 | + * @param WP_REST_Request $request Request object. |
|
44 | + * @return array The appropriate date range. |
|
45 | + */ |
|
46 | + public function get_date_range( $request ) { |
|
47 | + |
|
48 | + // If not supported, assume all time. |
|
49 | + if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
50 | + $request['period'] = '7_days'; |
|
51 | + } |
|
52 | + |
|
53 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
54 | + $this->prepare_interval( $date_range ); |
|
55 | + |
|
56 | + return $date_range; |
|
57 | + |
|
58 | + } |
|
59 | + |
|
60 | + /** |
|
61 | + * Groups by month or days. |
|
62 | + * |
|
63 | + * @param array $range Date range. |
|
64 | + * @return array The appropriate date range. |
|
65 | + */ |
|
66 | + public function prepare_interval( $range ) { |
|
67 | + |
|
68 | + $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
69 | + $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
70 | + if ( 'day' === $this->groupby ) { |
|
71 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
72 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
73 | + return; |
|
74 | + } |
|
75 | + |
|
76 | + $this->interval = 0; |
|
77 | + $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
78 | + |
|
79 | + while ( $min_date <= $before ) { |
|
80 | + $this->interval ++; |
|
81 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
82 | + } |
|
83 | + |
|
84 | + $this->interval = max( 1, $this->interval ); |
|
85 | + |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * Retrieves a custom date range. |
|
90 | + * |
|
91 | + * @param WP_REST_Request $request Request object. |
|
92 | + * @return array The appropriate date range. |
|
93 | + */ |
|
94 | + public function get_custom_date_range( $request ) { |
|
95 | + |
|
96 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
97 | + $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
98 | + |
|
99 | + if ( ! empty( $request['before'] ) ) { |
|
100 | + $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
101 | + } |
|
102 | + |
|
103 | + // 3 months max for day view |
|
104 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
105 | + $this->groupby = 'month'; |
|
106 | + } |
|
107 | + |
|
108 | + // Set the previous date range. |
|
109 | + $difference = $before - $after; |
|
110 | + $this->previous_range = array( |
|
111 | + 'period' => 'custom', |
|
112 | + 'before' => date( 'Y-m-d', $before - $difference ), |
|
113 | + 'after' => date( 'Y-m-d', $after - $difference ), |
|
114 | + ); |
|
115 | + |
|
116 | + // Generate the report. |
|
117 | + return array( |
|
118 | + 'before' => date( 'Y-m-d', $before ), |
|
119 | + 'after' => date( 'Y-m-d', $after ), |
|
120 | + ); |
|
121 | + |
|
122 | + } |
|
123 | + |
|
124 | + /** |
|
125 | + * Retrieves todays date range. |
|
126 | + * |
|
127 | + * @return array The appropriate date range. |
|
128 | + */ |
|
129 | + public function get_today_date_range() { |
|
130 | + |
|
131 | + // Set the previous date range. |
|
132 | + $this->previous_range = array( |
|
133 | + 'period' => 'yesterday', |
|
134 | + ); |
|
135 | + |
|
136 | + // Generate the report. |
|
137 | + return array( |
|
138 | + 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
139 | + 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
140 | + ); |
|
141 | + |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Retrieves yesterdays date range. |
|
146 | + * |
|
147 | + * @return array The appropriate date range. |
|
148 | + */ |
|
149 | + public function get_yesterday_date_range() { |
|
150 | + |
|
151 | + // Set the previous date range. |
|
152 | + $this->previous_range = array( |
|
153 | + 'period' => 'custom', |
|
154 | + 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
155 | + 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
156 | + ); |
|
157 | + |
|
158 | + // Generate the report. |
|
159 | + return array( |
|
160 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
161 | + 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
162 | + ); |
|
163 | + |
|
164 | + } |
|
165 | + |
|
166 | + /** |
|
167 | + * Retrieves this week's date range. |
|
168 | + * |
|
169 | + * @return array The appropriate date range. |
|
170 | + */ |
|
171 | + public function get_week_date_range() { |
|
172 | + |
|
173 | + // Set the previous date range. |
|
174 | + $this->previous_range = array( |
|
175 | + 'period' => 'last_week', |
|
176 | + ); |
|
177 | + |
|
178 | + // Generate the report. |
|
179 | + return array( |
|
180 | + 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
181 | + 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
182 | + ); |
|
183 | + |
|
184 | + } |
|
185 | + |
|
186 | + /** |
|
187 | + * Retrieves last week's date range. |
|
188 | + * |
|
189 | + * @return array The appropriate date range. |
|
190 | + */ |
|
191 | + public function get_last_week_date_range() { |
|
192 | + |
|
193 | + // Set the previous date range. |
|
194 | + $this->previous_range = array( |
|
195 | + 'period' => 'custom', |
|
196 | + 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
197 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
198 | + ); |
|
199 | + |
|
200 | + // Generate the report. |
|
201 | + return array( |
|
202 | + 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
203 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
204 | + ); |
|
205 | + |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * Retrieves last 7 days date range. |
|
210 | + * |
|
211 | + * @return array The appropriate date range. |
|
212 | + */ |
|
213 | + public function get_7_days_date_range() { |
|
214 | + |
|
215 | + // Set the previous date range. |
|
216 | + $this->previous_range = array( |
|
217 | + 'period' => 'custom', |
|
218 | + 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
219 | + 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
220 | + ); |
|
221 | + |
|
222 | + // Generate the report. |
|
223 | + return array( |
|
224 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
225 | + 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
226 | + ); |
|
227 | + |
|
228 | + } |
|
229 | + |
|
230 | + /** |
|
231 | + * Retrieves last 30 days date range. |
|
232 | + * |
|
233 | + * @return array The appropriate date range. |
|
234 | + */ |
|
235 | + public function get_30_days_date_range() { |
|
236 | + |
|
237 | + // Set the previous date range. |
|
238 | + $this->previous_range = array( |
|
239 | + 'period' => 'custom', |
|
240 | + 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
241 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
242 | + ); |
|
243 | + |
|
244 | + // Generate the report. |
|
245 | + return array( |
|
246 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
247 | + 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
248 | + ); |
|
249 | + |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * Retrieves last 90 days date range. |
|
254 | + * |
|
255 | + * @return array The appropriate date range. |
|
256 | + */ |
|
257 | + public function get_90_days_date_range() { |
|
258 | + |
|
259 | + $this->groupby = 'month'; |
|
260 | + |
|
261 | + // Set the previous date range. |
|
262 | + $this->previous_range = array( |
|
263 | + 'period' => 'custom', |
|
264 | + 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
265 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
266 | + ); |
|
267 | + |
|
268 | + // Generate the report. |
|
269 | + return array( |
|
270 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
271 | + 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
272 | + ); |
|
273 | + |
|
274 | + } |
|
275 | + |
|
276 | + /** |
|
277 | + * Retrieves last 180 days date range. |
|
278 | + * |
|
279 | + * @return array The appropriate date range. |
|
280 | + */ |
|
281 | + public function get_180_days_date_range() { |
|
282 | + |
|
283 | + $this->groupby = 'month'; |
|
284 | + |
|
285 | + // Set the previous date range. |
|
286 | + $this->previous_range = array( |
|
287 | + 'period' => 'custom', |
|
288 | + 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
289 | + 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
290 | + ); |
|
291 | + |
|
292 | + // Generate the report. |
|
293 | + return array( |
|
294 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
295 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
296 | + ); |
|
297 | + |
|
298 | + } |
|
299 | + |
|
300 | + /** |
|
301 | + * Retrieves last 60 days date range. |
|
302 | + * |
|
303 | + * @return array The appropriate date range. |
|
304 | + */ |
|
305 | + public function get_60_days_date_range() { |
|
306 | + |
|
307 | + // Set the previous date range. |
|
308 | + $this->previous_range = array( |
|
309 | + 'period' => 'custom', |
|
310 | + 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
311 | + 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
312 | + ); |
|
313 | + |
|
314 | + // Generate the report. |
|
315 | + return array( |
|
316 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
317 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
318 | + ); |
|
319 | + |
|
320 | + } |
|
321 | + |
|
322 | + /** |
|
323 | + * Retrieves this month date range. |
|
324 | + * |
|
325 | + * @return array The appropriate date range. |
|
326 | + */ |
|
327 | + public function get_month_date_range() { |
|
328 | + |
|
329 | + // Set the previous date range. |
|
330 | + $this->previous_range = array( |
|
331 | + 'period' => 'last_month', |
|
332 | + ); |
|
333 | + |
|
334 | + // Generate the report. |
|
335 | + return array( |
|
336 | + 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
337 | + 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
338 | + ); |
|
339 | + |
|
340 | + } |
|
341 | + |
|
342 | + /** |
|
343 | + * Retrieves last month's date range. |
|
344 | + * |
|
345 | + * @return array The appropriate date range. |
|
346 | + */ |
|
347 | + public function get_last_month_date_range() { |
|
348 | + |
|
349 | + // Set the previous date range. |
|
350 | + $this->previous_range = array( |
|
351 | + 'period' => 'custom', |
|
352 | + 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
353 | + 'after' => date( 'Y-m-t', strtotime( '-3 months', current_time( 'timestamp' ) ) ), |
|
354 | + ); |
|
355 | + |
|
356 | + // Generate the report. |
|
357 | + return array( |
|
358 | + 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
359 | + 'after' => date( 'Y-m-t', strtotime( '-2 months', current_time( 'timestamp' ) ) ), |
|
360 | + ); |
|
361 | + |
|
362 | + } |
|
363 | + |
|
364 | + /** |
|
365 | + * Retrieves this quarter date range. |
|
366 | + * |
|
367 | + * @return array The available quarters. |
|
368 | + */ |
|
369 | + public function get_quarters() { |
|
370 | + |
|
371 | + $last_year = (int) date( 'Y' ) - 1; |
|
372 | + $next_year = (int) date( 'Y' ) + 1; |
|
373 | + $year = (int) date( 'Y' ); |
|
374 | + return array( |
|
375 | + |
|
376 | + array( |
|
377 | + 'after' => "$last_year-06-30", |
|
378 | + 'before' => "$last_year-10-01", |
|
379 | + ), |
|
380 | + |
|
381 | + array( |
|
382 | + 'before' => "$year-01-01", |
|
383 | + 'after' => "$last_year-09-30", |
|
384 | + ), |
|
385 | + |
|
386 | + array( |
|
387 | + 'before' => "$year-04-01", |
|
388 | + 'after' => "$last_year-12-31", |
|
389 | + ), |
|
390 | + |
|
391 | + array( |
|
392 | + 'before' => "$year-07-01", |
|
393 | + 'after' => "$year-03-31", |
|
394 | + ), |
|
395 | + |
|
396 | + array( |
|
397 | + 'after' => "$year-06-30", |
|
398 | + 'before' => "$year-10-01", |
|
399 | + ), |
|
400 | + |
|
401 | + array( |
|
402 | + 'before' => "$next_year-01-01", |
|
403 | + 'after' => "$year-09-30", |
|
404 | + ), |
|
405 | + |
|
406 | + ); |
|
407 | + |
|
408 | + } |
|
409 | + |
|
410 | + /** |
|
411 | + * Retrieves the current quater. |
|
412 | + * |
|
413 | + * @return int The current quarter. |
|
414 | + */ |
|
415 | + public function get_quarter() { |
|
416 | + |
|
417 | + $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
418 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
419 | + return $quarters[ $month - 1 ]; |
|
420 | + |
|
421 | + } |
|
422 | + |
|
423 | + /** |
|
424 | + * Retrieves this quarter date range. |
|
425 | + * |
|
426 | + * @return array The appropriate date range. |
|
427 | + */ |
|
428 | + public function get_quarter_date_range() { |
|
429 | + |
|
430 | + // Set the previous date range. |
|
431 | + $this->previous_range = array( |
|
432 | + 'period' => 'last_quarter', |
|
433 | + ); |
|
434 | + |
|
435 | + // Generate the report. |
|
436 | + $quarters = $this->get_quarters(); |
|
437 | + return $quarters[ $this->get_quarter() + 1 ]; |
|
438 | + |
|
439 | + } |
|
440 | + |
|
441 | + /** |
|
442 | + * Retrieves last quarter's date range. |
|
443 | + * |
|
444 | + * @return array The appropriate date range. |
|
445 | + */ |
|
446 | + public function get_last_quarter_date_range() { |
|
447 | + |
|
448 | + $quarters = $this->get_quarters(); |
|
449 | + $quarter = $this->get_quarter(); |
|
450 | + |
|
451 | + // Set the previous date range. |
|
452 | + $this->previous_range = array_merge( |
|
453 | + $quarters[ $quarter - 1 ], |
|
454 | + array( 'period' => 'custom' ) |
|
455 | + ); |
|
456 | + |
|
457 | + // Generate the report. |
|
458 | + return $quarters[ $quarter ]; |
|
459 | + |
|
460 | + } |
|
461 | + |
|
462 | + /** |
|
463 | + * Retrieves this year date range. |
|
464 | + * |
|
465 | + * @return array The appropriate date range. |
|
466 | + */ |
|
467 | + public function get_year_date_range() { |
|
468 | + |
|
469 | + $this->groupby = 'month'; |
|
470 | + |
|
471 | + // Set the previous date range. |
|
472 | + $this->previous_range = array( |
|
473 | + 'period' => 'last_year', |
|
474 | + ); |
|
475 | + |
|
476 | + // Generate the report. |
|
477 | + return array( |
|
478 | + 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
479 | + 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
480 | + ); |
|
481 | + |
|
482 | + } |
|
483 | + |
|
484 | + /** |
|
485 | + * Retrieves last year date range. |
|
486 | + * |
|
487 | + * @return array The appropriate date range. |
|
488 | + */ |
|
489 | + public function get_last_year_date_range() { |
|
490 | + |
|
491 | + $this->groupby = 'month'; |
|
492 | + |
|
493 | + // Set the previous date range. |
|
494 | + $year = (int) date( 'Y' ) - 3; |
|
495 | + $this->previous_range = array( |
|
496 | + 'period' => 'custom', |
|
497 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
498 | + 'after' => "$year-12-31", |
|
499 | + ); |
|
500 | + |
|
501 | + // Generate the report. |
|
502 | + $year = (int) date( 'Y' ) - 2; |
|
503 | + return array( |
|
504 | + 'after' => "$year-12-31", |
|
505 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
506 | + ); |
|
507 | + |
|
508 | + } |
|
509 | + |
|
510 | + /** |
|
511 | + * Prepare a the request date for SQL usage. |
|
512 | + * |
|
513 | + * @param WP_REST_Request $request Request object. |
|
514 | + * @param string $date_field The date field. |
|
515 | + * @return string The appropriate SQL. |
|
516 | + */ |
|
517 | + public function get_date_range_sql( $request, $date_field ) { |
|
518 | + global $wpdb; |
|
519 | + |
|
520 | + $sql = '1=1'; |
|
521 | + $range = $this->get_date_range( $request ); |
|
522 | + |
|
523 | + if ( ! empty( $range['after'] ) ) { |
|
524 | + $sql .= ' AND ' . $wpdb->prepare( |
|
525 | + "$date_field > %s", |
|
526 | + $range['after'] |
|
527 | + ); |
|
528 | + } |
|
529 | + |
|
530 | + if ( ! empty( $range['before'] ) ) { |
|
531 | + $sql .= ' AND ' . $wpdb->prepare( |
|
532 | + "$date_field < %s", |
|
533 | + $range['before'] |
|
534 | + ); |
|
535 | + } |
|
536 | + |
|
537 | + return $sql; |
|
538 | + |
|
539 | + } |
|
540 | + |
|
541 | + /** |
|
542 | + * Prepares a group by query. |
|
543 | + * |
|
544 | + * @param string $date_field The date field. |
|
545 | + * @return string The appropriate SQL. |
|
546 | + */ |
|
547 | + public function get_group_by_sql( $date_field ) { |
|
548 | + |
|
549 | + if ( 'day' === $this->groupby ) { |
|
550 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
551 | + } |
|
552 | + |
|
553 | + return "YEAR($date_field), MONTH($date_field)"; |
|
554 | + } |
|
555 | + |
|
556 | + /** |
|
557 | + * Get the query params for collections. |
|
558 | + * |
|
559 | + * @return array |
|
560 | + */ |
|
561 | + public function get_collection_params() { |
|
562 | + return array( |
|
563 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
564 | + 'period' => array( |
|
565 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
566 | + 'type' => 'string', |
|
567 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
568 | + 'validate_callback' => 'rest_validate_request_arg', |
|
569 | + 'sanitize_callback' => 'sanitize_text_field', |
|
570 | + 'default' => '7_days', |
|
571 | + ), |
|
572 | + 'after' => array( |
|
573 | + /* translators: %s: date format */ |
|
574 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
575 | + 'type' => 'string', |
|
576 | + 'format' => 'date', |
|
577 | + 'validate_callback' => 'rest_validate_request_arg', |
|
578 | + 'sanitize_callback' => 'sanitize_text_field', |
|
579 | + 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
580 | + ), |
|
581 | + 'before' => array( |
|
582 | + /* translators: %s: date format */ |
|
583 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
584 | + 'type' => 'string', |
|
585 | + 'format' => 'date', |
|
586 | + 'validate_callback' => 'rest_validate_request_arg', |
|
587 | + 'sanitize_callback' => 'sanitize_text_field', |
|
588 | + 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
589 | + ), |
|
590 | + ); |
|
591 | + } |
|
592 | 592 | } |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * @since 2.0.0 |
8 | 8 | */ |
9 | 9 | |
10 | -defined( 'ABSPATH' ) || exit; |
|
10 | +defined('ABSPATH') || exit; |
|
11 | 11 | |
12 | 12 | /** |
13 | 13 | * GetPaid REST date based controller class. |
@@ -43,15 +43,15 @@ discard block |
||
43 | 43 | * @param WP_REST_Request $request Request object. |
44 | 44 | * @return array The appropriate date range. |
45 | 45 | */ |
46 | - public function get_date_range( $request ) { |
|
46 | + public function get_date_range($request) { |
|
47 | 47 | |
48 | 48 | // If not supported, assume all time. |
49 | - if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
49 | + if (!in_array($request['period'], array('custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year'))) { |
|
50 | 50 | $request['period'] = '7_days'; |
51 | 51 | } |
52 | 52 | |
53 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
54 | - $this->prepare_interval( $date_range ); |
|
53 | + $date_range = call_user_func(array($this, 'get_' . $request['period'] . '_date_range'), $request); |
|
54 | + $this->prepare_interval($date_range); |
|
55 | 55 | |
56 | 56 | return $date_range; |
57 | 57 | |
@@ -63,25 +63,25 @@ discard block |
||
63 | 63 | * @param array $range Date range. |
64 | 64 | * @return array The appropriate date range. |
65 | 65 | */ |
66 | - public function prepare_interval( $range ) { |
|
66 | + public function prepare_interval($range) { |
|
67 | 67 | |
68 | - $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
69 | - $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
70 | - if ( 'day' === $this->groupby ) { |
|
71 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
72 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
68 | + $before = strtotime($range['before']) - DAY_IN_SECONDS; |
|
69 | + $after = strtotime($range['after']) + DAY_IN_SECONDS; |
|
70 | + if ('day' === $this->groupby) { |
|
71 | + $difference = max(DAY_IN_SECONDS, (DAY_IN_SECONDS + $before - $after)); // Prevent division by 0; |
|
72 | + $this->interval = absint(ceil(max(1, $difference / DAY_IN_SECONDS))); |
|
73 | 73 | return; |
74 | 74 | } |
75 | 75 | |
76 | 76 | $this->interval = 0; |
77 | - $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
77 | + $min_date = strtotime(date('Y-m-01', $after)); |
|
78 | 78 | |
79 | - while ( $min_date <= $before ) { |
|
80 | - $this->interval ++; |
|
81 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
79 | + while ($min_date <= $before) { |
|
80 | + $this->interval++; |
|
81 | + $min_date = strtotime('+1 MONTH', $min_date); |
|
82 | 82 | } |
83 | 83 | |
84 | - $this->interval = max( 1, $this->interval ); |
|
84 | + $this->interval = max(1, $this->interval); |
|
85 | 85 | |
86 | 86 | } |
87 | 87 | |
@@ -91,17 +91,17 @@ discard block |
||
91 | 91 | * @param WP_REST_Request $request Request object. |
92 | 92 | * @return array The appropriate date range. |
93 | 93 | */ |
94 | - public function get_custom_date_range( $request ) { |
|
94 | + public function get_custom_date_range($request) { |
|
95 | 95 | |
96 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
97 | - $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
96 | + $after = max(strtotime('-20 years'), strtotime(sanitize_text_field($request['after']))); |
|
97 | + $before = strtotime('+1 day', current_time('timestamp')); |
|
98 | 98 | |
99 | - if ( ! empty( $request['before'] ) ) { |
|
100 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
99 | + if (!empty($request['before'])) { |
|
100 | + $before = min($before, strtotime(sanitize_text_field($request['before']))); |
|
101 | 101 | } |
102 | 102 | |
103 | 103 | // 3 months max for day view |
104 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
104 | + if (floor(($before - $after) / MONTH_IN_SECONDS) > 3) { |
|
105 | 105 | $this->groupby = 'month'; |
106 | 106 | } |
107 | 107 | |
@@ -109,14 +109,14 @@ discard block |
||
109 | 109 | $difference = $before - $after; |
110 | 110 | $this->previous_range = array( |
111 | 111 | 'period' => 'custom', |
112 | - 'before' => date( 'Y-m-d', $before - $difference ), |
|
113 | - 'after' => date( 'Y-m-d', $after - $difference ), |
|
112 | + 'before' => date('Y-m-d', $before - $difference), |
|
113 | + 'after' => date('Y-m-d', $after - $difference), |
|
114 | 114 | ); |
115 | 115 | |
116 | 116 | // Generate the report. |
117 | 117 | return array( |
118 | - 'before' => date( 'Y-m-d', $before ), |
|
119 | - 'after' => date( 'Y-m-d', $after ), |
|
118 | + 'before' => date('Y-m-d', $before), |
|
119 | + 'after' => date('Y-m-d', $after), |
|
120 | 120 | ); |
121 | 121 | |
122 | 122 | } |
@@ -135,8 +135,8 @@ discard block |
||
135 | 135 | |
136 | 136 | // Generate the report. |
137 | 137 | return array( |
138 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
139 | - 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
138 | + 'before' => date('Y-m-d', strtotime('+1 day', current_time('timestamp'))), |
|
139 | + 'after' => date('Y-m-d', strtotime('-1 day', current_time('timestamp'))), |
|
140 | 140 | ); |
141 | 141 | |
142 | 142 | } |
@@ -151,14 +151,14 @@ discard block |
||
151 | 151 | // Set the previous date range. |
152 | 152 | $this->previous_range = array( |
153 | 153 | 'period' => 'custom', |
154 | - 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
155 | - 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
154 | + 'before' => date('Y-m-d', strtotime('-1 day', current_time('timestamp'))), |
|
155 | + 'after' => date('Y-m-d', strtotime('-3 days', current_time('timestamp'))), |
|
156 | 156 | ); |
157 | 157 | |
158 | 158 | // Generate the report. |
159 | 159 | return array( |
160 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
161 | - 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
160 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
161 | + 'after' => date('Y-m-d', strtotime('-2 days', current_time('timestamp'))), |
|
162 | 162 | ); |
163 | 163 | |
164 | 164 | } |
@@ -177,8 +177,8 @@ discard block |
||
177 | 177 | |
178 | 178 | // Generate the report. |
179 | 179 | return array( |
180 | - 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
180 | + 'before' => date('Y-m-d', strtotime('sunday last week', current_time('timestamp')) + 8 * DAY_IN_SECONDS), |
|
181 | + 'after' => date('Y-m-d', strtotime('sunday last week', current_time('timestamp'))), |
|
182 | 182 | ); |
183 | 183 | |
184 | 184 | } |
@@ -193,14 +193,14 @@ discard block |
||
193 | 193 | // Set the previous date range. |
194 | 194 | $this->previous_range = array( |
195 | 195 | 'period' => 'custom', |
196 | - 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
197 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
196 | + 'before' => date('Y-m-d', strtotime('monday last week', current_time('timestamp'))), |
|
197 | + 'after' => date('Y-m-d', strtotime('monday last week', current_time('timestamp')) - 8 * DAY_IN_SECONDS), |
|
198 | 198 | ); |
199 | 199 | |
200 | 200 | // Generate the report. |
201 | 201 | return array( |
202 | - 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
203 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
202 | + 'before' => date('Y-m-d', strtotime('monday this week', current_time('timestamp'))), |
|
203 | + 'after' => date('Y-m-d', strtotime('monday last week', current_time('timestamp')) - DAY_IN_SECONDS), |
|
204 | 204 | ); |
205 | 205 | |
206 | 206 | } |
@@ -215,14 +215,14 @@ discard block |
||
215 | 215 | // Set the previous date range. |
216 | 216 | $this->previous_range = array( |
217 | 217 | 'period' => 'custom', |
218 | - 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
219 | - 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
218 | + 'before' => date('Y-m-d', strtotime('-7 days', current_time('timestamp'))), |
|
219 | + 'after' => date('Y-m-d', strtotime('-15 days', current_time('timestamp'))), |
|
220 | 220 | ); |
221 | 221 | |
222 | 222 | // Generate the report. |
223 | 223 | return array( |
224 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
225 | - 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
224 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
225 | + 'after' => date('Y-m-d', strtotime('-8 days', current_time('timestamp'))), |
|
226 | 226 | ); |
227 | 227 | |
228 | 228 | } |
@@ -237,14 +237,14 @@ discard block |
||
237 | 237 | // Set the previous date range. |
238 | 238 | $this->previous_range = array( |
239 | 239 | 'period' => 'custom', |
240 | - 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
241 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
240 | + 'before' => date('Y-m-d', strtotime('-30 days', current_time('timestamp'))), |
|
241 | + 'after' => date('Y-m-d', strtotime('-61 days', current_time('timestamp'))), |
|
242 | 242 | ); |
243 | 243 | |
244 | 244 | // Generate the report. |
245 | 245 | return array( |
246 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
247 | - 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
246 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
247 | + 'after' => date('Y-m-d', strtotime('-31 days', current_time('timestamp'))), |
|
248 | 248 | ); |
249 | 249 | |
250 | 250 | } |
@@ -261,14 +261,14 @@ discard block |
||
261 | 261 | // Set the previous date range. |
262 | 262 | $this->previous_range = array( |
263 | 263 | 'period' => 'custom', |
264 | - 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
265 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
264 | + 'before' => date('Y-m-d', strtotime('-90 days', current_time('timestamp'))), |
|
265 | + 'after' => date('Y-m-d', strtotime('-181 days', current_time('timestamp'))), |
|
266 | 266 | ); |
267 | 267 | |
268 | 268 | // Generate the report. |
269 | 269 | return array( |
270 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
271 | - 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
270 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
271 | + 'after' => date('Y-m-d', strtotime('-91 days', current_time('timestamp'))), |
|
272 | 272 | ); |
273 | 273 | |
274 | 274 | } |
@@ -285,14 +285,14 @@ discard block |
||
285 | 285 | // Set the previous date range. |
286 | 286 | $this->previous_range = array( |
287 | 287 | 'period' => 'custom', |
288 | - 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
289 | - 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
288 | + 'before' => date('Y-m-d', strtotime('-180 days', current_time('timestamp'))), |
|
289 | + 'after' => date('Y-m-d', strtotime('-361 days', current_time('timestamp'))), |
|
290 | 290 | ); |
291 | 291 | |
292 | 292 | // Generate the report. |
293 | 293 | return array( |
294 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
295 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
294 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
295 | + 'after' => date('Y-m-d', strtotime('-181 days', current_time('timestamp'))), |
|
296 | 296 | ); |
297 | 297 | |
298 | 298 | } |
@@ -307,14 +307,14 @@ discard block |
||
307 | 307 | // Set the previous date range. |
308 | 308 | $this->previous_range = array( |
309 | 309 | 'period' => 'custom', |
310 | - 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
311 | - 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
310 | + 'before' => date('Y-m-d', strtotime('-60 days', current_time('timestamp'))), |
|
311 | + 'after' => date('Y-m-d', strtotime('-121 days', current_time('timestamp'))), |
|
312 | 312 | ); |
313 | 313 | |
314 | 314 | // Generate the report. |
315 | 315 | return array( |
316 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
317 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
316 | + 'before' => date('Y-m-d', current_time('timestamp')), |
|
317 | + 'after' => date('Y-m-d', strtotime('-61 days', current_time('timestamp'))), |
|
318 | 318 | ); |
319 | 319 | |
320 | 320 | } |
@@ -333,8 +333,8 @@ discard block |
||
333 | 333 | |
334 | 334 | // Generate the report. |
335 | 335 | return array( |
336 | - 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
336 | + 'before' => date('Y-m-01', strtotime('next month', current_time('timestamp'))), |
|
337 | + 'after' => date('Y-m-t', strtotime('last month', current_time('timestamp'))), |
|
338 | 338 | ); |
339 | 339 | |
340 | 340 | } |
@@ -349,14 +349,14 @@ discard block |
||
349 | 349 | // Set the previous date range. |
350 | 350 | $this->previous_range = array( |
351 | 351 | 'period' => 'custom', |
352 | - 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
353 | - 'after' => date( 'Y-m-t', strtotime( '-3 months', current_time( 'timestamp' ) ) ), |
|
352 | + 'before' => date('Y-m-1', strtotime('last month', current_time('timestamp'))), |
|
353 | + 'after' => date('Y-m-t', strtotime('-3 months', current_time('timestamp'))), |
|
354 | 354 | ); |
355 | 355 | |
356 | 356 | // Generate the report. |
357 | 357 | return array( |
358 | - 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
359 | - 'after' => date( 'Y-m-t', strtotime( '-2 months', current_time( 'timestamp' ) ) ), |
|
358 | + 'before' => date('Y-m-1', current_time('timestamp')), |
|
359 | + 'after' => date('Y-m-t', strtotime('-2 months', current_time('timestamp'))), |
|
360 | 360 | ); |
361 | 361 | |
362 | 362 | } |
@@ -368,9 +368,9 @@ discard block |
||
368 | 368 | */ |
369 | 369 | public function get_quarters() { |
370 | 370 | |
371 | - $last_year = (int) date( 'Y' ) - 1; |
|
372 | - $next_year = (int) date( 'Y' ) + 1; |
|
373 | - $year = (int) date( 'Y' ); |
|
371 | + $last_year = (int) date('Y') - 1; |
|
372 | + $next_year = (int) date('Y') + 1; |
|
373 | + $year = (int) date('Y'); |
|
374 | 374 | return array( |
375 | 375 | |
376 | 376 | array( |
@@ -414,9 +414,9 @@ discard block |
||
414 | 414 | */ |
415 | 415 | public function get_quarter() { |
416 | 416 | |
417 | - $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
418 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
419 | - return $quarters[ $month - 1 ]; |
|
417 | + $month = (int) date('n', current_time('timestamp')); |
|
418 | + $quarters = array(1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4); |
|
419 | + return $quarters[$month - 1]; |
|
420 | 420 | |
421 | 421 | } |
422 | 422 | |
@@ -434,7 +434,7 @@ discard block |
||
434 | 434 | |
435 | 435 | // Generate the report. |
436 | 436 | $quarters = $this->get_quarters(); |
437 | - return $quarters[ $this->get_quarter() + 1 ]; |
|
437 | + return $quarters[$this->get_quarter() + 1]; |
|
438 | 438 | |
439 | 439 | } |
440 | 440 | |
@@ -450,12 +450,12 @@ discard block |
||
450 | 450 | |
451 | 451 | // Set the previous date range. |
452 | 452 | $this->previous_range = array_merge( |
453 | - $quarters[ $quarter - 1 ], |
|
454 | - array( 'period' => 'custom' ) |
|
453 | + $quarters[$quarter - 1], |
|
454 | + array('period' => 'custom') |
|
455 | 455 | ); |
456 | 456 | |
457 | 457 | // Generate the report. |
458 | - return $quarters[ $quarter ]; |
|
458 | + return $quarters[$quarter]; |
|
459 | 459 | |
460 | 460 | } |
461 | 461 | |
@@ -475,8 +475,8 @@ discard block |
||
475 | 475 | |
476 | 476 | // Generate the report. |
477 | 477 | return array( |
478 | - 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
479 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
478 | + 'before' => date('Y-m-d', strtotime('next year January 1st', current_time('timestamp'))), |
|
479 | + 'after' => date('Y-m-d', strtotime('last year December 31st', current_time('timestamp'))), |
|
480 | 480 | ); |
481 | 481 | |
482 | 482 | } |
@@ -491,18 +491,18 @@ discard block |
||
491 | 491 | $this->groupby = 'month'; |
492 | 492 | |
493 | 493 | // Set the previous date range. |
494 | - $year = (int) date( 'Y' ) - 3; |
|
494 | + $year = (int) date('Y') - 3; |
|
495 | 495 | $this->previous_range = array( |
496 | 496 | 'period' => 'custom', |
497 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
497 | + 'before' => date('Y-m-d', strtotime('first day of january last year', current_time('timestamp'))), |
|
498 | 498 | 'after' => "$year-12-31", |
499 | 499 | ); |
500 | 500 | |
501 | 501 | // Generate the report. |
502 | - $year = (int) date( 'Y' ) - 2; |
|
502 | + $year = (int) date('Y') - 2; |
|
503 | 503 | return array( |
504 | 504 | 'after' => "$year-12-31", |
505 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
505 | + 'before' => date('Y-m-d', strtotime('first day of january this year', current_time('timestamp'))), |
|
506 | 506 | ); |
507 | 507 | |
508 | 508 | } |
@@ -514,20 +514,20 @@ discard block |
||
514 | 514 | * @param string $date_field The date field. |
515 | 515 | * @return string The appropriate SQL. |
516 | 516 | */ |
517 | - public function get_date_range_sql( $request, $date_field ) { |
|
517 | + public function get_date_range_sql($request, $date_field) { |
|
518 | 518 | global $wpdb; |
519 | 519 | |
520 | 520 | $sql = '1=1'; |
521 | - $range = $this->get_date_range( $request ); |
|
521 | + $range = $this->get_date_range($request); |
|
522 | 522 | |
523 | - if ( ! empty( $range['after'] ) ) { |
|
523 | + if (!empty($range['after'])) { |
|
524 | 524 | $sql .= ' AND ' . $wpdb->prepare( |
525 | 525 | "$date_field > %s", |
526 | 526 | $range['after'] |
527 | 527 | ); |
528 | 528 | } |
529 | 529 | |
530 | - if ( ! empty( $range['before'] ) ) { |
|
530 | + if (!empty($range['before'])) { |
|
531 | 531 | $sql .= ' AND ' . $wpdb->prepare( |
532 | 532 | "$date_field < %s", |
533 | 533 | $range['before'] |
@@ -544,9 +544,9 @@ discard block |
||
544 | 544 | * @param string $date_field The date field. |
545 | 545 | * @return string The appropriate SQL. |
546 | 546 | */ |
547 | - public function get_group_by_sql( $date_field ) { |
|
547 | + public function get_group_by_sql($date_field) { |
|
548 | 548 | |
549 | - if ( 'day' === $this->groupby ) { |
|
549 | + if ('day' === $this->groupby) { |
|
550 | 550 | return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
551 | 551 | } |
552 | 552 | |
@@ -560,32 +560,32 @@ discard block |
||
560 | 560 | */ |
561 | 561 | public function get_collection_params() { |
562 | 562 | return array( |
563 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
563 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
564 | 564 | 'period' => array( |
565 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
565 | + 'description' => __('Limit to results of a specific period.', 'invoicing'), |
|
566 | 566 | 'type' => 'string', |
567 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
567 | + 'enum' => array('custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter'), |
|
568 | 568 | 'validate_callback' => 'rest_validate_request_arg', |
569 | 569 | 'sanitize_callback' => 'sanitize_text_field', |
570 | 570 | 'default' => '7_days', |
571 | 571 | ), |
572 | 572 | 'after' => array( |
573 | 573 | /* translators: %s: date format */ |
574 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
574 | + 'description' => sprintf(__('Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
575 | 575 | 'type' => 'string', |
576 | 576 | 'format' => 'date', |
577 | 577 | 'validate_callback' => 'rest_validate_request_arg', |
578 | 578 | 'sanitize_callback' => 'sanitize_text_field', |
579 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
579 | + 'default' => date('Y-m-d', strtotime('-8 days', current_time('timestamp'))), |
|
580 | 580 | ), |
581 | 581 | 'before' => array( |
582 | 582 | /* translators: %s: date format */ |
583 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
583 | + 'description' => sprintf(__('Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
584 | 584 | 'type' => 'string', |
585 | 585 | 'format' => 'date', |
586 | 586 | 'validate_callback' => 'rest_validate_request_arg', |
587 | 587 | 'sanitize_callback' => 'sanitize_text_field', |
588 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
588 | + 'default' => date('Y-m-d', current_time('timestamp')), |
|
589 | 589 | ), |
590 | 590 | ); |
591 | 591 | } |