@@ -14,71 +14,71 @@ discard block |
||
14 | 14 | class GetPaid_Admin { |
15 | 15 | |
16 | 16 | /** |
17 | - * Local path to this plugins admin directory |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - public $admin_path; |
|
22 | - |
|
23 | - /** |
|
24 | - * Web path to this plugins admin directory |
|
25 | - * |
|
26 | - * @var string |
|
27 | - */ |
|
28 | - public $admin_url; |
|
17 | + * Local path to this plugins admin directory |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + public $admin_path; |
|
22 | + |
|
23 | + /** |
|
24 | + * Web path to this plugins admin directory |
|
25 | + * |
|
26 | + * @var string |
|
27 | + */ |
|
28 | + public $admin_url; |
|
29 | 29 | |
30 | - /** |
|
31 | - * Reports components. |
|
32 | - * |
|
33 | - * @var GetPaid_Reports |
|
34 | - */ |
|
30 | + /** |
|
31 | + * Reports components. |
|
32 | + * |
|
33 | + * @var GetPaid_Reports |
|
34 | + */ |
|
35 | 35 | public $reports; |
36 | 36 | |
37 | 37 | /** |
38 | - * Class constructor. |
|
39 | - */ |
|
40 | - public function __construct(){ |
|
38 | + * Class constructor. |
|
39 | + */ |
|
40 | + public function __construct(){ |
|
41 | 41 | |
42 | 42 | $this->admin_path = plugin_dir_path( __FILE__ ); |
43 | - $this->admin_url = plugins_url( '/', __FILE__ ); |
|
44 | - $this->reports = new GetPaid_Reports(); |
|
43 | + $this->admin_url = plugins_url( '/', __FILE__ ); |
|
44 | + $this->reports = new GetPaid_Reports(); |
|
45 | 45 | |
46 | 46 | if ( is_admin() ) { |
47 | - $this->init_admin_hooks(); |
|
47 | + $this->init_admin_hooks(); |
|
48 | 48 | } |
49 | 49 | |
50 | 50 | } |
51 | 51 | |
52 | 52 | /** |
53 | - * Init action and filter hooks |
|
54 | - * |
|
55 | - */ |
|
56 | - private function init_admin_hooks() { |
|
53 | + * Init action and filter hooks |
|
54 | + * |
|
55 | + */ |
|
56 | + private function init_admin_hooks() { |
|
57 | 57 | add_action( 'admin_enqueue_scripts', array( $this, 'enqeue_scripts' ) ); |
58 | 58 | add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) ); |
59 | 59 | add_action( 'admin_init', array( $this, 'init_ayecode_connect_helper' ) ); |
60 | 60 | add_action( 'admin_init', array( $this, 'activation_redirect') ); |
61 | 61 | add_action( 'admin_init', array( $this, 'maybe_do_admin_action') ); |
62 | - add_action( 'admin_notices', array( $this, 'show_notices' ) ); |
|
63 | - add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
64 | - add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
62 | + add_action( 'admin_notices', array( $this, 'show_notices' ) ); |
|
63 | + add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
64 | + add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
65 | 65 | add_action( 'getpaid_authenticated_admin_action_reset_tax_rates', array( $this, 'admin_reset_tax_rates' ) ); |
66 | - do_action( 'getpaid_init_admin_hooks', $this ); |
|
66 | + do_action( 'getpaid_init_admin_hooks', $this ); |
|
67 | 67 | |
68 | 68 | } |
69 | 69 | |
70 | 70 | /** |
71 | - * Register admin scripts |
|
72 | - * |
|
73 | - */ |
|
74 | - public function enqeue_scripts() { |
|
71 | + * Register admin scripts |
|
72 | + * |
|
73 | + */ |
|
74 | + public function enqeue_scripts() { |
|
75 | 75 | global $current_screen, $pagenow; |
76 | 76 | |
77 | - $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
78 | - $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
77 | + $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
78 | + $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
79 | 79 | |
80 | 80 | if ( ! empty( $current_screen->post_type ) ) { |
81 | - $page = $current_screen->post_type; |
|
81 | + $page = $current_screen->post_type; |
|
82 | 82 | } |
83 | 83 | |
84 | 84 | // General styles. |
@@ -101,38 +101,38 @@ discard block |
||
101 | 101 | } |
102 | 102 | |
103 | 103 | // Payment form scripts. |
104 | - if ( 'wpi_payment_form' == $page && $editing ) { |
|
104 | + if ( 'wpi_payment_form' == $page && $editing ) { |
|
105 | 105 | $this->load_payment_form_scripts(); |
106 | 106 | } |
107 | 107 | |
108 | - if ( $page == 'wpinv-subscriptions' ) { |
|
109 | - wp_enqueue_script( 'postbox' ); |
|
110 | - } |
|
108 | + if ( $page == 'wpinv-subscriptions' ) { |
|
109 | + wp_enqueue_script( 'postbox' ); |
|
110 | + } |
|
111 | 111 | |
112 | 112 | } |
113 | 113 | |
114 | 114 | /** |
115 | - * Returns admin js translations. |
|
116 | - * |
|
117 | - */ |
|
118 | - protected function get_admin_i18() { |
|
115 | + * Returns admin js translations. |
|
116 | + * |
|
117 | + */ |
|
118 | + protected function get_admin_i18() { |
|
119 | 119 | global $post; |
120 | 120 | |
121 | 121 | $i18n = array( |
122 | 122 | 'ajax_url' => admin_url( 'admin-ajax.php' ), |
123 | 123 | 'post_ID' => isset( $post->ID ) ? $post->ID : '', |
124 | - 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
125 | - 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
126 | - 'rest_root' => esc_url_raw( rest_url() ), |
|
127 | - 'date_range' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days', |
|
124 | + 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
125 | + 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
126 | + 'rest_root' => esc_url_raw( rest_url() ), |
|
127 | + 'date_range' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days', |
|
128 | 128 | 'add_invoice_note_nonce' => wp_create_nonce( 'add-invoice-note' ), |
129 | 129 | 'delete_invoice_note_nonce' => wp_create_nonce( 'delete-invoice-note' ), |
130 | 130 | 'invoice_item_nonce' => wp_create_nonce( 'invoice-item' ), |
131 | 131 | 'billing_details_nonce' => wp_create_nonce( 'get-billing-details' ), |
132 | 132 | 'tax' => wpinv_tax_amount(), |
133 | 133 | 'discount' => 0, |
134 | - 'currency_symbol' => wpinv_currency_symbol(), |
|
135 | - 'currency' => wpinv_get_currency(), |
|
134 | + 'currency_symbol' => wpinv_currency_symbol(), |
|
135 | + 'currency' => wpinv_get_currency(), |
|
136 | 136 | 'currency_pos' => wpinv_currency_position(), |
137 | 137 | 'thousand_sep' => wpinv_thousands_separator(), |
138 | 138 | 'decimal_sep' => wpinv_decimal_separator(), |
@@ -155,50 +155,50 @@ discard block |
||
155 | 155 | 'searching' => __( 'Searching', 'invoicing' ), |
156 | 156 | ); |
157 | 157 | |
158 | - if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
158 | + if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
159 | 159 | |
160 | - $invoice = new WPInv_Invoice( $post ); |
|
161 | - $i18n['save_invoice'] = sprintf( |
|
162 | - __( 'Save %s', 'invoicing' ), |
|
163 | - ucfirst( $invoice->get_type() ) |
|
164 | - ); |
|
160 | + $invoice = new WPInv_Invoice( $post ); |
|
161 | + $i18n['save_invoice'] = sprintf( |
|
162 | + __( 'Save %s', 'invoicing' ), |
|
163 | + ucfirst( $invoice->get_type() ) |
|
164 | + ); |
|
165 | 165 | |
166 | - $i18n['invoice_description'] = sprintf( |
|
167 | - __( '%s Description', 'invoicing' ), |
|
168 | - ucfirst( $invoice->get_type() ) |
|
169 | - ); |
|
166 | + $i18n['invoice_description'] = sprintf( |
|
167 | + __( '%s Description', 'invoicing' ), |
|
168 | + ucfirst( $invoice->get_type() ) |
|
169 | + ); |
|
170 | 170 | |
171 | - } |
|
172 | - return $i18n; |
|
171 | + } |
|
172 | + return $i18n; |
|
173 | 173 | } |
174 | 174 | |
175 | 175 | /** |
176 | - * Loads payment form js. |
|
177 | - * |
|
178 | - */ |
|
179 | - protected function load_payment_form_scripts() { |
|
176 | + * Loads payment form js. |
|
177 | + * |
|
178 | + */ |
|
179 | + protected function load_payment_form_scripts() { |
|
180 | 180 | global $post; |
181 | 181 | |
182 | 182 | wp_enqueue_script( 'vue', WPINV_PLUGIN_URL . 'assets/js/vue/vue.js', array(), WPINV_VERSION ); |
183 | - wp_enqueue_script( 'sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION ); |
|
184 | - wp_enqueue_script( 'vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array( 'sortable', 'vue' ), WPINV_VERSION ); |
|
183 | + wp_enqueue_script( 'sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION ); |
|
184 | + wp_enqueue_script( 'vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array( 'sortable', 'vue' ), WPINV_VERSION ); |
|
185 | 185 | |
186 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js' ); |
|
187 | - wp_register_script( 'wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array( 'wpinv-admin-script', 'vue_draggable' ), $version ); |
|
186 | + $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js' ); |
|
187 | + wp_register_script( 'wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array( 'wpinv-admin-script', 'vue_draggable' ), $version ); |
|
188 | 188 | |
189 | - wp_localize_script( |
|
189 | + wp_localize_script( |
|
190 | 190 | 'wpinv-admin-payment-form-script', |
191 | 191 | 'wpinvPaymentFormAdmin', |
192 | 192 | array( |
193 | - 'elements' => wpinv_get_data( 'payment-form-elements' ), |
|
194 | - 'form_elements' => getpaid_get_payment_form_elements( $post->ID ), |
|
195 | - 'currency' => wpinv_currency_symbol(), |
|
196 | - 'position' => wpinv_currency_position(), |
|
197 | - 'decimals' => (int) wpinv_decimals(), |
|
198 | - 'thousands_sep' => wpinv_thousands_separator(), |
|
199 | - 'decimals_sep' => wpinv_decimal_separator(), |
|
200 | - 'form_items' => gepaid_get_form_items( $post->ID ), |
|
201 | - 'is_default' => $post->ID == wpinv_get_default_payment_form(), |
|
193 | + 'elements' => wpinv_get_data( 'payment-form-elements' ), |
|
194 | + 'form_elements' => getpaid_get_payment_form_elements( $post->ID ), |
|
195 | + 'currency' => wpinv_currency_symbol(), |
|
196 | + 'position' => wpinv_currency_position(), |
|
197 | + 'decimals' => (int) wpinv_decimals(), |
|
198 | + 'thousands_sep' => wpinv_thousands_separator(), |
|
199 | + 'decimals_sep' => wpinv_decimal_separator(), |
|
200 | + 'form_items' => gepaid_get_form_items( $post->ID ), |
|
201 | + 'is_default' => $post->ID == wpinv_get_default_payment_form(), |
|
202 | 202 | ) |
203 | 203 | ); |
204 | 204 | |
@@ -207,20 +207,20 @@ discard block |
||
207 | 207 | } |
208 | 208 | |
209 | 209 | /** |
210 | - * Add our classes to admin pages. |
|
210 | + * Add our classes to admin pages. |
|
211 | 211 | * |
212 | 212 | * @param string $classes |
213 | 213 | * @return string |
214 | - * |
|
215 | - */ |
|
214 | + * |
|
215 | + */ |
|
216 | 216 | public function admin_body_class( $classes ) { |
217 | - global $pagenow, $post, $current_screen; |
|
217 | + global $pagenow, $post, $current_screen; |
|
218 | 218 | |
219 | 219 | |
220 | 220 | $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
221 | 221 | |
222 | 222 | if ( ! empty( $current_screen->post_type ) ) { |
223 | - $page = $current_screen->post_type; |
|
223 | + $page = $current_screen->post_type; |
|
224 | 224 | } |
225 | 225 | |
226 | 226 | if ( false !== stripos( $page, 'wpi' ) ) { |
@@ -229,29 +229,29 @@ discard block |
||
229 | 229 | |
230 | 230 | if ( in_array( $page, wpinv_parse_list( 'wpi_invoice wpi_payment_form wpi_quote' ) ) ) { |
231 | 231 | $classes .= ' wpinv-cpt wpinv'; |
232 | - } |
|
232 | + } |
|
233 | 233 | |
234 | - if ( getpaid_is_invoice_post_type( $page ) ) { |
|
234 | + if ( getpaid_is_invoice_post_type( $page ) ) { |
|
235 | 235 | $classes .= ' getpaid-is-invoice-cpt'; |
236 | 236 | } |
237 | 237 | |
238 | - return $classes; |
|
238 | + return $classes; |
|
239 | 239 | } |
240 | 240 | |
241 | 241 | /** |
242 | - * Maybe show the AyeCode Connect Notice. |
|
243 | - */ |
|
244 | - public function init_ayecode_connect_helper(){ |
|
242 | + * Maybe show the AyeCode Connect Notice. |
|
243 | + */ |
|
244 | + public function init_ayecode_connect_helper(){ |
|
245 | 245 | |
246 | 246 | new AyeCode_Connect_Helper( |
247 | 247 | array( |
248 | - 'connect_title' => __("WP Invoicing - an AyeCode product!","invoicing"), |
|
249 | - 'connect_external' => __( "Please confirm you wish to connect your site?","invoicing" ), |
|
250 | - 'connect' => sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s","invoicing" ),"<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>","</a>" ), |
|
251 | - 'connect_button' => __("Connect Site","invoicing"), |
|
252 | - 'connecting_button' => __("Connecting...","invoicing"), |
|
253 | - 'error_localhost' => __( "This service will only work with a live domain, not a localhost.","invoicing" ), |
|
254 | - 'error' => __( "Something went wrong, please refresh and try again.","invoicing" ), |
|
248 | + 'connect_title' => __("WP Invoicing - an AyeCode product!","invoicing"), |
|
249 | + 'connect_external' => __( "Please confirm you wish to connect your site?","invoicing" ), |
|
250 | + 'connect' => sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s","invoicing" ),"<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>","</a>" ), |
|
251 | + 'connect_button' => __("Connect Site","invoicing"), |
|
252 | + 'connecting_button' => __("Connecting...","invoicing"), |
|
253 | + 'error_localhost' => __( "This service will only work with a live domain, not a localhost.","invoicing" ), |
|
254 | + 'error' => __( "Something went wrong, please refresh and try again.","invoicing" ), |
|
255 | 255 | ), |
256 | 256 | array( 'wpi-addons' ) |
257 | 257 | ); |
@@ -263,21 +263,21 @@ discard block |
||
263 | 263 | */ |
264 | 264 | public function activation_redirect() { |
265 | 265 | |
266 | - // Bail if no activation redirect. |
|
267 | - if ( ! get_transient( '_wpinv_activation_redirect' ) || wp_doing_ajax() ) { |
|
268 | - return; |
|
269 | - } |
|
266 | + // Bail if no activation redirect. |
|
267 | + if ( ! get_transient( '_wpinv_activation_redirect' ) || wp_doing_ajax() ) { |
|
268 | + return; |
|
269 | + } |
|
270 | 270 | |
271 | - // Delete the redirect transient. |
|
272 | - delete_transient( '_wpinv_activation_redirect' ); |
|
271 | + // Delete the redirect transient. |
|
272 | + delete_transient( '_wpinv_activation_redirect' ); |
|
273 | 273 | |
274 | - // Bail if activating from network, or bulk |
|
275 | - if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
276 | - return; |
|
277 | - } |
|
274 | + // Bail if activating from network, or bulk |
|
275 | + if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
276 | + return; |
|
277 | + } |
|
278 | 278 | |
279 | - wp_safe_redirect( admin_url( 'admin.php?page=wpinv-settings&tab=general' ) ); |
|
280 | - exit; |
|
279 | + wp_safe_redirect( admin_url( 'admin.php?page=wpinv-settings&tab=general' ) ); |
|
280 | + exit; |
|
281 | 281 | } |
282 | 282 | |
283 | 283 | /** |
@@ -292,162 +292,162 @@ discard block |
||
292 | 292 | |
293 | 293 | } |
294 | 294 | |
295 | - /** |
|
295 | + /** |
|
296 | 296 | * Sends a payment reminder to a customer. |
297 | - * |
|
298 | - * @param array $args |
|
297 | + * |
|
298 | + * @param array $args |
|
299 | 299 | */ |
300 | 300 | public function send_customer_invoice( $args ) { |
301 | - $sent = getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
301 | + $sent = getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
302 | 302 | |
303 | - if ( $sent ) { |
|
304 | - $this->show_success( __( 'Invoice was successfully sent to the customer', 'invoicing' ) ); |
|
305 | - } else { |
|
306 | - $this->show_error( __( 'Could not sent the invoice to the customer', 'invoicing' ) ); |
|
307 | - } |
|
303 | + if ( $sent ) { |
|
304 | + $this->show_success( __( 'Invoice was successfully sent to the customer', 'invoicing' ) ); |
|
305 | + } else { |
|
306 | + $this->show_error( __( 'Could not sent the invoice to the customer', 'invoicing' ) ); |
|
307 | + } |
|
308 | 308 | |
309 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
310 | - exit; |
|
311 | - } |
|
309 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
310 | + exit; |
|
311 | + } |
|
312 | 312 | |
313 | - /** |
|
313 | + /** |
|
314 | 314 | * Sends a payment reminder to a customer. |
315 | - * |
|
316 | - * @param array $args |
|
315 | + * |
|
316 | + * @param array $args |
|
317 | 317 | */ |
318 | 318 | public function send_customer_payment_reminder( $args ) { |
319 | - $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
319 | + $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
320 | 320 | |
321 | - if ( $sent ) { |
|
322 | - $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
323 | - } else { |
|
324 | - $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
325 | - } |
|
321 | + if ( $sent ) { |
|
322 | + $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
323 | + } else { |
|
324 | + $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
325 | + } |
|
326 | 326 | |
327 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
328 | - exit; |
|
329 | - } |
|
327 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
328 | + exit; |
|
329 | + } |
|
330 | 330 | |
331 | - /** |
|
331 | + /** |
|
332 | 332 | * Resets tax rates. |
333 | - * |
|
333 | + * |
|
334 | 334 | */ |
335 | 335 | public function admin_reset_tax_rates() { |
336 | 336 | |
337 | - update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
338 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
339 | - exit; |
|
337 | + update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
338 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
339 | + exit; |
|
340 | 340 | |
341 | - } |
|
341 | + } |
|
342 | 342 | |
343 | 343 | /** |
344 | - * Returns an array of admin notices. |
|
345 | - * |
|
346 | - * @since 1.0.19 |
|
344 | + * Returns an array of admin notices. |
|
345 | + * |
|
346 | + * @since 1.0.19 |
|
347 | 347 | * @return array |
348 | - */ |
|
349 | - public function get_notices() { |
|
350 | - $notices = get_option( 'wpinv_admin_notices' ); |
|
348 | + */ |
|
349 | + public function get_notices() { |
|
350 | + $notices = get_option( 'wpinv_admin_notices' ); |
|
351 | 351 | return is_array( $notices ) ? $notices : array(); |
352 | - } |
|
353 | - |
|
354 | - /** |
|
355 | - * Clears all admin notices |
|
356 | - * |
|
357 | - * @access public |
|
358 | - * @since 1.0.19 |
|
359 | - */ |
|
360 | - public function clear_notices() { |
|
361 | - delete_option( 'wpinv_admin_notices' ); |
|
362 | - } |
|
363 | - |
|
364 | - /** |
|
365 | - * Saves a new admin notice |
|
366 | - * |
|
367 | - * @access public |
|
368 | - * @since 1.0.19 |
|
369 | - */ |
|
370 | - public function save_notice( $type, $message ) { |
|
371 | - $notices = $this->get_notices(); |
|
372 | - |
|
373 | - if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ]) ) { |
|
374 | - $notices[ $type ] = array(); |
|
375 | - } |
|
376 | - |
|
377 | - $notices[ $type ][] = $message; |
|
378 | - |
|
379 | - update_option( 'wpinv_admin_notices', $notices ); |
|
380 | - } |
|
381 | - |
|
382 | - /** |
|
383 | - * Displays a success notice |
|
384 | - * |
|
385 | - * @param string $msg The message to qeue. |
|
386 | - * @access public |
|
387 | - * @since 1.0.19 |
|
388 | - */ |
|
389 | - public function show_success( $msg ) { |
|
390 | - $this->save_notice( 'success', $msg ); |
|
391 | - } |
|
392 | - |
|
393 | - /** |
|
394 | - * Displays a error notice |
|
395 | - * |
|
396 | - * @access public |
|
397 | - * @param string $msg The message to qeue. |
|
398 | - * @since 1.0.19 |
|
399 | - */ |
|
400 | - public function show_error( $msg ) { |
|
401 | - $this->save_notice( 'error', $msg ); |
|
402 | - } |
|
403 | - |
|
404 | - /** |
|
405 | - * Displays a warning notice |
|
406 | - * |
|
407 | - * @access public |
|
408 | - * @param string $msg The message to qeue. |
|
409 | - * @since 1.0.19 |
|
410 | - */ |
|
411 | - public function show_warning( $msg ) { |
|
412 | - $this->save_notice( 'warning', $msg ); |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * Displays a info notice |
|
417 | - * |
|
418 | - * @access public |
|
419 | - * @param string $msg The message to qeue. |
|
420 | - * @since 1.0.19 |
|
421 | - */ |
|
422 | - public function show_info( $msg ) { |
|
423 | - $this->save_notice( 'info', $msg ); |
|
424 | - } |
|
425 | - |
|
426 | - /** |
|
427 | - * Show notices |
|
428 | - * |
|
429 | - * @access public |
|
430 | - * @since 1.0.19 |
|
431 | - */ |
|
432 | - public function show_notices() { |
|
352 | + } |
|
353 | + |
|
354 | + /** |
|
355 | + * Clears all admin notices |
|
356 | + * |
|
357 | + * @access public |
|
358 | + * @since 1.0.19 |
|
359 | + */ |
|
360 | + public function clear_notices() { |
|
361 | + delete_option( 'wpinv_admin_notices' ); |
|
362 | + } |
|
363 | + |
|
364 | + /** |
|
365 | + * Saves a new admin notice |
|
366 | + * |
|
367 | + * @access public |
|
368 | + * @since 1.0.19 |
|
369 | + */ |
|
370 | + public function save_notice( $type, $message ) { |
|
371 | + $notices = $this->get_notices(); |
|
372 | + |
|
373 | + if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ]) ) { |
|
374 | + $notices[ $type ] = array(); |
|
375 | + } |
|
376 | + |
|
377 | + $notices[ $type ][] = $message; |
|
378 | + |
|
379 | + update_option( 'wpinv_admin_notices', $notices ); |
|
380 | + } |
|
381 | + |
|
382 | + /** |
|
383 | + * Displays a success notice |
|
384 | + * |
|
385 | + * @param string $msg The message to qeue. |
|
386 | + * @access public |
|
387 | + * @since 1.0.19 |
|
388 | + */ |
|
389 | + public function show_success( $msg ) { |
|
390 | + $this->save_notice( 'success', $msg ); |
|
391 | + } |
|
392 | + |
|
393 | + /** |
|
394 | + * Displays a error notice |
|
395 | + * |
|
396 | + * @access public |
|
397 | + * @param string $msg The message to qeue. |
|
398 | + * @since 1.0.19 |
|
399 | + */ |
|
400 | + public function show_error( $msg ) { |
|
401 | + $this->save_notice( 'error', $msg ); |
|
402 | + } |
|
403 | + |
|
404 | + /** |
|
405 | + * Displays a warning notice |
|
406 | + * |
|
407 | + * @access public |
|
408 | + * @param string $msg The message to qeue. |
|
409 | + * @since 1.0.19 |
|
410 | + */ |
|
411 | + public function show_warning( $msg ) { |
|
412 | + $this->save_notice( 'warning', $msg ); |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * Displays a info notice |
|
417 | + * |
|
418 | + * @access public |
|
419 | + * @param string $msg The message to qeue. |
|
420 | + * @since 1.0.19 |
|
421 | + */ |
|
422 | + public function show_info( $msg ) { |
|
423 | + $this->save_notice( 'info', $msg ); |
|
424 | + } |
|
425 | + |
|
426 | + /** |
|
427 | + * Show notices |
|
428 | + * |
|
429 | + * @access public |
|
430 | + * @since 1.0.19 |
|
431 | + */ |
|
432 | + public function show_notices() { |
|
433 | 433 | |
434 | 434 | $notices = $this->get_notices(); |
435 | 435 | $this->clear_notices(); |
436 | 436 | |
437 | - foreach ( $notices as $type => $messages ) { |
|
437 | + foreach ( $notices as $type => $messages ) { |
|
438 | 438 | |
439 | - if ( ! is_array( $messages ) ) { |
|
440 | - continue; |
|
441 | - } |
|
439 | + if ( ! is_array( $messages ) ) { |
|
440 | + continue; |
|
441 | + } |
|
442 | 442 | |
443 | 443 | $type = sanitize_key( $type ); |
444 | - foreach ( $messages as $message ) { |
|
444 | + foreach ( $messages as $message ) { |
|
445 | 445 | $message = wp_kses_post( $message ); |
446 | - echo "<div class='notice notice-$type is-dismissible'><p>$message</p></div>"; |
|
446 | + echo "<div class='notice notice-$type is-dismissible'><p>$message</p></div>"; |
|
447 | 447 | } |
448 | 448 | |
449 | 449 | } |
450 | 450 | |
451 | - } |
|
451 | + } |
|
452 | 452 | |
453 | 453 | } |
@@ -4,7 +4,7 @@ discard block |
||
4 | 4 | * |
5 | 5 | */ |
6 | 6 | |
7 | -defined( 'ABSPATH' ) || exit; |
|
7 | +defined('ABSPATH') || exit; |
|
8 | 8 | |
9 | 9 | /** |
10 | 10 | * The main admin class. |
@@ -37,13 +37,13 @@ discard block |
||
37 | 37 | /** |
38 | 38 | * Class constructor. |
39 | 39 | */ |
40 | - public function __construct(){ |
|
40 | + public function __construct() { |
|
41 | 41 | |
42 | - $this->admin_path = plugin_dir_path( __FILE__ ); |
|
43 | - $this->admin_url = plugins_url( '/', __FILE__ ); |
|
42 | + $this->admin_path = plugin_dir_path(__FILE__); |
|
43 | + $this->admin_url = plugins_url('/', __FILE__); |
|
44 | 44 | $this->reports = new GetPaid_Reports(); |
45 | 45 | |
46 | - if ( is_admin() ) { |
|
46 | + if (is_admin()) { |
|
47 | 47 | $this->init_admin_hooks(); |
48 | 48 | } |
49 | 49 | |
@@ -54,16 +54,16 @@ discard block |
||
54 | 54 | * |
55 | 55 | */ |
56 | 56 | private function init_admin_hooks() { |
57 | - add_action( 'admin_enqueue_scripts', array( $this, 'enqeue_scripts' ) ); |
|
58 | - add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) ); |
|
59 | - add_action( 'admin_init', array( $this, 'init_ayecode_connect_helper' ) ); |
|
60 | - add_action( 'admin_init', array( $this, 'activation_redirect') ); |
|
61 | - add_action( 'admin_init', array( $this, 'maybe_do_admin_action') ); |
|
62 | - add_action( 'admin_notices', array( $this, 'show_notices' ) ); |
|
63 | - add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
64 | - add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
65 | - add_action( 'getpaid_authenticated_admin_action_reset_tax_rates', array( $this, 'admin_reset_tax_rates' ) ); |
|
66 | - do_action( 'getpaid_init_admin_hooks', $this ); |
|
57 | + add_action('admin_enqueue_scripts', array($this, 'enqeue_scripts')); |
|
58 | + add_filter('admin_body_class', array($this, 'admin_body_class')); |
|
59 | + add_action('admin_init', array($this, 'init_ayecode_connect_helper')); |
|
60 | + add_action('admin_init', array($this, 'activation_redirect')); |
|
61 | + add_action('admin_init', array($this, 'maybe_do_admin_action')); |
|
62 | + add_action('admin_notices', array($this, 'show_notices')); |
|
63 | + add_action('getpaid_authenticated_admin_action_send_invoice', array($this, 'send_customer_invoice')); |
|
64 | + add_action('getpaid_authenticated_admin_action_send_invoice_reminder', array($this, 'send_customer_payment_reminder')); |
|
65 | + add_action('getpaid_authenticated_admin_action_reset_tax_rates', array($this, 'admin_reset_tax_rates')); |
|
66 | + do_action('getpaid_init_admin_hooks', $this); |
|
67 | 67 | |
68 | 68 | } |
69 | 69 | |
@@ -74,39 +74,39 @@ discard block |
||
74 | 74 | public function enqeue_scripts() { |
75 | 75 | global $current_screen, $pagenow; |
76 | 76 | |
77 | - $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
77 | + $page = isset($_GET['page']) ? $_GET['page'] : ''; |
|
78 | 78 | $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
79 | 79 | |
80 | - if ( ! empty( $current_screen->post_type ) ) { |
|
80 | + if (!empty($current_screen->post_type)) { |
|
81 | 81 | $page = $current_screen->post_type; |
82 | 82 | } |
83 | 83 | |
84 | 84 | // General styles. |
85 | - if ( false !== stripos( $page, 'wpi' ) ) { |
|
85 | + if (false !== stripos($page, 'wpi')) { |
|
86 | 86 | |
87 | 87 | // Styles. |
88 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/css/admin.css' ); |
|
89 | - wp_enqueue_style( 'wpinv_admin_style', WPINV_PLUGIN_URL . 'assets/css/admin.css', array( 'wp-color-picker' ), $version ); |
|
90 | - wp_enqueue_style( 'select2', WPINV_PLUGIN_URL . 'assets/css/select2/select2.min.css', array(), '4.0.13', 'all' ); |
|
91 | - wp_enqueue_style( 'jquery-ui-css', WPINV_PLUGIN_URL . 'assets/css/jquery-ui.min.css', array(), '1.8.16' ); |
|
88 | + $version = filemtime(WPINV_PLUGIN_DIR . 'assets/css/admin.css'); |
|
89 | + wp_enqueue_style('wpinv_admin_style', WPINV_PLUGIN_URL . 'assets/css/admin.css', array('wp-color-picker'), $version); |
|
90 | + wp_enqueue_style('select2', WPINV_PLUGIN_URL . 'assets/css/select2/select2.min.css', array(), '4.0.13', 'all'); |
|
91 | + wp_enqueue_style('jquery-ui-css', WPINV_PLUGIN_URL . 'assets/css/jquery-ui.min.css', array(), '1.8.16'); |
|
92 | 92 | |
93 | 93 | // Scripts. |
94 | - wp_register_script( 'jquery-blockui', WPINV_PLUGIN_URL . 'assets/js/jquery.blockUI.min.js', array( 'jquery' ), '4.0.13', true ); |
|
95 | - wp_enqueue_script('select2', WPINV_PLUGIN_URL . 'assets/js/select2/select2.full.min.js', array( 'jquery' ), WPINV_VERSION ); |
|
94 | + wp_register_script('jquery-blockui', WPINV_PLUGIN_URL . 'assets/js/jquery.blockUI.min.js', array('jquery'), '4.0.13', true); |
|
95 | + wp_enqueue_script('select2', WPINV_PLUGIN_URL . 'assets/js/select2/select2.full.min.js', array('jquery'), WPINV_VERSION); |
|
96 | 96 | |
97 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin.js' ); |
|
98 | - wp_enqueue_script( 'wpinv-admin-script', WPINV_PLUGIN_URL . 'assets/js/admin.js', array( 'jquery', 'jquery-blockui','jquery-ui-tooltip', 'wp-color-picker', 'jquery-ui-datepicker' ), $version ); |
|
99 | - wp_localize_script( 'wpinv-admin-script', 'WPInv_Admin', apply_filters( 'wpinv_admin_js_localize', $this->get_admin_i18() ) ); |
|
97 | + $version = filemtime(WPINV_PLUGIN_DIR . 'assets/js/admin.js'); |
|
98 | + wp_enqueue_script('wpinv-admin-script', WPINV_PLUGIN_URL . 'assets/js/admin.js', array('jquery', 'jquery-blockui', 'jquery-ui-tooltip', 'wp-color-picker', 'jquery-ui-datepicker'), $version); |
|
99 | + wp_localize_script('wpinv-admin-script', 'WPInv_Admin', apply_filters('wpinv_admin_js_localize', $this->get_admin_i18())); |
|
100 | 100 | |
101 | 101 | } |
102 | 102 | |
103 | 103 | // Payment form scripts. |
104 | - if ( 'wpi_payment_form' == $page && $editing ) { |
|
104 | + if ('wpi_payment_form' == $page && $editing) { |
|
105 | 105 | $this->load_payment_form_scripts(); |
106 | 106 | } |
107 | 107 | |
108 | - if ( $page == 'wpinv-subscriptions' ) { |
|
109 | - wp_enqueue_script( 'postbox' ); |
|
108 | + if ($page == 'wpinv-subscriptions') { |
|
109 | + wp_enqueue_script('postbox'); |
|
110 | 110 | } |
111 | 111 | |
112 | 112 | } |
@@ -119,16 +119,16 @@ discard block |
||
119 | 119 | global $post; |
120 | 120 | |
121 | 121 | $i18n = array( |
122 | - 'ajax_url' => admin_url( 'admin-ajax.php' ), |
|
123 | - 'post_ID' => isset( $post->ID ) ? $post->ID : '', |
|
124 | - 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
125 | - 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
126 | - 'rest_root' => esc_url_raw( rest_url() ), |
|
127 | - 'date_range' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days', |
|
128 | - 'add_invoice_note_nonce' => wp_create_nonce( 'add-invoice-note' ), |
|
129 | - 'delete_invoice_note_nonce' => wp_create_nonce( 'delete-invoice-note' ), |
|
130 | - 'invoice_item_nonce' => wp_create_nonce( 'invoice-item' ), |
|
131 | - 'billing_details_nonce' => wp_create_nonce( 'get-billing-details' ), |
|
122 | + 'ajax_url' => admin_url('admin-ajax.php'), |
|
123 | + 'post_ID' => isset($post->ID) ? $post->ID : '', |
|
124 | + 'wpinv_nonce' => wp_create_nonce('wpinv-nonce'), |
|
125 | + 'rest_nonce' => wp_create_nonce('wp_rest'), |
|
126 | + 'rest_root' => esc_url_raw(rest_url()), |
|
127 | + 'date_range' => isset($_GET['date_range']) ? sanitize_text_field($_GET['date_range']) : '7_days', |
|
128 | + 'add_invoice_note_nonce' => wp_create_nonce('add-invoice-note'), |
|
129 | + 'delete_invoice_note_nonce' => wp_create_nonce('delete-invoice-note'), |
|
130 | + 'invoice_item_nonce' => wp_create_nonce('invoice-item'), |
|
131 | + 'billing_details_nonce' => wp_create_nonce('get-billing-details'), |
|
132 | 132 | 'tax' => wpinv_tax_amount(), |
133 | 133 | 'discount' => 0, |
134 | 134 | 'currency_symbol' => wpinv_currency_symbol(), |
@@ -137,35 +137,35 @@ discard block |
||
137 | 137 | 'thousand_sep' => wpinv_thousands_separator(), |
138 | 138 | 'decimal_sep' => wpinv_decimal_separator(), |
139 | 139 | 'decimals' => wpinv_decimals(), |
140 | - 'save_invoice' => __( 'Save Invoice', 'invoicing' ), |
|
141 | - 'status_publish' => wpinv_status_nicename( 'publish' ), |
|
142 | - 'status_pending' => wpinv_status_nicename( 'wpi-pending' ), |
|
143 | - 'delete_tax_rate' => __( 'Are you sure you wish to delete this tax rate?', 'invoicing' ), |
|
144 | - 'status_pending' => wpinv_status_nicename( 'wpi-pending' ), |
|
145 | - 'FillBillingDetails' => __( 'Fill the user\'s billing information? This will remove any currently entered billing information', 'invoicing' ), |
|
146 | - 'confirmCalcTotals' => __( 'Recalculate totals? This will recalculate totals based on the user billing country. If no billing country is set it will use the base country.', 'invoicing' ), |
|
147 | - 'AreYouSure' => __( 'Are you sure?', 'invoicing' ), |
|
148 | - 'errDeleteItem' => __( 'This item is in use! Before delete this item, you need to delete all the invoice(s) using this item.', 'invoicing' ), |
|
149 | - 'delete_subscription' => __( 'Are you sure you want to delete this subscription?', 'invoicing' ), |
|
150 | - 'action_edit' => __( 'Edit', 'invoicing' ), |
|
151 | - 'action_cancel' => __( 'Cancel', 'invoicing' ), |
|
152 | - 'item_description' => __( 'Item Description', 'invoicing' ), |
|
153 | - 'invoice_description' => __( 'Invoice Description', 'invoicing' ), |
|
154 | - 'discount_description' => __( 'Discount Description', 'invoicing' ), |
|
155 | - 'searching' => __( 'Searching', 'invoicing' ), |
|
140 | + 'save_invoice' => __('Save Invoice', 'invoicing'), |
|
141 | + 'status_publish' => wpinv_status_nicename('publish'), |
|
142 | + 'status_pending' => wpinv_status_nicename('wpi-pending'), |
|
143 | + 'delete_tax_rate' => __('Are you sure you wish to delete this tax rate?', 'invoicing'), |
|
144 | + 'status_pending' => wpinv_status_nicename('wpi-pending'), |
|
145 | + 'FillBillingDetails' => __('Fill the user\'s billing information? This will remove any currently entered billing information', 'invoicing'), |
|
146 | + 'confirmCalcTotals' => __('Recalculate totals? This will recalculate totals based on the user billing country. If no billing country is set it will use the base country.', 'invoicing'), |
|
147 | + 'AreYouSure' => __('Are you sure?', 'invoicing'), |
|
148 | + 'errDeleteItem' => __('This item is in use! Before delete this item, you need to delete all the invoice(s) using this item.', 'invoicing'), |
|
149 | + 'delete_subscription' => __('Are you sure you want to delete this subscription?', 'invoicing'), |
|
150 | + 'action_edit' => __('Edit', 'invoicing'), |
|
151 | + 'action_cancel' => __('Cancel', 'invoicing'), |
|
152 | + 'item_description' => __('Item Description', 'invoicing'), |
|
153 | + 'invoice_description' => __('Invoice Description', 'invoicing'), |
|
154 | + 'discount_description' => __('Discount Description', 'invoicing'), |
|
155 | + 'searching' => __('Searching', 'invoicing'), |
|
156 | 156 | ); |
157 | 157 | |
158 | - if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
158 | + if (!empty($post) && getpaid_is_invoice_post_type($post->post_type)) { |
|
159 | 159 | |
160 | - $invoice = new WPInv_Invoice( $post ); |
|
160 | + $invoice = new WPInv_Invoice($post); |
|
161 | 161 | $i18n['save_invoice'] = sprintf( |
162 | - __( 'Save %s', 'invoicing' ), |
|
163 | - ucfirst( $invoice->get_type() ) |
|
162 | + __('Save %s', 'invoicing'), |
|
163 | + ucfirst($invoice->get_type()) |
|
164 | 164 | ); |
165 | 165 | |
166 | 166 | $i18n['invoice_description'] = sprintf( |
167 | - __( '%s Description', 'invoicing' ), |
|
168 | - ucfirst( $invoice->get_type() ) |
|
167 | + __('%s Description', 'invoicing'), |
|
168 | + ucfirst($invoice->get_type()) |
|
169 | 169 | ); |
170 | 170 | |
171 | 171 | } |
@@ -179,30 +179,30 @@ discard block |
||
179 | 179 | protected function load_payment_form_scripts() { |
180 | 180 | global $post; |
181 | 181 | |
182 | - wp_enqueue_script( 'vue', WPINV_PLUGIN_URL . 'assets/js/vue/vue.js', array(), WPINV_VERSION ); |
|
183 | - wp_enqueue_script( 'sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION ); |
|
184 | - wp_enqueue_script( 'vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array( 'sortable', 'vue' ), WPINV_VERSION ); |
|
182 | + wp_enqueue_script('vue', WPINV_PLUGIN_URL . 'assets/js/vue/vue.js', array(), WPINV_VERSION); |
|
183 | + wp_enqueue_script('sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION); |
|
184 | + wp_enqueue_script('vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array('sortable', 'vue'), WPINV_VERSION); |
|
185 | 185 | |
186 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js' ); |
|
187 | - wp_register_script( 'wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array( 'wpinv-admin-script', 'vue_draggable' ), $version ); |
|
186 | + $version = filemtime(WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js'); |
|
187 | + wp_register_script('wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array('wpinv-admin-script', 'vue_draggable'), $version); |
|
188 | 188 | |
189 | 189 | wp_localize_script( |
190 | 190 | 'wpinv-admin-payment-form-script', |
191 | 191 | 'wpinvPaymentFormAdmin', |
192 | 192 | array( |
193 | - 'elements' => wpinv_get_data( 'payment-form-elements' ), |
|
194 | - 'form_elements' => getpaid_get_payment_form_elements( $post->ID ), |
|
193 | + 'elements' => wpinv_get_data('payment-form-elements'), |
|
194 | + 'form_elements' => getpaid_get_payment_form_elements($post->ID), |
|
195 | 195 | 'currency' => wpinv_currency_symbol(), |
196 | 196 | 'position' => wpinv_currency_position(), |
197 | 197 | 'decimals' => (int) wpinv_decimals(), |
198 | 198 | 'thousands_sep' => wpinv_thousands_separator(), |
199 | 199 | 'decimals_sep' => wpinv_decimal_separator(), |
200 | - 'form_items' => gepaid_get_form_items( $post->ID ), |
|
200 | + 'form_items' => gepaid_get_form_items($post->ID), |
|
201 | 201 | 'is_default' => $post->ID == wpinv_get_default_payment_form(), |
202 | 202 | ) |
203 | 203 | ); |
204 | 204 | |
205 | - wp_enqueue_script( 'wpinv-admin-payment-form-script' ); |
|
205 | + wp_enqueue_script('wpinv-admin-payment-form-script'); |
|
206 | 206 | |
207 | 207 | } |
208 | 208 | |
@@ -213,25 +213,25 @@ discard block |
||
213 | 213 | * @return string |
214 | 214 | * |
215 | 215 | */ |
216 | - public function admin_body_class( $classes ) { |
|
216 | + public function admin_body_class($classes) { |
|
217 | 217 | global $pagenow, $post, $current_screen; |
218 | 218 | |
219 | 219 | |
220 | - $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
220 | + $page = isset($_GET['page']) ? $_GET['page'] : ''; |
|
221 | 221 | |
222 | - if ( ! empty( $current_screen->post_type ) ) { |
|
222 | + if (!empty($current_screen->post_type)) { |
|
223 | 223 | $page = $current_screen->post_type; |
224 | 224 | } |
225 | 225 | |
226 | - if ( false !== stripos( $page, 'wpi' ) ) { |
|
227 | - $classes .= ' wpi-' . sanitize_key( $page ); |
|
226 | + if (false !== stripos($page, 'wpi')) { |
|
227 | + $classes .= ' wpi-' . sanitize_key($page); |
|
228 | 228 | } |
229 | 229 | |
230 | - if ( in_array( $page, wpinv_parse_list( 'wpi_invoice wpi_payment_form wpi_quote' ) ) ) { |
|
230 | + if (in_array($page, wpinv_parse_list('wpi_invoice wpi_payment_form wpi_quote'))) { |
|
231 | 231 | $classes .= ' wpinv-cpt wpinv'; |
232 | 232 | } |
233 | 233 | |
234 | - if ( getpaid_is_invoice_post_type( $page ) ) { |
|
234 | + if (getpaid_is_invoice_post_type($page)) { |
|
235 | 235 | $classes .= ' getpaid-is-invoice-cpt'; |
236 | 236 | } |
237 | 237 | |
@@ -241,19 +241,19 @@ discard block |
||
241 | 241 | /** |
242 | 242 | * Maybe show the AyeCode Connect Notice. |
243 | 243 | */ |
244 | - public function init_ayecode_connect_helper(){ |
|
244 | + public function init_ayecode_connect_helper() { |
|
245 | 245 | |
246 | 246 | new AyeCode_Connect_Helper( |
247 | 247 | array( |
248 | - 'connect_title' => __("WP Invoicing - an AyeCode product!","invoicing"), |
|
249 | - 'connect_external' => __( "Please confirm you wish to connect your site?","invoicing" ), |
|
250 | - 'connect' => sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s","invoicing" ),"<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>","</a>" ), |
|
251 | - 'connect_button' => __("Connect Site","invoicing"), |
|
252 | - 'connecting_button' => __("Connecting...","invoicing"), |
|
253 | - 'error_localhost' => __( "This service will only work with a live domain, not a localhost.","invoicing" ), |
|
254 | - 'error' => __( "Something went wrong, please refresh and try again.","invoicing" ), |
|
248 | + 'connect_title' => __("WP Invoicing - an AyeCode product!", "invoicing"), |
|
249 | + 'connect_external' => __("Please confirm you wish to connect your site?", "invoicing"), |
|
250 | + 'connect' => sprintf(__("<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s", "invoicing"), "<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>", "</a>"), |
|
251 | + 'connect_button' => __("Connect Site", "invoicing"), |
|
252 | + 'connecting_button' => __("Connecting...", "invoicing"), |
|
253 | + 'error_localhost' => __("This service will only work with a live domain, not a localhost.", "invoicing"), |
|
254 | + 'error' => __("Something went wrong, please refresh and try again.", "invoicing"), |
|
255 | 255 | ), |
256 | - array( 'wpi-addons' ) |
|
256 | + array('wpi-addons') |
|
257 | 257 | ); |
258 | 258 | |
259 | 259 | } |
@@ -264,19 +264,19 @@ discard block |
||
264 | 264 | public function activation_redirect() { |
265 | 265 | |
266 | 266 | // Bail if no activation redirect. |
267 | - if ( ! get_transient( '_wpinv_activation_redirect' ) || wp_doing_ajax() ) { |
|
267 | + if (!get_transient('_wpinv_activation_redirect') || wp_doing_ajax()) { |
|
268 | 268 | return; |
269 | 269 | } |
270 | 270 | |
271 | 271 | // Delete the redirect transient. |
272 | - delete_transient( '_wpinv_activation_redirect' ); |
|
272 | + delete_transient('_wpinv_activation_redirect'); |
|
273 | 273 | |
274 | 274 | // Bail if activating from network, or bulk |
275 | - if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
275 | + if (is_network_admin() || isset($_GET['activate-multi'])) { |
|
276 | 276 | return; |
277 | 277 | } |
278 | 278 | |
279 | - wp_safe_redirect( admin_url( 'admin.php?page=wpinv-settings&tab=general' ) ); |
|
279 | + wp_safe_redirect(admin_url('admin.php?page=wpinv-settings&tab=general')); |
|
280 | 280 | exit; |
281 | 281 | } |
282 | 282 | |
@@ -285,9 +285,9 @@ discard block |
||
285 | 285 | */ |
286 | 286 | public function maybe_do_admin_action() { |
287 | 287 | |
288 | - if ( wpinv_current_user_can_manage_invoicing() && isset( $_REQUEST['getpaid-admin-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) { |
|
289 | - $key = sanitize_key( $_REQUEST['getpaid-admin-action'] ); |
|
290 | - do_action( "getpaid_authenticated_admin_action_$key", $_REQUEST ); |
|
288 | + if (wpinv_current_user_can_manage_invoicing() && isset($_REQUEST['getpaid-admin-action']) && isset($_REQUEST['getpaid-nonce']) && wp_verify_nonce($_REQUEST['getpaid-nonce'], 'getpaid-nonce')) { |
|
289 | + $key = sanitize_key($_REQUEST['getpaid-admin-action']); |
|
290 | + do_action("getpaid_authenticated_admin_action_$key", $_REQUEST); |
|
291 | 291 | } |
292 | 292 | |
293 | 293 | } |
@@ -297,16 +297,16 @@ discard block |
||
297 | 297 | * |
298 | 298 | * @param array $args |
299 | 299 | */ |
300 | - public function send_customer_invoice( $args ) { |
|
301 | - $sent = getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
300 | + public function send_customer_invoice($args) { |
|
301 | + $sent = getpaid()->get('invoice_emails')->user_invoice(new WPInv_Invoice($args['invoice_id'])); |
|
302 | 302 | |
303 | - if ( $sent ) { |
|
304 | - $this->show_success( __( 'Invoice was successfully sent to the customer', 'invoicing' ) ); |
|
303 | + if ($sent) { |
|
304 | + $this->show_success(__('Invoice was successfully sent to the customer', 'invoicing')); |
|
305 | 305 | } else { |
306 | - $this->show_error( __( 'Could not sent the invoice to the customer', 'invoicing' ) ); |
|
306 | + $this->show_error(__('Could not sent the invoice to the customer', 'invoicing')); |
|
307 | 307 | } |
308 | 308 | |
309 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
309 | + wp_safe_redirect(remove_query_arg(array('getpaid-admin-action', 'getpaid-nonce', 'invoice_id'))); |
|
310 | 310 | exit; |
311 | 311 | } |
312 | 312 | |
@@ -315,16 +315,16 @@ discard block |
||
315 | 315 | * |
316 | 316 | * @param array $args |
317 | 317 | */ |
318 | - public function send_customer_payment_reminder( $args ) { |
|
319 | - $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
318 | + public function send_customer_payment_reminder($args) { |
|
319 | + $sent = getpaid()->get('invoice_emails')->force_send_overdue_notice(new WPInv_Invoice($args['invoice_id'])); |
|
320 | 320 | |
321 | - if ( $sent ) { |
|
322 | - $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
321 | + if ($sent) { |
|
322 | + $this->show_success(__('Payment reminder was successfully sent to the customer', 'invoicing')); |
|
323 | 323 | } else { |
324 | - $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
324 | + $this->show_error(__('Could not sent payment reminder to the customer', 'invoicing')); |
|
325 | 325 | } |
326 | 326 | |
327 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
327 | + wp_safe_redirect(remove_query_arg(array('getpaid-admin-action', 'getpaid-nonce', 'invoice_id'))); |
|
328 | 328 | exit; |
329 | 329 | } |
330 | 330 | |
@@ -334,8 +334,8 @@ discard block |
||
334 | 334 | */ |
335 | 335 | public function admin_reset_tax_rates() { |
336 | 336 | |
337 | - update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
338 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
337 | + update_option('wpinv_tax_rates', wpinv_get_data('tax-rates')); |
|
338 | + wp_safe_redirect(remove_query_arg(array('getpaid-admin-action', 'getpaid-nonce'))); |
|
339 | 339 | exit; |
340 | 340 | |
341 | 341 | } |
@@ -347,8 +347,8 @@ discard block |
||
347 | 347 | * @return array |
348 | 348 | */ |
349 | 349 | public function get_notices() { |
350 | - $notices = get_option( 'wpinv_admin_notices' ); |
|
351 | - return is_array( $notices ) ? $notices : array(); |
|
350 | + $notices = get_option('wpinv_admin_notices'); |
|
351 | + return is_array($notices) ? $notices : array(); |
|
352 | 352 | } |
353 | 353 | |
354 | 354 | /** |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | * @since 1.0.19 |
359 | 359 | */ |
360 | 360 | public function clear_notices() { |
361 | - delete_option( 'wpinv_admin_notices' ); |
|
361 | + delete_option('wpinv_admin_notices'); |
|
362 | 362 | } |
363 | 363 | |
364 | 364 | /** |
@@ -367,16 +367,16 @@ discard block |
||
367 | 367 | * @access public |
368 | 368 | * @since 1.0.19 |
369 | 369 | */ |
370 | - public function save_notice( $type, $message ) { |
|
370 | + public function save_notice($type, $message) { |
|
371 | 371 | $notices = $this->get_notices(); |
372 | 372 | |
373 | - if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ]) ) { |
|
374 | - $notices[ $type ] = array(); |
|
373 | + if (empty($notices[$type]) || !is_array($notices[$type])) { |
|
374 | + $notices[$type] = array(); |
|
375 | 375 | } |
376 | 376 | |
377 | - $notices[ $type ][] = $message; |
|
377 | + $notices[$type][] = $message; |
|
378 | 378 | |
379 | - update_option( 'wpinv_admin_notices', $notices ); |
|
379 | + update_option('wpinv_admin_notices', $notices); |
|
380 | 380 | } |
381 | 381 | |
382 | 382 | /** |
@@ -386,8 +386,8 @@ discard block |
||
386 | 386 | * @access public |
387 | 387 | * @since 1.0.19 |
388 | 388 | */ |
389 | - public function show_success( $msg ) { |
|
390 | - $this->save_notice( 'success', $msg ); |
|
389 | + public function show_success($msg) { |
|
390 | + $this->save_notice('success', $msg); |
|
391 | 391 | } |
392 | 392 | |
393 | 393 | /** |
@@ -397,8 +397,8 @@ discard block |
||
397 | 397 | * @param string $msg The message to qeue. |
398 | 398 | * @since 1.0.19 |
399 | 399 | */ |
400 | - public function show_error( $msg ) { |
|
401 | - $this->save_notice( 'error', $msg ); |
|
400 | + public function show_error($msg) { |
|
401 | + $this->save_notice('error', $msg); |
|
402 | 402 | } |
403 | 403 | |
404 | 404 | /** |
@@ -408,8 +408,8 @@ discard block |
||
408 | 408 | * @param string $msg The message to qeue. |
409 | 409 | * @since 1.0.19 |
410 | 410 | */ |
411 | - public function show_warning( $msg ) { |
|
412 | - $this->save_notice( 'warning', $msg ); |
|
411 | + public function show_warning($msg) { |
|
412 | + $this->save_notice('warning', $msg); |
|
413 | 413 | } |
414 | 414 | |
415 | 415 | /** |
@@ -419,8 +419,8 @@ discard block |
||
419 | 419 | * @param string $msg The message to qeue. |
420 | 420 | * @since 1.0.19 |
421 | 421 | */ |
422 | - public function show_info( $msg ) { |
|
423 | - $this->save_notice( 'info', $msg ); |
|
422 | + public function show_info($msg) { |
|
423 | + $this->save_notice('info', $msg); |
|
424 | 424 | } |
425 | 425 | |
426 | 426 | /** |
@@ -434,15 +434,15 @@ discard block |
||
434 | 434 | $notices = $this->get_notices(); |
435 | 435 | $this->clear_notices(); |
436 | 436 | |
437 | - foreach ( $notices as $type => $messages ) { |
|
437 | + foreach ($notices as $type => $messages) { |
|
438 | 438 | |
439 | - if ( ! is_array( $messages ) ) { |
|
439 | + if (!is_array($messages)) { |
|
440 | 440 | continue; |
441 | 441 | } |
442 | 442 | |
443 | - $type = sanitize_key( $type ); |
|
444 | - foreach ( $messages as $message ) { |
|
445 | - $message = wp_kses_post( $message ); |
|
443 | + $type = sanitize_key($type); |
|
444 | + foreach ($messages as $message) { |
|
445 | + $message = wp_kses_post($message); |
|
446 | 446 | echo "<div class='notice notice-$type is-dismissible'><p>$message</p></div>"; |
447 | 447 | } |
448 | 448 |
@@ -18,664 +18,664 @@ |
||
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 | - protected $report_data; |
|
34 | - |
|
35 | - /** |
|
36 | - * The report range. |
|
37 | - * |
|
38 | - * @var array |
|
39 | - */ |
|
40 | - protected $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 | - 'sales' => wpinv_round_amount( 0.00 ), |
|
134 | - 'invoices' => 0, |
|
135 | - 'refunds' => wpinv_round_amount( 0.00 ), |
|
136 | - 'items' => 0, |
|
137 | - 'refunded_items' => 0, |
|
138 | - 'tax' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
140 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
141 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
142 | - 'fees' => wpinv_round_amount( 0.00 ), |
|
143 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
144 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
145 | - ); |
|
146 | - |
|
147 | - } |
|
148 | - |
|
149 | - // add total sales, total invoice count, total tax for each period |
|
150 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
151 | - foreach ( $report_data->invoices as $invoice ) { |
|
152 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
153 | - |
|
154 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
155 | - continue; |
|
156 | - } |
|
157 | - |
|
158 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
159 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
160 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
161 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
162 | - |
|
163 | - } |
|
164 | - |
|
165 | - foreach ( $report_data->refunds as $invoice ) { |
|
166 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
167 | - |
|
168 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
169 | - continue; |
|
170 | - } |
|
171 | - |
|
172 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
173 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
174 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
175 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
176 | - |
|
177 | - } |
|
178 | - |
|
179 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
180 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
181 | - |
|
182 | - if ( isset( $period_totals[ $time ] ) ) { |
|
183 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
184 | - } |
|
185 | - |
|
186 | - } |
|
187 | - |
|
188 | - // Add total invoice items for each period. |
|
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | - |
|
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | - } |
|
195 | - |
|
196 | - } |
|
197 | - |
|
198 | - // Add total discount for each period. |
|
199 | - foreach ( $report_data->coupons as $discount ) { |
|
200 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
201 | - |
|
202 | - if ( isset( $period_totals[ $time ] ) ) { |
|
203 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
204 | - } |
|
205 | - |
|
206 | - } |
|
207 | - |
|
208 | - $report_data->totals = $period_totals; |
|
209 | - $report_data->grouped_by = $this->groupby; |
|
210 | - $report_data->interval = max( $this->interval, 1 ); |
|
211 | - $report_data->currency = wpinv_get_currency(); |
|
212 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
213 | - $report_data->currency_position = wpinv_currency_position(); |
|
214 | - $report_data->decimal_places = wpinv_decimals(); |
|
215 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
216 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
217 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
218 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
219 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
220 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
221 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
222 | - |
|
223 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
224 | - $data = $report_data; |
|
225 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
226 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
227 | - $data = $this->filter_response_by_context( $data, $context ); |
|
228 | - |
|
229 | - // Wrap the data in a response object. |
|
230 | - $response = rest_ensure_response( $data ); |
|
231 | - $response->add_links( array( |
|
232 | - 'about' => array( |
|
233 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
234 | - ), |
|
235 | - ) ); |
|
236 | - |
|
237 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
238 | - } |
|
239 | - |
|
240 | - /** |
|
241 | - * Get report data. |
|
242 | - * |
|
243 | - * @return stdClass |
|
244 | - */ |
|
245 | - public function get_report_data() { |
|
246 | - if ( empty( $this->report_data ) ) { |
|
247 | - $this->query_report_data(); |
|
248 | - } |
|
249 | - return $this->report_data; |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * Get all data needed for this report and store in the class. |
|
254 | - */ |
|
255 | - protected function query_report_data() { |
|
256 | - |
|
257 | - // Prepare reports. |
|
258 | - $this->report_data = (object) array( |
|
259 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
260 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
261 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
262 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
263 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
264 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
265 | - 'previous_range' => $this->previous_range, |
|
266 | - ); |
|
267 | - |
|
268 | - // Calculated totals. |
|
269 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
270 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
271 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
272 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
273 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
274 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
275 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
276 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
277 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
278 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
279 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
280 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
281 | - |
|
282 | - |
|
283 | - // Calculate average based on net. |
|
284 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
285 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
286 | - |
|
287 | - // Total invoices in this period, even if refunded. |
|
288 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
289 | - |
|
290 | - // Items invoiced in this period, even if refunded. |
|
291 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
292 | - |
|
293 | - // 3rd party filtering of report data |
|
294 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * Prepares invoice counts. |
|
299 | - * |
|
300 | - * @return array. |
|
301 | - */ |
|
302 | - protected function query_invoice_counts() { |
|
303 | - |
|
304 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
305 | - array( |
|
306 | - 'data' => array( |
|
307 | - 'ID' => array( |
|
308 | - 'type' => 'post_data', |
|
309 | - 'function' => 'COUNT', |
|
310 | - 'name' => 'count', |
|
311 | - 'distinct' => true, |
|
312 | - ), |
|
313 | - 'post_date' => array( |
|
314 | - 'type' => 'post_data', |
|
315 | - 'function' => '', |
|
316 | - 'name' => 'post_date', |
|
317 | - ), |
|
318 | - ), |
|
319 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
320 | - 'order_by' => 'post_date ASC', |
|
321 | - 'query_type' => 'get_results', |
|
322 | - 'filter_range' => $this->report_range, |
|
323 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
324 | - ) |
|
325 | - ); |
|
326 | - |
|
327 | - } |
|
328 | - |
|
329 | - /** |
|
330 | - * Prepares coupon counts. |
|
331 | - * |
|
332 | - * @return array. |
|
333 | - */ |
|
334 | - protected function query_coupon_counts() { |
|
335 | - |
|
336 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
337 | - array( |
|
338 | - 'data' => array( |
|
339 | - 'discount' => array( |
|
340 | - 'type' => 'invoice_data', |
|
341 | - 'function' => 'SUM', |
|
342 | - 'name' => 'discount_amount', |
|
343 | - ), |
|
344 | - 'post_date' => array( |
|
345 | - 'type' => 'post_data', |
|
346 | - 'function' => '', |
|
347 | - 'name' => 'post_date', |
|
348 | - ), |
|
349 | - ), |
|
350 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
351 | - 'order_by' => 'post_date ASC', |
|
352 | - 'query_type' => 'get_results', |
|
353 | - 'filter_range' => $this->report_range, |
|
354 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
355 | - ) |
|
356 | - ); |
|
357 | - |
|
358 | - } |
|
359 | - |
|
360 | - /** |
|
361 | - * Prepares item counts. |
|
362 | - * |
|
363 | - * @return array. |
|
364 | - */ |
|
365 | - protected function query_item_counts() { |
|
366 | - |
|
367 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
368 | - array( |
|
369 | - 'data' => array( |
|
370 | - 'quantity' => array( |
|
371 | - 'type' => 'invoice_item', |
|
372 | - 'function' => 'SUM', |
|
373 | - 'name' => 'invoice_item_count', |
|
374 | - ), |
|
375 | - 'post_date' => array( |
|
376 | - 'type' => 'post_data', |
|
377 | - 'function' => '', |
|
378 | - 'name' => 'post_date', |
|
379 | - ), |
|
380 | - ), |
|
381 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
382 | - 'order_by' => 'post_date ASC', |
|
383 | - 'query_type' => 'get_results', |
|
384 | - 'filter_range' => $this->report_range, |
|
385 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
386 | - ) |
|
387 | - ); |
|
388 | - |
|
389 | - } |
|
390 | - |
|
391 | - /** |
|
392 | - * Prepares refunded item counts. |
|
393 | - * |
|
394 | - * @return array. |
|
395 | - */ |
|
396 | - protected function count_refunded_items() { |
|
397 | - |
|
398 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
399 | - array( |
|
400 | - 'data' => array( |
|
401 | - 'quantity' => array( |
|
402 | - 'type' => 'invoice_item', |
|
403 | - 'function' => 'SUM', |
|
404 | - 'name' => 'invoice_item_count', |
|
405 | - ), |
|
406 | - ), |
|
407 | - 'query_type' => 'get_var', |
|
408 | - 'filter_range' => $this->report_range, |
|
409 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
410 | - ) |
|
411 | - ); |
|
412 | - |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * Prepares daily invoice totals. |
|
417 | - * |
|
418 | - * @return array. |
|
419 | - */ |
|
420 | - protected function query_invoice_totals() { |
|
421 | - |
|
422 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | - array( |
|
424 | - 'data' => array( |
|
425 | - 'total' => array( |
|
426 | - 'type' => 'invoice_data', |
|
427 | - 'function' => 'SUM', |
|
428 | - 'name' => 'total_sales', |
|
429 | - ), |
|
430 | - 'tax' => array( |
|
431 | - 'type' => 'invoice_data', |
|
432 | - 'function' => 'SUM', |
|
433 | - 'name' => 'total_tax', |
|
434 | - ), |
|
435 | - 'discount' => array( |
|
436 | - 'type' => 'invoice_data', |
|
437 | - 'function' => 'SUM', |
|
438 | - 'name' => 'total_discount', |
|
439 | - ), |
|
440 | - 'fees_total' => array( |
|
441 | - 'type' => 'invoice_data', |
|
442 | - 'function' => 'SUM', |
|
443 | - 'name' => 'total_fees', |
|
444 | - ), |
|
445 | - 'subtotal' => array( |
|
446 | - 'type' => 'invoice_data', |
|
447 | - 'function' => 'SUM', |
|
448 | - 'name' => 'subtotal', |
|
449 | - ), |
|
450 | - 'post_date' => array( |
|
451 | - 'type' => 'post_data', |
|
452 | - 'function' => '', |
|
453 | - 'name' => 'post_date', |
|
454 | - ), |
|
455 | - ), |
|
456 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
457 | - 'order_by' => 'post_date ASC', |
|
458 | - 'query_type' => 'get_results', |
|
459 | - 'filter_range' => $this->report_range, |
|
460 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
461 | - ) |
|
462 | - ); |
|
463 | - |
|
464 | - } |
|
465 | - |
|
466 | - /** |
|
467 | - * Prepares daily invoice totals. |
|
468 | - * |
|
469 | - * @return array. |
|
470 | - */ |
|
471 | - protected function query_refunded_totals() { |
|
472 | - |
|
473 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
474 | - array( |
|
475 | - 'data' => array( |
|
476 | - 'total' => array( |
|
477 | - 'type' => 'invoice_data', |
|
478 | - 'function' => 'SUM', |
|
479 | - 'name' => 'total_sales', |
|
480 | - ), |
|
481 | - 'tax' => array( |
|
482 | - 'type' => 'invoice_data', |
|
483 | - 'function' => 'SUM', |
|
484 | - 'name' => 'total_tax', |
|
485 | - ), |
|
486 | - 'discount' => array( |
|
487 | - 'type' => 'invoice_data', |
|
488 | - 'function' => 'SUM', |
|
489 | - 'name' => 'total_discount', |
|
490 | - ), |
|
491 | - 'fees_total' => array( |
|
492 | - 'type' => 'invoice_data', |
|
493 | - 'function' => 'SUM', |
|
494 | - 'name' => 'total_fees', |
|
495 | - ), |
|
496 | - 'subtotal' => array( |
|
497 | - 'type' => 'invoice_data', |
|
498 | - 'function' => 'SUM', |
|
499 | - 'name' => 'subtotal', |
|
500 | - ), |
|
501 | - 'post_date' => array( |
|
502 | - 'type' => 'post_data', |
|
503 | - 'function' => '', |
|
504 | - 'name' => 'post_date', |
|
505 | - ), |
|
506 | - ), |
|
507 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
508 | - 'order_by' => 'post_date ASC', |
|
509 | - 'query_type' => 'get_results', |
|
510 | - 'filter_range' => $this->report_range, |
|
511 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
512 | - ) |
|
513 | - ); |
|
514 | - |
|
515 | - } |
|
516 | - |
|
517 | - /** |
|
518 | - * Get the Report's schema, conforming to JSON Schema. |
|
519 | - * |
|
520 | - * @return array |
|
521 | - */ |
|
522 | - public function get_item_schema() { |
|
523 | - |
|
524 | - $schema = array( |
|
525 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
526 | - 'title' => 'sales_report', |
|
527 | - 'type' => 'object', |
|
528 | - 'properties' => array( |
|
529 | - 'total_sales' => array( |
|
530 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
531 | - 'type' => 'string', |
|
532 | - 'context' => array( 'view' ), |
|
533 | - 'readonly' => true, |
|
534 | - ), |
|
535 | - 'net_sales' => array( |
|
536 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
537 | - 'type' => 'string', |
|
538 | - 'context' => array( 'view' ), |
|
539 | - 'readonly' => true, |
|
540 | - ), |
|
541 | - 'average_sales' => array( |
|
542 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
543 | - 'type' => 'string', |
|
544 | - 'context' => array( 'view' ), |
|
545 | - 'readonly' => true, |
|
546 | - ), |
|
547 | - 'average_total_sales' => array( |
|
548 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
549 | - 'type' => 'string', |
|
550 | - 'context' => array( 'view' ), |
|
551 | - 'readonly' => true, |
|
552 | - ), |
|
553 | - 'total_invoices' => array( |
|
554 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
555 | - 'type' => 'integer', |
|
556 | - 'context' => array( 'view' ), |
|
557 | - 'readonly' => true, |
|
558 | - ), |
|
559 | - 'total_items' => array( |
|
560 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
561 | - 'type' => 'integer', |
|
562 | - 'context' => array( 'view' ), |
|
563 | - 'readonly' => true, |
|
564 | - ), |
|
565 | - 'refunded_items' => array( |
|
566 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
567 | - 'type' => 'integer', |
|
568 | - 'context' => array( 'view' ), |
|
569 | - 'readonly' => true, |
|
570 | - ), |
|
571 | - 'total_tax' => array( |
|
572 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
573 | - 'type' => 'string', |
|
574 | - 'context' => array( 'view' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'total_refunded_tax' => array( |
|
578 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
579 | - 'type' => 'string', |
|
580 | - 'context' => array( 'view' ), |
|
581 | - 'readonly' => true, |
|
582 | - ), |
|
583 | - 'total_fees' => array( |
|
584 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
585 | - 'type' => 'string', |
|
586 | - 'context' => array( 'view' ), |
|
587 | - 'readonly' => true, |
|
588 | - ), |
|
589 | - 'total_refunds' => array( |
|
590 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
591 | - 'type' => 'integer', |
|
592 | - 'context' => array( 'view' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'net_refunds' => array( |
|
596 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
597 | - 'type' => 'integer', |
|
598 | - 'context' => array( 'view' ), |
|
599 | - 'readonly' => true, |
|
600 | - ), |
|
601 | - 'total_discount' => array( |
|
602 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
603 | - 'type' => 'integer', |
|
604 | - 'context' => array( 'view' ), |
|
605 | - 'readonly' => true, |
|
606 | - ), |
|
607 | - 'totals' => array( |
|
608 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
609 | - 'type' => 'array', |
|
610 | - 'items' => array( |
|
611 | - 'type' => 'array', |
|
612 | - ), |
|
613 | - 'context' => array( 'view' ), |
|
614 | - 'readonly' => true, |
|
615 | - ), |
|
616 | - 'interval' => array( |
|
617 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
618 | - 'type' => 'integer', |
|
619 | - 'context' => array( 'view' ), |
|
620 | - 'readonly' => true, |
|
621 | - ), |
|
622 | - 'previous_range' => array( |
|
623 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
624 | - 'type' => 'array', |
|
625 | - 'items' => array( |
|
626 | - 'type' => 'string', |
|
627 | - ), |
|
628 | - 'context' => array( 'view' ), |
|
629 | - 'readonly' => true, |
|
630 | - ), |
|
631 | - 'grouped_by' => array( |
|
632 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
633 | - 'type' => 'string', |
|
634 | - 'context' => array( 'view' ), |
|
635 | - 'enum' => array( 'day', 'month' ), |
|
636 | - 'readonly' => true, |
|
637 | - ), |
|
638 | - 'currency' => array( |
|
639 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
640 | - 'type' => 'string', |
|
641 | - 'context' => array( 'view' ), |
|
642 | - 'readonly' => true, |
|
643 | - ), |
|
644 | - 'currency_symbol' => array( |
|
645 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
646 | - 'type' => 'string', |
|
647 | - 'context' => array( 'view' ), |
|
648 | - 'readonly' => true, |
|
649 | - ), |
|
650 | - 'currency_position' => array( |
|
651 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
652 | - 'type' => 'string', |
|
653 | - 'context' => array( 'view' ), |
|
654 | - 'readonly' => true, |
|
655 | - ), |
|
656 | - 'decimal_places' => array( |
|
657 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
658 | - 'type' => 'string', |
|
659 | - 'context' => array( 'view' ), |
|
660 | - 'readonly' => true, |
|
661 | - ), |
|
662 | - 'thousands_sep' => array( |
|
663 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
664 | - 'type' => 'string', |
|
665 | - 'context' => array( 'view' ), |
|
666 | - 'readonly' => true, |
|
667 | - ), |
|
668 | - 'decimals_sep' => array( |
|
669 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
670 | - 'type' => 'string', |
|
671 | - 'context' => array( 'view' ), |
|
672 | - 'readonly' => true, |
|
673 | - ), |
|
674 | - ), |
|
675 | - ); |
|
676 | - |
|
677 | - return $this->add_additional_fields_schema( $schema ); |
|
678 | - |
|
679 | - } |
|
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 | + protected $report_data; |
|
34 | + |
|
35 | + /** |
|
36 | + * The report range. |
|
37 | + * |
|
38 | + * @var array |
|
39 | + */ |
|
40 | + protected $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 | + 'sales' => wpinv_round_amount( 0.00 ), |
|
134 | + 'invoices' => 0, |
|
135 | + 'refunds' => wpinv_round_amount( 0.00 ), |
|
136 | + 'items' => 0, |
|
137 | + 'refunded_items' => 0, |
|
138 | + 'tax' => wpinv_round_amount( 0.00 ), |
|
139 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
140 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
141 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
142 | + 'fees' => wpinv_round_amount( 0.00 ), |
|
143 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
144 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
145 | + ); |
|
146 | + |
|
147 | + } |
|
148 | + |
|
149 | + // add total sales, total invoice count, total tax for each period |
|
150 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
151 | + foreach ( $report_data->invoices as $invoice ) { |
|
152 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
153 | + |
|
154 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
155 | + continue; |
|
156 | + } |
|
157 | + |
|
158 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
159 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
160 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
161 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
162 | + |
|
163 | + } |
|
164 | + |
|
165 | + foreach ( $report_data->refunds as $invoice ) { |
|
166 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
167 | + |
|
168 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
169 | + continue; |
|
170 | + } |
|
171 | + |
|
172 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
173 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
174 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
175 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
176 | + |
|
177 | + } |
|
178 | + |
|
179 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
180 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
181 | + |
|
182 | + if ( isset( $period_totals[ $time ] ) ) { |
|
183 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
184 | + } |
|
185 | + |
|
186 | + } |
|
187 | + |
|
188 | + // Add total invoice items for each period. |
|
189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | + |
|
192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | + } |
|
195 | + |
|
196 | + } |
|
197 | + |
|
198 | + // Add total discount for each period. |
|
199 | + foreach ( $report_data->coupons as $discount ) { |
|
200 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
201 | + |
|
202 | + if ( isset( $period_totals[ $time ] ) ) { |
|
203 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
204 | + } |
|
205 | + |
|
206 | + } |
|
207 | + |
|
208 | + $report_data->totals = $period_totals; |
|
209 | + $report_data->grouped_by = $this->groupby; |
|
210 | + $report_data->interval = max( $this->interval, 1 ); |
|
211 | + $report_data->currency = wpinv_get_currency(); |
|
212 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
213 | + $report_data->currency_position = wpinv_currency_position(); |
|
214 | + $report_data->decimal_places = wpinv_decimals(); |
|
215 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
216 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
217 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
218 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
219 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
220 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
221 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
222 | + |
|
223 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
224 | + $data = $report_data; |
|
225 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
226 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
227 | + $data = $this->filter_response_by_context( $data, $context ); |
|
228 | + |
|
229 | + // Wrap the data in a response object. |
|
230 | + $response = rest_ensure_response( $data ); |
|
231 | + $response->add_links( array( |
|
232 | + 'about' => array( |
|
233 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
234 | + ), |
|
235 | + ) ); |
|
236 | + |
|
237 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
238 | + } |
|
239 | + |
|
240 | + /** |
|
241 | + * Get report data. |
|
242 | + * |
|
243 | + * @return stdClass |
|
244 | + */ |
|
245 | + public function get_report_data() { |
|
246 | + if ( empty( $this->report_data ) ) { |
|
247 | + $this->query_report_data(); |
|
248 | + } |
|
249 | + return $this->report_data; |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * Get all data needed for this report and store in the class. |
|
254 | + */ |
|
255 | + protected function query_report_data() { |
|
256 | + |
|
257 | + // Prepare reports. |
|
258 | + $this->report_data = (object) array( |
|
259 | + 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
260 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
261 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
262 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
263 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
264 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
265 | + 'previous_range' => $this->previous_range, |
|
266 | + ); |
|
267 | + |
|
268 | + // Calculated totals. |
|
269 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
270 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
271 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
272 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
273 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
274 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
275 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
276 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
277 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
278 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
279 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
280 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
281 | + |
|
282 | + |
|
283 | + // Calculate average based on net. |
|
284 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
285 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
286 | + |
|
287 | + // Total invoices in this period, even if refunded. |
|
288 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
289 | + |
|
290 | + // Items invoiced in this period, even if refunded. |
|
291 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
292 | + |
|
293 | + // 3rd party filtering of report data |
|
294 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * Prepares invoice counts. |
|
299 | + * |
|
300 | + * @return array. |
|
301 | + */ |
|
302 | + protected function query_invoice_counts() { |
|
303 | + |
|
304 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
305 | + array( |
|
306 | + 'data' => array( |
|
307 | + 'ID' => array( |
|
308 | + 'type' => 'post_data', |
|
309 | + 'function' => 'COUNT', |
|
310 | + 'name' => 'count', |
|
311 | + 'distinct' => true, |
|
312 | + ), |
|
313 | + 'post_date' => array( |
|
314 | + 'type' => 'post_data', |
|
315 | + 'function' => '', |
|
316 | + 'name' => 'post_date', |
|
317 | + ), |
|
318 | + ), |
|
319 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
320 | + 'order_by' => 'post_date ASC', |
|
321 | + 'query_type' => 'get_results', |
|
322 | + 'filter_range' => $this->report_range, |
|
323 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
324 | + ) |
|
325 | + ); |
|
326 | + |
|
327 | + } |
|
328 | + |
|
329 | + /** |
|
330 | + * Prepares coupon counts. |
|
331 | + * |
|
332 | + * @return array. |
|
333 | + */ |
|
334 | + protected function query_coupon_counts() { |
|
335 | + |
|
336 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
337 | + array( |
|
338 | + 'data' => array( |
|
339 | + 'discount' => array( |
|
340 | + 'type' => 'invoice_data', |
|
341 | + 'function' => 'SUM', |
|
342 | + 'name' => 'discount_amount', |
|
343 | + ), |
|
344 | + 'post_date' => array( |
|
345 | + 'type' => 'post_data', |
|
346 | + 'function' => '', |
|
347 | + 'name' => 'post_date', |
|
348 | + ), |
|
349 | + ), |
|
350 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
351 | + 'order_by' => 'post_date ASC', |
|
352 | + 'query_type' => 'get_results', |
|
353 | + 'filter_range' => $this->report_range, |
|
354 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
355 | + ) |
|
356 | + ); |
|
357 | + |
|
358 | + } |
|
359 | + |
|
360 | + /** |
|
361 | + * Prepares item counts. |
|
362 | + * |
|
363 | + * @return array. |
|
364 | + */ |
|
365 | + protected function query_item_counts() { |
|
366 | + |
|
367 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
368 | + array( |
|
369 | + 'data' => array( |
|
370 | + 'quantity' => array( |
|
371 | + 'type' => 'invoice_item', |
|
372 | + 'function' => 'SUM', |
|
373 | + 'name' => 'invoice_item_count', |
|
374 | + ), |
|
375 | + 'post_date' => array( |
|
376 | + 'type' => 'post_data', |
|
377 | + 'function' => '', |
|
378 | + 'name' => 'post_date', |
|
379 | + ), |
|
380 | + ), |
|
381 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
382 | + 'order_by' => 'post_date ASC', |
|
383 | + 'query_type' => 'get_results', |
|
384 | + 'filter_range' => $this->report_range, |
|
385 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
386 | + ) |
|
387 | + ); |
|
388 | + |
|
389 | + } |
|
390 | + |
|
391 | + /** |
|
392 | + * Prepares refunded item counts. |
|
393 | + * |
|
394 | + * @return array. |
|
395 | + */ |
|
396 | + protected function count_refunded_items() { |
|
397 | + |
|
398 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
399 | + array( |
|
400 | + 'data' => array( |
|
401 | + 'quantity' => array( |
|
402 | + 'type' => 'invoice_item', |
|
403 | + 'function' => 'SUM', |
|
404 | + 'name' => 'invoice_item_count', |
|
405 | + ), |
|
406 | + ), |
|
407 | + 'query_type' => 'get_var', |
|
408 | + 'filter_range' => $this->report_range, |
|
409 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
410 | + ) |
|
411 | + ); |
|
412 | + |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * Prepares daily invoice totals. |
|
417 | + * |
|
418 | + * @return array. |
|
419 | + */ |
|
420 | + protected function query_invoice_totals() { |
|
421 | + |
|
422 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | + array( |
|
424 | + 'data' => array( |
|
425 | + 'total' => array( |
|
426 | + 'type' => 'invoice_data', |
|
427 | + 'function' => 'SUM', |
|
428 | + 'name' => 'total_sales', |
|
429 | + ), |
|
430 | + 'tax' => array( |
|
431 | + 'type' => 'invoice_data', |
|
432 | + 'function' => 'SUM', |
|
433 | + 'name' => 'total_tax', |
|
434 | + ), |
|
435 | + 'discount' => array( |
|
436 | + 'type' => 'invoice_data', |
|
437 | + 'function' => 'SUM', |
|
438 | + 'name' => 'total_discount', |
|
439 | + ), |
|
440 | + 'fees_total' => array( |
|
441 | + 'type' => 'invoice_data', |
|
442 | + 'function' => 'SUM', |
|
443 | + 'name' => 'total_fees', |
|
444 | + ), |
|
445 | + 'subtotal' => array( |
|
446 | + 'type' => 'invoice_data', |
|
447 | + 'function' => 'SUM', |
|
448 | + 'name' => 'subtotal', |
|
449 | + ), |
|
450 | + 'post_date' => array( |
|
451 | + 'type' => 'post_data', |
|
452 | + 'function' => '', |
|
453 | + 'name' => 'post_date', |
|
454 | + ), |
|
455 | + ), |
|
456 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
457 | + 'order_by' => 'post_date ASC', |
|
458 | + 'query_type' => 'get_results', |
|
459 | + 'filter_range' => $this->report_range, |
|
460 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
461 | + ) |
|
462 | + ); |
|
463 | + |
|
464 | + } |
|
465 | + |
|
466 | + /** |
|
467 | + * Prepares daily invoice totals. |
|
468 | + * |
|
469 | + * @return array. |
|
470 | + */ |
|
471 | + protected function query_refunded_totals() { |
|
472 | + |
|
473 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
474 | + array( |
|
475 | + 'data' => array( |
|
476 | + 'total' => array( |
|
477 | + 'type' => 'invoice_data', |
|
478 | + 'function' => 'SUM', |
|
479 | + 'name' => 'total_sales', |
|
480 | + ), |
|
481 | + 'tax' => array( |
|
482 | + 'type' => 'invoice_data', |
|
483 | + 'function' => 'SUM', |
|
484 | + 'name' => 'total_tax', |
|
485 | + ), |
|
486 | + 'discount' => array( |
|
487 | + 'type' => 'invoice_data', |
|
488 | + 'function' => 'SUM', |
|
489 | + 'name' => 'total_discount', |
|
490 | + ), |
|
491 | + 'fees_total' => array( |
|
492 | + 'type' => 'invoice_data', |
|
493 | + 'function' => 'SUM', |
|
494 | + 'name' => 'total_fees', |
|
495 | + ), |
|
496 | + 'subtotal' => array( |
|
497 | + 'type' => 'invoice_data', |
|
498 | + 'function' => 'SUM', |
|
499 | + 'name' => 'subtotal', |
|
500 | + ), |
|
501 | + 'post_date' => array( |
|
502 | + 'type' => 'post_data', |
|
503 | + 'function' => '', |
|
504 | + 'name' => 'post_date', |
|
505 | + ), |
|
506 | + ), |
|
507 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
508 | + 'order_by' => 'post_date ASC', |
|
509 | + 'query_type' => 'get_results', |
|
510 | + 'filter_range' => $this->report_range, |
|
511 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
512 | + ) |
|
513 | + ); |
|
514 | + |
|
515 | + } |
|
516 | + |
|
517 | + /** |
|
518 | + * Get the Report's schema, conforming to JSON Schema. |
|
519 | + * |
|
520 | + * @return array |
|
521 | + */ |
|
522 | + public function get_item_schema() { |
|
523 | + |
|
524 | + $schema = array( |
|
525 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
526 | + 'title' => 'sales_report', |
|
527 | + 'type' => 'object', |
|
528 | + 'properties' => array( |
|
529 | + 'total_sales' => array( |
|
530 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
531 | + 'type' => 'string', |
|
532 | + 'context' => array( 'view' ), |
|
533 | + 'readonly' => true, |
|
534 | + ), |
|
535 | + 'net_sales' => array( |
|
536 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
537 | + 'type' => 'string', |
|
538 | + 'context' => array( 'view' ), |
|
539 | + 'readonly' => true, |
|
540 | + ), |
|
541 | + 'average_sales' => array( |
|
542 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
543 | + 'type' => 'string', |
|
544 | + 'context' => array( 'view' ), |
|
545 | + 'readonly' => true, |
|
546 | + ), |
|
547 | + 'average_total_sales' => array( |
|
548 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
549 | + 'type' => 'string', |
|
550 | + 'context' => array( 'view' ), |
|
551 | + 'readonly' => true, |
|
552 | + ), |
|
553 | + 'total_invoices' => array( |
|
554 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
555 | + 'type' => 'integer', |
|
556 | + 'context' => array( 'view' ), |
|
557 | + 'readonly' => true, |
|
558 | + ), |
|
559 | + 'total_items' => array( |
|
560 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
561 | + 'type' => 'integer', |
|
562 | + 'context' => array( 'view' ), |
|
563 | + 'readonly' => true, |
|
564 | + ), |
|
565 | + 'refunded_items' => array( |
|
566 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
567 | + 'type' => 'integer', |
|
568 | + 'context' => array( 'view' ), |
|
569 | + 'readonly' => true, |
|
570 | + ), |
|
571 | + 'total_tax' => array( |
|
572 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
573 | + 'type' => 'string', |
|
574 | + 'context' => array( 'view' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'total_refunded_tax' => array( |
|
578 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
579 | + 'type' => 'string', |
|
580 | + 'context' => array( 'view' ), |
|
581 | + 'readonly' => true, |
|
582 | + ), |
|
583 | + 'total_fees' => array( |
|
584 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
585 | + 'type' => 'string', |
|
586 | + 'context' => array( 'view' ), |
|
587 | + 'readonly' => true, |
|
588 | + ), |
|
589 | + 'total_refunds' => array( |
|
590 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
591 | + 'type' => 'integer', |
|
592 | + 'context' => array( 'view' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'net_refunds' => array( |
|
596 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
597 | + 'type' => 'integer', |
|
598 | + 'context' => array( 'view' ), |
|
599 | + 'readonly' => true, |
|
600 | + ), |
|
601 | + 'total_discount' => array( |
|
602 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
603 | + 'type' => 'integer', |
|
604 | + 'context' => array( 'view' ), |
|
605 | + 'readonly' => true, |
|
606 | + ), |
|
607 | + 'totals' => array( |
|
608 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
609 | + 'type' => 'array', |
|
610 | + 'items' => array( |
|
611 | + 'type' => 'array', |
|
612 | + ), |
|
613 | + 'context' => array( 'view' ), |
|
614 | + 'readonly' => true, |
|
615 | + ), |
|
616 | + 'interval' => array( |
|
617 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
618 | + 'type' => 'integer', |
|
619 | + 'context' => array( 'view' ), |
|
620 | + 'readonly' => true, |
|
621 | + ), |
|
622 | + 'previous_range' => array( |
|
623 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
624 | + 'type' => 'array', |
|
625 | + 'items' => array( |
|
626 | + 'type' => 'string', |
|
627 | + ), |
|
628 | + 'context' => array( 'view' ), |
|
629 | + 'readonly' => true, |
|
630 | + ), |
|
631 | + 'grouped_by' => array( |
|
632 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
633 | + 'type' => 'string', |
|
634 | + 'context' => array( 'view' ), |
|
635 | + 'enum' => array( 'day', 'month' ), |
|
636 | + 'readonly' => true, |
|
637 | + ), |
|
638 | + 'currency' => array( |
|
639 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
640 | + 'type' => 'string', |
|
641 | + 'context' => array( 'view' ), |
|
642 | + 'readonly' => true, |
|
643 | + ), |
|
644 | + 'currency_symbol' => array( |
|
645 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
646 | + 'type' => 'string', |
|
647 | + 'context' => array( 'view' ), |
|
648 | + 'readonly' => true, |
|
649 | + ), |
|
650 | + 'currency_position' => array( |
|
651 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
652 | + 'type' => 'string', |
|
653 | + 'context' => array( 'view' ), |
|
654 | + 'readonly' => true, |
|
655 | + ), |
|
656 | + 'decimal_places' => array( |
|
657 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
658 | + 'type' => 'string', |
|
659 | + 'context' => array( 'view' ), |
|
660 | + 'readonly' => true, |
|
661 | + ), |
|
662 | + 'thousands_sep' => array( |
|
663 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
664 | + 'type' => 'string', |
|
665 | + 'context' => array( 'view' ), |
|
666 | + 'readonly' => true, |
|
667 | + ), |
|
668 | + 'decimals_sep' => array( |
|
669 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
670 | + 'type' => 'string', |
|
671 | + 'context' => array( 'view' ), |
|
672 | + 'readonly' => true, |
|
673 | + ), |
|
674 | + ), |
|
675 | + ); |
|
676 | + |
|
677 | + return $this->add_additional_fields_schema( $schema ); |
|
678 | + |
|
679 | + } |
|
680 | 680 | |
681 | 681 | } |
@@ -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,139 +102,139 @@ 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( |
|
133 | - 'sales' => wpinv_round_amount( 0.00 ), |
|
132 | + $period_totals[$time] = array( |
|
133 | + 'sales' => wpinv_round_amount(0.00), |
|
134 | 134 | 'invoices' => 0, |
135 | - 'refunds' => wpinv_round_amount( 0.00 ), |
|
135 | + 'refunds' => wpinv_round_amount(0.00), |
|
136 | 136 | 'items' => 0, |
137 | 137 | 'refunded_items' => 0, |
138 | - 'tax' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
140 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
141 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
142 | - 'fees' => wpinv_round_amount( 0.00 ), |
|
143 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
144 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
138 | + 'tax' => wpinv_round_amount(0.00), |
|
139 | + 'refunded_tax' => wpinv_round_amount(0.00), |
|
140 | + 'subtotal' => wpinv_round_amount(0.00), |
|
141 | + 'refunded_subtotal' => wpinv_round_amount(0.00), |
|
142 | + 'fees' => wpinv_round_amount(0.00), |
|
143 | + 'refunded_fees' => wpinv_round_amount(0.00), |
|
144 | + 'discount' => wpinv_round_amount(0.00), |
|
145 | 145 | ); |
146 | 146 | |
147 | 147 | } |
148 | 148 | |
149 | 149 | // add total sales, total invoice count, total tax for each period |
150 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
151 | - foreach ( $report_data->invoices as $invoice ) { |
|
152 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
150 | + $date_format = ('day' === $this->groupby) ? 'Y-m-d' : 'Y-m'; |
|
151 | + foreach ($report_data->invoices as $invoice) { |
|
152 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
153 | 153 | |
154 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
154 | + if (!isset($period_totals[$time])) { |
|
155 | 155 | continue; |
156 | 156 | } |
157 | 157 | |
158 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
159 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
160 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
161 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
158 | + $period_totals[$time]['sales'] = wpinv_round_amount($invoice->total_sales); |
|
159 | + $period_totals[$time]['tax'] = wpinv_round_amount($invoice->total_tax); |
|
160 | + $period_totals[$time]['subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
161 | + $period_totals[$time]['fees'] = wpinv_round_amount($invoice->total_fees); |
|
162 | 162 | |
163 | 163 | } |
164 | 164 | |
165 | - foreach ( $report_data->refunds as $invoice ) { |
|
166 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
165 | + foreach ($report_data->refunds as $invoice) { |
|
166 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
167 | 167 | |
168 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
168 | + if (!isset($period_totals[$time])) { |
|
169 | 169 | continue; |
170 | 170 | } |
171 | 171 | |
172 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
173 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
174 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
175 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
172 | + $period_totals[$time]['refunds'] = wpinv_round_amount($invoice->total_sales); |
|
173 | + $period_totals[$time]['refunded_tax'] = wpinv_round_amount($invoice->total_tax); |
|
174 | + $period_totals[$time]['refunded_subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
175 | + $period_totals[$time]['refunded_fees'] = wpinv_round_amount($invoice->total_fees); |
|
176 | 176 | |
177 | 177 | } |
178 | 178 | |
179 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
180 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
179 | + foreach ($report_data->invoice_counts as $invoice) { |
|
180 | + $time = date($date_format, strtotime($invoice->post_date)); |
|
181 | 181 | |
182 | - if ( isset( $period_totals[ $time ] ) ) { |
|
183 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
182 | + if (isset($period_totals[$time])) { |
|
183 | + $period_totals[$time]['invoices'] = (int) $invoice->count; |
|
184 | 184 | } |
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 | |
198 | 198 | // Add total discount for each period. |
199 | - foreach ( $report_data->coupons as $discount ) { |
|
200 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
199 | + foreach ($report_data->coupons as $discount) { |
|
200 | + $time = ('day' === $this->groupby) ? date('Y-m-d', strtotime($discount->post_date)) : date('Y-m', strtotime($discount->post_date)); |
|
201 | 201 | |
202 | - if ( isset( $period_totals[ $time ] ) ) { |
|
203 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
202 | + if (isset($period_totals[$time])) { |
|
203 | + $period_totals[$time]['discount'] = wpinv_round_amount($discount->discount_amount); |
|
204 | 204 | } |
205 | 205 | |
206 | 206 | } |
207 | 207 | |
208 | 208 | $report_data->totals = $period_totals; |
209 | 209 | $report_data->grouped_by = $this->groupby; |
210 | - $report_data->interval = max( $this->interval, 1 ); |
|
210 | + $report_data->interval = max($this->interval, 1); |
|
211 | 211 | $report_data->currency = wpinv_get_currency(); |
212 | 212 | $report_data->currency_symbol = wpinv_currency_symbol(); |
213 | 213 | $report_data->currency_position = wpinv_currency_position(); |
214 | 214 | $report_data->decimal_places = wpinv_decimals(); |
215 | 215 | $report_data->thousands_sep = wpinv_thousands_separator(); |
216 | 216 | $report_data->decimals_sep = wpinv_decimal_separator(); |
217 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
218 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
219 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
220 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
217 | + $report_data->start_date = date('Y-m-d', strtotime($this->report_range['after']) + DAY_IN_SECONDS); |
|
218 | + $report_data->end_date = date('Y-m-d', strtotime($this->report_range['before']) - DAY_IN_SECONDS); |
|
219 | + $report_data->start_date_locale = getpaid_format_date(date('Y-m-d', strtotime($this->report_range['after']) + DAY_IN_SECONDS)); |
|
220 | + $report_data->end_date_locale = getpaid_format_date(date('Y-m-d', strtotime($this->report_range['before']) - DAY_IN_SECONDS)); |
|
221 | 221 | $report_data->decimals_sep = wpinv_decimal_separator(); |
222 | 222 | |
223 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
223 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
224 | 224 | $data = $report_data; |
225 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
226 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
227 | - $data = $this->filter_response_by_context( $data, $context ); |
|
225 | + unset($data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items); |
|
226 | + $data = $this->add_additional_fields_to_object((array) $data, $request); |
|
227 | + $data = $this->filter_response_by_context($data, $context); |
|
228 | 228 | |
229 | 229 | // Wrap the data in a response object. |
230 | - $response = rest_ensure_response( $data ); |
|
231 | - $response->add_links( array( |
|
230 | + $response = rest_ensure_response($data); |
|
231 | + $response->add_links(array( |
|
232 | 232 | 'about' => array( |
233 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
233 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
234 | 234 | ), |
235 | - ) ); |
|
235 | + )); |
|
236 | 236 | |
237 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
237 | + return apply_filters('getpaid_rest_prepare_report_sales', $response, $report_data, $request); |
|
238 | 238 | } |
239 | 239 | |
240 | 240 | /** |
@@ -243,7 +243,7 @@ discard block |
||
243 | 243 | * @return stdClass |
244 | 244 | */ |
245 | 245 | public function get_report_data() { |
246 | - if ( empty( $this->report_data ) ) { |
|
246 | + if (empty($this->report_data)) { |
|
247 | 247 | $this->query_report_data(); |
248 | 248 | } |
249 | 249 | return $this->report_data; |
@@ -256,7 +256,7 @@ discard block |
||
256 | 256 | |
257 | 257 | // Prepare reports. |
258 | 258 | $this->report_data = (object) array( |
259 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
259 | + 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
260 | 260 | 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
261 | 261 | 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
262 | 262 | 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
@@ -266,32 +266,32 @@ discard block |
||
266 | 266 | ); |
267 | 267 | |
268 | 268 | // Calculated totals. |
269 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
270 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
271 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
272 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
273 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
274 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
275 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
276 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
277 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
278 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
279 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
280 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
269 | + $this->report_data->total_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_tax'))); |
|
270 | + $this->report_data->total_sales = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_sales'))); |
|
271 | + $this->report_data->total_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_discount'))); |
|
272 | + $this->report_data->total_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_fees'))); |
|
273 | + $this->report_data->subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'subtotal'))); |
|
274 | + $this->report_data->net_sales = wpinv_round_amount($this->report_data->total_sales - max(0, $this->report_data->total_tax)); |
|
275 | + $this->report_data->total_refunded_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_tax'))); |
|
276 | + $this->report_data->total_refunds = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_sales'))); |
|
277 | + $this->report_data->refunded_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_discount'))); |
|
278 | + $this->report_data->refunded_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_fees'))); |
|
279 | + $this->report_data->subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'subtotal'))); |
|
280 | + $this->report_data->net_refunds = wpinv_round_amount($this->report_data->total_refunds + max(0, $this->report_data->total_refunded_tax)); |
|
281 | 281 | |
282 | 282 | |
283 | 283 | // Calculate average based on net. |
284 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
285 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
284 | + $this->report_data->average_sales = wpinv_round_amount($this->report_data->net_sales / max($this->interval, 1), 2); |
|
285 | + $this->report_data->average_total_sales = wpinv_round_amount($this->report_data->total_sales / max($this->interval, 1), 2); |
|
286 | 286 | |
287 | 287 | // Total invoices in this period, even if refunded. |
288 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
288 | + $this->report_data->total_invoices = absint(array_sum(wp_list_pluck($this->report_data->invoice_counts, 'count'))); |
|
289 | 289 | |
290 | 290 | // Items invoiced in this period, even if refunded. |
291 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
291 | + $this->report_data->total_items = absint(array_sum(wp_list_pluck($this->report_data->invoice_items, 'invoice_item_count'))); |
|
292 | 292 | |
293 | 293 | // 3rd party filtering of report data |
294 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
294 | + $this->report_data = apply_filters('getpaid_rest_api_filter_report_data', $this->report_data); |
|
295 | 295 | } |
296 | 296 | |
297 | 297 | /** |
@@ -316,11 +316,11 @@ discard block |
||
316 | 316 | 'name' => 'post_date', |
317 | 317 | ), |
318 | 318 | ), |
319 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
319 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
320 | 320 | 'order_by' => 'post_date ASC', |
321 | 321 | 'query_type' => 'get_results', |
322 | 322 | 'filter_range' => $this->report_range, |
323 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
323 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded'), |
|
324 | 324 | ) |
325 | 325 | ); |
326 | 326 | |
@@ -347,11 +347,11 @@ discard block |
||
347 | 347 | 'name' => 'post_date', |
348 | 348 | ), |
349 | 349 | ), |
350 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
350 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
351 | 351 | 'order_by' => 'post_date ASC', |
352 | 352 | 'query_type' => 'get_results', |
353 | 353 | 'filter_range' => $this->report_range, |
354 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
354 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded'), |
|
355 | 355 | ) |
356 | 356 | ); |
357 | 357 | |
@@ -378,11 +378,11 @@ discard block |
||
378 | 378 | 'name' => 'post_date', |
379 | 379 | ), |
380 | 380 | ), |
381 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
381 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
382 | 382 | 'order_by' => 'post_date ASC', |
383 | 383 | 'query_type' => 'get_results', |
384 | 384 | 'filter_range' => $this->report_range, |
385 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded' ), |
|
385 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded'), |
|
386 | 386 | ) |
387 | 387 | ); |
388 | 388 | |
@@ -406,7 +406,7 @@ discard block |
||
406 | 406 | ), |
407 | 407 | 'query_type' => 'get_var', |
408 | 408 | 'filter_range' => $this->report_range, |
409 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
409 | + 'invoice_status' => array('wpi-refunded'), |
|
410 | 410 | ) |
411 | 411 | ); |
412 | 412 | |
@@ -453,11 +453,11 @@ discard block |
||
453 | 453 | 'name' => 'post_date', |
454 | 454 | ), |
455 | 455 | ), |
456 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
456 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
457 | 457 | 'order_by' => 'post_date ASC', |
458 | 458 | 'query_type' => 'get_results', |
459 | 459 | 'filter_range' => $this->report_range, |
460 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
460 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold'), |
|
461 | 461 | ) |
462 | 462 | ); |
463 | 463 | |
@@ -504,11 +504,11 @@ discard block |
||
504 | 504 | 'name' => 'post_date', |
505 | 505 | ), |
506 | 506 | ), |
507 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
507 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
508 | 508 | 'order_by' => 'post_date ASC', |
509 | 509 | 'query_type' => 'get_results', |
510 | 510 | 'filter_range' => $this->report_range, |
511 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
511 | + 'invoice_status' => array('wpi-refunded'), |
|
512 | 512 | ) |
513 | 513 | ); |
514 | 514 | |
@@ -527,154 +527,154 @@ discard block |
||
527 | 527 | 'type' => 'object', |
528 | 528 | 'properties' => array( |
529 | 529 | 'total_sales' => array( |
530 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
530 | + 'description' => __('Gross sales in the period.', 'invoicing'), |
|
531 | 531 | 'type' => 'string', |
532 | - 'context' => array( 'view' ), |
|
532 | + 'context' => array('view'), |
|
533 | 533 | 'readonly' => true, |
534 | 534 | ), |
535 | 535 | 'net_sales' => array( |
536 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
536 | + 'description' => __('Net sales in the period.', 'invoicing'), |
|
537 | 537 | 'type' => 'string', |
538 | - 'context' => array( 'view' ), |
|
538 | + 'context' => array('view'), |
|
539 | 539 | 'readonly' => true, |
540 | 540 | ), |
541 | 541 | 'average_sales' => array( |
542 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
542 | + 'description' => __('Average net daily sales.', 'invoicing'), |
|
543 | 543 | 'type' => 'string', |
544 | - 'context' => array( 'view' ), |
|
544 | + 'context' => array('view'), |
|
545 | 545 | 'readonly' => true, |
546 | 546 | ), |
547 | 547 | 'average_total_sales' => array( |
548 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
548 | + 'description' => __('Average gross daily sales.', 'invoicing'), |
|
549 | 549 | 'type' => 'string', |
550 | - 'context' => array( 'view' ), |
|
550 | + 'context' => array('view'), |
|
551 | 551 | 'readonly' => true, |
552 | 552 | ), |
553 | 553 | 'total_invoices' => array( |
554 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
554 | + 'description' => __('Number of paid invoices.', 'invoicing'), |
|
555 | 555 | 'type' => 'integer', |
556 | - 'context' => array( 'view' ), |
|
556 | + 'context' => array('view'), |
|
557 | 557 | 'readonly' => true, |
558 | 558 | ), |
559 | 559 | 'total_items' => array( |
560 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
560 | + 'description' => __('Number of items purchased.', 'invoicing'), |
|
561 | 561 | 'type' => 'integer', |
562 | - 'context' => array( 'view' ), |
|
562 | + 'context' => array('view'), |
|
563 | 563 | 'readonly' => true, |
564 | 564 | ), |
565 | 565 | 'refunded_items' => array( |
566 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
566 | + 'description' => __('Number of items refunded.', 'invoicing'), |
|
567 | 567 | 'type' => 'integer', |
568 | - 'context' => array( 'view' ), |
|
568 | + 'context' => array('view'), |
|
569 | 569 | 'readonly' => true, |
570 | 570 | ), |
571 | 571 | 'total_tax' => array( |
572 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
572 | + 'description' => __('Total charged for taxes.', 'invoicing'), |
|
573 | 573 | 'type' => 'string', |
574 | - 'context' => array( 'view' ), |
|
574 | + 'context' => array('view'), |
|
575 | 575 | 'readonly' => true, |
576 | 576 | ), |
577 | 577 | 'total_refunded_tax' => array( |
578 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
578 | + 'description' => __('Total refunded for taxes.', 'invoicing'), |
|
579 | 579 | 'type' => 'string', |
580 | - 'context' => array( 'view' ), |
|
580 | + 'context' => array('view'), |
|
581 | 581 | 'readonly' => true, |
582 | 582 | ), |
583 | 583 | 'total_fees' => array( |
584 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
584 | + 'description' => __('Total fees charged.', 'invoicing'), |
|
585 | 585 | 'type' => 'string', |
586 | - 'context' => array( 'view' ), |
|
586 | + 'context' => array('view'), |
|
587 | 587 | 'readonly' => true, |
588 | 588 | ), |
589 | 589 | 'total_refunds' => array( |
590 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
590 | + 'description' => __('Total of refunded invoices.', 'invoicing'), |
|
591 | 591 | 'type' => 'integer', |
592 | - 'context' => array( 'view' ), |
|
592 | + 'context' => array('view'), |
|
593 | 593 | 'readonly' => true, |
594 | 594 | ), |
595 | 595 | 'net_refunds' => array( |
596 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
596 | + 'description' => __('Net of refunded invoices.', 'invoicing'), |
|
597 | 597 | 'type' => 'integer', |
598 | - 'context' => array( 'view' ), |
|
598 | + 'context' => array('view'), |
|
599 | 599 | 'readonly' => true, |
600 | 600 | ), |
601 | 601 | 'total_discount' => array( |
602 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
602 | + 'description' => __('Total of discounts used.', 'invoicing'), |
|
603 | 603 | 'type' => 'integer', |
604 | - 'context' => array( 'view' ), |
|
604 | + 'context' => array('view'), |
|
605 | 605 | 'readonly' => true, |
606 | 606 | ), |
607 | 607 | 'totals' => array( |
608 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
608 | + 'description' => __('Totals.', 'invoicing'), |
|
609 | 609 | 'type' => 'array', |
610 | 610 | 'items' => array( |
611 | 611 | 'type' => 'array', |
612 | 612 | ), |
613 | - 'context' => array( 'view' ), |
|
613 | + 'context' => array('view'), |
|
614 | 614 | 'readonly' => true, |
615 | 615 | ), |
616 | 616 | 'interval' => array( |
617 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
617 | + 'description' => __('Number of months/days in the report period.', 'invoicing'), |
|
618 | 618 | 'type' => 'integer', |
619 | - 'context' => array( 'view' ), |
|
619 | + 'context' => array('view'), |
|
620 | 620 | 'readonly' => true, |
621 | 621 | ), |
622 | 622 | 'previous_range' => array( |
623 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
623 | + 'description' => __('The previous report period.', 'invoicing'), |
|
624 | 624 | 'type' => 'array', |
625 | 625 | 'items' => array( |
626 | 626 | 'type' => 'string', |
627 | 627 | ), |
628 | - 'context' => array( 'view' ), |
|
628 | + 'context' => array('view'), |
|
629 | 629 | 'readonly' => true, |
630 | 630 | ), |
631 | 631 | 'grouped_by' => array( |
632 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
632 | + 'description' => __('The period used to group the totals.', 'invoicing'), |
|
633 | 633 | 'type' => 'string', |
634 | - 'context' => array( 'view' ), |
|
635 | - 'enum' => array( 'day', 'month' ), |
|
634 | + 'context' => array('view'), |
|
635 | + 'enum' => array('day', 'month'), |
|
636 | 636 | 'readonly' => true, |
637 | 637 | ), |
638 | 638 | 'currency' => array( |
639 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
639 | + 'description' => __('The default store currency.', 'invoicing'), |
|
640 | 640 | 'type' => 'string', |
641 | - 'context' => array( 'view' ), |
|
641 | + 'context' => array('view'), |
|
642 | 642 | 'readonly' => true, |
643 | 643 | ), |
644 | 644 | 'currency_symbol' => array( |
645 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
645 | + 'description' => __('The default store currency symbol.', 'invoicing'), |
|
646 | 646 | 'type' => 'string', |
647 | - 'context' => array( 'view' ), |
|
647 | + 'context' => array('view'), |
|
648 | 648 | 'readonly' => true, |
649 | 649 | ), |
650 | 650 | 'currency_position' => array( |
651 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
651 | + 'description' => __('The default store currency position.', 'invoicing'), |
|
652 | 652 | 'type' => 'string', |
653 | - 'context' => array( 'view' ), |
|
653 | + 'context' => array('view'), |
|
654 | 654 | 'readonly' => true, |
655 | 655 | ), |
656 | 656 | 'decimal_places' => array( |
657 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
657 | + 'description' => __('The default store decimal places.', 'invoicing'), |
|
658 | 658 | 'type' => 'string', |
659 | - 'context' => array( 'view' ), |
|
659 | + 'context' => array('view'), |
|
660 | 660 | 'readonly' => true, |
661 | 661 | ), |
662 | 662 | 'thousands_sep' => array( |
663 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
663 | + 'description' => __('The default store thousands separator.', 'invoicing'), |
|
664 | 664 | 'type' => 'string', |
665 | - 'context' => array( 'view' ), |
|
665 | + 'context' => array('view'), |
|
666 | 666 | 'readonly' => true, |
667 | 667 | ), |
668 | 668 | 'decimals_sep' => array( |
669 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
669 | + 'description' => __('The default store decimals separator.', 'invoicing'), |
|
670 | 670 | 'type' => 'string', |
671 | - 'context' => array( 'view' ), |
|
671 | + 'context' => array('view'), |
|
672 | 672 | 'readonly' => true, |
673 | 673 | ), |
674 | 674 | ), |
675 | 675 | ); |
676 | 676 | |
677 | - return $this->add_additional_fields_schema( $schema ); |
|
677 | + return $this->add_additional_fields_schema($schema); |
|
678 | 678 | |
679 | 679 | } |
680 | 680 |
@@ -16,479 +16,479 @@ |
||
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', '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 ( ( $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( '+1 day', current_time( 'timestamp' ) ) ), |
|
181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week' ) ), |
|
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-d', strtotime( '+1 day', 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 year date range. |
|
366 | - * |
|
367 | - * @return array The appropriate date range. |
|
368 | - */ |
|
369 | - public function get_year_date_range() { |
|
370 | - |
|
371 | - $this->groupby = 'month'; |
|
372 | - |
|
373 | - // Set the previous date range. |
|
374 | - $this->previous_range = array( |
|
375 | - 'period' => 'last_year', |
|
376 | - ); |
|
377 | - |
|
378 | - // Generate the report. |
|
379 | - return array( |
|
380 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
381 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
382 | - ); |
|
383 | - |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Retrieves last year date range. |
|
388 | - * |
|
389 | - * @return array The appropriate date range. |
|
390 | - */ |
|
391 | - public function get_last_year_date_range() { |
|
392 | - |
|
393 | - $this->groupby = 'month'; |
|
394 | - |
|
395 | - // Set the previous date range. |
|
396 | - $year = (int) date('Y') - 3; |
|
397 | - $this->previous_range = array( |
|
398 | - 'period' => 'custom', |
|
399 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
400 | - 'after' => "$year-12-31", |
|
401 | - ); |
|
402 | - |
|
403 | - // Generate the report. |
|
404 | - $year = (int) date('Y') - 2; |
|
405 | - return array( |
|
406 | - 'after' => "$year-12-31", |
|
407 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
408 | - ); |
|
409 | - |
|
410 | - } |
|
411 | - |
|
412 | - /** |
|
413 | - * Prepare a the request date for SQL usage. |
|
414 | - * |
|
415 | - * @param WP_REST_Request $request Request object. |
|
416 | - * @param string $date_field The date field. |
|
417 | - * @return string The appropriate SQL. |
|
418 | - */ |
|
419 | - public function get_date_range_sql( $request, $date_field ) { |
|
420 | - global $wpdb; |
|
421 | - |
|
422 | - $sql = '1=1'; |
|
423 | - $range = $this->get_date_range( $request ); |
|
424 | - |
|
425 | - if ( ! empty( $range['after'] ) ) { |
|
426 | - $sql .= ' AND ' . $wpdb->prepare( |
|
427 | - "$date_field > %s", |
|
428 | - $range['after'] |
|
429 | - ); |
|
430 | - } |
|
431 | - |
|
432 | - if ( ! empty( $range['before'] ) ) { |
|
433 | - $sql .= ' AND ' . $wpdb->prepare( |
|
434 | - "$date_field < %s", |
|
435 | - $range['before'] |
|
436 | - ); |
|
437 | - } |
|
438 | - |
|
439 | - return $sql; |
|
440 | - |
|
441 | - } |
|
442 | - |
|
443 | - /** |
|
444 | - * Prepares a group by query. |
|
445 | - * |
|
446 | - * @param string $date_field The date field. |
|
447 | - * @return string The appropriate SQL. |
|
448 | - */ |
|
449 | - public function get_group_by_sql( $date_field ) { |
|
450 | - |
|
451 | - if ( 'day' === $this->groupby ) { |
|
452 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
453 | - } |
|
454 | - |
|
455 | - return "YEAR($date_field), MONTH($date_field)"; |
|
456 | - } |
|
457 | - |
|
458 | - /** |
|
459 | - * Get the query params for collections. |
|
460 | - * |
|
461 | - * @return array |
|
462 | - */ |
|
463 | - public function get_collection_params() { |
|
464 | - return array( |
|
465 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
466 | - 'period' => array( |
|
467 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
468 | - 'type' => 'string', |
|
469 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
470 | - 'validate_callback' => 'rest_validate_request_arg', |
|
471 | - 'sanitize_callback' => 'sanitize_text_field', |
|
472 | - 'default' => '7_days', |
|
473 | - ), |
|
474 | - 'after' => array( |
|
475 | - /* translators: %s: date format */ |
|
476 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
477 | - 'type' => 'string', |
|
478 | - 'format' => 'date', |
|
479 | - 'validate_callback' => 'rest_validate_request_arg', |
|
480 | - 'sanitize_callback' => 'sanitize_text_field', |
|
481 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
482 | - ), |
|
483 | - 'before' => array( |
|
484 | - /* translators: %s: date format */ |
|
485 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
486 | - 'type' => 'string', |
|
487 | - 'format' => 'date', |
|
488 | - 'validate_callback' => 'rest_validate_request_arg', |
|
489 | - 'sanitize_callback' => 'sanitize_text_field', |
|
490 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
491 | - ), |
|
492 | - ); |
|
493 | - } |
|
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', '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 ( ( $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( '+1 day', current_time( 'timestamp' ) ) ), |
|
181 | + 'after' => date( 'Y-m-d', strtotime( 'sunday last week' ) ), |
|
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-d', strtotime( '+1 day', 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 year date range. |
|
366 | + * |
|
367 | + * @return array The appropriate date range. |
|
368 | + */ |
|
369 | + public function get_year_date_range() { |
|
370 | + |
|
371 | + $this->groupby = 'month'; |
|
372 | + |
|
373 | + // Set the previous date range. |
|
374 | + $this->previous_range = array( |
|
375 | + 'period' => 'last_year', |
|
376 | + ); |
|
377 | + |
|
378 | + // Generate the report. |
|
379 | + return array( |
|
380 | + 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
381 | + 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
382 | + ); |
|
383 | + |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Retrieves last year date range. |
|
388 | + * |
|
389 | + * @return array The appropriate date range. |
|
390 | + */ |
|
391 | + public function get_last_year_date_range() { |
|
392 | + |
|
393 | + $this->groupby = 'month'; |
|
394 | + |
|
395 | + // Set the previous date range. |
|
396 | + $year = (int) date('Y') - 3; |
|
397 | + $this->previous_range = array( |
|
398 | + 'period' => 'custom', |
|
399 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
400 | + 'after' => "$year-12-31", |
|
401 | + ); |
|
402 | + |
|
403 | + // Generate the report. |
|
404 | + $year = (int) date('Y') - 2; |
|
405 | + return array( |
|
406 | + 'after' => "$year-12-31", |
|
407 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
408 | + ); |
|
409 | + |
|
410 | + } |
|
411 | + |
|
412 | + /** |
|
413 | + * Prepare a the request date for SQL usage. |
|
414 | + * |
|
415 | + * @param WP_REST_Request $request Request object. |
|
416 | + * @param string $date_field The date field. |
|
417 | + * @return string The appropriate SQL. |
|
418 | + */ |
|
419 | + public function get_date_range_sql( $request, $date_field ) { |
|
420 | + global $wpdb; |
|
421 | + |
|
422 | + $sql = '1=1'; |
|
423 | + $range = $this->get_date_range( $request ); |
|
424 | + |
|
425 | + if ( ! empty( $range['after'] ) ) { |
|
426 | + $sql .= ' AND ' . $wpdb->prepare( |
|
427 | + "$date_field > %s", |
|
428 | + $range['after'] |
|
429 | + ); |
|
430 | + } |
|
431 | + |
|
432 | + if ( ! empty( $range['before'] ) ) { |
|
433 | + $sql .= ' AND ' . $wpdb->prepare( |
|
434 | + "$date_field < %s", |
|
435 | + $range['before'] |
|
436 | + ); |
|
437 | + } |
|
438 | + |
|
439 | + return $sql; |
|
440 | + |
|
441 | + } |
|
442 | + |
|
443 | + /** |
|
444 | + * Prepares a group by query. |
|
445 | + * |
|
446 | + * @param string $date_field The date field. |
|
447 | + * @return string The appropriate SQL. |
|
448 | + */ |
|
449 | + public function get_group_by_sql( $date_field ) { |
|
450 | + |
|
451 | + if ( 'day' === $this->groupby ) { |
|
452 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
453 | + } |
|
454 | + |
|
455 | + return "YEAR($date_field), MONTH($date_field)"; |
|
456 | + } |
|
457 | + |
|
458 | + /** |
|
459 | + * Get the query params for collections. |
|
460 | + * |
|
461 | + * @return array |
|
462 | + */ |
|
463 | + public function get_collection_params() { |
|
464 | + return array( |
|
465 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
466 | + 'period' => array( |
|
467 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
468 | + 'type' => 'string', |
|
469 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
470 | + 'validate_callback' => 'rest_validate_request_arg', |
|
471 | + 'sanitize_callback' => 'sanitize_text_field', |
|
472 | + 'default' => '7_days', |
|
473 | + ), |
|
474 | + 'after' => array( |
|
475 | + /* translators: %s: date format */ |
|
476 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
477 | + 'type' => 'string', |
|
478 | + 'format' => 'date', |
|
479 | + 'validate_callback' => 'rest_validate_request_arg', |
|
480 | + 'sanitize_callback' => 'sanitize_text_field', |
|
481 | + 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
482 | + ), |
|
483 | + 'before' => array( |
|
484 | + /* translators: %s: date format */ |
|
485 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
486 | + 'type' => 'string', |
|
487 | + 'format' => 'date', |
|
488 | + 'validate_callback' => 'rest_validate_request_arg', |
|
489 | + 'sanitize_callback' => 'sanitize_text_field', |
|
490 | + 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
491 | + ), |
|
492 | + ); |
|
493 | + } |
|
494 | 494 | } |
@@ -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', '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', '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 ( ( $before - $after ) / MONTH_IN_SECONDS > 3 ) { |
|
104 | + if (($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( '+1 day', current_time( 'timestamp' ) ) ), |
|
181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week' ) ), |
|
180 | + 'before' => date('Y-m-d', strtotime('+1 day', current_time('timestamp'))), |
|
181 | + 'after' => date('Y-m-d', strtotime('sunday last week')), |
|
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-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
336 | + 'before' => date('Y-m-d', strtotime('+1 day', 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 | } |
@@ -377,8 +377,8 @@ discard block |
||
377 | 377 | |
378 | 378 | // Generate the report. |
379 | 379 | return array( |
380 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
381 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
380 | + 'before' => date('Y-m-d', strtotime('+1 day', current_time('timestamp'))), |
|
381 | + 'after' => date('Y-m-d', strtotime('last year December 31st', current_time('timestamp'))), |
|
382 | 382 | ); |
383 | 383 | |
384 | 384 | } |
@@ -396,15 +396,15 @@ discard block |
||
396 | 396 | $year = (int) date('Y') - 3; |
397 | 397 | $this->previous_range = array( |
398 | 398 | 'period' => 'custom', |
399 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
399 | + 'before' => date('Y-m-d', strtotime('first day of january last year', current_time('timestamp'))), |
|
400 | 400 | 'after' => "$year-12-31", |
401 | 401 | ); |
402 | 402 | |
403 | 403 | // Generate the report. |
404 | - $year = (int) date('Y') - 2; |
|
404 | + $year = (int) date('Y') - 2; |
|
405 | 405 | return array( |
406 | 406 | 'after' => "$year-12-31", |
407 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
407 | + 'before' => date('Y-m-d', strtotime('first day of january this year', current_time('timestamp'))), |
|
408 | 408 | ); |
409 | 409 | |
410 | 410 | } |
@@ -416,21 +416,21 @@ discard block |
||
416 | 416 | * @param string $date_field The date field. |
417 | 417 | * @return string The appropriate SQL. |
418 | 418 | */ |
419 | - public function get_date_range_sql( $request, $date_field ) { |
|
419 | + public function get_date_range_sql($request, $date_field) { |
|
420 | 420 | global $wpdb; |
421 | 421 | |
422 | 422 | $sql = '1=1'; |
423 | - $range = $this->get_date_range( $request ); |
|
423 | + $range = $this->get_date_range($request); |
|
424 | 424 | |
425 | - if ( ! empty( $range['after'] ) ) { |
|
426 | - $sql .= ' AND ' . $wpdb->prepare( |
|
425 | + if (!empty($range['after'])) { |
|
426 | + $sql .= ' AND ' . $wpdb->prepare( |
|
427 | 427 | "$date_field > %s", |
428 | 428 | $range['after'] |
429 | 429 | ); |
430 | 430 | } |
431 | 431 | |
432 | - if ( ! empty( $range['before'] ) ) { |
|
433 | - $sql .= ' AND ' . $wpdb->prepare( |
|
432 | + if (!empty($range['before'])) { |
|
433 | + $sql .= ' AND ' . $wpdb->prepare( |
|
434 | 434 | "$date_field < %s", |
435 | 435 | $range['before'] |
436 | 436 | ); |
@@ -446,9 +446,9 @@ discard block |
||
446 | 446 | * @param string $date_field The date field. |
447 | 447 | * @return string The appropriate SQL. |
448 | 448 | */ |
449 | - public function get_group_by_sql( $date_field ) { |
|
449 | + public function get_group_by_sql($date_field) { |
|
450 | 450 | |
451 | - if ( 'day' === $this->groupby ) { |
|
451 | + if ('day' === $this->groupby) { |
|
452 | 452 | return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
453 | 453 | } |
454 | 454 | |
@@ -462,32 +462,32 @@ discard block |
||
462 | 462 | */ |
463 | 463 | public function get_collection_params() { |
464 | 464 | return array( |
465 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
465 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
466 | 466 | 'period' => array( |
467 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
467 | + 'description' => __('Limit to results of a specific period.', 'invoicing'), |
|
468 | 468 | 'type' => 'string', |
469 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
469 | + 'enum' => array('custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'year', 'last_year', 'quarter', 'last_quarter'), |
|
470 | 470 | 'validate_callback' => 'rest_validate_request_arg', |
471 | 471 | 'sanitize_callback' => 'sanitize_text_field', |
472 | 472 | 'default' => '7_days', |
473 | 473 | ), |
474 | 474 | 'after' => array( |
475 | 475 | /* translators: %s: date format */ |
476 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
476 | + 'description' => sprintf(__('Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
477 | 477 | 'type' => 'string', |
478 | 478 | 'format' => 'date', |
479 | 479 | 'validate_callback' => 'rest_validate_request_arg', |
480 | 480 | 'sanitize_callback' => 'sanitize_text_field', |
481 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
481 | + 'default' => date('Y-m-d', strtotime('-8 days', current_time('timestamp'))), |
|
482 | 482 | ), |
483 | 483 | 'before' => array( |
484 | 484 | /* translators: %s: date format */ |
485 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
485 | + 'description' => sprintf(__('Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
486 | 486 | 'type' => 'string', |
487 | 487 | 'format' => 'date', |
488 | 488 | 'validate_callback' => 'rest_validate_request_arg', |
489 | 489 | 'sanitize_callback' => 'sanitize_text_field', |
490 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
490 | + 'default' => date('Y-m-d', current_time('timestamp')), |
|
491 | 491 | ), |
492 | 492 | ); |
493 | 493 | } |
@@ -12,43 +12,43 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report { |
14 | 14 | |
15 | - /** |
|
16 | - * Retrieves the earning graphs. |
|
17 | - * |
|
18 | - */ |
|
19 | - public function get_graphs() { |
|
15 | + /** |
|
16 | + * Retrieves the earning graphs. |
|
17 | + * |
|
18 | + */ |
|
19 | + public function get_graphs() { |
|
20 | 20 | |
21 | - $graphs = array( |
|
21 | + $graphs = array( |
|
22 | 22 | |
23 | 23 | 'total' => __( 'Earnings', 'invoicing' ), |
24 | 24 | 'discount' => __( 'Discount', 'invoicing' ), |
25 | - 'fees_total' => __( 'Fees', 'invoicing' ), |
|
26 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
25 | + 'fees_total' => __( 'Fees', 'invoicing' ), |
|
26 | + 'tax' => __( 'Tax', 'invoicing' ), |
|
27 | 27 | |
28 | - ); |
|
28 | + ); |
|
29 | 29 | |
30 | - return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
30 | + return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
31 | 31 | |
32 | - } |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * Retrieves the earning sql. |
|
36 | - * |
|
37 | - */ |
|
38 | - public function get_sql( $range ) { |
|
39 | - global $wpdb; |
|
34 | + /** |
|
35 | + * Retrieves the earning sql. |
|
36 | + * |
|
37 | + */ |
|
38 | + public function get_sql( $range ) { |
|
39 | + global $wpdb; |
|
40 | 40 | |
41 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
42 | - $clauses = $this->get_range_sql( $range ); |
|
43 | - $graphs = array_keys( $this->get_graphs() ); |
|
44 | - $graphs_sql = array(); |
|
41 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
42 | + $clauses = $this->get_range_sql( $range ); |
|
43 | + $graphs = array_keys( $this->get_graphs() ); |
|
44 | + $graphs_sql = array(); |
|
45 | 45 | |
46 | - foreach ( $graphs as $graph ) { |
|
47 | - $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
48 | - } |
|
46 | + foreach ( $graphs as $graph ) { |
|
47 | + $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
48 | + } |
|
49 | 49 | |
50 | - $graphs_sql = implode( ', ', $graphs_sql ); |
|
51 | - $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
50 | + $graphs_sql = implode( ', ', $graphs_sql ); |
|
51 | + $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
52 | 52 | FROM $wpdb->posts |
53 | 53 | LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID |
54 | 54 | WHERE meta.post_id IS NOT NULL |
@@ -58,94 +58,94 @@ discard block |
||
58 | 58 | GROUP BY {$clauses[0]} |
59 | 59 | "; |
60 | 60 | |
61 | - return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
62 | - |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * Prepares the report stats. |
|
67 | - * |
|
68 | - */ |
|
69 | - public function prepare_stats() { |
|
70 | - global $wpdb; |
|
71 | - $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * Retrieves report labels. |
|
76 | - * |
|
77 | - */ |
|
78 | - public function get_labels( $range ) { |
|
79 | - |
|
80 | - $labels = array( |
|
81 | - 'today' => $this->get_hours_in_a_day(), |
|
82 | - 'yesterday' => $this->get_hours_in_a_day(), |
|
83 | - '7_days' => $this->get_days_in_period( 7 ), |
|
84 | - '30_days' => $this->get_days_in_period( 30 ), |
|
85 | - '60_days' => $this->get_days_in_period( 60 ), |
|
86 | - '90_days' => $this->get_weeks_in_period( 90 ), |
|
87 | - '180_days' => $this->get_weeks_in_period( 180 ), |
|
88 | - '360_days' => $this->get_weeks_in_period( 360 ), |
|
89 | - ); |
|
90 | - |
|
91 | - $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
92 | - return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Retrieves report datasets. |
|
97 | - * |
|
98 | - */ |
|
99 | - public function get_datasets( $labels ) { |
|
100 | - |
|
101 | - $datasets = array(); |
|
102 | - |
|
103 | - foreach ( $this->get_graphs() as $key => $label ) { |
|
104 | - $datasets[ $key ] = array( |
|
105 | - 'label' => $label, |
|
106 | - 'data' => $this->get_data( $key, $labels ) |
|
107 | - ); |
|
108 | - } |
|
109 | - |
|
110 | - return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Retrieves report data. |
|
115 | - * |
|
116 | - */ |
|
117 | - public function get_data( $key, $labels ) { |
|
118 | - |
|
119 | - $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
120 | - $prepared = array(); |
|
121 | - |
|
122 | - foreach ( $labels as $label ) { |
|
123 | - |
|
124 | - $value = 0; |
|
125 | - if ( isset( $data[ $label ] ) ) { |
|
126 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
127 | - } |
|
128 | - |
|
129 | - $prepared[] = $value; |
|
130 | - } |
|
131 | - |
|
132 | - return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
133 | - |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Displays the report card. |
|
138 | - * |
|
139 | - */ |
|
140 | - public function display() { |
|
141 | - |
|
142 | - $labels = $this->get_labels( $this->get_range() ); |
|
143 | - $chart_data = array( |
|
144 | - 'labels' => array_values( $labels ), |
|
145 | - 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
146 | - ); |
|
147 | - |
|
148 | - ?> |
|
61 | + return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
62 | + |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * Prepares the report stats. |
|
67 | + * |
|
68 | + */ |
|
69 | + public function prepare_stats() { |
|
70 | + global $wpdb; |
|
71 | + $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * Retrieves report labels. |
|
76 | + * |
|
77 | + */ |
|
78 | + public function get_labels( $range ) { |
|
79 | + |
|
80 | + $labels = array( |
|
81 | + 'today' => $this->get_hours_in_a_day(), |
|
82 | + 'yesterday' => $this->get_hours_in_a_day(), |
|
83 | + '7_days' => $this->get_days_in_period( 7 ), |
|
84 | + '30_days' => $this->get_days_in_period( 30 ), |
|
85 | + '60_days' => $this->get_days_in_period( 60 ), |
|
86 | + '90_days' => $this->get_weeks_in_period( 90 ), |
|
87 | + '180_days' => $this->get_weeks_in_period( 180 ), |
|
88 | + '360_days' => $this->get_weeks_in_period( 360 ), |
|
89 | + ); |
|
90 | + |
|
91 | + $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
92 | + return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Retrieves report datasets. |
|
97 | + * |
|
98 | + */ |
|
99 | + public function get_datasets( $labels ) { |
|
100 | + |
|
101 | + $datasets = array(); |
|
102 | + |
|
103 | + foreach ( $this->get_graphs() as $key => $label ) { |
|
104 | + $datasets[ $key ] = array( |
|
105 | + 'label' => $label, |
|
106 | + 'data' => $this->get_data( $key, $labels ) |
|
107 | + ); |
|
108 | + } |
|
109 | + |
|
110 | + return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Retrieves report data. |
|
115 | + * |
|
116 | + */ |
|
117 | + public function get_data( $key, $labels ) { |
|
118 | + |
|
119 | + $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
120 | + $prepared = array(); |
|
121 | + |
|
122 | + foreach ( $labels as $label ) { |
|
123 | + |
|
124 | + $value = 0; |
|
125 | + if ( isset( $data[ $label ] ) ) { |
|
126 | + $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
127 | + } |
|
128 | + |
|
129 | + $prepared[] = $value; |
|
130 | + } |
|
131 | + |
|
132 | + return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
133 | + |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Displays the report card. |
|
138 | + * |
|
139 | + */ |
|
140 | + public function display() { |
|
141 | + |
|
142 | + $labels = $this->get_labels( $this->get_range() ); |
|
143 | + $chart_data = array( |
|
144 | + 'labels' => array_values( $labels ), |
|
145 | + 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
146 | + ); |
|
147 | + |
|
148 | + ?> |
|
149 | 149 | |
150 | 150 | <?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?> |
151 | 151 | <div class="row mb-4"> |
@@ -165,15 +165,15 @@ discard block |
||
165 | 165 | |
166 | 166 | <?php |
167 | 167 | |
168 | - } |
|
168 | + } |
|
169 | 169 | |
170 | - /** |
|
171 | - * Displays the actual report. |
|
172 | - * |
|
173 | - */ |
|
174 | - public function display_graph( $key, $dataset, $labels ) { |
|
170 | + /** |
|
171 | + * Displays the actual report. |
|
172 | + * |
|
173 | + */ |
|
174 | + public function display_graph( $key, $dataset, $labels ) { |
|
175 | 175 | |
176 | - ?> |
|
176 | + ?> |
|
177 | 177 | |
178 | 178 | <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas> |
179 | 179 | |
@@ -223,20 +223,20 @@ discard block |
||
223 | 223 | </script> |
224 | 224 | |
225 | 225 | <?php |
226 | - } |
|
226 | + } |
|
227 | 227 | |
228 | - /** |
|
229 | - * Displays the actual report. |
|
230 | - * |
|
231 | - */ |
|
232 | - public function display_stats() {} |
|
228 | + /** |
|
229 | + * Displays the actual report. |
|
230 | + * |
|
231 | + */ |
|
232 | + public function display_stats() {} |
|
233 | 233 | |
234 | - /** |
|
235 | - * Displays the range selector. |
|
236 | - * |
|
237 | - */ |
|
238 | - public function display_range_selector() { |
|
234 | + /** |
|
235 | + * Displays the range selector. |
|
236 | + * |
|
237 | + */ |
|
238 | + public function display_range_selector() { |
|
239 | 239 | |
240 | - } |
|
240 | + } |
|
241 | 241 | |
242 | 242 | } |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * |
6 | 6 | */ |
7 | 7 | |
8 | -defined( 'ABSPATH' ) || exit; |
|
8 | +defined('ABSPATH') || exit; |
|
9 | 9 | |
10 | 10 | /** |
11 | 11 | * GetPaid_Reports_Report_Earnings Class. |
@@ -20,14 +20,14 @@ discard block |
||
20 | 20 | |
21 | 21 | $graphs = array( |
22 | 22 | |
23 | - 'total' => __( 'Earnings', 'invoicing' ), |
|
24 | - 'discount' => __( 'Discount', 'invoicing' ), |
|
25 | - 'fees_total' => __( 'Fees', 'invoicing' ), |
|
26 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
23 | + 'total' => __('Earnings', 'invoicing'), |
|
24 | + 'discount' => __('Discount', 'invoicing'), |
|
25 | + 'fees_total' => __('Fees', 'invoicing'), |
|
26 | + 'tax' => __('Tax', 'invoicing'), |
|
27 | 27 | |
28 | 28 | ); |
29 | 29 | |
30 | - return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
30 | + return apply_filters('getpaid_earning_graphs', $graphs); |
|
31 | 31 | |
32 | 32 | } |
33 | 33 | |
@@ -35,19 +35,19 @@ discard block |
||
35 | 35 | * Retrieves the earning sql. |
36 | 36 | * |
37 | 37 | */ |
38 | - public function get_sql( $range ) { |
|
38 | + public function get_sql($range) { |
|
39 | 39 | global $wpdb; |
40 | 40 | |
41 | 41 | $table = $wpdb->prefix . 'getpaid_invoices'; |
42 | - $clauses = $this->get_range_sql( $range ); |
|
43 | - $graphs = array_keys( $this->get_graphs() ); |
|
42 | + $clauses = $this->get_range_sql($range); |
|
43 | + $graphs = array_keys($this->get_graphs()); |
|
44 | 44 | $graphs_sql = array(); |
45 | 45 | |
46 | - foreach ( $graphs as $graph ) { |
|
46 | + foreach ($graphs as $graph) { |
|
47 | 47 | $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
48 | 48 | } |
49 | 49 | |
50 | - $graphs_sql = implode( ', ', $graphs_sql ); |
|
50 | + $graphs_sql = implode(', ', $graphs_sql); |
|
51 | 51 | $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
52 | 52 | FROM $wpdb->posts |
53 | 53 | LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | GROUP BY {$clauses[0]} |
59 | 59 | "; |
60 | 60 | |
61 | - return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
61 | + return apply_filters('getpaid_earning_graphs_get_sql', $sql, $range); |
|
62 | 62 | |
63 | 63 | } |
64 | 64 | |
@@ -68,68 +68,68 @@ discard block |
||
68 | 68 | */ |
69 | 69 | public function prepare_stats() { |
70 | 70 | global $wpdb; |
71 | - $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
71 | + $this->stats = $wpdb->get_results($this->get_sql($this->get_range())); |
|
72 | 72 | } |
73 | 73 | |
74 | 74 | /** |
75 | 75 | * Retrieves report labels. |
76 | 76 | * |
77 | 77 | */ |
78 | - public function get_labels( $range ) { |
|
78 | + public function get_labels($range) { |
|
79 | 79 | |
80 | 80 | $labels = array( |
81 | 81 | 'today' => $this->get_hours_in_a_day(), |
82 | 82 | 'yesterday' => $this->get_hours_in_a_day(), |
83 | - '7_days' => $this->get_days_in_period( 7 ), |
|
84 | - '30_days' => $this->get_days_in_period( 30 ), |
|
85 | - '60_days' => $this->get_days_in_period( 60 ), |
|
86 | - '90_days' => $this->get_weeks_in_period( 90 ), |
|
87 | - '180_days' => $this->get_weeks_in_period( 180 ), |
|
88 | - '360_days' => $this->get_weeks_in_period( 360 ), |
|
83 | + '7_days' => $this->get_days_in_period(7), |
|
84 | + '30_days' => $this->get_days_in_period(30), |
|
85 | + '60_days' => $this->get_days_in_period(60), |
|
86 | + '90_days' => $this->get_weeks_in_period(90), |
|
87 | + '180_days' => $this->get_weeks_in_period(180), |
|
88 | + '360_days' => $this->get_weeks_in_period(360), |
|
89 | 89 | ); |
90 | 90 | |
91 | - $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
92 | - return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
91 | + $label = isset($labels[$range]) ? $labels[$range] : $labels['7_days']; |
|
92 | + return apply_filters('getpaid_earning_graphs_get_labels', $label, $range); |
|
93 | 93 | } |
94 | 94 | |
95 | 95 | /** |
96 | 96 | * Retrieves report datasets. |
97 | 97 | * |
98 | 98 | */ |
99 | - public function get_datasets( $labels ) { |
|
99 | + public function get_datasets($labels) { |
|
100 | 100 | |
101 | 101 | $datasets = array(); |
102 | 102 | |
103 | - foreach ( $this->get_graphs() as $key => $label ) { |
|
104 | - $datasets[ $key ] = array( |
|
103 | + foreach ($this->get_graphs() as $key => $label) { |
|
104 | + $datasets[$key] = array( |
|
105 | 105 | 'label' => $label, |
106 | - 'data' => $this->get_data( $key, $labels ) |
|
106 | + 'data' => $this->get_data($key, $labels) |
|
107 | 107 | ); |
108 | 108 | } |
109 | 109 | |
110 | - return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
110 | + return apply_filters('getpaid_earning_graphs_get_datasets', $datasets, $labels); |
|
111 | 111 | } |
112 | 112 | |
113 | 113 | /** |
114 | 114 | * Retrieves report data. |
115 | 115 | * |
116 | 116 | */ |
117 | - public function get_data( $key, $labels ) { |
|
117 | + public function get_data($key, $labels) { |
|
118 | 118 | |
119 | - $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
119 | + $data = wp_list_pluck($this->stats, $key, 'completed_date'); |
|
120 | 120 | $prepared = array(); |
121 | 121 | |
122 | - foreach ( $labels as $label ) { |
|
122 | + foreach ($labels as $label) { |
|
123 | 123 | |
124 | 124 | $value = 0; |
125 | - if ( isset( $data[ $label ] ) ) { |
|
126 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
125 | + if (isset($data[$label])) { |
|
126 | + $value = wpinv_round_amount(wpinv_sanitize_amount($data[$label])); |
|
127 | 127 | } |
128 | 128 | |
129 | 129 | $prepared[] = $value; |
130 | 130 | } |
131 | 131 | |
132 | - return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
132 | + return apply_filters('getpaid_earning_graphs_get_data', $prepared, $key, $labels); |
|
133 | 133 | |
134 | 134 | } |
135 | 135 | |
@@ -139,15 +139,15 @@ discard block |
||
139 | 139 | */ |
140 | 140 | public function display() { |
141 | 141 | |
142 | - $labels = $this->get_labels( $this->get_range() ); |
|
142 | + $labels = $this->get_labels($this->get_range()); |
|
143 | 143 | $chart_data = array( |
144 | - 'labels' => array_values( $labels ), |
|
145 | - 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
144 | + 'labels' => array_values($labels), |
|
145 | + 'datasets' => $this->get_datasets(array_keys($labels)), |
|
146 | 146 | ); |
147 | 147 | |
148 | 148 | ?> |
149 | 149 | |
150 | - <?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?> |
|
150 | + <?php foreach ($chart_data['datasets'] as $key => $dataset) : ?> |
|
151 | 151 | <div class="row mb-4"> |
152 | 152 | <div class="col-12"> |
153 | 153 | <div class="card m-0 p-0" style="max-width:100%"> |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | <?php $this->display_range_selector(); ?> |
157 | 157 | </div> |
158 | 158 | <div class="card-body"> |
159 | - <?php $this->display_graph( $key, $dataset, $chart_data['labels'] ); ?> |
|
159 | + <?php $this->display_graph($key, $dataset, $chart_data['labels']); ?> |
|
160 | 160 | </div> |
161 | 161 | </div> |
162 | 162 | </div> |
@@ -171,26 +171,26 @@ discard block |
||
171 | 171 | * Displays the actual report. |
172 | 172 | * |
173 | 173 | */ |
174 | - public function display_graph( $key, $dataset, $labels ) { |
|
174 | + public function display_graph($key, $dataset, $labels) { |
|
175 | 175 | |
176 | 176 | ?> |
177 | 177 | |
178 | - <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas> |
|
178 | + <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key($key); ?>"></canvas> |
|
179 | 179 | |
180 | 180 | <script> |
181 | 181 | window.addEventListener( 'DOMContentLoaded', function() { |
182 | 182 | |
183 | - var ctx = document.getElementById( 'getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>' ).getContext('2d'); |
|
183 | + var ctx = document.getElementById( 'getpaid-chartjs-earnings-<?php echo sanitize_key($key); ?>' ).getContext('2d'); |
|
184 | 184 | new Chart( |
185 | 185 | ctx, |
186 | 186 | { |
187 | 187 | type: 'line', |
188 | 188 | data: { |
189 | - 'labels': <?php echo wp_json_encode( $labels ); ?>, |
|
189 | + 'labels': <?php echo wp_json_encode($labels); ?>, |
|
190 | 190 | 'datasets': [ |
191 | 191 | { |
192 | - label: '<?php echo esc_attr( $dataset['label'] ); ?>', |
|
193 | - data: <?php echo wp_json_encode( $dataset['data'] ); ?>, |
|
192 | + label: '<?php echo esc_attr($dataset['label']); ?>', |
|
193 | + data: <?php echo wp_json_encode($dataset['data']); ?>, |
|
194 | 194 | backgroundColor: 'rgba(54, 162, 235, 0.1)', |
195 | 195 | borderColor: 'rgb(54, 162, 235)', |
196 | 196 | borderWidth: 4, |
@@ -12,86 +12,86 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Reports_Report { |
14 | 14 | |
15 | - /** |
|
16 | - * @var array |
|
17 | - */ |
|
18 | - public $views; |
|
15 | + /** |
|
16 | + * @var array |
|
17 | + */ |
|
18 | + public $views; |
|
19 | 19 | |
20 | - /** |
|
21 | - * Class constructor. |
|
22 | - * |
|
23 | - */ |
|
24 | - public function __construct() { |
|
20 | + /** |
|
21 | + * Class constructor. |
|
22 | + * |
|
23 | + */ |
|
24 | + public function __construct() { |
|
25 | 25 | |
26 | - $this->views = array( |
|
26 | + $this->views = array( |
|
27 | 27 | |
28 | 28 | 'items' => array( |
29 | - 'label' => __( 'Items', 'invoicing' ), |
|
30 | - 'class' => 'GetPaid_Reports_Report_Items', |
|
31 | - ), |
|
29 | + 'label' => __( 'Items', 'invoicing' ), |
|
30 | + 'class' => 'GetPaid_Reports_Report_Items', |
|
31 | + ), |
|
32 | 32 | |
33 | - 'gateways' => array( |
|
34 | - 'label' => __( 'Payment Methods', 'invoicing' ), |
|
35 | - 'class' => 'GetPaid_Reports_Report_Gateways', |
|
36 | - ), |
|
33 | + 'gateways' => array( |
|
34 | + 'label' => __( 'Payment Methods', 'invoicing' ), |
|
35 | + 'class' => 'GetPaid_Reports_Report_Gateways', |
|
36 | + ), |
|
37 | 37 | |
38 | - 'discounts' => array( |
|
39 | - 'label' => __( 'Discount Codes', 'invoicing' ), |
|
40 | - 'class' => 'GetPaid_Reports_Report_Discounts', |
|
41 | - ), |
|
38 | + 'discounts' => array( |
|
39 | + 'label' => __( 'Discount Codes', 'invoicing' ), |
|
40 | + 'class' => 'GetPaid_Reports_Report_Discounts', |
|
41 | + ), |
|
42 | 42 | |
43 | 43 | ); |
44 | 44 | |
45 | - $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
46 | - |
|
47 | - } |
|
48 | - |
|
49 | - /** |
|
50 | - * Retrieves the current range. |
|
51 | - * |
|
52 | - */ |
|
53 | - public function get_range() { |
|
54 | - $valid_ranges = $this->get_periods(); |
|
55 | - |
|
56 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
57 | - return sanitize_key( $_GET['date_range'] ); |
|
58 | - } |
|
59 | - |
|
60 | - return '7_days'; |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Returns an array of date ranges. |
|
65 | - * |
|
66 | - * @return array |
|
67 | - */ |
|
68 | - public function get_periods() { |
|
69 | - |
|
70 | - $periods = array( |
|
71 | - 'today' => __( 'Today', 'invoicing' ), |
|
72 | - 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
73 | - 'week' => __( 'This week', 'invoicing' ), |
|
74 | - 'last_week' => __( 'Last week', 'invoicing' ), |
|
75 | - '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
76 | - 'month' => __( 'This month', 'invoicing' ), |
|
77 | - 'last_month' => __( 'Last month', 'invoicing' ), |
|
78 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
79 | - 'year' => __( 'This year', 'invoicing' ), |
|
80 | - 'last_year' => __( 'Last Year', 'invoicing' ), |
|
81 | - 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
82 | - ); |
|
83 | - |
|
84 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Displays the range selector. |
|
89 | - * |
|
90 | - */ |
|
91 | - public function display_range_selector() { |
|
92 | - |
|
93 | - $range = $this->get_range(); |
|
94 | - ?> |
|
45 | + $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
46 | + |
|
47 | + } |
|
48 | + |
|
49 | + /** |
|
50 | + * Retrieves the current range. |
|
51 | + * |
|
52 | + */ |
|
53 | + public function get_range() { |
|
54 | + $valid_ranges = $this->get_periods(); |
|
55 | + |
|
56 | + if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
57 | + return sanitize_key( $_GET['date_range'] ); |
|
58 | + } |
|
59 | + |
|
60 | + return '7_days'; |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Returns an array of date ranges. |
|
65 | + * |
|
66 | + * @return array |
|
67 | + */ |
|
68 | + public function get_periods() { |
|
69 | + |
|
70 | + $periods = array( |
|
71 | + 'today' => __( 'Today', 'invoicing' ), |
|
72 | + 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
73 | + 'week' => __( 'This week', 'invoicing' ), |
|
74 | + 'last_week' => __( 'Last week', 'invoicing' ), |
|
75 | + '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
76 | + 'month' => __( 'This month', 'invoicing' ), |
|
77 | + 'last_month' => __( 'Last month', 'invoicing' ), |
|
78 | + '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
79 | + 'year' => __( 'This year', 'invoicing' ), |
|
80 | + 'last_year' => __( 'Last Year', 'invoicing' ), |
|
81 | + 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
82 | + ); |
|
83 | + |
|
84 | + return apply_filters( 'getpaid_earning_periods', $periods ); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Displays the range selector. |
|
89 | + * |
|
90 | + */ |
|
91 | + public function display_range_selector() { |
|
92 | + |
|
93 | + $range = $this->get_range(); |
|
94 | + ?> |
|
95 | 95 | |
96 | 96 | <form method="get" class="getpaid-filter-earnings float-right"> |
97 | 97 | <?php getpaid_hidden_field( 'page', 'wpinv-reports' ); ?> |
@@ -113,14 +113,14 @@ discard block |
||
113 | 113 | </form> |
114 | 114 | |
115 | 115 | <?php |
116 | - } |
|
116 | + } |
|
117 | 117 | |
118 | - /** |
|
119 | - * Displays the reports tab. |
|
120 | - * |
|
121 | - */ |
|
122 | - public function display() { |
|
123 | - ?> |
|
118 | + /** |
|
119 | + * Displays the reports tab. |
|
120 | + * |
|
121 | + */ |
|
122 | + public function display() { |
|
123 | + ?> |
|
124 | 124 | |
125 | 125 | <div class="mt-4" style="max-width: 1200px;"> |
126 | 126 | |
@@ -200,24 +200,24 @@ discard block |
||
200 | 200 | |
201 | 201 | <?php |
202 | 202 | |
203 | - } |
|
204 | - |
|
205 | - /** |
|
206 | - * Displays the left side. |
|
207 | - * |
|
208 | - */ |
|
209 | - public function display_left() { |
|
210 | - $graphs = array( |
|
211 | - 'sales' => __( 'Earnings', 'invoicing' ), |
|
212 | - 'refunds' => __( 'Refunds', 'invoicing' ), |
|
213 | - 'tax' => __( 'Taxes', 'invoicing' ), |
|
214 | - 'fees' => __( 'Fees', 'invoicing' ), |
|
215 | - 'discount' => __( 'Discounts', 'invoicing' ), |
|
216 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
217 | - 'items' => __( 'Purchased Items', 'invoicing' ), |
|
218 | - ); |
|
219 | - |
|
220 | - ?> |
|
203 | + } |
|
204 | + |
|
205 | + /** |
|
206 | + * Displays the left side. |
|
207 | + * |
|
208 | + */ |
|
209 | + public function display_left() { |
|
210 | + $graphs = array( |
|
211 | + 'sales' => __( 'Earnings', 'invoicing' ), |
|
212 | + 'refunds' => __( 'Refunds', 'invoicing' ), |
|
213 | + 'tax' => __( 'Taxes', 'invoicing' ), |
|
214 | + 'fees' => __( 'Fees', 'invoicing' ), |
|
215 | + 'discount' => __( 'Discounts', 'invoicing' ), |
|
216 | + 'invoices' => __( 'Invoices', 'invoicing' ), |
|
217 | + 'items' => __( 'Purchased Items', 'invoicing' ), |
|
218 | + ); |
|
219 | + |
|
220 | + ?> |
|
221 | 221 | |
222 | 222 | <?php foreach ( $graphs as $key => $graph ) : ?> |
223 | 223 | <div class="row mb-4"> |
@@ -236,35 +236,35 @@ discard block |
||
236 | 236 | |
237 | 237 | <?php |
238 | 238 | |
239 | - } |
|
240 | - |
|
241 | - /** |
|
242 | - * Retrieves the download url. |
|
243 | - * |
|
244 | - */ |
|
245 | - public function get_download_url( $graph, $file_type ) { |
|
246 | - |
|
247 | - return wp_nonce_url( |
|
248 | - add_query_arg( |
|
249 | - array( |
|
250 | - 'getpaid-admin-action' => 'download_graph', |
|
251 | - 'file_type' => urlencode( $file_type ), |
|
252 | - 'graph' => urlencode( $graph ), |
|
253 | - ) |
|
254 | - ), |
|
255 | - 'getpaid-nonce', |
|
256 | - 'getpaid-nonce' |
|
257 | - ); |
|
239 | + } |
|
240 | + |
|
241 | + /** |
|
242 | + * Retrieves the download url. |
|
243 | + * |
|
244 | + */ |
|
245 | + public function get_download_url( $graph, $file_type ) { |
|
246 | + |
|
247 | + return wp_nonce_url( |
|
248 | + add_query_arg( |
|
249 | + array( |
|
250 | + 'getpaid-admin-action' => 'download_graph', |
|
251 | + 'file_type' => urlencode( $file_type ), |
|
252 | + 'graph' => urlencode( $graph ), |
|
253 | + ) |
|
254 | + ), |
|
255 | + 'getpaid-nonce', |
|
256 | + 'getpaid-nonce' |
|
257 | + ); |
|
258 | 258 | |
259 | - } |
|
259 | + } |
|
260 | 260 | |
261 | - /** |
|
262 | - * Displays the right side. |
|
263 | - * |
|
264 | - */ |
|
265 | - public function display_right() { |
|
261 | + /** |
|
262 | + * Displays the right side. |
|
263 | + * |
|
264 | + */ |
|
265 | + public function display_right() { |
|
266 | 266 | |
267 | - ?> |
|
267 | + ?> |
|
268 | 268 | |
269 | 269 | <?php foreach ( $this->views as $key => $view ) : ?> |
270 | 270 | <div class="row mb-4"> |
@@ -293,10 +293,10 @@ discard block |
||
293 | 293 | </div> |
294 | 294 | <div class="card-body"> |
295 | 295 | <?php |
296 | - $class = $view['class']; |
|
297 | - $class = new $class(); |
|
298 | - $class->display_stats(); |
|
299 | - ?> |
|
296 | + $class = $view['class']; |
|
297 | + $class = new $class(); |
|
298 | + $class->display_stats(); |
|
299 | + ?> |
|
300 | 300 | </div> |
301 | 301 | </div> |
302 | 302 | </div> |
@@ -305,67 +305,67 @@ discard block |
||
305 | 305 | |
306 | 306 | <?php |
307 | 307 | |
308 | - } |
|
309 | - |
|
310 | - /** |
|
311 | - * Returns a list of report cards. |
|
312 | - * |
|
313 | - */ |
|
314 | - public function get_cards() { |
|
315 | - |
|
316 | - $cards = array( |
|
317 | - 'total_sales' => array( |
|
318 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
319 | - 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
320 | - ), |
|
321 | - 'net_sales' => array( |
|
322 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
323 | - 'label' => __( 'Net Revenue', 'invoicing' ), |
|
324 | - ), |
|
325 | - 'average_sales' => array( |
|
326 | - 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
327 | - 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
328 | - ), |
|
329 | - 'average_total_sales' => array( |
|
330 | - 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
331 | - 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
332 | - ), |
|
333 | - 'total_invoices' => array( |
|
334 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
335 | - 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
336 | - ), |
|
337 | - 'total_items' => array( |
|
338 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
339 | - 'label' => __( 'Purchased Items', 'invoicing' ), |
|
340 | - ), |
|
341 | - 'refunded_items' => array( |
|
342 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
343 | - 'label' => __( 'Refunded Items', 'invoicing' ), |
|
344 | - ), |
|
345 | - 'total_tax' => array( |
|
346 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
347 | - 'label' => __( 'Tax', 'invoicing' ), |
|
348 | - ), |
|
349 | - 'total_refunded_tax' => array( |
|
350 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
351 | - 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
352 | - ), |
|
353 | - 'total_fees' => array( |
|
354 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
355 | - 'label' => __( 'Fees', 'invoicing' ), |
|
356 | - ), |
|
357 | - 'total_refunds' => array( |
|
358 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
359 | - 'label' => __( 'Refunded', 'invoicing' ), |
|
360 | - ), |
|
361 | - 'total_discount' => array( |
|
362 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
363 | - 'label' => __( 'Discounted', 'invoicing' ), |
|
364 | - ), |
|
365 | - ); |
|
366 | - |
|
367 | - return apply_filters( 'wpinv_report_cards', $cards ); |
|
368 | - } |
|
308 | + } |
|
309 | + |
|
310 | + /** |
|
311 | + * Returns a list of report cards. |
|
312 | + * |
|
313 | + */ |
|
314 | + public function get_cards() { |
|
315 | + |
|
316 | + $cards = array( |
|
317 | + 'total_sales' => array( |
|
318 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
319 | + 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
320 | + ), |
|
321 | + 'net_sales' => array( |
|
322 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
323 | + 'label' => __( 'Net Revenue', 'invoicing' ), |
|
324 | + ), |
|
325 | + 'average_sales' => array( |
|
326 | + 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
327 | + 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
328 | + ), |
|
329 | + 'average_total_sales' => array( |
|
330 | + 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
331 | + 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
332 | + ), |
|
333 | + 'total_invoices' => array( |
|
334 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
335 | + 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
336 | + ), |
|
337 | + 'total_items' => array( |
|
338 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
339 | + 'label' => __( 'Purchased Items', 'invoicing' ), |
|
340 | + ), |
|
341 | + 'refunded_items' => array( |
|
342 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
343 | + 'label' => __( 'Refunded Items', 'invoicing' ), |
|
344 | + ), |
|
345 | + 'total_tax' => array( |
|
346 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
347 | + 'label' => __( 'Tax', 'invoicing' ), |
|
348 | + ), |
|
349 | + 'total_refunded_tax' => array( |
|
350 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
351 | + 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
352 | + ), |
|
353 | + 'total_fees' => array( |
|
354 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
355 | + 'label' => __( 'Fees', 'invoicing' ), |
|
356 | + ), |
|
357 | + 'total_refunds' => array( |
|
358 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
359 | + 'label' => __( 'Refunded', 'invoicing' ), |
|
360 | + ), |
|
361 | + 'total_discount' => array( |
|
362 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
363 | + 'label' => __( 'Discounted', 'invoicing' ), |
|
364 | + ), |
|
365 | + ); |
|
366 | + |
|
367 | + return apply_filters( 'wpinv_report_cards', $cards ); |
|
368 | + } |
|
369 | 369 | |
370 | 370 | |
371 | 371 |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * |
6 | 6 | */ |
7 | 7 | |
8 | -defined( 'ABSPATH' ) || exit; |
|
8 | +defined('ABSPATH') || exit; |
|
9 | 9 | |
10 | 10 | /** |
11 | 11 | * GetPaid_Reports_Report Class. |
@@ -23,26 +23,26 @@ discard block |
||
23 | 23 | */ |
24 | 24 | public function __construct() { |
25 | 25 | |
26 | - $this->views = array( |
|
26 | + $this->views = array( |
|
27 | 27 | |
28 | 28 | 'items' => array( |
29 | - 'label' => __( 'Items', 'invoicing' ), |
|
29 | + 'label' => __('Items', 'invoicing'), |
|
30 | 30 | 'class' => 'GetPaid_Reports_Report_Items', |
31 | 31 | ), |
32 | 32 | |
33 | 33 | 'gateways' => array( |
34 | - 'label' => __( 'Payment Methods', 'invoicing' ), |
|
34 | + 'label' => __('Payment Methods', 'invoicing'), |
|
35 | 35 | 'class' => 'GetPaid_Reports_Report_Gateways', |
36 | 36 | ), |
37 | 37 | |
38 | 38 | 'discounts' => array( |
39 | - 'label' => __( 'Discount Codes', 'invoicing' ), |
|
39 | + 'label' => __('Discount Codes', 'invoicing'), |
|
40 | 40 | 'class' => 'GetPaid_Reports_Report_Discounts', |
41 | 41 | ), |
42 | 42 | |
43 | 43 | ); |
44 | 44 | |
45 | - $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
45 | + $this->views = apply_filters('wpinv_report_views', $this->views); |
|
46 | 46 | |
47 | 47 | } |
48 | 48 | |
@@ -53,8 +53,8 @@ discard block |
||
53 | 53 | public function get_range() { |
54 | 54 | $valid_ranges = $this->get_periods(); |
55 | 55 | |
56 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
57 | - return sanitize_key( $_GET['date_range'] ); |
|
56 | + if (isset($_GET['date_range']) && array_key_exists($_GET['date_range'], $valid_ranges)) { |
|
57 | + return sanitize_key($_GET['date_range']); |
|
58 | 58 | } |
59 | 59 | |
60 | 60 | return '7_days'; |
@@ -68,20 +68,20 @@ discard block |
||
68 | 68 | public function get_periods() { |
69 | 69 | |
70 | 70 | $periods = array( |
71 | - 'today' => __( 'Today', 'invoicing' ), |
|
72 | - 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
73 | - 'week' => __( 'This week', 'invoicing' ), |
|
74 | - 'last_week' => __( 'Last week', 'invoicing' ), |
|
75 | - '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
76 | - 'month' => __( 'This month', 'invoicing' ), |
|
77 | - 'last_month' => __( 'Last month', 'invoicing' ), |
|
78 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
79 | - 'year' => __( 'This year', 'invoicing' ), |
|
80 | - 'last_year' => __( 'Last Year', 'invoicing' ), |
|
81 | - 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
71 | + 'today' => __('Today', 'invoicing'), |
|
72 | + 'yesterday' => __('Yesterday', 'invoicing'), |
|
73 | + 'week' => __('This week', 'invoicing'), |
|
74 | + 'last_week' => __('Last week', 'invoicing'), |
|
75 | + '7_days' => __('Last 7 days', 'invoicing'), |
|
76 | + 'month' => __('This month', 'invoicing'), |
|
77 | + 'last_month' => __('Last month', 'invoicing'), |
|
78 | + '30_days' => __('Last 30 days', 'invoicing'), |
|
79 | + 'year' => __('This year', 'invoicing'), |
|
80 | + 'last_year' => __('Last Year', 'invoicing'), |
|
81 | + 'custom' => __('Custom Date Range', 'invoicing'), |
|
82 | 82 | ); |
83 | 83 | |
84 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
84 | + return apply_filters('getpaid_earning_periods', $periods); |
|
85 | 85 | } |
86 | 86 | |
87 | 87 | /** |
@@ -94,21 +94,21 @@ discard block |
||
94 | 94 | ?> |
95 | 95 | |
96 | 96 | <form method="get" class="getpaid-filter-earnings float-right"> |
97 | - <?php getpaid_hidden_field( 'page', 'wpinv-reports' ); ?> |
|
98 | - <?php getpaid_hidden_field( 'tab', 'reports' ); ?> |
|
97 | + <?php getpaid_hidden_field('page', 'wpinv-reports'); ?> |
|
98 | + <?php getpaid_hidden_field('tab', 'reports'); ?> |
|
99 | 99 | <select name='date_range'> |
100 | - <?php foreach( $this->get_periods() as $key => $label ) :?> |
|
101 | - <option value="<?php echo sanitize_key( $key ); ?>" <?php selected( $key, $range ); ?>><?php echo sanitize_text_field( $label ); ?></option> |
|
102 | - <?php endforeach;?> |
|
100 | + <?php foreach ($this->get_periods() as $key => $label) :?> |
|
101 | + <option value="<?php echo sanitize_key($key); ?>" <?php selected($key, $range); ?>><?php echo sanitize_text_field($label); ?></option> |
|
102 | + <?php endforeach; ?> |
|
103 | 103 | </select> |
104 | 104 | <span class="getpaid-date-range-picker <?php echo 'custom' == $range ? '' : 'd-none'; ?>"> |
105 | 105 | <input type="text" name="from" class="getpaid-from align-middle" /> |
106 | - <?php _e( 'to', 'invoicing' ); ?> |
|
106 | + <?php _e('to', 'invoicing'); ?> |
|
107 | 107 | <input type="text" name="to" class="getpaid-to align-middle" /> |
108 | 108 | </span> |
109 | 109 | <button type="submit" class="button button-primary"> |
110 | 110 | <i class="fa fa-chevron-right fa-lg"></i> |
111 | - <span class="screen-reader-text"><?php _e( 'Next', 'invoicing' ); ?></span> |
|
111 | + <span class="screen-reader-text"><?php _e('Next', 'invoicing'); ?></span> |
|
112 | 112 | </button> |
113 | 113 | </form> |
114 | 114 | |
@@ -157,17 +157,17 @@ discard block |
||
157 | 157 | |
158 | 158 | <div class="col-12 col-md-4"> |
159 | 159 | <div class="row getpaid-report-cards"> |
160 | - <?php foreach( $this->get_cards() as $key => $card ) : ?> |
|
160 | + <?php foreach ($this->get_cards() as $key => $card) : ?> |
|
161 | 161 | <div class="col-12 mb-4"> |
162 | 162 | |
163 | - <!-- <?php echo sanitize_text_field( $card['label'] ); ?> Card --> |
|
164 | - <div class="card p-0 m-0 shadow-none <?php echo sanitize_html_class( $key ); ?>"> |
|
163 | + <!-- <?php echo sanitize_text_field($card['label']); ?> Card --> |
|
164 | + <div class="card p-0 m-0 shadow-none <?php echo sanitize_html_class($key); ?>"> |
|
165 | 165 | |
166 | 166 | <div class="card-body"> |
167 | 167 | |
168 | 168 | <p class="getpaid-current text-uppercase small mb-2"> |
169 | - <strong><?php echo sanitize_text_field( $card['label'] ); ?></strong> |
|
170 | - <span title="<?php echo esc_attr( $card['description'] ); ?>" class="wpi-help-tip dashicons dashicons-editor-help text-muted" style="margin-top: -2px;"></span> |
|
169 | + <strong><?php echo sanitize_text_field($card['label']); ?></strong> |
|
170 | + <span title="<?php echo esc_attr($card['description']); ?>" class="wpi-help-tip dashicons dashicons-editor-help text-muted" style="margin-top: -2px;"></span> |
|
171 | 171 | </p> |
172 | 172 | <h5 class="font-weight-bold mb-0"> |
173 | 173 | <span class="getpaid-report-card-value"> |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | |
179 | 179 | <hr> |
180 | 180 | |
181 | - <p class="getpaid-previous text-uppercase text-muted small mb-2"><strong><?php _e( 'Previous Period', 'invoicing' ); ?></strong></p> |
|
181 | + <p class="getpaid-previous text-uppercase text-muted small mb-2"><strong><?php _e('Previous Period', 'invoicing'); ?></strong></p> |
|
182 | 182 | <h5 class="getpaid-report-card-previous-value font-weight-bold text-muted mb-0"> |
183 | 183 | <span class="spinner is-active float-none"></span> |
184 | 184 | </h5> |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | </div> |
187 | 187 | |
188 | 188 | </div> |
189 | - <!-- <?php echo sanitize_text_field( $card['label'] ); ?> Card --> |
|
189 | + <!-- <?php echo sanitize_text_field($card['label']); ?> Card --> |
|
190 | 190 | |
191 | 191 | </div> |
192 | 192 | <?php endforeach; ?> |
@@ -208,26 +208,26 @@ discard block |
||
208 | 208 | */ |
209 | 209 | public function display_left() { |
210 | 210 | $graphs = array( |
211 | - 'sales' => __( 'Earnings', 'invoicing' ), |
|
212 | - 'refunds' => __( 'Refunds', 'invoicing' ), |
|
213 | - 'tax' => __( 'Taxes', 'invoicing' ), |
|
214 | - 'fees' => __( 'Fees', 'invoicing' ), |
|
215 | - 'discount' => __( 'Discounts', 'invoicing' ), |
|
216 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
217 | - 'items' => __( 'Purchased Items', 'invoicing' ), |
|
211 | + 'sales' => __('Earnings', 'invoicing'), |
|
212 | + 'refunds' => __('Refunds', 'invoicing'), |
|
213 | + 'tax' => __('Taxes', 'invoicing'), |
|
214 | + 'fees' => __('Fees', 'invoicing'), |
|
215 | + 'discount' => __('Discounts', 'invoicing'), |
|
216 | + 'invoices' => __('Invoices', 'invoicing'), |
|
217 | + 'items' => __('Purchased Items', 'invoicing'), |
|
218 | 218 | ); |
219 | 219 | |
220 | 220 | ?> |
221 | 221 | |
222 | - <?php foreach ( $graphs as $key => $graph ) : ?> |
|
222 | + <?php foreach ($graphs as $key => $graph) : ?> |
|
223 | 223 | <div class="row mb-4"> |
224 | 224 | <div class="col-12"> |
225 | 225 | <div class="card m-0 p-0" style="max-width:100%"> |
226 | 226 | <div class="card-header"> |
227 | - <strong><?php echo wpinv_clean( $graph ); ?></strong> |
|
227 | + <strong><?php echo wpinv_clean($graph); ?></strong> |
|
228 | 228 | </div> |
229 | 229 | <div class="card-body"> |
230 | - <canvas id="getpaid-chartjs-<?php echo sanitize_key( $key ); ?>"></canvas> |
|
230 | + <canvas id="getpaid-chartjs-<?php echo sanitize_key($key); ?>"></canvas> |
|
231 | 231 | </div> |
232 | 232 | </div> |
233 | 233 | </div> |
@@ -242,14 +242,14 @@ discard block |
||
242 | 242 | * Retrieves the download url. |
243 | 243 | * |
244 | 244 | */ |
245 | - public function get_download_url( $graph, $file_type ) { |
|
245 | + public function get_download_url($graph, $file_type) { |
|
246 | 246 | |
247 | 247 | return wp_nonce_url( |
248 | 248 | add_query_arg( |
249 | 249 | array( |
250 | 250 | 'getpaid-admin-action' => 'download_graph', |
251 | - 'file_type' => urlencode( $file_type ), |
|
252 | - 'graph' => urlencode( $graph ), |
|
251 | + 'file_type' => urlencode($file_type), |
|
252 | + 'graph' => urlencode($graph), |
|
253 | 253 | ) |
254 | 254 | ), |
255 | 255 | 'getpaid-nonce', |
@@ -266,7 +266,7 @@ discard block |
||
266 | 266 | |
267 | 267 | ?> |
268 | 268 | |
269 | - <?php foreach ( $this->views as $key => $view ) : ?> |
|
269 | + <?php foreach ($this->views as $key => $view) : ?> |
|
270 | 270 | <div class="row mb-4"> |
271 | 271 | <div class="col-12"> |
272 | 272 | <div class="card m-0 p-0" style="max-width:100%"> |
@@ -276,17 +276,17 @@ discard block |
||
276 | 276 | <strong><?php echo $view['label']; ?></strong> |
277 | 277 | </div> |
278 | 278 | <div class="col-3"> |
279 | - <a title="<?php esc_attr_e( 'Download JSON', 'invoicing' ); ?>" href="<?php echo esc_url( $this->get_download_url( $key, 'json' ) ); ?>"> |
|
279 | + <a title="<?php esc_attr_e('Download JSON', 'invoicing'); ?>" href="<?php echo esc_url($this->get_download_url($key, 'json')); ?>"> |
|
280 | 280 | <i class="fa fa-download text-dark" style="font-size: 16px" aria-hidden="true"></i> |
281 | - <span class="screen-reader-text"><?php _e( 'Download JSON', 'invoicing' ); ?></span> |
|
281 | + <span class="screen-reader-text"><?php _e('Download JSON', 'invoicing'); ?></span> |
|
282 | 282 | </a> |
283 | - <a title="<?php esc_attr_e( 'Download CSV', 'invoicing' ); ?>" href="<?php echo esc_url( $this->get_download_url( $key, 'csv' ) ); ?>"> |
|
283 | + <a title="<?php esc_attr_e('Download CSV', 'invoicing'); ?>" href="<?php echo esc_url($this->get_download_url($key, 'csv')); ?>"> |
|
284 | 284 | <i class="fa fa-file-csv text-dark" style="font-size: 16px" aria-hidden="true"></i> |
285 | - <span class="screen-reader-text"><?php _e( 'Download CSV', 'invoicing' ); ?></span> |
|
285 | + <span class="screen-reader-text"><?php _e('Download CSV', 'invoicing'); ?></span> |
|
286 | 286 | </a> |
287 | - <a title="<?php esc_attr_e( 'Download XML', 'invoicing' ); ?>" href="<?php echo esc_url( $this->get_download_url( $key, 'xml' ) ); ?>"> |
|
287 | + <a title="<?php esc_attr_e('Download XML', 'invoicing'); ?>" href="<?php echo esc_url($this->get_download_url($key, 'xml')); ?>"> |
|
288 | 288 | <i class="fa fa-file-code text-dark" style="font-size: 16px" aria-hidden="true"></i> |
289 | - <span class="screen-reader-text"><?php _e( 'Download XML', 'invoicing' ); ?></span> |
|
289 | + <span class="screen-reader-text"><?php _e('Download XML', 'invoicing'); ?></span> |
|
290 | 290 | </a> |
291 | 291 | </div> |
292 | 292 | </div> |
@@ -315,56 +315,56 @@ discard block |
||
315 | 315 | |
316 | 316 | $cards = array( |
317 | 317 | 'total_sales' => array( |
318 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
319 | - 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
318 | + 'description' => __('Gross sales in the period.', 'invoicing'), |
|
319 | + 'label' => __('Gross Revenue', 'invoicing'), |
|
320 | 320 | ), |
321 | 321 | 'net_sales' => array( |
322 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
323 | - 'label' => __( 'Net Revenue', 'invoicing' ), |
|
322 | + 'description' => __('Net sales in the period.', 'invoicing'), |
|
323 | + 'label' => __('Net Revenue', 'invoicing'), |
|
324 | 324 | ), |
325 | 325 | 'average_sales' => array( |
326 | - 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
327 | - 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
326 | + 'description' => __('Average net daily/monthly sales.', 'invoicing'), |
|
327 | + 'label' => __('Avg. Net Sales', 'invoicing'), |
|
328 | 328 | ), |
329 | 329 | 'average_total_sales' => array( |
330 | - 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
331 | - 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
330 | + 'description' => __('Average gross daily/monthly sales.', 'invoicing'), |
|
331 | + 'label' => __('Avg. Gross Sales', 'invoicing'), |
|
332 | 332 | ), |
333 | 333 | 'total_invoices' => array( |
334 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
335 | - 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
334 | + 'description' => __('Number of paid invoices.', 'invoicing'), |
|
335 | + 'label' => __('Paid Invoices', 'invoicing'), |
|
336 | 336 | ), |
337 | 337 | 'total_items' => array( |
338 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
339 | - 'label' => __( 'Purchased Items', 'invoicing' ), |
|
338 | + 'description' => __('Number of items purchased.', 'invoicing'), |
|
339 | + 'label' => __('Purchased Items', 'invoicing'), |
|
340 | 340 | ), |
341 | 341 | 'refunded_items' => array( |
342 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
343 | - 'label' => __( 'Refunded Items', 'invoicing' ), |
|
342 | + 'description' => __('Number of items refunded.', 'invoicing'), |
|
343 | + 'label' => __('Refunded Items', 'invoicing'), |
|
344 | 344 | ), |
345 | 345 | 'total_tax' => array( |
346 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
347 | - 'label' => __( 'Tax', 'invoicing' ), |
|
346 | + 'description' => __('Total charged for taxes.', 'invoicing'), |
|
347 | + 'label' => __('Tax', 'invoicing'), |
|
348 | 348 | ), |
349 | 349 | 'total_refunded_tax' => array( |
350 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
351 | - 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
350 | + 'description' => __('Total refunded for taxes.', 'invoicing'), |
|
351 | + 'label' => __('Refunded Tax', 'invoicing'), |
|
352 | 352 | ), |
353 | 353 | 'total_fees' => array( |
354 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
355 | - 'label' => __( 'Fees', 'invoicing' ), |
|
354 | + 'description' => __('Total fees charged.', 'invoicing'), |
|
355 | + 'label' => __('Fees', 'invoicing'), |
|
356 | 356 | ), |
357 | 357 | 'total_refunds' => array( |
358 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
359 | - 'label' => __( 'Refunded', 'invoicing' ), |
|
358 | + 'description' => __('Total of refunded invoices.', 'invoicing'), |
|
359 | + 'label' => __('Refunded', 'invoicing'), |
|
360 | 360 | ), |
361 | 361 | 'total_discount' => array( |
362 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
363 | - 'label' => __( 'Discounted', 'invoicing' ), |
|
362 | + 'description' => __('Total of discounts used.', 'invoicing'), |
|
363 | + 'label' => __('Discounted', 'invoicing'), |
|
364 | 364 | ), |
365 | 365 | ); |
366 | 366 | |
367 | - return apply_filters( 'wpinv_report_cards', $cards ); |
|
367 | + return apply_filters('wpinv_report_cards', $cards); |
|
368 | 368 | } |
369 | 369 | |
370 | 370 |
@@ -14,30 +14,30 @@ discard block |
||
14 | 14 | class WPInv_Invoice extends GetPaid_Data { |
15 | 15 | |
16 | 16 | /** |
17 | - * Which data store to load. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
17 | + * Which data store to load. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | 21 | protected $data_store_name = 'invoice'; |
22 | 22 | |
23 | 23 | /** |
24 | - * This is the name of this object type. |
|
25 | - * |
|
26 | - * @var string |
|
27 | - */ |
|
24 | + * This is the name of this object type. |
|
25 | + * |
|
26 | + * @var string |
|
27 | + */ |
|
28 | 28 | protected $object_type = 'invoice'; |
29 | 29 | |
30 | 30 | /** |
31 | - * Item Data array. This is the core item data exposed in APIs. |
|
32 | - * |
|
33 | - * @since 1.0.19 |
|
34 | - * @var array |
|
35 | - */ |
|
36 | - protected $data = array( |
|
37 | - 'parent_id' => 0, |
|
38 | - 'status' => 'wpi-pending', |
|
39 | - 'version' => '', |
|
40 | - 'date_created' => null, |
|
31 | + * Item Data array. This is the core item data exposed in APIs. |
|
32 | + * |
|
33 | + * @since 1.0.19 |
|
34 | + * @var array |
|
35 | + */ |
|
36 | + protected $data = array( |
|
37 | + 'parent_id' => 0, |
|
38 | + 'status' => 'wpi-pending', |
|
39 | + 'version' => '', |
|
40 | + 'date_created' => null, |
|
41 | 41 | 'date_modified' => null, |
42 | 42 | 'due_date' => null, |
43 | 43 | 'completed_date' => null, |
@@ -79,22 +79,22 @@ discard block |
||
79 | 79 | 'transaction_id' => '', |
80 | 80 | 'currency' => '', |
81 | 81 | 'disable_taxes' => false, |
82 | - 'subscription_id' => null, |
|
83 | - 'remote_subscription_id' => null, |
|
84 | - 'is_viewed' => false, |
|
85 | - 'email_cc' => '', |
|
86 | - 'template' => 'quantity', // hours, amount only |
|
87 | - 'created_via' => null, |
|
82 | + 'subscription_id' => null, |
|
83 | + 'remote_subscription_id' => null, |
|
84 | + 'is_viewed' => false, |
|
85 | + 'email_cc' => '', |
|
86 | + 'template' => 'quantity', // hours, amount only |
|
87 | + 'created_via' => null, |
|
88 | 88 | ); |
89 | 89 | |
90 | 90 | /** |
91 | - * Stores meta in cache for future reads. |
|
92 | - * |
|
93 | - * A group must be set to to enable caching. |
|
94 | - * |
|
95 | - * @var string |
|
96 | - */ |
|
97 | - protected $cache_group = 'getpaid_invoices'; |
|
91 | + * Stores meta in cache for future reads. |
|
92 | + * |
|
93 | + * A group must be set to to enable caching. |
|
94 | + * |
|
95 | + * @var string |
|
96 | + */ |
|
97 | + protected $cache_group = 'getpaid_invoices'; |
|
98 | 98 | |
99 | 99 | /** |
100 | 100 | * Stores a reference to the original WP_Post object |
@@ -108,104 +108,104 @@ discard block |
||
108 | 108 | * |
109 | 109 | * @var int |
110 | 110 | */ |
111 | - protected $recurring_item = null; |
|
111 | + protected $recurring_item = null; |
|
112 | 112 | |
113 | - /** |
|
113 | + /** |
|
114 | 114 | * Stores an array of item totals. |
115 | - * |
|
116 | - * e.g $totals['discount'] = array( |
|
117 | - * 'initial' => 10, |
|
118 | - * 'recurring' => 10, |
|
119 | - * ) |
|
115 | + * |
|
116 | + * e.g $totals['discount'] = array( |
|
117 | + * 'initial' => 10, |
|
118 | + * 'recurring' => 10, |
|
119 | + * ) |
|
120 | 120 | * |
121 | 121 | * @var array |
122 | 122 | */ |
123 | - protected $totals = array(); |
|
123 | + protected $totals = array(); |
|
124 | 124 | |
125 | - /** |
|
126 | - * Stores the status transition information. |
|
127 | - * |
|
128 | - * @since 1.0.19 |
|
129 | - * @var bool|array |
|
130 | - */ |
|
131 | - protected $status_transition = false; |
|
125 | + /** |
|
126 | + * Stores the status transition information. |
|
127 | + * |
|
128 | + * @since 1.0.19 |
|
129 | + * @var bool|array |
|
130 | + */ |
|
131 | + protected $status_transition = false; |
|
132 | 132 | |
133 | 133 | /** |
134 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
135 | - * |
|
136 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
137 | - */ |
|
134 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
135 | + * |
|
136 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
137 | + */ |
|
138 | 138 | public function __construct( $invoice = 0 ) { |
139 | 139 | |
140 | 140 | parent::__construct( $invoice ); |
141 | 141 | |
142 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
143 | - $this->set_id( (int) $invoice ); |
|
144 | - } elseif ( $invoice instanceof self ) { |
|
145 | - $this->set_id( $invoice->get_id() ); |
|
146 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
147 | - $this->set_id( $invoice->ID ); |
|
148 | - } elseif ( is_array( $invoice ) ) { |
|
149 | - $this->set_props( $invoice ); |
|
150 | - |
|
151 | - if ( isset( $invoice['ID'] ) ) { |
|
152 | - $this->set_id( $invoice['ID'] ); |
|
153 | - } |
|
154 | - |
|
155 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
156 | - $this->set_id( $invoice_id ); |
|
157 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
158 | - $this->set_id( $invoice_id ); |
|
159 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
160 | - $this->set_id( $invoice_id ); |
|
161 | - }else { |
|
162 | - $this->set_object_read( true ); |
|
163 | - } |
|
142 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
143 | + $this->set_id( (int) $invoice ); |
|
144 | + } elseif ( $invoice instanceof self ) { |
|
145 | + $this->set_id( $invoice->get_id() ); |
|
146 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
147 | + $this->set_id( $invoice->ID ); |
|
148 | + } elseif ( is_array( $invoice ) ) { |
|
149 | + $this->set_props( $invoice ); |
|
150 | + |
|
151 | + if ( isset( $invoice['ID'] ) ) { |
|
152 | + $this->set_id( $invoice['ID'] ); |
|
153 | + } |
|
154 | + |
|
155 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
156 | + $this->set_id( $invoice_id ); |
|
157 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
158 | + $this->set_id( $invoice_id ); |
|
159 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
160 | + $this->set_id( $invoice_id ); |
|
161 | + }else { |
|
162 | + $this->set_object_read( true ); |
|
163 | + } |
|
164 | 164 | |
165 | 165 | // Load the datastore. |
166 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
166 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
167 | 167 | |
168 | - if ( $this->get_id() > 0 ) { |
|
168 | + if ( $this->get_id() > 0 ) { |
|
169 | 169 | $this->post = get_post( $this->get_id() ); |
170 | 170 | $this->ID = $this->get_id(); |
171 | - $this->data_store->read( $this ); |
|
171 | + $this->data_store->read( $this ); |
|
172 | 172 | } |
173 | 173 | |
174 | 174 | } |
175 | 175 | |
176 | 176 | /** |
177 | - * Given an invoice key/number, it returns its id. |
|
178 | - * |
|
179 | - * |
|
180 | - * @static |
|
181 | - * @param string $value The invoice key or number |
|
182 | - * @param string $field Either key, transaction_id or number. |
|
183 | - * @since 1.0.15 |
|
184 | - * @return int |
|
185 | - */ |
|
186 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
177 | + * Given an invoice key/number, it returns its id. |
|
178 | + * |
|
179 | + * |
|
180 | + * @static |
|
181 | + * @param string $value The invoice key or number |
|
182 | + * @param string $field Either key, transaction_id or number. |
|
183 | + * @since 1.0.15 |
|
184 | + * @return int |
|
185 | + */ |
|
186 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
187 | 187 | global $wpdb; |
188 | 188 | |
189 | - // Trim the value. |
|
190 | - $value = trim( $value ); |
|
189 | + // Trim the value. |
|
190 | + $value = trim( $value ); |
|
191 | 191 | |
192 | - if ( empty( $value ) ) { |
|
193 | - return 0; |
|
194 | - } |
|
192 | + if ( empty( $value ) ) { |
|
193 | + return 0; |
|
194 | + } |
|
195 | 195 | |
196 | 196 | // Valid fields. |
197 | 197 | $fields = array( 'key', 'number', 'transaction_id' ); |
198 | 198 | |
199 | - // Ensure a field has been passed. |
|
200 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
201 | - return 0; |
|
202 | - } |
|
199 | + // Ensure a field has been passed. |
|
200 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
201 | + return 0; |
|
202 | + } |
|
203 | 203 | |
204 | - // Maybe retrieve from the cache. |
|
205 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
206 | - if ( false !== $invoice_id ) { |
|
207 | - return $invoice_id; |
|
208 | - } |
|
204 | + // Maybe retrieve from the cache. |
|
205 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
206 | + if ( false !== $invoice_id ) { |
|
207 | + return $invoice_id; |
|
208 | + } |
|
209 | 209 | |
210 | 210 | // Fetch from the db. |
211 | 211 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -213,10 +213,10 @@ discard block |
||
213 | 213 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
214 | 214 | ); |
215 | 215 | |
216 | - // Update the cache with our data |
|
217 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
216 | + // Update the cache with our data |
|
217 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
218 | 218 | |
219 | - return $invoice_id; |
|
219 | + return $invoice_id; |
|
220 | 220 | } |
221 | 221 | |
222 | 222 | /** |
@@ -242,83 +242,83 @@ discard block |
||
242 | 242 | */ |
243 | 243 | |
244 | 244 | /** |
245 | - * Get parent invoice ID. |
|
246 | - * |
|
247 | - * @since 1.0.19 |
|
248 | - * @param string $context View or edit context. |
|
249 | - * @return int |
|
250 | - */ |
|
251 | - public function get_parent_id( $context = 'view' ) { |
|
252 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
245 | + * Get parent invoice ID. |
|
246 | + * |
|
247 | + * @since 1.0.19 |
|
248 | + * @param string $context View or edit context. |
|
249 | + * @return int |
|
250 | + */ |
|
251 | + public function get_parent_id( $context = 'view' ) { |
|
252 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
253 | 253 | } |
254 | 254 | |
255 | 255 | /** |
256 | - * Get parent invoice. |
|
257 | - * |
|
258 | - * @since 1.0.19 |
|
259 | - * @return WPInv_Invoice |
|
260 | - */ |
|
256 | + * Get parent invoice. |
|
257 | + * |
|
258 | + * @since 1.0.19 |
|
259 | + * @return WPInv_Invoice |
|
260 | + */ |
|
261 | 261 | public function get_parent_payment() { |
262 | 262 | return new WPInv_Invoice( $this->get_parent_id() ); |
263 | 263 | } |
264 | 264 | |
265 | 265 | /** |
266 | - * Alias for self::get_parent_payment(). |
|
267 | - * |
|
268 | - * @since 1.0.19 |
|
269 | - * @return WPInv_Invoice |
|
270 | - */ |
|
266 | + * Alias for self::get_parent_payment(). |
|
267 | + * |
|
268 | + * @since 1.0.19 |
|
269 | + * @return WPInv_Invoice |
|
270 | + */ |
|
271 | 271 | public function get_parent() { |
272 | 272 | return $this->get_parent_payment(); |
273 | 273 | } |
274 | 274 | |
275 | 275 | /** |
276 | - * Get invoice status. |
|
277 | - * |
|
278 | - * @since 1.0.19 |
|
279 | - * @param string $context View or edit context. |
|
280 | - * @return string |
|
281 | - */ |
|
282 | - public function get_status( $context = 'view' ) { |
|
283 | - return $this->get_prop( 'status', $context ); |
|
284 | - } |
|
276 | + * Get invoice status. |
|
277 | + * |
|
278 | + * @since 1.0.19 |
|
279 | + * @param string $context View or edit context. |
|
280 | + * @return string |
|
281 | + */ |
|
282 | + public function get_status( $context = 'view' ) { |
|
283 | + return $this->get_prop( 'status', $context ); |
|
284 | + } |
|
285 | 285 | |
286 | - /** |
|
287 | - * Retrieves an array of possible invoice statuses. |
|
288 | - * |
|
289 | - * @since 1.0.19 |
|
290 | - * @return array |
|
291 | - */ |
|
292 | - public function get_all_statuses() { |
|
293 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
294 | - } |
|
295 | - |
|
296 | - /** |
|
297 | - * Get invoice status nice name. |
|
298 | - * |
|
299 | - * @since 1.0.19 |
|
300 | - * @return string |
|
301 | - */ |
|
286 | + /** |
|
287 | + * Retrieves an array of possible invoice statuses. |
|
288 | + * |
|
289 | + * @since 1.0.19 |
|
290 | + * @return array |
|
291 | + */ |
|
292 | + public function get_all_statuses() { |
|
293 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
294 | + } |
|
295 | + |
|
296 | + /** |
|
297 | + * Get invoice status nice name. |
|
298 | + * |
|
299 | + * @since 1.0.19 |
|
300 | + * @return string |
|
301 | + */ |
|
302 | 302 | public function get_status_nicename() { |
303 | - $statuses = $this->get_all_statuses(); |
|
303 | + $statuses = $this->get_all_statuses(); |
|
304 | 304 | |
305 | 305 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
306 | 306 | |
307 | 307 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
308 | 308 | } |
309 | 309 | |
310 | - /** |
|
311 | - * Retrieves the invoice status class |
|
312 | - * |
|
313 | - * @since 1.0.19 |
|
314 | - * @return string |
|
315 | - */ |
|
316 | - public function get_status_class() { |
|
317 | - $statuses = getpaid_get_invoice_status_classes(); |
|
318 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
319 | - } |
|
310 | + /** |
|
311 | + * Retrieves the invoice status class |
|
312 | + * |
|
313 | + * @since 1.0.19 |
|
314 | + * @return string |
|
315 | + */ |
|
316 | + public function get_status_class() { |
|
317 | + $statuses = getpaid_get_invoice_status_classes(); |
|
318 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
319 | + } |
|
320 | 320 | |
321 | - /** |
|
321 | + /** |
|
322 | 322 | * Retrieves the invoice status label html |
323 | 323 | * |
324 | 324 | * @since 1.0.0 |
@@ -326,263 +326,263 @@ discard block |
||
326 | 326 | */ |
327 | 327 | public function get_status_label_html() { |
328 | 328 | |
329 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
330 | - $status = sanitize_html_class( $this->get_status() ); |
|
331 | - $class = esc_attr( $this->get_status_class() ); |
|
329 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
330 | + $status = sanitize_html_class( $this->get_status() ); |
|
331 | + $class = esc_attr( $this->get_status_class() ); |
|
332 | 332 | |
333 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
334 | - } |
|
333 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
334 | + } |
|
335 | 335 | |
336 | 336 | /** |
337 | - * Get plugin version when the invoice was created. |
|
338 | - * |
|
339 | - * @since 1.0.19 |
|
340 | - * @param string $context View or edit context. |
|
341 | - * @return string |
|
342 | - */ |
|
343 | - public function get_version( $context = 'view' ) { |
|
344 | - return $this->get_prop( 'version', $context ); |
|
345 | - } |
|
337 | + * Get plugin version when the invoice was created. |
|
338 | + * |
|
339 | + * @since 1.0.19 |
|
340 | + * @param string $context View or edit context. |
|
341 | + * @return string |
|
342 | + */ |
|
343 | + public function get_version( $context = 'view' ) { |
|
344 | + return $this->get_prop( 'version', $context ); |
|
345 | + } |
|
346 | 346 | |
347 | - /** |
|
348 | - * @deprecated |
|
349 | - */ |
|
350 | - public function get_invoice_date( $format = true ) { |
|
351 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
352 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
353 | - $formatted = getpaid_format_date( $date ); |
|
347 | + /** |
|
348 | + * @deprecated |
|
349 | + */ |
|
350 | + public function get_invoice_date( $format = true ) { |
|
351 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
352 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
353 | + $formatted = getpaid_format_date( $date ); |
|
354 | 354 | |
355 | - if ( $format ) { |
|
356 | - return $formatted; |
|
357 | - } |
|
355 | + if ( $format ) { |
|
356 | + return $formatted; |
|
357 | + } |
|
358 | 358 | |
359 | - return empty( $formatted ) ? '' : $date; |
|
359 | + return empty( $formatted ) ? '' : $date; |
|
360 | 360 | |
361 | 361 | } |
362 | 362 | |
363 | 363 | /** |
364 | - * Get date when the invoice was created. |
|
365 | - * |
|
366 | - * @since 1.0.19 |
|
367 | - * @param string $context View or edit context. |
|
368 | - * @return string |
|
369 | - */ |
|
370 | - public function get_date_created( $context = 'view' ) { |
|
371 | - return $this->get_prop( 'date_created', $context ); |
|
372 | - } |
|
364 | + * Get date when the invoice was created. |
|
365 | + * |
|
366 | + * @since 1.0.19 |
|
367 | + * @param string $context View or edit context. |
|
368 | + * @return string |
|
369 | + */ |
|
370 | + public function get_date_created( $context = 'view' ) { |
|
371 | + return $this->get_prop( 'date_created', $context ); |
|
372 | + } |
|
373 | 373 | |
374 | - /** |
|
375 | - * Alias for self::get_date_created(). |
|
376 | - * |
|
377 | - * @since 1.0.19 |
|
378 | - * @param string $context View or edit context. |
|
379 | - * @return string |
|
380 | - */ |
|
381 | - public function get_created_date( $context = 'view' ) { |
|
382 | - return $this->get_date_created( $context ); |
|
383 | - } |
|
384 | - |
|
385 | - /** |
|
386 | - * Get GMT date when the invoice was created. |
|
387 | - * |
|
388 | - * @since 1.0.19 |
|
389 | - * @param string $context View or edit context. |
|
390 | - * @return string |
|
391 | - */ |
|
392 | - public function get_date_created_gmt( $context = 'view' ) { |
|
374 | + /** |
|
375 | + * Alias for self::get_date_created(). |
|
376 | + * |
|
377 | + * @since 1.0.19 |
|
378 | + * @param string $context View or edit context. |
|
379 | + * @return string |
|
380 | + */ |
|
381 | + public function get_created_date( $context = 'view' ) { |
|
382 | + return $this->get_date_created( $context ); |
|
383 | + } |
|
384 | + |
|
385 | + /** |
|
386 | + * Get GMT date when the invoice was created. |
|
387 | + * |
|
388 | + * @since 1.0.19 |
|
389 | + * @param string $context View or edit context. |
|
390 | + * @return string |
|
391 | + */ |
|
392 | + public function get_date_created_gmt( $context = 'view' ) { |
|
393 | 393 | $date = $this->get_date_created( $context ); |
394 | 394 | |
395 | 395 | if ( $date ) { |
396 | 396 | $date = get_gmt_from_date( $date ); |
397 | 397 | } |
398 | - return $date; |
|
398 | + return $date; |
|
399 | 399 | } |
400 | 400 | |
401 | 401 | /** |
402 | - * Get date when the invoice was last modified. |
|
403 | - * |
|
404 | - * @since 1.0.19 |
|
405 | - * @param string $context View or edit context. |
|
406 | - * @return string |
|
407 | - */ |
|
408 | - public function get_date_modified( $context = 'view' ) { |
|
409 | - return $this->get_prop( 'date_modified', $context ); |
|
410 | - } |
|
402 | + * Get date when the invoice was last modified. |
|
403 | + * |
|
404 | + * @since 1.0.19 |
|
405 | + * @param string $context View or edit context. |
|
406 | + * @return string |
|
407 | + */ |
|
408 | + public function get_date_modified( $context = 'view' ) { |
|
409 | + return $this->get_prop( 'date_modified', $context ); |
|
410 | + } |
|
411 | 411 | |
412 | - /** |
|
413 | - * Alias for self::get_date_modified(). |
|
414 | - * |
|
415 | - * @since 1.0.19 |
|
416 | - * @param string $context View or edit context. |
|
417 | - * @return string |
|
418 | - */ |
|
419 | - public function get_modified_date( $context = 'view' ) { |
|
420 | - return $this->get_date_modified( $context ); |
|
412 | + /** |
|
413 | + * Alias for self::get_date_modified(). |
|
414 | + * |
|
415 | + * @since 1.0.19 |
|
416 | + * @param string $context View or edit context. |
|
417 | + * @return string |
|
418 | + */ |
|
419 | + public function get_modified_date( $context = 'view' ) { |
|
420 | + return $this->get_date_modified( $context ); |
|
421 | 421 | } |
422 | 422 | |
423 | 423 | /** |
424 | - * Get GMT date when the invoice was last modified. |
|
425 | - * |
|
426 | - * @since 1.0.19 |
|
427 | - * @param string $context View or edit context. |
|
428 | - * @return string |
|
429 | - */ |
|
430 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
424 | + * Get GMT date when the invoice was last modified. |
|
425 | + * |
|
426 | + * @since 1.0.19 |
|
427 | + * @param string $context View or edit context. |
|
428 | + * @return string |
|
429 | + */ |
|
430 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
431 | 431 | $date = $this->get_date_modified( $context ); |
432 | 432 | |
433 | 433 | if ( $date ) { |
434 | 434 | $date = get_gmt_from_date( $date ); |
435 | 435 | } |
436 | - return $date; |
|
436 | + return $date; |
|
437 | 437 | } |
438 | 438 | |
439 | 439 | /** |
440 | - * Get the invoice due date. |
|
441 | - * |
|
442 | - * @since 1.0.19 |
|
443 | - * @param string $context View or edit context. |
|
444 | - * @return string |
|
445 | - */ |
|
446 | - public function get_due_date( $context = 'view' ) { |
|
447 | - return $this->get_prop( 'due_date', $context ); |
|
440 | + * Get the invoice due date. |
|
441 | + * |
|
442 | + * @since 1.0.19 |
|
443 | + * @param string $context View or edit context. |
|
444 | + * @return string |
|
445 | + */ |
|
446 | + public function get_due_date( $context = 'view' ) { |
|
447 | + return $this->get_prop( 'due_date', $context ); |
|
448 | 448 | } |
449 | 449 | |
450 | 450 | /** |
451 | - * Alias for self::get_due_date(). |
|
452 | - * |
|
453 | - * @since 1.0.19 |
|
454 | - * @param string $context View or edit context. |
|
455 | - * @return string |
|
456 | - */ |
|
457 | - public function get_date_due( $context = 'view' ) { |
|
458 | - return $this->get_due_date( $context ); |
|
451 | + * Alias for self::get_due_date(). |
|
452 | + * |
|
453 | + * @since 1.0.19 |
|
454 | + * @param string $context View or edit context. |
|
455 | + * @return string |
|
456 | + */ |
|
457 | + public function get_date_due( $context = 'view' ) { |
|
458 | + return $this->get_due_date( $context ); |
|
459 | 459 | } |
460 | 460 | |
461 | 461 | /** |
462 | - * Get the invoice GMT due date. |
|
463 | - * |
|
464 | - * @since 1.0.19 |
|
465 | - * @param string $context View or edit context. |
|
466 | - * @return string |
|
467 | - */ |
|
468 | - public function get_due_date_gmt( $context = 'view' ) { |
|
462 | + * Get the invoice GMT due date. |
|
463 | + * |
|
464 | + * @since 1.0.19 |
|
465 | + * @param string $context View or edit context. |
|
466 | + * @return string |
|
467 | + */ |
|
468 | + public function get_due_date_gmt( $context = 'view' ) { |
|
469 | 469 | $date = $this->get_due_date( $context ); |
470 | 470 | |
471 | 471 | if ( $date ) { |
472 | 472 | $date = get_gmt_from_date( $date ); |
473 | 473 | } |
474 | - return $date; |
|
474 | + return $date; |
|
475 | 475 | } |
476 | 476 | |
477 | 477 | /** |
478 | - * Alias for self::get_due_date_gmt(). |
|
479 | - * |
|
480 | - * @since 1.0.19 |
|
481 | - * @param string $context View or edit context. |
|
482 | - * @return string |
|
483 | - */ |
|
484 | - public function get_gmt_date_due( $context = 'view' ) { |
|
485 | - return $this->get_due_date_gmt( $context ); |
|
478 | + * Alias for self::get_due_date_gmt(). |
|
479 | + * |
|
480 | + * @since 1.0.19 |
|
481 | + * @param string $context View or edit context. |
|
482 | + * @return string |
|
483 | + */ |
|
484 | + public function get_gmt_date_due( $context = 'view' ) { |
|
485 | + return $this->get_due_date_gmt( $context ); |
|
486 | 486 | } |
487 | 487 | |
488 | 488 | /** |
489 | - * Get date when the invoice was completed. |
|
490 | - * |
|
491 | - * @since 1.0.19 |
|
492 | - * @param string $context View or edit context. |
|
493 | - * @return string |
|
494 | - */ |
|
495 | - public function get_completed_date( $context = 'view' ) { |
|
496 | - return $this->get_prop( 'completed_date', $context ); |
|
489 | + * Get date when the invoice was completed. |
|
490 | + * |
|
491 | + * @since 1.0.19 |
|
492 | + * @param string $context View or edit context. |
|
493 | + * @return string |
|
494 | + */ |
|
495 | + public function get_completed_date( $context = 'view' ) { |
|
496 | + return $this->get_prop( 'completed_date', $context ); |
|
497 | 497 | } |
498 | 498 | |
499 | 499 | /** |
500 | - * Alias for self::get_completed_date(). |
|
501 | - * |
|
502 | - * @since 1.0.19 |
|
503 | - * @param string $context View or edit context. |
|
504 | - * @return string |
|
505 | - */ |
|
506 | - public function get_date_completed( $context = 'view' ) { |
|
507 | - return $this->get_completed_date( $context ); |
|
500 | + * Alias for self::get_completed_date(). |
|
501 | + * |
|
502 | + * @since 1.0.19 |
|
503 | + * @param string $context View or edit context. |
|
504 | + * @return string |
|
505 | + */ |
|
506 | + public function get_date_completed( $context = 'view' ) { |
|
507 | + return $this->get_completed_date( $context ); |
|
508 | 508 | } |
509 | 509 | |
510 | 510 | /** |
511 | - * Get GMT date when the invoice was was completed. |
|
512 | - * |
|
513 | - * @since 1.0.19 |
|
514 | - * @param string $context View or edit context. |
|
515 | - * @return string |
|
516 | - */ |
|
517 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
511 | + * Get GMT date when the invoice was was completed. |
|
512 | + * |
|
513 | + * @since 1.0.19 |
|
514 | + * @param string $context View or edit context. |
|
515 | + * @return string |
|
516 | + */ |
|
517 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
518 | 518 | $date = $this->get_completed_date( $context ); |
519 | 519 | |
520 | 520 | if ( $date ) { |
521 | 521 | $date = get_gmt_from_date( $date ); |
522 | 522 | } |
523 | - return $date; |
|
523 | + return $date; |
|
524 | 524 | } |
525 | 525 | |
526 | 526 | /** |
527 | - * Alias for self::get_completed_date_gmt(). |
|
528 | - * |
|
529 | - * @since 1.0.19 |
|
530 | - * @param string $context View or edit context. |
|
531 | - * @return string |
|
532 | - */ |
|
533 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
534 | - return $this->get_completed_date_gmt( $context ); |
|
527 | + * Alias for self::get_completed_date_gmt(). |
|
528 | + * |
|
529 | + * @since 1.0.19 |
|
530 | + * @param string $context View or edit context. |
|
531 | + * @return string |
|
532 | + */ |
|
533 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
534 | + return $this->get_completed_date_gmt( $context ); |
|
535 | 535 | } |
536 | 536 | |
537 | 537 | /** |
538 | - * Get the invoice number. |
|
539 | - * |
|
540 | - * @since 1.0.19 |
|
541 | - * @param string $context View or edit context. |
|
542 | - * @return string |
|
543 | - */ |
|
544 | - public function get_number( $context = 'view' ) { |
|
545 | - $number = $this->get_prop( 'number', $context ); |
|
538 | + * Get the invoice number. |
|
539 | + * |
|
540 | + * @since 1.0.19 |
|
541 | + * @param string $context View or edit context. |
|
542 | + * @return string |
|
543 | + */ |
|
544 | + public function get_number( $context = 'view' ) { |
|
545 | + $number = $this->get_prop( 'number', $context ); |
|
546 | 546 | |
547 | - if ( empty( $number ) ) { |
|
548 | - $number = $this->generate_number(); |
|
549 | - $this->set_number( $this->generate_number() ); |
|
550 | - } |
|
547 | + if ( empty( $number ) ) { |
|
548 | + $number = $this->generate_number(); |
|
549 | + $this->set_number( $this->generate_number() ); |
|
550 | + } |
|
551 | 551 | |
552 | - return $number; |
|
552 | + return $number; |
|
553 | 553 | } |
554 | 554 | |
555 | - /** |
|
556 | - * Set the invoice number. |
|
557 | - * |
|
558 | - * @since 1.0.19 |
|
559 | - */ |
|
560 | - public function maybe_set_number() { |
|
555 | + /** |
|
556 | + * Set the invoice number. |
|
557 | + * |
|
558 | + * @since 1.0.19 |
|
559 | + */ |
|
560 | + public function maybe_set_number() { |
|
561 | 561 | $number = $this->get_number(); |
562 | 562 | |
563 | 563 | if ( empty( $number ) || $this->get_id() == $number ) { |
564 | - $this->set_number( $this->generate_number() ); |
|
564 | + $this->set_number( $this->generate_number() ); |
|
565 | 565 | } |
566 | 566 | |
567 | - } |
|
567 | + } |
|
568 | 568 | |
569 | 569 | /** |
570 | - * Get the invoice key. |
|
571 | - * |
|
572 | - * @since 1.0.19 |
|
573 | - * @param string $context View or edit context. |
|
574 | - * @return string |
|
575 | - */ |
|
576 | - public function get_key( $context = 'view' ) { |
|
570 | + * Get the invoice key. |
|
571 | + * |
|
572 | + * @since 1.0.19 |
|
573 | + * @param string $context View or edit context. |
|
574 | + * @return string |
|
575 | + */ |
|
576 | + public function get_key( $context = 'view' ) { |
|
577 | 577 | return $this->get_prop( 'key', $context ); |
578 | - } |
|
579 | - |
|
580 | - /** |
|
581 | - * Set the invoice key. |
|
582 | - * |
|
583 | - * @since 1.0.19 |
|
584 | - */ |
|
585 | - public function maybe_set_key() { |
|
578 | + } |
|
579 | + |
|
580 | + /** |
|
581 | + * Set the invoice key. |
|
582 | + * |
|
583 | + * @since 1.0.19 |
|
584 | + */ |
|
585 | + public function maybe_set_key() { |
|
586 | 586 | $key = $this->get_key(); |
587 | 587 | |
588 | 588 | if ( empty( $key ) ) { |
@@ -593,140 +593,140 @@ discard block |
||
593 | 593 | } |
594 | 594 | |
595 | 595 | /** |
596 | - * Get the invoice type. |
|
597 | - * |
|
598 | - * @since 1.0.19 |
|
599 | - * @param string $context View or edit context. |
|
600 | - * @return string |
|
601 | - */ |
|
602 | - public function get_type( $context = 'view' ) { |
|
596 | + * Get the invoice type. |
|
597 | + * |
|
598 | + * @since 1.0.19 |
|
599 | + * @param string $context View or edit context. |
|
600 | + * @return string |
|
601 | + */ |
|
602 | + public function get_type( $context = 'view' ) { |
|
603 | 603 | return $this->get_prop( 'type', $context ); |
604 | - } |
|
605 | - |
|
606 | - /** |
|
607 | - * Returns the post type name. |
|
608 | - * |
|
609 | - * @since 1.0.19 |
|
610 | - * @return string |
|
611 | - */ |
|
612 | - public function get_invoice_quote_type() { |
|
604 | + } |
|
605 | + |
|
606 | + /** |
|
607 | + * Returns the post type name. |
|
608 | + * |
|
609 | + * @since 1.0.19 |
|
610 | + * @return string |
|
611 | + */ |
|
612 | + public function get_invoice_quote_type() { |
|
613 | 613 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
614 | 614 | } |
615 | 615 | |
616 | 616 | /** |
617 | - * Get the invoice post type label. |
|
618 | - * |
|
619 | - * @since 1.0.19 |
|
620 | - * @param string $context View or edit context. |
|
621 | - * @return string |
|
622 | - */ |
|
623 | - public function get_label( $context = 'view' ) { |
|
617 | + * Get the invoice post type label. |
|
618 | + * |
|
619 | + * @since 1.0.19 |
|
620 | + * @param string $context View or edit context. |
|
621 | + * @return string |
|
622 | + */ |
|
623 | + public function get_label( $context = 'view' ) { |
|
624 | 624 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
625 | - } |
|
626 | - |
|
627 | - /** |
|
628 | - * Get the invoice post type. |
|
629 | - * |
|
630 | - * @since 1.0.19 |
|
631 | - * @param string $context View or edit context. |
|
632 | - * @return string |
|
633 | - */ |
|
634 | - public function get_post_type( $context = 'view' ) { |
|
625 | + } |
|
626 | + |
|
627 | + /** |
|
628 | + * Get the invoice post type. |
|
629 | + * |
|
630 | + * @since 1.0.19 |
|
631 | + * @param string $context View or edit context. |
|
632 | + * @return string |
|
633 | + */ |
|
634 | + public function get_post_type( $context = 'view' ) { |
|
635 | 635 | return $this->get_prop( 'post_type', $context ); |
636 | 636 | } |
637 | 637 | |
638 | 638 | /** |
639 | - * Get the invoice mode. |
|
640 | - * |
|
641 | - * @since 1.0.19 |
|
642 | - * @param string $context View or edit context. |
|
643 | - * @return string |
|
644 | - */ |
|
645 | - public function get_mode( $context = 'view' ) { |
|
639 | + * Get the invoice mode. |
|
640 | + * |
|
641 | + * @since 1.0.19 |
|
642 | + * @param string $context View or edit context. |
|
643 | + * @return string |
|
644 | + */ |
|
645 | + public function get_mode( $context = 'view' ) { |
|
646 | 646 | return $this->get_prop( 'mode', $context ); |
647 | 647 | } |
648 | 648 | |
649 | 649 | /** |
650 | - * Get the invoice path. |
|
651 | - * |
|
652 | - * @since 1.0.19 |
|
653 | - * @param string $context View or edit context. |
|
654 | - * @return string |
|
655 | - */ |
|
656 | - public function get_path( $context = 'view' ) { |
|
650 | + * Get the invoice path. |
|
651 | + * |
|
652 | + * @since 1.0.19 |
|
653 | + * @param string $context View or edit context. |
|
654 | + * @return string |
|
655 | + */ |
|
656 | + public function get_path( $context = 'view' ) { |
|
657 | 657 | $path = $this->get_prop( 'path', $context ); |
658 | - $prefix = $this->get_type(); |
|
658 | + $prefix = $this->get_type(); |
|
659 | 659 | |
660 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
661 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
662 | - $this->set_path( $path ); |
|
663 | - } |
|
660 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
661 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
662 | + $this->set_path( $path ); |
|
663 | + } |
|
664 | 664 | |
665 | - return $path; |
|
665 | + return $path; |
|
666 | 666 | } |
667 | 667 | |
668 | 668 | /** |
669 | - * Get the invoice name/title. |
|
670 | - * |
|
671 | - * @since 1.0.19 |
|
672 | - * @param string $context View or edit context. |
|
673 | - * @return string |
|
674 | - */ |
|
675 | - public function get_name( $context = 'view' ) { |
|
669 | + * Get the invoice name/title. |
|
670 | + * |
|
671 | + * @since 1.0.19 |
|
672 | + * @param string $context View or edit context. |
|
673 | + * @return string |
|
674 | + */ |
|
675 | + public function get_name( $context = 'view' ) { |
|
676 | 676 | return $this->get_prop( 'title', $context ); |
677 | 677 | } |
678 | 678 | |
679 | 679 | /** |
680 | - * Alias of self::get_name(). |
|
681 | - * |
|
682 | - * @since 1.0.19 |
|
683 | - * @param string $context View or edit context. |
|
684 | - * @return string |
|
685 | - */ |
|
686 | - public function get_title( $context = 'view' ) { |
|
687 | - return $this->get_name( $context ); |
|
680 | + * Alias of self::get_name(). |
|
681 | + * |
|
682 | + * @since 1.0.19 |
|
683 | + * @param string $context View or edit context. |
|
684 | + * @return string |
|
685 | + */ |
|
686 | + public function get_title( $context = 'view' ) { |
|
687 | + return $this->get_name( $context ); |
|
688 | 688 | } |
689 | 689 | |
690 | 690 | /** |
691 | - * Get the invoice description. |
|
692 | - * |
|
693 | - * @since 1.0.19 |
|
694 | - * @param string $context View or edit context. |
|
695 | - * @return string |
|
696 | - */ |
|
697 | - public function get_description( $context = 'view' ) { |
|
698 | - return $this->get_prop( 'description', $context ); |
|
691 | + * Get the invoice description. |
|
692 | + * |
|
693 | + * @since 1.0.19 |
|
694 | + * @param string $context View or edit context. |
|
695 | + * @return string |
|
696 | + */ |
|
697 | + public function get_description( $context = 'view' ) { |
|
698 | + return $this->get_prop( 'description', $context ); |
|
699 | 699 | } |
700 | 700 | |
701 | 701 | /** |
702 | - * Alias of self::get_description(). |
|
703 | - * |
|
704 | - * @since 1.0.19 |
|
705 | - * @param string $context View or edit context. |
|
706 | - * @return string |
|
707 | - */ |
|
708 | - public function get_excerpt( $context = 'view' ) { |
|
709 | - return $this->get_description( $context ); |
|
702 | + * Alias of self::get_description(). |
|
703 | + * |
|
704 | + * @since 1.0.19 |
|
705 | + * @param string $context View or edit context. |
|
706 | + * @return string |
|
707 | + */ |
|
708 | + public function get_excerpt( $context = 'view' ) { |
|
709 | + return $this->get_description( $context ); |
|
710 | 710 | } |
711 | 711 | |
712 | 712 | /** |
713 | - * Alias of self::get_description(). |
|
714 | - * |
|
715 | - * @since 1.0.19 |
|
716 | - * @param string $context View or edit context. |
|
717 | - * @return string |
|
718 | - */ |
|
719 | - public function get_summary( $context = 'view' ) { |
|
720 | - return $this->get_description( $context ); |
|
713 | + * Alias of self::get_description(). |
|
714 | + * |
|
715 | + * @since 1.0.19 |
|
716 | + * @param string $context View or edit context. |
|
717 | + * @return string |
|
718 | + */ |
|
719 | + public function get_summary( $context = 'view' ) { |
|
720 | + return $this->get_description( $context ); |
|
721 | 721 | } |
722 | 722 | |
723 | 723 | /** |
724 | - * Returns the user info. |
|
725 | - * |
|
726 | - * @since 1.0.19 |
|
724 | + * Returns the user info. |
|
725 | + * |
|
726 | + * @since 1.0.19 |
|
727 | 727 | * @param string $context View or edit context. |
728 | - * @return array |
|
729 | - */ |
|
728 | + * @return array |
|
729 | + */ |
|
730 | 730 | public function get_user_info( $context = 'view' ) { |
731 | 731 | |
732 | 732 | $user_info = array( |
@@ -743,616 +743,616 @@ discard block |
||
743 | 743 | 'company' => $this->get_company( $context ), |
744 | 744 | 'vat_number' => $this->get_vat_number( $context ), |
745 | 745 | 'discount' => $this->get_discount_code( $context ), |
746 | - ); |
|
746 | + ); |
|
747 | 747 | |
748 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
748 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
749 | 749 | |
750 | 750 | } |
751 | 751 | |
752 | 752 | /** |
753 | - * Get the customer id. |
|
754 | - * |
|
755 | - * @since 1.0.19 |
|
756 | - * @param string $context View or edit context. |
|
757 | - * @return int |
|
758 | - */ |
|
759 | - public function get_author( $context = 'view' ) { |
|
760 | - return (int) $this->get_prop( 'author', $context ); |
|
753 | + * Get the customer id. |
|
754 | + * |
|
755 | + * @since 1.0.19 |
|
756 | + * @param string $context View or edit context. |
|
757 | + * @return int |
|
758 | + */ |
|
759 | + public function get_author( $context = 'view' ) { |
|
760 | + return (int) $this->get_prop( 'author', $context ); |
|
761 | 761 | } |
762 | 762 | |
763 | 763 | /** |
764 | - * Alias of self::get_author(). |
|
765 | - * |
|
766 | - * @since 1.0.19 |
|
767 | - * @param string $context View or edit context. |
|
768 | - * @return int |
|
769 | - */ |
|
770 | - public function get_user_id( $context = 'view' ) { |
|
771 | - return $this->get_author( $context ); |
|
764 | + * Alias of self::get_author(). |
|
765 | + * |
|
766 | + * @since 1.0.19 |
|
767 | + * @param string $context View or edit context. |
|
768 | + * @return int |
|
769 | + */ |
|
770 | + public function get_user_id( $context = 'view' ) { |
|
771 | + return $this->get_author( $context ); |
|
772 | 772 | } |
773 | 773 | |
774 | - /** |
|
775 | - * Alias of self::get_author(). |
|
776 | - * |
|
777 | - * @since 1.0.19 |
|
778 | - * @param string $context View or edit context. |
|
779 | - * @return int |
|
780 | - */ |
|
781 | - public function get_customer_id( $context = 'view' ) { |
|
782 | - return $this->get_author( $context ); |
|
774 | + /** |
|
775 | + * Alias of self::get_author(). |
|
776 | + * |
|
777 | + * @since 1.0.19 |
|
778 | + * @param string $context View or edit context. |
|
779 | + * @return int |
|
780 | + */ |
|
781 | + public function get_customer_id( $context = 'view' ) { |
|
782 | + return $this->get_author( $context ); |
|
783 | 783 | } |
784 | 784 | |
785 | 785 | /** |
786 | - * Get the customer's ip. |
|
787 | - * |
|
788 | - * @since 1.0.19 |
|
789 | - * @param string $context View or edit context. |
|
790 | - * @return string |
|
791 | - */ |
|
792 | - public function get_ip( $context = 'view' ) { |
|
793 | - return $this->get_prop( 'user_ip', $context ); |
|
786 | + * Get the customer's ip. |
|
787 | + * |
|
788 | + * @since 1.0.19 |
|
789 | + * @param string $context View or edit context. |
|
790 | + * @return string |
|
791 | + */ |
|
792 | + public function get_ip( $context = 'view' ) { |
|
793 | + return $this->get_prop( 'user_ip', $context ); |
|
794 | 794 | } |
795 | 795 | |
796 | 796 | /** |
797 | - * Alias of self::get_ip(). |
|
798 | - * |
|
799 | - * @since 1.0.19 |
|
800 | - * @param string $context View or edit context. |
|
801 | - * @return string |
|
802 | - */ |
|
803 | - public function get_user_ip( $context = 'view' ) { |
|
804 | - return $this->get_ip( $context ); |
|
797 | + * Alias of self::get_ip(). |
|
798 | + * |
|
799 | + * @since 1.0.19 |
|
800 | + * @param string $context View or edit context. |
|
801 | + * @return string |
|
802 | + */ |
|
803 | + public function get_user_ip( $context = 'view' ) { |
|
804 | + return $this->get_ip( $context ); |
|
805 | 805 | } |
806 | 806 | |
807 | - /** |
|
808 | - * Alias of self::get_ip(). |
|
809 | - * |
|
810 | - * @since 1.0.19 |
|
811 | - * @param string $context View or edit context. |
|
812 | - * @return string |
|
813 | - */ |
|
814 | - public function get_customer_ip( $context = 'view' ) { |
|
815 | - return $this->get_ip( $context ); |
|
807 | + /** |
|
808 | + * Alias of self::get_ip(). |
|
809 | + * |
|
810 | + * @since 1.0.19 |
|
811 | + * @param string $context View or edit context. |
|
812 | + * @return string |
|
813 | + */ |
|
814 | + public function get_customer_ip( $context = 'view' ) { |
|
815 | + return $this->get_ip( $context ); |
|
816 | 816 | } |
817 | 817 | |
818 | 818 | /** |
819 | - * Get the customer's first name. |
|
820 | - * |
|
821 | - * @since 1.0.19 |
|
822 | - * @param string $context View or edit context. |
|
823 | - * @return string |
|
824 | - */ |
|
825 | - public function get_first_name( $context = 'view' ) { |
|
826 | - return $this->get_prop( 'first_name', $context ); |
|
819 | + * Get the customer's first name. |
|
820 | + * |
|
821 | + * @since 1.0.19 |
|
822 | + * @param string $context View or edit context. |
|
823 | + * @return string |
|
824 | + */ |
|
825 | + public function get_first_name( $context = 'view' ) { |
|
826 | + return $this->get_prop( 'first_name', $context ); |
|
827 | 827 | } |
828 | 828 | |
829 | 829 | /** |
830 | - * Alias of self::get_first_name(). |
|
831 | - * |
|
832 | - * @since 1.0.19 |
|
833 | - * @param string $context View or edit context. |
|
834 | - * @return string |
|
835 | - */ |
|
836 | - public function get_user_first_name( $context = 'view' ) { |
|
837 | - return $this->get_first_name( $context ); |
|
830 | + * Alias of self::get_first_name(). |
|
831 | + * |
|
832 | + * @since 1.0.19 |
|
833 | + * @param string $context View or edit context. |
|
834 | + * @return string |
|
835 | + */ |
|
836 | + public function get_user_first_name( $context = 'view' ) { |
|
837 | + return $this->get_first_name( $context ); |
|
838 | 838 | } |
839 | 839 | |
840 | - /** |
|
841 | - * Alias of self::get_first_name(). |
|
842 | - * |
|
843 | - * @since 1.0.19 |
|
844 | - * @param string $context View or edit context. |
|
845 | - * @return string |
|
846 | - */ |
|
847 | - public function get_customer_first_name( $context = 'view' ) { |
|
848 | - return $this->get_first_name( $context ); |
|
840 | + /** |
|
841 | + * Alias of self::get_first_name(). |
|
842 | + * |
|
843 | + * @since 1.0.19 |
|
844 | + * @param string $context View or edit context. |
|
845 | + * @return string |
|
846 | + */ |
|
847 | + public function get_customer_first_name( $context = 'view' ) { |
|
848 | + return $this->get_first_name( $context ); |
|
849 | 849 | } |
850 | 850 | |
851 | 851 | /** |
852 | - * Get the customer's last name. |
|
853 | - * |
|
854 | - * @since 1.0.19 |
|
855 | - * @param string $context View or edit context. |
|
856 | - * @return string |
|
857 | - */ |
|
858 | - public function get_last_name( $context = 'view' ) { |
|
859 | - return $this->get_prop( 'last_name', $context ); |
|
852 | + * Get the customer's last name. |
|
853 | + * |
|
854 | + * @since 1.0.19 |
|
855 | + * @param string $context View or edit context. |
|
856 | + * @return string |
|
857 | + */ |
|
858 | + public function get_last_name( $context = 'view' ) { |
|
859 | + return $this->get_prop( 'last_name', $context ); |
|
860 | 860 | } |
861 | 861 | |
862 | 862 | /** |
863 | - * Alias of self::get_last_name(). |
|
864 | - * |
|
865 | - * @since 1.0.19 |
|
866 | - * @param string $context View or edit context. |
|
867 | - * @return string |
|
868 | - */ |
|
869 | - public function get_user_last_name( $context = 'view' ) { |
|
870 | - return $this->get_last_name( $context ); |
|
863 | + * Alias of self::get_last_name(). |
|
864 | + * |
|
865 | + * @since 1.0.19 |
|
866 | + * @param string $context View or edit context. |
|
867 | + * @return string |
|
868 | + */ |
|
869 | + public function get_user_last_name( $context = 'view' ) { |
|
870 | + return $this->get_last_name( $context ); |
|
871 | 871 | } |
872 | 872 | |
873 | 873 | /** |
874 | - * Alias of self::get_last_name(). |
|
875 | - * |
|
876 | - * @since 1.0.19 |
|
877 | - * @param string $context View or edit context. |
|
878 | - * @return string |
|
879 | - */ |
|
880 | - public function get_customer_last_name( $context = 'view' ) { |
|
881 | - return $this->get_last_name( $context ); |
|
874 | + * Alias of self::get_last_name(). |
|
875 | + * |
|
876 | + * @since 1.0.19 |
|
877 | + * @param string $context View or edit context. |
|
878 | + * @return string |
|
879 | + */ |
|
880 | + public function get_customer_last_name( $context = 'view' ) { |
|
881 | + return $this->get_last_name( $context ); |
|
882 | 882 | } |
883 | 883 | |
884 | 884 | /** |
885 | - * Get the customer's full name. |
|
886 | - * |
|
887 | - * @since 1.0.19 |
|
888 | - * @param string $context View or edit context. |
|
889 | - * @return string |
|
890 | - */ |
|
891 | - public function get_full_name( $context = 'view' ) { |
|
892 | - return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
885 | + * Get the customer's full name. |
|
886 | + * |
|
887 | + * @since 1.0.19 |
|
888 | + * @param string $context View or edit context. |
|
889 | + * @return string |
|
890 | + */ |
|
891 | + public function get_full_name( $context = 'view' ) { |
|
892 | + return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
893 | 893 | } |
894 | 894 | |
895 | 895 | /** |
896 | - * Alias of self::get_full_name(). |
|
897 | - * |
|
898 | - * @since 1.0.19 |
|
899 | - * @param string $context View or edit context. |
|
900 | - * @return string |
|
901 | - */ |
|
902 | - public function get_user_full_name( $context = 'view' ) { |
|
903 | - return $this->get_full_name( $context ); |
|
896 | + * Alias of self::get_full_name(). |
|
897 | + * |
|
898 | + * @since 1.0.19 |
|
899 | + * @param string $context View or edit context. |
|
900 | + * @return string |
|
901 | + */ |
|
902 | + public function get_user_full_name( $context = 'view' ) { |
|
903 | + return $this->get_full_name( $context ); |
|
904 | 904 | } |
905 | 905 | |
906 | 906 | /** |
907 | - * Alias of self::get_full_name(). |
|
908 | - * |
|
909 | - * @since 1.0.19 |
|
910 | - * @param string $context View or edit context. |
|
911 | - * @return string |
|
912 | - */ |
|
913 | - public function get_customer_full_name( $context = 'view' ) { |
|
914 | - return $this->get_full_name( $context ); |
|
907 | + * Alias of self::get_full_name(). |
|
908 | + * |
|
909 | + * @since 1.0.19 |
|
910 | + * @param string $context View or edit context. |
|
911 | + * @return string |
|
912 | + */ |
|
913 | + public function get_customer_full_name( $context = 'view' ) { |
|
914 | + return $this->get_full_name( $context ); |
|
915 | 915 | } |
916 | 916 | |
917 | 917 | /** |
918 | - * Get the customer's phone number. |
|
919 | - * |
|
920 | - * @since 1.0.19 |
|
921 | - * @param string $context View or edit context. |
|
922 | - * @return string |
|
923 | - */ |
|
924 | - public function get_phone( $context = 'view' ) { |
|
925 | - return $this->get_prop( 'phone', $context ); |
|
918 | + * Get the customer's phone number. |
|
919 | + * |
|
920 | + * @since 1.0.19 |
|
921 | + * @param string $context View or edit context. |
|
922 | + * @return string |
|
923 | + */ |
|
924 | + public function get_phone( $context = 'view' ) { |
|
925 | + return $this->get_prop( 'phone', $context ); |
|
926 | 926 | } |
927 | 927 | |
928 | 928 | /** |
929 | - * Alias of self::get_phone(). |
|
930 | - * |
|
931 | - * @since 1.0.19 |
|
932 | - * @param string $context View or edit context. |
|
933 | - * @return string |
|
934 | - */ |
|
935 | - public function get_phone_number( $context = 'view' ) { |
|
936 | - return $this->get_phone( $context ); |
|
929 | + * Alias of self::get_phone(). |
|
930 | + * |
|
931 | + * @since 1.0.19 |
|
932 | + * @param string $context View or edit context. |
|
933 | + * @return string |
|
934 | + */ |
|
935 | + public function get_phone_number( $context = 'view' ) { |
|
936 | + return $this->get_phone( $context ); |
|
937 | 937 | } |
938 | 938 | |
939 | 939 | /** |
940 | - * Alias of self::get_phone(). |
|
941 | - * |
|
942 | - * @since 1.0.19 |
|
943 | - * @param string $context View or edit context. |
|
944 | - * @return string |
|
945 | - */ |
|
946 | - public function get_user_phone( $context = 'view' ) { |
|
947 | - return $this->get_phone( $context ); |
|
940 | + * Alias of self::get_phone(). |
|
941 | + * |
|
942 | + * @since 1.0.19 |
|
943 | + * @param string $context View or edit context. |
|
944 | + * @return string |
|
945 | + */ |
|
946 | + public function get_user_phone( $context = 'view' ) { |
|
947 | + return $this->get_phone( $context ); |
|
948 | 948 | } |
949 | 949 | |
950 | 950 | /** |
951 | - * Alias of self::get_phone(). |
|
952 | - * |
|
953 | - * @since 1.0.19 |
|
954 | - * @param string $context View or edit context. |
|
955 | - * @return string |
|
956 | - */ |
|
957 | - public function get_customer_phone( $context = 'view' ) { |
|
958 | - return $this->get_phone( $context ); |
|
951 | + * Alias of self::get_phone(). |
|
952 | + * |
|
953 | + * @since 1.0.19 |
|
954 | + * @param string $context View or edit context. |
|
955 | + * @return string |
|
956 | + */ |
|
957 | + public function get_customer_phone( $context = 'view' ) { |
|
958 | + return $this->get_phone( $context ); |
|
959 | 959 | } |
960 | 960 | |
961 | 961 | /** |
962 | - * Get the customer's email address. |
|
963 | - * |
|
964 | - * @since 1.0.19 |
|
965 | - * @param string $context View or edit context. |
|
966 | - * @return string |
|
967 | - */ |
|
968 | - public function get_email( $context = 'view' ) { |
|
969 | - return $this->get_prop( 'email', $context ); |
|
962 | + * Get the customer's email address. |
|
963 | + * |
|
964 | + * @since 1.0.19 |
|
965 | + * @param string $context View or edit context. |
|
966 | + * @return string |
|
967 | + */ |
|
968 | + public function get_email( $context = 'view' ) { |
|
969 | + return $this->get_prop( 'email', $context ); |
|
970 | 970 | } |
971 | 971 | |
972 | 972 | /** |
973 | - * Alias of self::get_email(). |
|
974 | - * |
|
975 | - * @since 1.0.19 |
|
976 | - * @param string $context View or edit context. |
|
977 | - * @return string |
|
978 | - */ |
|
979 | - public function get_email_address( $context = 'view' ) { |
|
980 | - return $this->get_email( $context ); |
|
973 | + * Alias of self::get_email(). |
|
974 | + * |
|
975 | + * @since 1.0.19 |
|
976 | + * @param string $context View or edit context. |
|
977 | + * @return string |
|
978 | + */ |
|
979 | + public function get_email_address( $context = 'view' ) { |
|
980 | + return $this->get_email( $context ); |
|
981 | 981 | } |
982 | 982 | |
983 | 983 | /** |
984 | - * Alias of self::get_email(). |
|
985 | - * |
|
986 | - * @since 1.0.19 |
|
987 | - * @param string $context View or edit context. |
|
988 | - * @return string |
|
989 | - */ |
|
990 | - public function get_user_email( $context = 'view' ) { |
|
991 | - return $this->get_email( $context ); |
|
984 | + * Alias of self::get_email(). |
|
985 | + * |
|
986 | + * @since 1.0.19 |
|
987 | + * @param string $context View or edit context. |
|
988 | + * @return string |
|
989 | + */ |
|
990 | + public function get_user_email( $context = 'view' ) { |
|
991 | + return $this->get_email( $context ); |
|
992 | 992 | } |
993 | 993 | |
994 | 994 | /** |
995 | - * Alias of self::get_email(). |
|
996 | - * |
|
997 | - * @since 1.0.19 |
|
998 | - * @param string $context View or edit context. |
|
999 | - * @return string |
|
1000 | - */ |
|
1001 | - public function get_customer_email( $context = 'view' ) { |
|
1002 | - return $this->get_email( $context ); |
|
995 | + * Alias of self::get_email(). |
|
996 | + * |
|
997 | + * @since 1.0.19 |
|
998 | + * @param string $context View or edit context. |
|
999 | + * @return string |
|
1000 | + */ |
|
1001 | + public function get_customer_email( $context = 'view' ) { |
|
1002 | + return $this->get_email( $context ); |
|
1003 | 1003 | } |
1004 | 1004 | |
1005 | 1005 | /** |
1006 | - * Get the customer's country. |
|
1007 | - * |
|
1008 | - * @since 1.0.19 |
|
1009 | - * @param string $context View or edit context. |
|
1010 | - * @return string |
|
1011 | - */ |
|
1012 | - public function get_country( $context = 'view' ) { |
|
1013 | - $country = $this->get_prop( 'country', $context ); |
|
1014 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1006 | + * Get the customer's country. |
|
1007 | + * |
|
1008 | + * @since 1.0.19 |
|
1009 | + * @param string $context View or edit context. |
|
1010 | + * @return string |
|
1011 | + */ |
|
1012 | + public function get_country( $context = 'view' ) { |
|
1013 | + $country = $this->get_prop( 'country', $context ); |
|
1014 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1015 | 1015 | } |
1016 | 1016 | |
1017 | 1017 | /** |
1018 | - * Alias of self::get_country(). |
|
1019 | - * |
|
1020 | - * @since 1.0.19 |
|
1021 | - * @param string $context View or edit context. |
|
1022 | - * @return string |
|
1023 | - */ |
|
1024 | - public function get_user_country( $context = 'view' ) { |
|
1025 | - return $this->get_country( $context ); |
|
1018 | + * Alias of self::get_country(). |
|
1019 | + * |
|
1020 | + * @since 1.0.19 |
|
1021 | + * @param string $context View or edit context. |
|
1022 | + * @return string |
|
1023 | + */ |
|
1024 | + public function get_user_country( $context = 'view' ) { |
|
1025 | + return $this->get_country( $context ); |
|
1026 | 1026 | } |
1027 | 1027 | |
1028 | 1028 | /** |
1029 | - * Alias of self::get_country(). |
|
1030 | - * |
|
1031 | - * @since 1.0.19 |
|
1032 | - * @param string $context View or edit context. |
|
1033 | - * @return string |
|
1034 | - */ |
|
1035 | - public function get_customer_country( $context = 'view' ) { |
|
1036 | - return $this->get_country( $context ); |
|
1029 | + * Alias of self::get_country(). |
|
1030 | + * |
|
1031 | + * @since 1.0.19 |
|
1032 | + * @param string $context View or edit context. |
|
1033 | + * @return string |
|
1034 | + */ |
|
1035 | + public function get_customer_country( $context = 'view' ) { |
|
1036 | + return $this->get_country( $context ); |
|
1037 | 1037 | } |
1038 | 1038 | |
1039 | 1039 | /** |
1040 | - * Get the customer's state. |
|
1041 | - * |
|
1042 | - * @since 1.0.19 |
|
1043 | - * @param string $context View or edit context. |
|
1044 | - * @return string |
|
1045 | - */ |
|
1046 | - public function get_state( $context = 'view' ) { |
|
1047 | - $state = $this->get_prop( 'state', $context ); |
|
1048 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1040 | + * Get the customer's state. |
|
1041 | + * |
|
1042 | + * @since 1.0.19 |
|
1043 | + * @param string $context View or edit context. |
|
1044 | + * @return string |
|
1045 | + */ |
|
1046 | + public function get_state( $context = 'view' ) { |
|
1047 | + $state = $this->get_prop( 'state', $context ); |
|
1048 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1049 | 1049 | } |
1050 | 1050 | |
1051 | 1051 | /** |
1052 | - * Alias of self::get_state(). |
|
1053 | - * |
|
1054 | - * @since 1.0.19 |
|
1055 | - * @param string $context View or edit context. |
|
1056 | - * @return string |
|
1057 | - */ |
|
1058 | - public function get_user_state( $context = 'view' ) { |
|
1059 | - return $this->get_state( $context ); |
|
1052 | + * Alias of self::get_state(). |
|
1053 | + * |
|
1054 | + * @since 1.0.19 |
|
1055 | + * @param string $context View or edit context. |
|
1056 | + * @return string |
|
1057 | + */ |
|
1058 | + public function get_user_state( $context = 'view' ) { |
|
1059 | + return $this->get_state( $context ); |
|
1060 | 1060 | } |
1061 | 1061 | |
1062 | 1062 | /** |
1063 | - * Alias of self::get_state(). |
|
1064 | - * |
|
1065 | - * @since 1.0.19 |
|
1066 | - * @param string $context View or edit context. |
|
1067 | - * @return string |
|
1068 | - */ |
|
1069 | - public function get_customer_state( $context = 'view' ) { |
|
1070 | - return $this->get_state( $context ); |
|
1063 | + * Alias of self::get_state(). |
|
1064 | + * |
|
1065 | + * @since 1.0.19 |
|
1066 | + * @param string $context View or edit context. |
|
1067 | + * @return string |
|
1068 | + */ |
|
1069 | + public function get_customer_state( $context = 'view' ) { |
|
1070 | + return $this->get_state( $context ); |
|
1071 | 1071 | } |
1072 | 1072 | |
1073 | 1073 | /** |
1074 | - * Get the customer's city. |
|
1075 | - * |
|
1076 | - * @since 1.0.19 |
|
1077 | - * @param string $context View or edit context. |
|
1078 | - * @return string |
|
1079 | - */ |
|
1080 | - public function get_city( $context = 'view' ) { |
|
1081 | - return $this->get_prop( 'city', $context ); |
|
1074 | + * Get the customer's city. |
|
1075 | + * |
|
1076 | + * @since 1.0.19 |
|
1077 | + * @param string $context View or edit context. |
|
1078 | + * @return string |
|
1079 | + */ |
|
1080 | + public function get_city( $context = 'view' ) { |
|
1081 | + return $this->get_prop( 'city', $context ); |
|
1082 | 1082 | } |
1083 | 1083 | |
1084 | 1084 | /** |
1085 | - * Alias of self::get_city(). |
|
1086 | - * |
|
1087 | - * @since 1.0.19 |
|
1088 | - * @param string $context View or edit context. |
|
1089 | - * @return string |
|
1090 | - */ |
|
1091 | - public function get_user_city( $context = 'view' ) { |
|
1092 | - return $this->get_city( $context ); |
|
1085 | + * Alias of self::get_city(). |
|
1086 | + * |
|
1087 | + * @since 1.0.19 |
|
1088 | + * @param string $context View or edit context. |
|
1089 | + * @return string |
|
1090 | + */ |
|
1091 | + public function get_user_city( $context = 'view' ) { |
|
1092 | + return $this->get_city( $context ); |
|
1093 | 1093 | } |
1094 | 1094 | |
1095 | 1095 | /** |
1096 | - * Alias of self::get_city(). |
|
1097 | - * |
|
1098 | - * @since 1.0.19 |
|
1099 | - * @param string $context View or edit context. |
|
1100 | - * @return string |
|
1101 | - */ |
|
1102 | - public function get_customer_city( $context = 'view' ) { |
|
1103 | - return $this->get_city( $context ); |
|
1096 | + * Alias of self::get_city(). |
|
1097 | + * |
|
1098 | + * @since 1.0.19 |
|
1099 | + * @param string $context View or edit context. |
|
1100 | + * @return string |
|
1101 | + */ |
|
1102 | + public function get_customer_city( $context = 'view' ) { |
|
1103 | + return $this->get_city( $context ); |
|
1104 | 1104 | } |
1105 | 1105 | |
1106 | 1106 | /** |
1107 | - * Get the customer's zip. |
|
1108 | - * |
|
1109 | - * @since 1.0.19 |
|
1110 | - * @param string $context View or edit context. |
|
1111 | - * @return string |
|
1112 | - */ |
|
1113 | - public function get_zip( $context = 'view' ) { |
|
1114 | - return $this->get_prop( 'zip', $context ); |
|
1107 | + * Get the customer's zip. |
|
1108 | + * |
|
1109 | + * @since 1.0.19 |
|
1110 | + * @param string $context View or edit context. |
|
1111 | + * @return string |
|
1112 | + */ |
|
1113 | + public function get_zip( $context = 'view' ) { |
|
1114 | + return $this->get_prop( 'zip', $context ); |
|
1115 | 1115 | } |
1116 | 1116 | |
1117 | 1117 | /** |
1118 | - * Alias of self::get_zip(). |
|
1119 | - * |
|
1120 | - * @since 1.0.19 |
|
1121 | - * @param string $context View or edit context. |
|
1122 | - * @return string |
|
1123 | - */ |
|
1124 | - public function get_user_zip( $context = 'view' ) { |
|
1125 | - return $this->get_zip( $context ); |
|
1118 | + * Alias of self::get_zip(). |
|
1119 | + * |
|
1120 | + * @since 1.0.19 |
|
1121 | + * @param string $context View or edit context. |
|
1122 | + * @return string |
|
1123 | + */ |
|
1124 | + public function get_user_zip( $context = 'view' ) { |
|
1125 | + return $this->get_zip( $context ); |
|
1126 | 1126 | } |
1127 | 1127 | |
1128 | 1128 | /** |
1129 | - * Alias of self::get_zip(). |
|
1130 | - * |
|
1131 | - * @since 1.0.19 |
|
1132 | - * @param string $context View or edit context. |
|
1133 | - * @return string |
|
1134 | - */ |
|
1135 | - public function get_customer_zip( $context = 'view' ) { |
|
1136 | - return $this->get_zip( $context ); |
|
1129 | + * Alias of self::get_zip(). |
|
1130 | + * |
|
1131 | + * @since 1.0.19 |
|
1132 | + * @param string $context View or edit context. |
|
1133 | + * @return string |
|
1134 | + */ |
|
1135 | + public function get_customer_zip( $context = 'view' ) { |
|
1136 | + return $this->get_zip( $context ); |
|
1137 | 1137 | } |
1138 | 1138 | |
1139 | 1139 | /** |
1140 | - * Get the customer's company. |
|
1141 | - * |
|
1142 | - * @since 1.0.19 |
|
1143 | - * @param string $context View or edit context. |
|
1144 | - * @return string |
|
1145 | - */ |
|
1146 | - public function get_company( $context = 'view' ) { |
|
1147 | - return $this->get_prop( 'company', $context ); |
|
1140 | + * Get the customer's company. |
|
1141 | + * |
|
1142 | + * @since 1.0.19 |
|
1143 | + * @param string $context View or edit context. |
|
1144 | + * @return string |
|
1145 | + */ |
|
1146 | + public function get_company( $context = 'view' ) { |
|
1147 | + return $this->get_prop( 'company', $context ); |
|
1148 | 1148 | } |
1149 | 1149 | |
1150 | 1150 | /** |
1151 | - * Alias of self::get_company(). |
|
1152 | - * |
|
1153 | - * @since 1.0.19 |
|
1154 | - * @param string $context View or edit context. |
|
1155 | - * @return string |
|
1156 | - */ |
|
1157 | - public function get_user_company( $context = 'view' ) { |
|
1158 | - return $this->get_company( $context ); |
|
1151 | + * Alias of self::get_company(). |
|
1152 | + * |
|
1153 | + * @since 1.0.19 |
|
1154 | + * @param string $context View or edit context. |
|
1155 | + * @return string |
|
1156 | + */ |
|
1157 | + public function get_user_company( $context = 'view' ) { |
|
1158 | + return $this->get_company( $context ); |
|
1159 | 1159 | } |
1160 | 1160 | |
1161 | 1161 | /** |
1162 | - * Alias of self::get_company(). |
|
1163 | - * |
|
1164 | - * @since 1.0.19 |
|
1165 | - * @param string $context View or edit context. |
|
1166 | - * @return string |
|
1167 | - */ |
|
1168 | - public function get_customer_company( $context = 'view' ) { |
|
1169 | - return $this->get_company( $context ); |
|
1162 | + * Alias of self::get_company(). |
|
1163 | + * |
|
1164 | + * @since 1.0.19 |
|
1165 | + * @param string $context View or edit context. |
|
1166 | + * @return string |
|
1167 | + */ |
|
1168 | + public function get_customer_company( $context = 'view' ) { |
|
1169 | + return $this->get_company( $context ); |
|
1170 | 1170 | } |
1171 | 1171 | |
1172 | 1172 | /** |
1173 | - * Get the customer's vat number. |
|
1174 | - * |
|
1175 | - * @since 1.0.19 |
|
1176 | - * @param string $context View or edit context. |
|
1177 | - * @return string |
|
1178 | - */ |
|
1179 | - public function get_vat_number( $context = 'view' ) { |
|
1180 | - return $this->get_prop( 'vat_number', $context ); |
|
1173 | + * Get the customer's vat number. |
|
1174 | + * |
|
1175 | + * @since 1.0.19 |
|
1176 | + * @param string $context View or edit context. |
|
1177 | + * @return string |
|
1178 | + */ |
|
1179 | + public function get_vat_number( $context = 'view' ) { |
|
1180 | + return $this->get_prop( 'vat_number', $context ); |
|
1181 | + } |
|
1182 | + |
|
1183 | + /** |
|
1184 | + * Alias of self::get_vat_number(). |
|
1185 | + * |
|
1186 | + * @since 1.0.19 |
|
1187 | + * @param string $context View or edit context. |
|
1188 | + * @return string |
|
1189 | + */ |
|
1190 | + public function get_user_vat_number( $context = 'view' ) { |
|
1191 | + return $this->get_vat_number( $context ); |
|
1192 | + } |
|
1193 | + |
|
1194 | + /** |
|
1195 | + * Alias of self::get_vat_number(). |
|
1196 | + * |
|
1197 | + * @since 1.0.19 |
|
1198 | + * @param string $context View or edit context. |
|
1199 | + * @return string |
|
1200 | + */ |
|
1201 | + public function get_customer_vat_number( $context = 'view' ) { |
|
1202 | + return $this->get_vat_number( $context ); |
|
1203 | + } |
|
1204 | + |
|
1205 | + /** |
|
1206 | + * Get the customer's vat rate. |
|
1207 | + * |
|
1208 | + * @since 1.0.19 |
|
1209 | + * @param string $context View or edit context. |
|
1210 | + * @return string |
|
1211 | + */ |
|
1212 | + public function get_vat_rate( $context = 'view' ) { |
|
1213 | + return $this->get_prop( 'vat_rate', $context ); |
|
1214 | + } |
|
1215 | + |
|
1216 | + /** |
|
1217 | + * Alias of self::get_vat_rate(). |
|
1218 | + * |
|
1219 | + * @since 1.0.19 |
|
1220 | + * @param string $context View or edit context. |
|
1221 | + * @return string |
|
1222 | + */ |
|
1223 | + public function get_user_vat_rate( $context = 'view' ) { |
|
1224 | + return $this->get_vat_rate( $context ); |
|
1225 | + } |
|
1226 | + |
|
1227 | + /** |
|
1228 | + * Alias of self::get_vat_rate(). |
|
1229 | + * |
|
1230 | + * @since 1.0.19 |
|
1231 | + * @param string $context View or edit context. |
|
1232 | + * @return string |
|
1233 | + */ |
|
1234 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
1235 | + return $this->get_vat_rate( $context ); |
|
1236 | + } |
|
1237 | + |
|
1238 | + /** |
|
1239 | + * Get the customer's address. |
|
1240 | + * |
|
1241 | + * @since 1.0.19 |
|
1242 | + * @param string $context View or edit context. |
|
1243 | + * @return string |
|
1244 | + */ |
|
1245 | + public function get_address( $context = 'view' ) { |
|
1246 | + return $this->get_prop( 'address', $context ); |
|
1181 | 1247 | } |
1182 | 1248 | |
1183 | 1249 | /** |
1184 | - * Alias of self::get_vat_number(). |
|
1185 | - * |
|
1186 | - * @since 1.0.19 |
|
1187 | - * @param string $context View or edit context. |
|
1188 | - * @return string |
|
1189 | - */ |
|
1190 | - public function get_user_vat_number( $context = 'view' ) { |
|
1191 | - return $this->get_vat_number( $context ); |
|
1250 | + * Alias of self::get_address(). |
|
1251 | + * |
|
1252 | + * @since 1.0.19 |
|
1253 | + * @param string $context View or edit context. |
|
1254 | + * @return string |
|
1255 | + */ |
|
1256 | + public function get_user_address( $context = 'view' ) { |
|
1257 | + return $this->get_address( $context ); |
|
1192 | 1258 | } |
1193 | 1259 | |
1194 | 1260 | /** |
1195 | - * Alias of self::get_vat_number(). |
|
1196 | - * |
|
1197 | - * @since 1.0.19 |
|
1198 | - * @param string $context View or edit context. |
|
1199 | - * @return string |
|
1200 | - */ |
|
1201 | - public function get_customer_vat_number( $context = 'view' ) { |
|
1202 | - return $this->get_vat_number( $context ); |
|
1261 | + * Alias of self::get_address(). |
|
1262 | + * |
|
1263 | + * @since 1.0.19 |
|
1264 | + * @param string $context View or edit context. |
|
1265 | + * @return string |
|
1266 | + */ |
|
1267 | + public function get_customer_address( $context = 'view' ) { |
|
1268 | + return $this->get_address( $context ); |
|
1203 | 1269 | } |
1204 | 1270 | |
1205 | 1271 | /** |
1206 | - * Get the customer's vat rate. |
|
1207 | - * |
|
1208 | - * @since 1.0.19 |
|
1209 | - * @param string $context View or edit context. |
|
1210 | - * @return string |
|
1211 | - */ |
|
1212 | - public function get_vat_rate( $context = 'view' ) { |
|
1213 | - return $this->get_prop( 'vat_rate', $context ); |
|
1214 | - } |
|
1215 | - |
|
1216 | - /** |
|
1217 | - * Alias of self::get_vat_rate(). |
|
1218 | - * |
|
1219 | - * @since 1.0.19 |
|
1220 | - * @param string $context View or edit context. |
|
1221 | - * @return string |
|
1222 | - */ |
|
1223 | - public function get_user_vat_rate( $context = 'view' ) { |
|
1224 | - return $this->get_vat_rate( $context ); |
|
1225 | - } |
|
1226 | - |
|
1227 | - /** |
|
1228 | - * Alias of self::get_vat_rate(). |
|
1229 | - * |
|
1230 | - * @since 1.0.19 |
|
1231 | - * @param string $context View or edit context. |
|
1232 | - * @return string |
|
1233 | - */ |
|
1234 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
1235 | - return $this->get_vat_rate( $context ); |
|
1236 | - } |
|
1237 | - |
|
1238 | - /** |
|
1239 | - * Get the customer's address. |
|
1240 | - * |
|
1241 | - * @since 1.0.19 |
|
1242 | - * @param string $context View or edit context. |
|
1243 | - * @return string |
|
1244 | - */ |
|
1245 | - public function get_address( $context = 'view' ) { |
|
1246 | - return $this->get_prop( 'address', $context ); |
|
1247 | - } |
|
1248 | - |
|
1249 | - /** |
|
1250 | - * Alias of self::get_address(). |
|
1251 | - * |
|
1252 | - * @since 1.0.19 |
|
1253 | - * @param string $context View or edit context. |
|
1254 | - * @return string |
|
1255 | - */ |
|
1256 | - public function get_user_address( $context = 'view' ) { |
|
1257 | - return $this->get_address( $context ); |
|
1258 | - } |
|
1259 | - |
|
1260 | - /** |
|
1261 | - * Alias of self::get_address(). |
|
1262 | - * |
|
1263 | - * @since 1.0.19 |
|
1264 | - * @param string $context View or edit context. |
|
1265 | - * @return string |
|
1266 | - */ |
|
1267 | - public function get_customer_address( $context = 'view' ) { |
|
1268 | - return $this->get_address( $context ); |
|
1269 | - } |
|
1270 | - |
|
1271 | - /** |
|
1272 | - * Get whether the customer has viewed the invoice or not. |
|
1273 | - * |
|
1274 | - * @since 1.0.19 |
|
1275 | - * @param string $context View or edit context. |
|
1276 | - * @return bool |
|
1277 | - */ |
|
1278 | - public function get_is_viewed( $context = 'view' ) { |
|
1279 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1280 | - } |
|
1281 | - |
|
1282 | - /** |
|
1283 | - * Get other recipients for invoice communications. |
|
1284 | - * |
|
1285 | - * @since 1.0.19 |
|
1286 | - * @param string $context View or edit context. |
|
1287 | - * @return bool |
|
1288 | - */ |
|
1289 | - public function get_email_cc( $context = 'view' ) { |
|
1290 | - return $this->get_prop( 'email_cc', $context ); |
|
1291 | - } |
|
1292 | - |
|
1293 | - /** |
|
1294 | - * Get invoice template. |
|
1295 | - * |
|
1296 | - * @since 1.0.19 |
|
1297 | - * @param string $context View or edit context. |
|
1298 | - * @return bool |
|
1299 | - */ |
|
1300 | - public function get_template( $context = 'view' ) { |
|
1301 | - return $this->get_prop( 'template', $context ); |
|
1302 | - } |
|
1303 | - |
|
1304 | - /** |
|
1305 | - * Get invoice source. |
|
1306 | - * |
|
1307 | - * @since 1.0.19 |
|
1308 | - * @param string $context View or edit context. |
|
1309 | - * @return bool |
|
1310 | - */ |
|
1311 | - public function get_created_via( $context = 'view' ) { |
|
1312 | - return $this->get_prop( 'created_via', $context ); |
|
1313 | - } |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * Get whether the customer has confirmed their address. |
|
1317 | - * |
|
1318 | - * @since 1.0.19 |
|
1319 | - * @param string $context View or edit context. |
|
1320 | - * @return bool |
|
1321 | - */ |
|
1322 | - public function get_address_confirmed( $context = 'view' ) { |
|
1323 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1324 | - } |
|
1325 | - |
|
1326 | - /** |
|
1327 | - * Alias of self::get_address_confirmed(). |
|
1328 | - * |
|
1329 | - * @since 1.0.19 |
|
1330 | - * @param string $context View or edit context. |
|
1331 | - * @return bool |
|
1332 | - */ |
|
1333 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
1334 | - return $this->get_address_confirmed( $context ); |
|
1335 | - } |
|
1336 | - |
|
1337 | - /** |
|
1338 | - * Alias of self::get_address(). |
|
1339 | - * |
|
1340 | - * @since 1.0.19 |
|
1341 | - * @param string $context View or edit context. |
|
1342 | - * @return bool |
|
1343 | - */ |
|
1344 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
1345 | - return $this->get_address_confirmed( $context ); |
|
1346 | - } |
|
1347 | - |
|
1348 | - /** |
|
1349 | - * Get the invoice subtotal. |
|
1350 | - * |
|
1351 | - * @since 1.0.19 |
|
1352 | - * @param string $context View or edit context. |
|
1353 | - * @return float |
|
1354 | - */ |
|
1355 | - public function get_subtotal( $context = 'view' ) { |
|
1272 | + * Get whether the customer has viewed the invoice or not. |
|
1273 | + * |
|
1274 | + * @since 1.0.19 |
|
1275 | + * @param string $context View or edit context. |
|
1276 | + * @return bool |
|
1277 | + */ |
|
1278 | + public function get_is_viewed( $context = 'view' ) { |
|
1279 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1280 | + } |
|
1281 | + |
|
1282 | + /** |
|
1283 | + * Get other recipients for invoice communications. |
|
1284 | + * |
|
1285 | + * @since 1.0.19 |
|
1286 | + * @param string $context View or edit context. |
|
1287 | + * @return bool |
|
1288 | + */ |
|
1289 | + public function get_email_cc( $context = 'view' ) { |
|
1290 | + return $this->get_prop( 'email_cc', $context ); |
|
1291 | + } |
|
1292 | + |
|
1293 | + /** |
|
1294 | + * Get invoice template. |
|
1295 | + * |
|
1296 | + * @since 1.0.19 |
|
1297 | + * @param string $context View or edit context. |
|
1298 | + * @return bool |
|
1299 | + */ |
|
1300 | + public function get_template( $context = 'view' ) { |
|
1301 | + return $this->get_prop( 'template', $context ); |
|
1302 | + } |
|
1303 | + |
|
1304 | + /** |
|
1305 | + * Get invoice source. |
|
1306 | + * |
|
1307 | + * @since 1.0.19 |
|
1308 | + * @param string $context View or edit context. |
|
1309 | + * @return bool |
|
1310 | + */ |
|
1311 | + public function get_created_via( $context = 'view' ) { |
|
1312 | + return $this->get_prop( 'created_via', $context ); |
|
1313 | + } |
|
1314 | + |
|
1315 | + /** |
|
1316 | + * Get whether the customer has confirmed their address. |
|
1317 | + * |
|
1318 | + * @since 1.0.19 |
|
1319 | + * @param string $context View or edit context. |
|
1320 | + * @return bool |
|
1321 | + */ |
|
1322 | + public function get_address_confirmed( $context = 'view' ) { |
|
1323 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1324 | + } |
|
1325 | + |
|
1326 | + /** |
|
1327 | + * Alias of self::get_address_confirmed(). |
|
1328 | + * |
|
1329 | + * @since 1.0.19 |
|
1330 | + * @param string $context View or edit context. |
|
1331 | + * @return bool |
|
1332 | + */ |
|
1333 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
1334 | + return $this->get_address_confirmed( $context ); |
|
1335 | + } |
|
1336 | + |
|
1337 | + /** |
|
1338 | + * Alias of self::get_address(). |
|
1339 | + * |
|
1340 | + * @since 1.0.19 |
|
1341 | + * @param string $context View or edit context. |
|
1342 | + * @return bool |
|
1343 | + */ |
|
1344 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
1345 | + return $this->get_address_confirmed( $context ); |
|
1346 | + } |
|
1347 | + |
|
1348 | + /** |
|
1349 | + * Get the invoice subtotal. |
|
1350 | + * |
|
1351 | + * @since 1.0.19 |
|
1352 | + * @param string $context View or edit context. |
|
1353 | + * @return float |
|
1354 | + */ |
|
1355 | + public function get_subtotal( $context = 'view' ) { |
|
1356 | 1356 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
1357 | 1357 | |
1358 | 1358 | // Backwards compatibility. |
@@ -1364,167 +1364,167 @@ discard block |
||
1364 | 1364 | } |
1365 | 1365 | |
1366 | 1366 | /** |
1367 | - * Get the invoice discount total. |
|
1368 | - * |
|
1369 | - * @since 1.0.19 |
|
1370 | - * @param string $context View or edit context. |
|
1371 | - * @return float |
|
1372 | - */ |
|
1373 | - public function get_total_discount( $context = 'view' ) { |
|
1374 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1367 | + * Get the invoice discount total. |
|
1368 | + * |
|
1369 | + * @since 1.0.19 |
|
1370 | + * @param string $context View or edit context. |
|
1371 | + * @return float |
|
1372 | + */ |
|
1373 | + public function get_total_discount( $context = 'view' ) { |
|
1374 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1375 | + } |
|
1376 | + |
|
1377 | + /** |
|
1378 | + * Get the invoice tax total. |
|
1379 | + * |
|
1380 | + * @since 1.0.19 |
|
1381 | + * @param string $context View or edit context. |
|
1382 | + * @return float |
|
1383 | + */ |
|
1384 | + public function get_total_tax( $context = 'view' ) { |
|
1385 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1375 | 1386 | } |
1376 | 1387 | |
1377 | 1388 | /** |
1378 | - * Get the invoice tax total. |
|
1379 | - * |
|
1380 | - * @since 1.0.19 |
|
1381 | - * @param string $context View or edit context. |
|
1382 | - * @return float |
|
1383 | - */ |
|
1384 | - public function get_total_tax( $context = 'view' ) { |
|
1385 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1386 | - } |
|
1387 | - |
|
1388 | - /** |
|
1389 | - * @deprecated |
|
1390 | - */ |
|
1391 | - public function get_final_tax( $currency = false ) { |
|
1392 | - $tax = $this->get_total_tax(); |
|
1389 | + * @deprecated |
|
1390 | + */ |
|
1391 | + public function get_final_tax( $currency = false ) { |
|
1392 | + $tax = $this->get_total_tax(); |
|
1393 | 1393 | |
1394 | 1394 | if ( $currency ) { |
1395 | - return wpinv_price( $tax, $this->get_currency() ); |
|
1395 | + return wpinv_price( $tax, $this->get_currency() ); |
|
1396 | 1396 | } |
1397 | 1397 | |
1398 | 1398 | return $tax; |
1399 | 1399 | } |
1400 | 1400 | |
1401 | 1401 | /** |
1402 | - * Get the invoice fees total. |
|
1403 | - * |
|
1404 | - * @since 1.0.19 |
|
1405 | - * @param string $context View or edit context. |
|
1406 | - * @return float |
|
1407 | - */ |
|
1408 | - public function get_total_fees( $context = 'view' ) { |
|
1409 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1402 | + * Get the invoice fees total. |
|
1403 | + * |
|
1404 | + * @since 1.0.19 |
|
1405 | + * @param string $context View or edit context. |
|
1406 | + * @return float |
|
1407 | + */ |
|
1408 | + public function get_total_fees( $context = 'view' ) { |
|
1409 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1410 | 1410 | } |
1411 | 1411 | |
1412 | 1412 | /** |
1413 | - * Alias for self::get_total_fees(). |
|
1414 | - * |
|
1415 | - * @since 1.0.19 |
|
1416 | - * @param string $context View or edit context. |
|
1417 | - * @return float |
|
1418 | - */ |
|
1419 | - public function get_fees_total( $context = 'view' ) { |
|
1420 | - return $this->get_total_fees( $context ); |
|
1413 | + * Alias for self::get_total_fees(). |
|
1414 | + * |
|
1415 | + * @since 1.0.19 |
|
1416 | + * @param string $context View or edit context. |
|
1417 | + * @return float |
|
1418 | + */ |
|
1419 | + public function get_fees_total( $context = 'view' ) { |
|
1420 | + return $this->get_total_fees( $context ); |
|
1421 | 1421 | } |
1422 | 1422 | |
1423 | 1423 | /** |
1424 | - * Get the invoice total. |
|
1425 | - * |
|
1426 | - * @since 1.0.19 |
|
1424 | + * Get the invoice total. |
|
1425 | + * |
|
1426 | + * @since 1.0.19 |
|
1427 | 1427 | * @return float |
1428 | - */ |
|
1429 | - public function get_total() { |
|
1430 | - $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
1431 | - return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
1432 | - } |
|
1428 | + */ |
|
1429 | + public function get_total() { |
|
1430 | + $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
1431 | + return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
1432 | + } |
|
1433 | 1433 | |
1434 | - /** |
|
1435 | - * Get the invoice totals. |
|
1436 | - * |
|
1437 | - * @since 1.0.19 |
|
1434 | + /** |
|
1435 | + * Get the invoice totals. |
|
1436 | + * |
|
1437 | + * @since 1.0.19 |
|
1438 | 1438 | * @return array |
1439 | - */ |
|
1440 | - public function get_totals() { |
|
1441 | - return $this->totals; |
|
1439 | + */ |
|
1440 | + public function get_totals() { |
|
1441 | + return $this->totals; |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | /** |
1445 | - * Get the initial invoice total. |
|
1446 | - * |
|
1447 | - * @since 1.0.19 |
|
1445 | + * Get the initial invoice total. |
|
1446 | + * |
|
1447 | + * @since 1.0.19 |
|
1448 | 1448 | * @param string $context View or edit context. |
1449 | 1449 | * @return float |
1450 | - */ |
|
1450 | + */ |
|
1451 | 1451 | public function get_initial_total() { |
1452 | 1452 | |
1453 | - if ( empty( $this->totals ) ) { |
|
1454 | - $this->recalculate_total(); |
|
1455 | - } |
|
1453 | + if ( empty( $this->totals ) ) { |
|
1454 | + $this->recalculate_total(); |
|
1455 | + } |
|
1456 | 1456 | |
1457 | - $tax = $this->totals['tax']['initial']; |
|
1458 | - $fee = $this->totals['fee']['initial']; |
|
1459 | - $discount = $this->totals['discount']['initial']; |
|
1460 | - $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | - $total = $tax + $fee - $discount + $subtotal; |
|
1457 | + $tax = $this->totals['tax']['initial']; |
|
1458 | + $fee = $this->totals['fee']['initial']; |
|
1459 | + $discount = $this->totals['discount']['initial']; |
|
1460 | + $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | + $total = $tax + $fee - $discount + $subtotal; |
|
1462 | 1462 | |
1463 | - if ( 0 > $total ) { |
|
1464 | - $total = 0; |
|
1465 | - } |
|
1463 | + if ( 0 > $total ) { |
|
1464 | + $total = 0; |
|
1465 | + } |
|
1466 | 1466 | |
1467 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1467 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1468 | 1468 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
1469 | - } |
|
1469 | + } |
|
1470 | 1470 | |
1471 | - /** |
|
1472 | - * Get the recurring invoice total. |
|
1473 | - * |
|
1474 | - * @since 1.0.19 |
|
1471 | + /** |
|
1472 | + * Get the recurring invoice total. |
|
1473 | + * |
|
1474 | + * @since 1.0.19 |
|
1475 | 1475 | * @param string $context View or edit context. |
1476 | 1476 | * @return float |
1477 | - */ |
|
1477 | + */ |
|
1478 | 1478 | public function get_recurring_total() { |
1479 | 1479 | |
1480 | - if ( empty( $this->totals ) ) { |
|
1481 | - $this->recalculate_total(); |
|
1482 | - } |
|
1480 | + if ( empty( $this->totals ) ) { |
|
1481 | + $this->recalculate_total(); |
|
1482 | + } |
|
1483 | 1483 | |
1484 | - $tax = $this->totals['tax']['recurring']; |
|
1485 | - $fee = $this->totals['fee']['recurring']; |
|
1486 | - $discount = $this->totals['discount']['recurring']; |
|
1487 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | - $total = $tax + $fee - $discount + $subtotal; |
|
1484 | + $tax = $this->totals['tax']['recurring']; |
|
1485 | + $fee = $this->totals['fee']['recurring']; |
|
1486 | + $discount = $this->totals['discount']['recurring']; |
|
1487 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | + $total = $tax + $fee - $discount + $subtotal; |
|
1489 | 1489 | |
1490 | - if ( 0 > $total ) { |
|
1491 | - $total = 0; |
|
1492 | - } |
|
1490 | + if ( 0 > $total ) { |
|
1491 | + $total = 0; |
|
1492 | + } |
|
1493 | 1493 | |
1494 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1494 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1495 | 1495 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
1496 | - } |
|
1496 | + } |
|
1497 | 1497 | |
1498 | - /** |
|
1499 | - * Returns recurring payment details. |
|
1500 | - * |
|
1501 | - * @since 1.0.19 |
|
1498 | + /** |
|
1499 | + * Returns recurring payment details. |
|
1500 | + * |
|
1501 | + * @since 1.0.19 |
|
1502 | 1502 | * @param string $field Optionally provide a field to return. |
1503 | - * @param string $currency Whether to include the currency. |
|
1503 | + * @param string $currency Whether to include the currency. |
|
1504 | 1504 | * @return float|string |
1505 | - */ |
|
1505 | + */ |
|
1506 | 1506 | public function get_recurring_details( $field = '', $currency = false ) { |
1507 | 1507 | |
1508 | - // Maybe recalculate totals. |
|
1509 | - if ( empty( $this->totals ) ) { |
|
1510 | - $this->recalculate_total(); |
|
1511 | - } |
|
1508 | + // Maybe recalculate totals. |
|
1509 | + if ( empty( $this->totals ) ) { |
|
1510 | + $this->recalculate_total(); |
|
1511 | + } |
|
1512 | 1512 | |
1513 | - // Prepare recurring totals. |
|
1513 | + // Prepare recurring totals. |
|
1514 | 1514 | $data = apply_filters( |
1515 | - 'wpinv_get_invoice_recurring_details', |
|
1516 | - array( |
|
1517 | - 'cart_details' => $this->get_cart_details(), |
|
1518 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | - 'discount' => $this->totals['discount']['recurring'], |
|
1520 | - 'tax' => $this->totals['tax']['recurring'], |
|
1521 | - 'fee' => $this->totals['fee']['recurring'], |
|
1522 | - 'total' => $this->get_recurring_total(), |
|
1523 | - ), |
|
1524 | - $this, |
|
1525 | - $field, |
|
1526 | - $currency |
|
1527 | - ); |
|
1515 | + 'wpinv_get_invoice_recurring_details', |
|
1516 | + array( |
|
1517 | + 'cart_details' => $this->get_cart_details(), |
|
1518 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | + 'discount' => $this->totals['discount']['recurring'], |
|
1520 | + 'tax' => $this->totals['tax']['recurring'], |
|
1521 | + 'fee' => $this->totals['fee']['recurring'], |
|
1522 | + 'total' => $this->get_recurring_total(), |
|
1523 | + ), |
|
1524 | + $this, |
|
1525 | + $field, |
|
1526 | + $currency |
|
1527 | + ); |
|
1528 | 1528 | |
1529 | 1529 | if ( isset( $data[$field] ) ) { |
1530 | 1530 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1534,166 +1534,166 @@ discard block |
||
1534 | 1534 | } |
1535 | 1535 | |
1536 | 1536 | /** |
1537 | - * Get the invoice fees. |
|
1538 | - * |
|
1539 | - * @since 1.0.19 |
|
1540 | - * @param string $context View or edit context. |
|
1541 | - * @return array |
|
1542 | - */ |
|
1543 | - public function get_fees( $context = 'view' ) { |
|
1544 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1537 | + * Get the invoice fees. |
|
1538 | + * |
|
1539 | + * @since 1.0.19 |
|
1540 | + * @param string $context View or edit context. |
|
1541 | + * @return array |
|
1542 | + */ |
|
1543 | + public function get_fees( $context = 'view' ) { |
|
1544 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1545 | 1545 | } |
1546 | 1546 | |
1547 | 1547 | /** |
1548 | - * Get the invoice discounts. |
|
1549 | - * |
|
1550 | - * @since 1.0.19 |
|
1551 | - * @param string $context View or edit context. |
|
1552 | - * @return array |
|
1553 | - */ |
|
1554 | - public function get_discounts( $context = 'view' ) { |
|
1555 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1548 | + * Get the invoice discounts. |
|
1549 | + * |
|
1550 | + * @since 1.0.19 |
|
1551 | + * @param string $context View or edit context. |
|
1552 | + * @return array |
|
1553 | + */ |
|
1554 | + public function get_discounts( $context = 'view' ) { |
|
1555 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1556 | 1556 | } |
1557 | 1557 | |
1558 | 1558 | /** |
1559 | - * Get the invoice taxes. |
|
1560 | - * |
|
1561 | - * @since 1.0.19 |
|
1562 | - * @param string $context View or edit context. |
|
1563 | - * @return array |
|
1564 | - */ |
|
1565 | - public function get_taxes( $context = 'view' ) { |
|
1566 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1559 | + * Get the invoice taxes. |
|
1560 | + * |
|
1561 | + * @since 1.0.19 |
|
1562 | + * @param string $context View or edit context. |
|
1563 | + * @return array |
|
1564 | + */ |
|
1565 | + public function get_taxes( $context = 'view' ) { |
|
1566 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1567 | 1567 | } |
1568 | 1568 | |
1569 | 1569 | /** |
1570 | - * Get the invoice items. |
|
1571 | - * |
|
1572 | - * @since 1.0.19 |
|
1573 | - * @param string $context View or edit context. |
|
1574 | - * @return GetPaid_Form_Item[] |
|
1575 | - */ |
|
1576 | - public function get_items( $context = 'view' ) { |
|
1570 | + * Get the invoice items. |
|
1571 | + * |
|
1572 | + * @since 1.0.19 |
|
1573 | + * @param string $context View or edit context. |
|
1574 | + * @return GetPaid_Form_Item[] |
|
1575 | + */ |
|
1576 | + public function get_items( $context = 'view' ) { |
|
1577 | 1577 | return $this->get_prop( 'items', $context ); |
1578 | - } |
|
1578 | + } |
|
1579 | 1579 | |
1580 | - /** |
|
1581 | - * Get the invoice item ids. |
|
1582 | - * |
|
1583 | - * @since 1.0.19 |
|
1584 | - * @return string |
|
1585 | - */ |
|
1586 | - public function get_item_ids() { |
|
1587 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1580 | + /** |
|
1581 | + * Get the invoice item ids. |
|
1582 | + * |
|
1583 | + * @since 1.0.19 |
|
1584 | + * @return string |
|
1585 | + */ |
|
1586 | + public function get_item_ids() { |
|
1587 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1588 | 1588 | } |
1589 | 1589 | |
1590 | 1590 | /** |
1591 | - * Get the invoice's payment form. |
|
1592 | - * |
|
1593 | - * @since 1.0.19 |
|
1594 | - * @param string $context View or edit context. |
|
1595 | - * @return int |
|
1596 | - */ |
|
1597 | - public function get_payment_form( $context = 'view' ) { |
|
1598 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1591 | + * Get the invoice's payment form. |
|
1592 | + * |
|
1593 | + * @since 1.0.19 |
|
1594 | + * @param string $context View or edit context. |
|
1595 | + * @return int |
|
1596 | + */ |
|
1597 | + public function get_payment_form( $context = 'view' ) { |
|
1598 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1599 | 1599 | } |
1600 | 1600 | |
1601 | 1601 | /** |
1602 | - * Get the invoice's submission id. |
|
1603 | - * |
|
1604 | - * @since 1.0.19 |
|
1605 | - * @param string $context View or edit context. |
|
1606 | - * @return string |
|
1607 | - */ |
|
1608 | - public function get_submission_id( $context = 'view' ) { |
|
1609 | - return $this->get_prop( 'submission_id', $context ); |
|
1602 | + * Get the invoice's submission id. |
|
1603 | + * |
|
1604 | + * @since 1.0.19 |
|
1605 | + * @param string $context View or edit context. |
|
1606 | + * @return string |
|
1607 | + */ |
|
1608 | + public function get_submission_id( $context = 'view' ) { |
|
1609 | + return $this->get_prop( 'submission_id', $context ); |
|
1610 | 1610 | } |
1611 | 1611 | |
1612 | 1612 | /** |
1613 | - * Get the invoice's discount code. |
|
1614 | - * |
|
1615 | - * @since 1.0.19 |
|
1616 | - * @param string $context View or edit context. |
|
1617 | - * @return string |
|
1618 | - */ |
|
1619 | - public function get_discount_code( $context = 'view' ) { |
|
1620 | - return $this->get_prop( 'discount_code', $context ); |
|
1613 | + * Get the invoice's discount code. |
|
1614 | + * |
|
1615 | + * @since 1.0.19 |
|
1616 | + * @param string $context View or edit context. |
|
1617 | + * @return string |
|
1618 | + */ |
|
1619 | + public function get_discount_code( $context = 'view' ) { |
|
1620 | + return $this->get_prop( 'discount_code', $context ); |
|
1621 | 1621 | } |
1622 | 1622 | |
1623 | 1623 | /** |
1624 | - * Get the invoice's gateway. |
|
1625 | - * |
|
1626 | - * @since 1.0.19 |
|
1627 | - * @param string $context View or edit context. |
|
1628 | - * @return string |
|
1629 | - */ |
|
1630 | - public function get_gateway( $context = 'view' ) { |
|
1631 | - return $this->get_prop( 'gateway', $context ); |
|
1624 | + * Get the invoice's gateway. |
|
1625 | + * |
|
1626 | + * @since 1.0.19 |
|
1627 | + * @param string $context View or edit context. |
|
1628 | + * @return string |
|
1629 | + */ |
|
1630 | + public function get_gateway( $context = 'view' ) { |
|
1631 | + return $this->get_prop( 'gateway', $context ); |
|
1632 | 1632 | } |
1633 | 1633 | |
1634 | 1634 | /** |
1635 | - * Get the invoice's gateway display title. |
|
1636 | - * |
|
1637 | - * @since 1.0.19 |
|
1638 | - * @return string |
|
1639 | - */ |
|
1635 | + * Get the invoice's gateway display title. |
|
1636 | + * |
|
1637 | + * @since 1.0.19 |
|
1638 | + * @return string |
|
1639 | + */ |
|
1640 | 1640 | public function get_gateway_title() { |
1641 | 1641 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
1642 | 1642 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
1643 | 1643 | } |
1644 | 1644 | |
1645 | 1645 | /** |
1646 | - * Get the invoice's transaction id. |
|
1647 | - * |
|
1648 | - * @since 1.0.19 |
|
1649 | - * @param string $context View or edit context. |
|
1650 | - * @return string |
|
1651 | - */ |
|
1652 | - public function get_transaction_id( $context = 'view' ) { |
|
1653 | - return $this->get_prop( 'transaction_id', $context ); |
|
1646 | + * Get the invoice's transaction id. |
|
1647 | + * |
|
1648 | + * @since 1.0.19 |
|
1649 | + * @param string $context View or edit context. |
|
1650 | + * @return string |
|
1651 | + */ |
|
1652 | + public function get_transaction_id( $context = 'view' ) { |
|
1653 | + return $this->get_prop( 'transaction_id', $context ); |
|
1654 | 1654 | } |
1655 | 1655 | |
1656 | 1656 | /** |
1657 | - * Get the invoice's currency. |
|
1658 | - * |
|
1659 | - * @since 1.0.19 |
|
1660 | - * @param string $context View or edit context. |
|
1661 | - * @return string |
|
1662 | - */ |
|
1663 | - public function get_currency( $context = 'view' ) { |
|
1657 | + * Get the invoice's currency. |
|
1658 | + * |
|
1659 | + * @since 1.0.19 |
|
1660 | + * @param string $context View or edit context. |
|
1661 | + * @return string |
|
1662 | + */ |
|
1663 | + public function get_currency( $context = 'view' ) { |
|
1664 | 1664 | $currency = $this->get_prop( 'currency', $context ); |
1665 | 1665 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
1666 | 1666 | } |
1667 | 1667 | |
1668 | 1668 | /** |
1669 | - * Checks if we are charging taxes for this invoice. |
|
1670 | - * |
|
1671 | - * @since 1.0.19 |
|
1672 | - * @param string $context View or edit context. |
|
1673 | - * @return bool |
|
1674 | - */ |
|
1675 | - public function get_disable_taxes( $context = 'view' ) { |
|
1669 | + * Checks if we are charging taxes for this invoice. |
|
1670 | + * |
|
1671 | + * @since 1.0.19 |
|
1672 | + * @param string $context View or edit context. |
|
1673 | + * @return bool |
|
1674 | + */ |
|
1675 | + public function get_disable_taxes( $context = 'view' ) { |
|
1676 | 1676 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
1677 | 1677 | } |
1678 | 1678 | |
1679 | 1679 | /** |
1680 | - * Retrieves the subscription id for an invoice. |
|
1681 | - * |
|
1682 | - * @since 1.0.19 |
|
1683 | - * @param string $context View or edit context. |
|
1684 | - * @return int |
|
1685 | - */ |
|
1680 | + * Retrieves the subscription id for an invoice. |
|
1681 | + * |
|
1682 | + * @since 1.0.19 |
|
1683 | + * @param string $context View or edit context. |
|
1684 | + * @return int |
|
1685 | + */ |
|
1686 | 1686 | public function get_subscription_id( $context = 'view' ) { |
1687 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | - } |
|
1689 | - |
|
1690 | - /** |
|
1691 | - * Retrieves the remote subscription id for an invoice. |
|
1692 | - * |
|
1693 | - * @since 1.0.19 |
|
1694 | - * @param string $context View or edit context. |
|
1695 | - * @return int |
|
1696 | - */ |
|
1687 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | + } |
|
1689 | + |
|
1690 | + /** |
|
1691 | + * Retrieves the remote subscription id for an invoice. |
|
1692 | + * |
|
1693 | + * @since 1.0.19 |
|
1694 | + * @param string $context View or edit context. |
|
1695 | + * @return int |
|
1696 | + */ |
|
1697 | 1697 | public function get_remote_subscription_id( $context = 'view' ) { |
1698 | 1698 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
1699 | 1699 | |
@@ -1706,12 +1706,12 @@ discard block |
||
1706 | 1706 | } |
1707 | 1707 | |
1708 | 1708 | /** |
1709 | - * Retrieves the payment meta for an invoice. |
|
1710 | - * |
|
1711 | - * @since 1.0.19 |
|
1712 | - * @param string $context View or edit context. |
|
1713 | - * @return array |
|
1714 | - */ |
|
1709 | + * Retrieves the payment meta for an invoice. |
|
1710 | + * |
|
1711 | + * @since 1.0.19 |
|
1712 | + * @param string $context View or edit context. |
|
1713 | + * @return array |
|
1714 | + */ |
|
1715 | 1715 | public function get_payment_meta( $context = 'view' ) { |
1716 | 1716 | |
1717 | 1717 | return array( |
@@ -1731,31 +1731,31 @@ discard block |
||
1731 | 1731 | } |
1732 | 1732 | |
1733 | 1733 | /** |
1734 | - * Retrieves the cart details for an invoice. |
|
1735 | - * |
|
1736 | - * @since 1.0.19 |
|
1737 | - * @return array |
|
1738 | - */ |
|
1734 | + * Retrieves the cart details for an invoice. |
|
1735 | + * |
|
1736 | + * @since 1.0.19 |
|
1737 | + * @return array |
|
1738 | + */ |
|
1739 | 1739 | public function get_cart_details() { |
1740 | 1740 | $items = $this->get_items(); |
1741 | 1741 | $cart_details = array(); |
1742 | 1742 | |
1743 | 1743 | foreach ( $items as $item ) { |
1744 | - $item->invoice_id = $this->get_id(); |
|
1744 | + $item->invoice_id = $this->get_id(); |
|
1745 | 1745 | $cart_details[] = $item->prepare_data_for_saving(); |
1746 | 1746 | } |
1747 | 1747 | |
1748 | 1748 | return $cart_details; |
1749 | - } |
|
1749 | + } |
|
1750 | 1750 | |
1751 | - /** |
|
1752 | - * Retrieves the recurring item. |
|
1753 | - * |
|
1754 | - * @return null|GetPaid_Form_Item|int |
|
1755 | - */ |
|
1756 | - public function get_recurring( $object = false ) { |
|
1751 | + /** |
|
1752 | + * Retrieves the recurring item. |
|
1753 | + * |
|
1754 | + * @return null|GetPaid_Form_Item|int |
|
1755 | + */ |
|
1756 | + public function get_recurring( $object = false ) { |
|
1757 | 1757 | |
1758 | - // Are we returning an object? |
|
1758 | + // Are we returning an object? |
|
1759 | 1759 | if ( $object ) { |
1760 | 1760 | return $this->get_item( $this->recurring_item ); |
1761 | 1761 | } |
@@ -1763,114 +1763,114 @@ discard block |
||
1763 | 1763 | return $this->recurring_item; |
1764 | 1764 | } |
1765 | 1765 | |
1766 | - /** |
|
1767 | - * Retrieves the subscription name. |
|
1768 | - * |
|
1769 | - * @since 1.0.19 |
|
1770 | - * @return string |
|
1771 | - */ |
|
1772 | - public function get_subscription_name() { |
|
1766 | + /** |
|
1767 | + * Retrieves the subscription name. |
|
1768 | + * |
|
1769 | + * @since 1.0.19 |
|
1770 | + * @return string |
|
1771 | + */ |
|
1772 | + public function get_subscription_name() { |
|
1773 | 1773 | |
1774 | - // Retrieve the recurring name |
|
1774 | + // Retrieve the recurring name |
|
1775 | 1775 | $item = $this->get_recurring( true ); |
1776 | 1776 | |
1777 | - // Abort if it does not exist. |
|
1777 | + // Abort if it does not exist. |
|
1778 | 1778 | if ( empty( $item ) ) { |
1779 | 1779 | return ''; |
1780 | 1780 | } |
1781 | 1781 | |
1782 | - // Return the item name. |
|
1782 | + // Return the item name. |
|
1783 | 1783 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
1784 | - } |
|
1785 | - |
|
1786 | - /** |
|
1787 | - * Retrieves the view url. |
|
1788 | - * |
|
1789 | - * @since 1.0.19 |
|
1790 | - * @return string |
|
1791 | - */ |
|
1792 | - public function get_view_url() { |
|
1784 | + } |
|
1785 | + |
|
1786 | + /** |
|
1787 | + * Retrieves the view url. |
|
1788 | + * |
|
1789 | + * @since 1.0.19 |
|
1790 | + * @return string |
|
1791 | + */ |
|
1792 | + public function get_view_url() { |
|
1793 | 1793 | $invoice_url = get_permalink( $this->get_id() ); |
1794 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1794 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1795 | 1795 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
1796 | - } |
|
1796 | + } |
|
1797 | 1797 | |
1798 | - /** |
|
1799 | - * Retrieves the payment url. |
|
1800 | - * |
|
1801 | - * @since 1.0.19 |
|
1802 | - * @return string |
|
1803 | - */ |
|
1804 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1798 | + /** |
|
1799 | + * Retrieves the payment url. |
|
1800 | + * |
|
1801 | + * @since 1.0.19 |
|
1802 | + * @return string |
|
1803 | + */ |
|
1804 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1805 | 1805 | |
1806 | - // Retrieve the checkout url. |
|
1806 | + // Retrieve the checkout url. |
|
1807 | 1807 | $pay_url = wpinv_get_checkout_uri(); |
1808 | 1808 | |
1809 | - // Maybe force ssl. |
|
1809 | + // Maybe force ssl. |
|
1810 | 1810 | if ( is_ssl() ) { |
1811 | 1811 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
1812 | 1812 | } |
1813 | 1813 | |
1814 | - // Add the invoice key. |
|
1815 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1814 | + // Add the invoice key. |
|
1815 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1816 | 1816 | |
1817 | - // (Maybe?) add a secret |
|
1817 | + // (Maybe?) add a secret |
|
1818 | 1818 | if ( $secret ) { |
1819 | 1819 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
1820 | 1820 | } |
1821 | 1821 | |
1822 | 1822 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
1823 | - } |
|
1823 | + } |
|
1824 | 1824 | |
1825 | - /** |
|
1826 | - * Retrieves the receipt url. |
|
1827 | - * |
|
1828 | - * @since 1.0.19 |
|
1829 | - * @return string |
|
1830 | - */ |
|
1831 | - public function get_receipt_url() { |
|
1832 | - |
|
1833 | - // Retrieve the checkout url. |
|
1825 | + /** |
|
1826 | + * Retrieves the receipt url. |
|
1827 | + * |
|
1828 | + * @since 1.0.19 |
|
1829 | + * @return string |
|
1830 | + */ |
|
1831 | + public function get_receipt_url() { |
|
1832 | + |
|
1833 | + // Retrieve the checkout url. |
|
1834 | 1834 | $receipt_url = wpinv_get_success_page_uri(); |
1835 | 1835 | |
1836 | - // Maybe force ssl. |
|
1836 | + // Maybe force ssl. |
|
1837 | 1837 | if ( is_ssl() ) { |
1838 | 1838 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
1839 | 1839 | } |
1840 | 1840 | |
1841 | - // Add the invoice key. |
|
1842 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1841 | + // Add the invoice key. |
|
1842 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1843 | 1843 | |
1844 | 1844 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
1845 | - } |
|
1845 | + } |
|
1846 | 1846 | |
1847 | - /** |
|
1848 | - * Retrieves the default status. |
|
1849 | - * |
|
1850 | - * @since 1.0.19 |
|
1851 | - * @return string |
|
1852 | - */ |
|
1853 | - public function get_default_status() { |
|
1854 | - |
|
1855 | - $type = $this->get_type(); |
|
1856 | - $status = "wpi-$type-pending"; |
|
1857 | - return str_replace( '-invoice', '', $status ); |
|
1858 | - |
|
1859 | - } |
|
1860 | - |
|
1861 | - /** |
|
1862 | - * Magic method for accessing invoice properties. |
|
1863 | - * |
|
1864 | - * @since 1.0.15 |
|
1865 | - * @access public |
|
1866 | - * |
|
1867 | - * @param string $key Discount data to retrieve |
|
1868 | - * @param string $context View or edit context. |
|
1869 | - * @return mixed Value of the given invoice property (if set). |
|
1870 | - */ |
|
1871 | - public function get( $key, $context = 'view' ) { |
|
1847 | + /** |
|
1848 | + * Retrieves the default status. |
|
1849 | + * |
|
1850 | + * @since 1.0.19 |
|
1851 | + * @return string |
|
1852 | + */ |
|
1853 | + public function get_default_status() { |
|
1854 | + |
|
1855 | + $type = $this->get_type(); |
|
1856 | + $status = "wpi-$type-pending"; |
|
1857 | + return str_replace( '-invoice', '', $status ); |
|
1858 | + |
|
1859 | + } |
|
1860 | + |
|
1861 | + /** |
|
1862 | + * Magic method for accessing invoice properties. |
|
1863 | + * |
|
1864 | + * @since 1.0.15 |
|
1865 | + * @access public |
|
1866 | + * |
|
1867 | + * @param string $key Discount data to retrieve |
|
1868 | + * @param string $context View or edit context. |
|
1869 | + * @return mixed Value of the given invoice property (if set). |
|
1870 | + */ |
|
1871 | + public function get( $key, $context = 'view' ) { |
|
1872 | 1872 | return $this->get_prop( $key, $context ); |
1873 | - } |
|
1873 | + } |
|
1874 | 1874 | |
1875 | 1875 | /* |
1876 | 1876 | |-------------------------------------------------------------------------- |
@@ -1883,130 +1883,130 @@ discard block |
||
1883 | 1883 | */ |
1884 | 1884 | |
1885 | 1885 | /** |
1886 | - * Magic method for setting invoice properties. |
|
1887 | - * |
|
1888 | - * @since 1.0.19 |
|
1889 | - * @access public |
|
1890 | - * |
|
1891 | - * @param string $key Discount data to retrieve |
|
1892 | - * @param mixed $value new value. |
|
1893 | - * @return mixed Value of the given invoice property (if set). |
|
1894 | - */ |
|
1895 | - public function set( $key, $value ) { |
|
1886 | + * Magic method for setting invoice properties. |
|
1887 | + * |
|
1888 | + * @since 1.0.19 |
|
1889 | + * @access public |
|
1890 | + * |
|
1891 | + * @param string $key Discount data to retrieve |
|
1892 | + * @param mixed $value new value. |
|
1893 | + * @return mixed Value of the given invoice property (if set). |
|
1894 | + */ |
|
1895 | + public function set( $key, $value ) { |
|
1896 | 1896 | |
1897 | 1897 | $setter = "set_$key"; |
1898 | 1898 | if ( is_callable( array( $this, $setter ) ) ) { |
1899 | 1899 | $this->{$setter}( $value ); |
1900 | 1900 | } |
1901 | 1901 | |
1902 | - } |
|
1902 | + } |
|
1903 | 1903 | |
1904 | - /** |
|
1905 | - * Sets item status. |
|
1906 | - * |
|
1907 | - * @since 1.0.19 |
|
1908 | - * @param string $new_status New status. |
|
1909 | - * @param string $note Optional note to add. |
|
1910 | - * @param bool $manual_update Is this a manual status change?. |
|
1911 | - * @return array details of change. |
|
1912 | - */ |
|
1913 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | - $old_status = $this->get_status(); |
|
1904 | + /** |
|
1905 | + * Sets item status. |
|
1906 | + * |
|
1907 | + * @since 1.0.19 |
|
1908 | + * @param string $new_status New status. |
|
1909 | + * @param string $note Optional note to add. |
|
1910 | + * @param bool $manual_update Is this a manual status change?. |
|
1911 | + * @return array details of change. |
|
1912 | + */ |
|
1913 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | + $old_status = $this->get_status(); |
|
1915 | 1915 | |
1916 | - $statuses = $this->get_all_statuses(); |
|
1916 | + $statuses = $this->get_all_statuses(); |
|
1917 | 1917 | |
1918 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | - unset( $statuses[ 'draft' ] ); |
|
1920 | - } |
|
1918 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | + unset( $statuses[ 'draft' ] ); |
|
1920 | + } |
|
1921 | 1921 | |
1922 | - $this->set_prop( 'status', $new_status ); |
|
1922 | + $this->set_prop( 'status', $new_status ); |
|
1923 | 1923 | |
1924 | - // If setting the status, ensure it's set to a valid status. |
|
1925 | - if ( true === $this->object_read ) { |
|
1924 | + // If setting the status, ensure it's set to a valid status. |
|
1925 | + if ( true === $this->object_read ) { |
|
1926 | 1926 | |
1927 | - // Only allow valid new status. |
|
1928 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | - $new_status = $this->get_default_status(); |
|
1930 | - } |
|
1927 | + // Only allow valid new status. |
|
1928 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | + $new_status = $this->get_default_status(); |
|
1930 | + } |
|
1931 | 1931 | |
1932 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | - $old_status = $this->get_default_status(); |
|
1935 | - } |
|
1932 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | + $old_status = $this->get_default_status(); |
|
1935 | + } |
|
1936 | 1936 | |
1937 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | - $old_status = 'wpi-pending'; |
|
1940 | - } |
|
1937 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | + $old_status = 'wpi-pending'; |
|
1940 | + } |
|
1941 | 1941 | |
1942 | - } |
|
1942 | + } |
|
1943 | 1943 | |
1944 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | - $this->status_transition = array( |
|
1946 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | - 'to' => $new_status, |
|
1948 | - 'note' => $note, |
|
1949 | - 'manual' => (bool) $manual_update, |
|
1950 | - ); |
|
1944 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | + $this->status_transition = array( |
|
1946 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | + 'to' => $new_status, |
|
1948 | + 'note' => $note, |
|
1949 | + 'manual' => (bool) $manual_update, |
|
1950 | + ); |
|
1951 | 1951 | |
1952 | - if ( $manual_update ) { |
|
1953 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | - } |
|
1952 | + if ( $manual_update ) { |
|
1953 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | + } |
|
1955 | 1955 | |
1956 | - $this->maybe_set_date_paid(); |
|
1956 | + $this->maybe_set_date_paid(); |
|
1957 | 1957 | |
1958 | - } |
|
1958 | + } |
|
1959 | 1959 | |
1960 | - return array( |
|
1961 | - 'from' => $old_status, |
|
1962 | - 'to' => $new_status, |
|
1963 | - ); |
|
1964 | - } |
|
1960 | + return array( |
|
1961 | + 'from' => $old_status, |
|
1962 | + 'to' => $new_status, |
|
1963 | + ); |
|
1964 | + } |
|
1965 | 1965 | |
1966 | - /** |
|
1967 | - * Maybe set date paid. |
|
1968 | - * |
|
1969 | - * Sets the date paid variable when transitioning to the payment complete |
|
1970 | - * order status. |
|
1971 | - * |
|
1972 | - * @since 1.0.19 |
|
1973 | - */ |
|
1974 | - public function maybe_set_date_paid() { |
|
1966 | + /** |
|
1967 | + * Maybe set date paid. |
|
1968 | + * |
|
1969 | + * Sets the date paid variable when transitioning to the payment complete |
|
1970 | + * order status. |
|
1971 | + * |
|
1972 | + * @since 1.0.19 |
|
1973 | + */ |
|
1974 | + public function maybe_set_date_paid() { |
|
1975 | 1975 | |
1976 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | - } |
|
1979 | - } |
|
1976 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | + } |
|
1979 | + } |
|
1980 | 1980 | |
1981 | 1981 | /** |
1982 | - * Set parent invoice ID. |
|
1983 | - * |
|
1984 | - * @since 1.0.19 |
|
1985 | - */ |
|
1986 | - public function set_parent_id( $value ) { |
|
1987 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | - return; |
|
1989 | - } |
|
1990 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
1982 | + * Set parent invoice ID. |
|
1983 | + * |
|
1984 | + * @since 1.0.19 |
|
1985 | + */ |
|
1986 | + public function set_parent_id( $value ) { |
|
1987 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | + return; |
|
1989 | + } |
|
1990 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
1991 | 1991 | } |
1992 | 1992 | |
1993 | 1993 | /** |
1994 | - * Set plugin version when the invoice was created. |
|
1995 | - * |
|
1996 | - * @since 1.0.19 |
|
1997 | - */ |
|
1998 | - public function set_version( $value ) { |
|
1999 | - $this->set_prop( 'version', $value ); |
|
1994 | + * Set plugin version when the invoice was created. |
|
1995 | + * |
|
1996 | + * @since 1.0.19 |
|
1997 | + */ |
|
1998 | + public function set_version( $value ) { |
|
1999 | + $this->set_prop( 'version', $value ); |
|
2000 | 2000 | } |
2001 | - |
|
2002 | - /** |
|
2003 | - * Set date when the invoice was created. |
|
2004 | - * |
|
2005 | - * @since 1.0.19 |
|
2006 | - * @param string $value Value to set. |
|
2001 | + |
|
2002 | + /** |
|
2003 | + * Set date when the invoice was created. |
|
2004 | + * |
|
2005 | + * @since 1.0.19 |
|
2006 | + * @param string $value Value to set. |
|
2007 | 2007 | * @return bool Whether or not the date was set. |
2008 | - */ |
|
2009 | - public function set_date_created( $value ) { |
|
2008 | + */ |
|
2009 | + public function set_date_created( $value ) { |
|
2010 | 2010 | $date = strtotime( $value ); |
2011 | 2011 | |
2012 | 2012 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2014,19 +2014,19 @@ discard block |
||
2014 | 2014 | return true; |
2015 | 2015 | } |
2016 | 2016 | |
2017 | - $this->set_prop( 'date_created', '' ); |
|
2018 | - return false; |
|
2017 | + $this->set_prop( 'date_created', '' ); |
|
2018 | + return false; |
|
2019 | 2019 | |
2020 | 2020 | } |
2021 | 2021 | |
2022 | 2022 | /** |
2023 | - * Set date invoice due date. |
|
2024 | - * |
|
2025 | - * @since 1.0.19 |
|
2026 | - * @param string $value Value to set. |
|
2023 | + * Set date invoice due date. |
|
2024 | + * |
|
2025 | + * @since 1.0.19 |
|
2026 | + * @param string $value Value to set. |
|
2027 | 2027 | * @return bool Whether or not the date was set. |
2028 | - */ |
|
2029 | - public function set_due_date( $value ) { |
|
2028 | + */ |
|
2029 | + public function set_due_date( $value ) { |
|
2030 | 2030 | $date = strtotime( $value ); |
2031 | 2031 | |
2032 | 2032 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2034,29 +2034,29 @@ discard block |
||
2034 | 2034 | return true; |
2035 | 2035 | } |
2036 | 2036 | |
2037 | - $this->set_prop( 'due_date', '' ); |
|
2037 | + $this->set_prop( 'due_date', '' ); |
|
2038 | 2038 | return false; |
2039 | 2039 | |
2040 | 2040 | } |
2041 | 2041 | |
2042 | 2042 | /** |
2043 | - * Alias of self::set_due_date(). |
|
2044 | - * |
|
2045 | - * @since 1.0.19 |
|
2046 | - * @param string $value New name. |
|
2047 | - */ |
|
2048 | - public function set_date_due( $value ) { |
|
2049 | - $this->set_due_date( $value ); |
|
2043 | + * Alias of self::set_due_date(). |
|
2044 | + * |
|
2045 | + * @since 1.0.19 |
|
2046 | + * @param string $value New name. |
|
2047 | + */ |
|
2048 | + public function set_date_due( $value ) { |
|
2049 | + $this->set_due_date( $value ); |
|
2050 | 2050 | } |
2051 | 2051 | |
2052 | 2052 | /** |
2053 | - * Set date invoice was completed. |
|
2054 | - * |
|
2055 | - * @since 1.0.19 |
|
2056 | - * @param string $value Value to set. |
|
2053 | + * Set date invoice was completed. |
|
2054 | + * |
|
2055 | + * @since 1.0.19 |
|
2056 | + * @param string $value Value to set. |
|
2057 | 2057 | * @return bool Whether or not the date was set. |
2058 | - */ |
|
2059 | - public function set_completed_date( $value ) { |
|
2058 | + */ |
|
2059 | + public function set_completed_date( $value ) { |
|
2060 | 2060 | $date = strtotime( $value ); |
2061 | 2061 | |
2062 | 2062 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2064,29 +2064,29 @@ discard block |
||
2064 | 2064 | return true; |
2065 | 2065 | } |
2066 | 2066 | |
2067 | - $this->set_prop( 'completed_date', '' ); |
|
2067 | + $this->set_prop( 'completed_date', '' ); |
|
2068 | 2068 | return false; |
2069 | 2069 | |
2070 | 2070 | } |
2071 | 2071 | |
2072 | 2072 | /** |
2073 | - * Alias of self::set_completed_date(). |
|
2074 | - * |
|
2075 | - * @since 1.0.19 |
|
2076 | - * @param string $value New name. |
|
2077 | - */ |
|
2078 | - public function set_date_completed( $value ) { |
|
2079 | - $this->set_completed_date( $value ); |
|
2073 | + * Alias of self::set_completed_date(). |
|
2074 | + * |
|
2075 | + * @since 1.0.19 |
|
2076 | + * @param string $value New name. |
|
2077 | + */ |
|
2078 | + public function set_date_completed( $value ) { |
|
2079 | + $this->set_completed_date( $value ); |
|
2080 | 2080 | } |
2081 | 2081 | |
2082 | 2082 | /** |
2083 | - * Set date when the invoice was last modified. |
|
2084 | - * |
|
2085 | - * @since 1.0.19 |
|
2086 | - * @param string $value Value to set. |
|
2083 | + * Set date when the invoice was last modified. |
|
2084 | + * |
|
2085 | + * @since 1.0.19 |
|
2086 | + * @param string $value Value to set. |
|
2087 | 2087 | * @return bool Whether or not the date was set. |
2088 | - */ |
|
2089 | - public function set_date_modified( $value ) { |
|
2088 | + */ |
|
2089 | + public function set_date_modified( $value ) { |
|
2090 | 2090 | $date = strtotime( $value ); |
2091 | 2091 | |
2092 | 2092 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2094,763 +2094,763 @@ discard block |
||
2094 | 2094 | return true; |
2095 | 2095 | } |
2096 | 2096 | |
2097 | - $this->set_prop( 'date_modified', '' ); |
|
2097 | + $this->set_prop( 'date_modified', '' ); |
|
2098 | 2098 | return false; |
2099 | 2099 | |
2100 | 2100 | } |
2101 | 2101 | |
2102 | 2102 | /** |
2103 | - * Set the invoice number. |
|
2104 | - * |
|
2105 | - * @since 1.0.19 |
|
2106 | - * @param string $value New number. |
|
2107 | - */ |
|
2108 | - public function set_number( $value ) { |
|
2103 | + * Set the invoice number. |
|
2104 | + * |
|
2105 | + * @since 1.0.19 |
|
2106 | + * @param string $value New number. |
|
2107 | + */ |
|
2108 | + public function set_number( $value ) { |
|
2109 | 2109 | $number = sanitize_text_field( $value ); |
2110 | - $this->set_prop( 'number', $number ); |
|
2110 | + $this->set_prop( 'number', $number ); |
|
2111 | 2111 | } |
2112 | 2112 | |
2113 | 2113 | /** |
2114 | - * Set the invoice type. |
|
2115 | - * |
|
2116 | - * @since 1.0.19 |
|
2117 | - * @param string $value Type. |
|
2118 | - */ |
|
2119 | - public function set_type( $value ) { |
|
2114 | + * Set the invoice type. |
|
2115 | + * |
|
2116 | + * @since 1.0.19 |
|
2117 | + * @param string $value Type. |
|
2118 | + */ |
|
2119 | + public function set_type( $value ) { |
|
2120 | 2120 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
2121 | - $this->set_prop( 'type', $type ); |
|
2122 | - } |
|
2121 | + $this->set_prop( 'type', $type ); |
|
2122 | + } |
|
2123 | 2123 | |
2124 | 2124 | /** |
2125 | - * Set the invoice post type. |
|
2126 | - * |
|
2127 | - * @since 1.0.19 |
|
2128 | - * @param string $value Post type. |
|
2129 | - */ |
|
2130 | - public function set_post_type( $value ) { |
|
2125 | + * Set the invoice post type. |
|
2126 | + * |
|
2127 | + * @since 1.0.19 |
|
2128 | + * @param string $value Post type. |
|
2129 | + */ |
|
2130 | + public function set_post_type( $value ) { |
|
2131 | 2131 | if ( getpaid_is_invoice_post_type( $value ) ) { |
2132 | - $this->set_type( $value ); |
|
2132 | + $this->set_type( $value ); |
|
2133 | 2133 | $this->set_prop( 'post_type', $value ); |
2134 | 2134 | } |
2135 | 2135 | } |
2136 | 2136 | |
2137 | 2137 | /** |
2138 | - * Set the invoice key. |
|
2139 | - * |
|
2140 | - * @since 1.0.19 |
|
2141 | - * @param string $value New key. |
|
2142 | - */ |
|
2143 | - public function set_key( $value ) { |
|
2138 | + * Set the invoice key. |
|
2139 | + * |
|
2140 | + * @since 1.0.19 |
|
2141 | + * @param string $value New key. |
|
2142 | + */ |
|
2143 | + public function set_key( $value ) { |
|
2144 | 2144 | $key = sanitize_text_field( $value ); |
2145 | - $this->set_prop( 'key', $key ); |
|
2145 | + $this->set_prop( 'key', $key ); |
|
2146 | 2146 | } |
2147 | 2147 | |
2148 | 2148 | /** |
2149 | - * Set the invoice mode. |
|
2150 | - * |
|
2151 | - * @since 1.0.19 |
|
2152 | - * @param string $value mode. |
|
2153 | - */ |
|
2154 | - public function set_mode( $value ) { |
|
2149 | + * Set the invoice mode. |
|
2150 | + * |
|
2151 | + * @since 1.0.19 |
|
2152 | + * @param string $value mode. |
|
2153 | + */ |
|
2154 | + public function set_mode( $value ) { |
|
2155 | 2155 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
2156 | 2156 | $this->set_prop( 'mode', $value ); |
2157 | 2157 | } |
2158 | 2158 | } |
2159 | 2159 | |
2160 | 2160 | /** |
2161 | - * Set the invoice path. |
|
2162 | - * |
|
2163 | - * @since 1.0.19 |
|
2164 | - * @param string $value path. |
|
2165 | - */ |
|
2166 | - public function set_path( $value ) { |
|
2161 | + * Set the invoice path. |
|
2162 | + * |
|
2163 | + * @since 1.0.19 |
|
2164 | + * @param string $value path. |
|
2165 | + */ |
|
2166 | + public function set_path( $value ) { |
|
2167 | 2167 | $this->set_prop( 'path', $value ); |
2168 | 2168 | } |
2169 | 2169 | |
2170 | 2170 | /** |
2171 | - * Set the invoice name. |
|
2172 | - * |
|
2173 | - * @since 1.0.19 |
|
2174 | - * @param string $value New name. |
|
2175 | - */ |
|
2176 | - public function set_name( $value ) { |
|
2171 | + * Set the invoice name. |
|
2172 | + * |
|
2173 | + * @since 1.0.19 |
|
2174 | + * @param string $value New name. |
|
2175 | + */ |
|
2176 | + public function set_name( $value ) { |
|
2177 | 2177 | $name = sanitize_text_field( $value ); |
2178 | - $this->set_prop( 'name', $name ); |
|
2178 | + $this->set_prop( 'name', $name ); |
|
2179 | 2179 | } |
2180 | 2180 | |
2181 | 2181 | /** |
2182 | - * Alias of self::set_name(). |
|
2183 | - * |
|
2184 | - * @since 1.0.19 |
|
2185 | - * @param string $value New name. |
|
2186 | - */ |
|
2187 | - public function set_title( $value ) { |
|
2188 | - $this->set_name( $value ); |
|
2182 | + * Alias of self::set_name(). |
|
2183 | + * |
|
2184 | + * @since 1.0.19 |
|
2185 | + * @param string $value New name. |
|
2186 | + */ |
|
2187 | + public function set_title( $value ) { |
|
2188 | + $this->set_name( $value ); |
|
2189 | 2189 | } |
2190 | 2190 | |
2191 | 2191 | /** |
2192 | - * Set the invoice description. |
|
2193 | - * |
|
2194 | - * @since 1.0.19 |
|
2195 | - * @param string $value New description. |
|
2196 | - */ |
|
2197 | - public function set_description( $value ) { |
|
2192 | + * Set the invoice description. |
|
2193 | + * |
|
2194 | + * @since 1.0.19 |
|
2195 | + * @param string $value New description. |
|
2196 | + */ |
|
2197 | + public function set_description( $value ) { |
|
2198 | 2198 | $description = wp_kses_post( $value ); |
2199 | - $this->set_prop( 'description', $description ); |
|
2199 | + $this->set_prop( 'description', $description ); |
|
2200 | + } |
|
2201 | + |
|
2202 | + /** |
|
2203 | + * Alias of self::set_description(). |
|
2204 | + * |
|
2205 | + * @since 1.0.19 |
|
2206 | + * @param string $value New description. |
|
2207 | + */ |
|
2208 | + public function set_excerpt( $value ) { |
|
2209 | + $this->set_description( $value ); |
|
2210 | + } |
|
2211 | + |
|
2212 | + /** |
|
2213 | + * Alias of self::set_description(). |
|
2214 | + * |
|
2215 | + * @since 1.0.19 |
|
2216 | + * @param string $value New description. |
|
2217 | + */ |
|
2218 | + public function set_summary( $value ) { |
|
2219 | + $this->set_description( $value ); |
|
2200 | 2220 | } |
2201 | 2221 | |
2202 | 2222 | /** |
2203 | - * Alias of self::set_description(). |
|
2204 | - * |
|
2205 | - * @since 1.0.19 |
|
2206 | - * @param string $value New description. |
|
2207 | - */ |
|
2208 | - public function set_excerpt( $value ) { |
|
2209 | - $this->set_description( $value ); |
|
2223 | + * Set the receiver of the invoice. |
|
2224 | + * |
|
2225 | + * @since 1.0.19 |
|
2226 | + * @param int $value New author. |
|
2227 | + */ |
|
2228 | + public function set_author( $value ) { |
|
2229 | + $user = get_user_by( 'id', (int) $value ); |
|
2230 | + |
|
2231 | + if ( $user && $user->ID ) { |
|
2232 | + $this->set_prop( 'author', $user->ID ); |
|
2233 | + $this->set_prop( 'email', $user->user_email ); |
|
2234 | + } |
|
2235 | + |
|
2210 | 2236 | } |
2211 | 2237 | |
2212 | 2238 | /** |
2213 | - * Alias of self::set_description(). |
|
2214 | - * |
|
2215 | - * @since 1.0.19 |
|
2216 | - * @param string $value New description. |
|
2217 | - */ |
|
2218 | - public function set_summary( $value ) { |
|
2219 | - $this->set_description( $value ); |
|
2239 | + * Alias of self::set_author(). |
|
2240 | + * |
|
2241 | + * @since 1.0.19 |
|
2242 | + * @param int $value New user id. |
|
2243 | + */ |
|
2244 | + public function set_user_id( $value ) { |
|
2245 | + $this->set_author( $value ); |
|
2220 | 2246 | } |
2221 | 2247 | |
2222 | 2248 | /** |
2223 | - * Set the receiver of the invoice. |
|
2224 | - * |
|
2225 | - * @since 1.0.19 |
|
2226 | - * @param int $value New author. |
|
2227 | - */ |
|
2228 | - public function set_author( $value ) { |
|
2229 | - $user = get_user_by( 'id', (int) $value ); |
|
2249 | + * Alias of self::set_author(). |
|
2250 | + * |
|
2251 | + * @since 1.0.19 |
|
2252 | + * @param int $value New user id. |
|
2253 | + */ |
|
2254 | + public function set_customer_id( $value ) { |
|
2255 | + $this->set_author( $value ); |
|
2256 | + } |
|
2230 | 2257 | |
2231 | - if ( $user && $user->ID ) { |
|
2232 | - $this->set_prop( 'author', $user->ID ); |
|
2233 | - $this->set_prop( 'email', $user->user_email ); |
|
2234 | - } |
|
2258 | + /** |
|
2259 | + * Set the customer's ip. |
|
2260 | + * |
|
2261 | + * @since 1.0.19 |
|
2262 | + * @param string $value ip address. |
|
2263 | + */ |
|
2264 | + public function set_ip( $value ) { |
|
2265 | + $this->set_prop( 'ip', $value ); |
|
2266 | + } |
|
2235 | 2267 | |
2268 | + /** |
|
2269 | + * Alias of self::set_ip(). |
|
2270 | + * |
|
2271 | + * @since 1.0.19 |
|
2272 | + * @param string $value ip address. |
|
2273 | + */ |
|
2274 | + public function set_user_ip( $value ) { |
|
2275 | + $this->set_ip( $value ); |
|
2236 | 2276 | } |
2237 | 2277 | |
2238 | 2278 | /** |
2239 | - * Alias of self::set_author(). |
|
2240 | - * |
|
2241 | - * @since 1.0.19 |
|
2242 | - * @param int $value New user id. |
|
2243 | - */ |
|
2244 | - public function set_user_id( $value ) { |
|
2245 | - $this->set_author( $value ); |
|
2279 | + * Set the customer's first name. |
|
2280 | + * |
|
2281 | + * @since 1.0.19 |
|
2282 | + * @param string $value first name. |
|
2283 | + */ |
|
2284 | + public function set_first_name( $value ) { |
|
2285 | + $this->set_prop( 'first_name', $value ); |
|
2246 | 2286 | } |
2247 | 2287 | |
2248 | 2288 | /** |
2249 | - * Alias of self::set_author(). |
|
2250 | - * |
|
2251 | - * @since 1.0.19 |
|
2252 | - * @param int $value New user id. |
|
2253 | - */ |
|
2254 | - public function set_customer_id( $value ) { |
|
2255 | - $this->set_author( $value ); |
|
2289 | + * Alias of self::set_first_name(). |
|
2290 | + * |
|
2291 | + * @since 1.0.19 |
|
2292 | + * @param string $value first name. |
|
2293 | + */ |
|
2294 | + public function set_user_first_name( $value ) { |
|
2295 | + $this->set_first_name( $value ); |
|
2256 | 2296 | } |
2257 | 2297 | |
2258 | 2298 | /** |
2259 | - * Set the customer's ip. |
|
2260 | - * |
|
2261 | - * @since 1.0.19 |
|
2262 | - * @param string $value ip address. |
|
2263 | - */ |
|
2264 | - public function set_ip( $value ) { |
|
2265 | - $this->set_prop( 'ip', $value ); |
|
2299 | + * Alias of self::set_first_name(). |
|
2300 | + * |
|
2301 | + * @since 1.0.19 |
|
2302 | + * @param string $value first name. |
|
2303 | + */ |
|
2304 | + public function set_customer_first_name( $value ) { |
|
2305 | + $this->set_first_name( $value ); |
|
2266 | 2306 | } |
2267 | 2307 | |
2268 | 2308 | /** |
2269 | - * Alias of self::set_ip(). |
|
2270 | - * |
|
2271 | - * @since 1.0.19 |
|
2272 | - * @param string $value ip address. |
|
2273 | - */ |
|
2274 | - public function set_user_ip( $value ) { |
|
2275 | - $this->set_ip( $value ); |
|
2309 | + * Set the customer's last name. |
|
2310 | + * |
|
2311 | + * @since 1.0.19 |
|
2312 | + * @param string $value last name. |
|
2313 | + */ |
|
2314 | + public function set_last_name( $value ) { |
|
2315 | + $this->set_prop( 'last_name', $value ); |
|
2276 | 2316 | } |
2277 | 2317 | |
2278 | 2318 | /** |
2279 | - * Set the customer's first name. |
|
2280 | - * |
|
2281 | - * @since 1.0.19 |
|
2282 | - * @param string $value first name. |
|
2283 | - */ |
|
2284 | - public function set_first_name( $value ) { |
|
2285 | - $this->set_prop( 'first_name', $value ); |
|
2319 | + * Alias of self::set_last_name(). |
|
2320 | + * |
|
2321 | + * @since 1.0.19 |
|
2322 | + * @param string $value last name. |
|
2323 | + */ |
|
2324 | + public function set_user_last_name( $value ) { |
|
2325 | + $this->set_last_name( $value ); |
|
2286 | 2326 | } |
2287 | 2327 | |
2288 | 2328 | /** |
2289 | - * Alias of self::set_first_name(). |
|
2290 | - * |
|
2291 | - * @since 1.0.19 |
|
2292 | - * @param string $value first name. |
|
2293 | - */ |
|
2294 | - public function set_user_first_name( $value ) { |
|
2295 | - $this->set_first_name( $value ); |
|
2329 | + * Alias of self::set_last_name(). |
|
2330 | + * |
|
2331 | + * @since 1.0.19 |
|
2332 | + * @param string $value last name. |
|
2333 | + */ |
|
2334 | + public function set_customer_last_name( $value ) { |
|
2335 | + $this->set_last_name( $value ); |
|
2296 | 2336 | } |
2297 | 2337 | |
2298 | 2338 | /** |
2299 | - * Alias of self::set_first_name(). |
|
2300 | - * |
|
2301 | - * @since 1.0.19 |
|
2302 | - * @param string $value first name. |
|
2303 | - */ |
|
2304 | - public function set_customer_first_name( $value ) { |
|
2305 | - $this->set_first_name( $value ); |
|
2339 | + * Set the customer's phone number. |
|
2340 | + * |
|
2341 | + * @since 1.0.19 |
|
2342 | + * @param string $value phone. |
|
2343 | + */ |
|
2344 | + public function set_phone( $value ) { |
|
2345 | + $this->set_prop( 'phone', $value ); |
|
2306 | 2346 | } |
2307 | 2347 | |
2308 | 2348 | /** |
2309 | - * Set the customer's last name. |
|
2310 | - * |
|
2311 | - * @since 1.0.19 |
|
2312 | - * @param string $value last name. |
|
2313 | - */ |
|
2314 | - public function set_last_name( $value ) { |
|
2315 | - $this->set_prop( 'last_name', $value ); |
|
2349 | + * Alias of self::set_phone(). |
|
2350 | + * |
|
2351 | + * @since 1.0.19 |
|
2352 | + * @param string $value phone. |
|
2353 | + */ |
|
2354 | + public function set_user_phone( $value ) { |
|
2355 | + $this->set_phone( $value ); |
|
2316 | 2356 | } |
2317 | 2357 | |
2318 | 2358 | /** |
2319 | - * Alias of self::set_last_name(). |
|
2320 | - * |
|
2321 | - * @since 1.0.19 |
|
2322 | - * @param string $value last name. |
|
2323 | - */ |
|
2324 | - public function set_user_last_name( $value ) { |
|
2325 | - $this->set_last_name( $value ); |
|
2359 | + * Alias of self::set_phone(). |
|
2360 | + * |
|
2361 | + * @since 1.0.19 |
|
2362 | + * @param string $value phone. |
|
2363 | + */ |
|
2364 | + public function set_customer_phone( $value ) { |
|
2365 | + $this->set_phone( $value ); |
|
2326 | 2366 | } |
2327 | 2367 | |
2328 | 2368 | /** |
2329 | - * Alias of self::set_last_name(). |
|
2330 | - * |
|
2331 | - * @since 1.0.19 |
|
2332 | - * @param string $value last name. |
|
2333 | - */ |
|
2334 | - public function set_customer_last_name( $value ) { |
|
2335 | - $this->set_last_name( $value ); |
|
2369 | + * Alias of self::set_phone(). |
|
2370 | + * |
|
2371 | + * @since 1.0.19 |
|
2372 | + * @param string $value phone. |
|
2373 | + */ |
|
2374 | + public function set_phone_number( $value ) { |
|
2375 | + $this->set_phone( $value ); |
|
2336 | 2376 | } |
2337 | 2377 | |
2338 | 2378 | /** |
2339 | - * Set the customer's phone number. |
|
2340 | - * |
|
2341 | - * @since 1.0.19 |
|
2342 | - * @param string $value phone. |
|
2343 | - */ |
|
2344 | - public function set_phone( $value ) { |
|
2345 | - $this->set_prop( 'phone', $value ); |
|
2379 | + * Set the customer's email address. |
|
2380 | + * |
|
2381 | + * @since 1.0.19 |
|
2382 | + * @param string $value email address. |
|
2383 | + */ |
|
2384 | + public function set_email( $value ) { |
|
2385 | + $this->set_prop( 'email', $value ); |
|
2346 | 2386 | } |
2347 | 2387 | |
2348 | 2388 | /** |
2349 | - * Alias of self::set_phone(). |
|
2350 | - * |
|
2351 | - * @since 1.0.19 |
|
2352 | - * @param string $value phone. |
|
2353 | - */ |
|
2354 | - public function set_user_phone( $value ) { |
|
2355 | - $this->set_phone( $value ); |
|
2389 | + * Alias of self::set_email(). |
|
2390 | + * |
|
2391 | + * @since 1.0.19 |
|
2392 | + * @param string $value email address. |
|
2393 | + */ |
|
2394 | + public function set_user_email( $value ) { |
|
2395 | + $this->set_email( $value ); |
|
2356 | 2396 | } |
2357 | 2397 | |
2358 | 2398 | /** |
2359 | - * Alias of self::set_phone(). |
|
2360 | - * |
|
2361 | - * @since 1.0.19 |
|
2362 | - * @param string $value phone. |
|
2363 | - */ |
|
2364 | - public function set_customer_phone( $value ) { |
|
2365 | - $this->set_phone( $value ); |
|
2399 | + * Alias of self::set_email(). |
|
2400 | + * |
|
2401 | + * @since 1.0.19 |
|
2402 | + * @param string $value email address. |
|
2403 | + */ |
|
2404 | + public function set_email_address( $value ) { |
|
2405 | + $this->set_email( $value ); |
|
2366 | 2406 | } |
2367 | 2407 | |
2368 | 2408 | /** |
2369 | - * Alias of self::set_phone(). |
|
2370 | - * |
|
2371 | - * @since 1.0.19 |
|
2372 | - * @param string $value phone. |
|
2373 | - */ |
|
2374 | - public function set_phone_number( $value ) { |
|
2375 | - $this->set_phone( $value ); |
|
2409 | + * Alias of self::set_email(). |
|
2410 | + * |
|
2411 | + * @since 1.0.19 |
|
2412 | + * @param string $value email address. |
|
2413 | + */ |
|
2414 | + public function set_customer_email( $value ) { |
|
2415 | + $this->set_email( $value ); |
|
2376 | 2416 | } |
2377 | 2417 | |
2378 | 2418 | /** |
2379 | - * Set the customer's email address. |
|
2380 | - * |
|
2381 | - * @since 1.0.19 |
|
2382 | - * @param string $value email address. |
|
2383 | - */ |
|
2384 | - public function set_email( $value ) { |
|
2385 | - $this->set_prop( 'email', $value ); |
|
2419 | + * Set the customer's country. |
|
2420 | + * |
|
2421 | + * @since 1.0.19 |
|
2422 | + * @param string $value country. |
|
2423 | + */ |
|
2424 | + public function set_country( $value ) { |
|
2425 | + $this->set_prop( 'country', $value ); |
|
2386 | 2426 | } |
2387 | 2427 | |
2388 | 2428 | /** |
2389 | - * Alias of self::set_email(). |
|
2390 | - * |
|
2391 | - * @since 1.0.19 |
|
2392 | - * @param string $value email address. |
|
2393 | - */ |
|
2394 | - public function set_user_email( $value ) { |
|
2395 | - $this->set_email( $value ); |
|
2429 | + * Alias of self::set_country(). |
|
2430 | + * |
|
2431 | + * @since 1.0.19 |
|
2432 | + * @param string $value country. |
|
2433 | + */ |
|
2434 | + public function set_user_country( $value ) { |
|
2435 | + $this->set_country( $value ); |
|
2396 | 2436 | } |
2397 | 2437 | |
2398 | 2438 | /** |
2399 | - * Alias of self::set_email(). |
|
2400 | - * |
|
2401 | - * @since 1.0.19 |
|
2402 | - * @param string $value email address. |
|
2403 | - */ |
|
2404 | - public function set_email_address( $value ) { |
|
2405 | - $this->set_email( $value ); |
|
2439 | + * Alias of self::set_country(). |
|
2440 | + * |
|
2441 | + * @since 1.0.19 |
|
2442 | + * @param string $value country. |
|
2443 | + */ |
|
2444 | + public function set_customer_country( $value ) { |
|
2445 | + $this->set_country( $value ); |
|
2406 | 2446 | } |
2407 | 2447 | |
2408 | 2448 | /** |
2409 | - * Alias of self::set_email(). |
|
2410 | - * |
|
2411 | - * @since 1.0.19 |
|
2412 | - * @param string $value email address. |
|
2413 | - */ |
|
2414 | - public function set_customer_email( $value ) { |
|
2415 | - $this->set_email( $value ); |
|
2449 | + * Set the customer's state. |
|
2450 | + * |
|
2451 | + * @since 1.0.19 |
|
2452 | + * @param string $value state. |
|
2453 | + */ |
|
2454 | + public function set_state( $value ) { |
|
2455 | + $this->set_prop( 'state', $value ); |
|
2416 | 2456 | } |
2417 | 2457 | |
2418 | 2458 | /** |
2419 | - * Set the customer's country. |
|
2420 | - * |
|
2421 | - * @since 1.0.19 |
|
2422 | - * @param string $value country. |
|
2423 | - */ |
|
2424 | - public function set_country( $value ) { |
|
2425 | - $this->set_prop( 'country', $value ); |
|
2459 | + * Alias of self::set_state(). |
|
2460 | + * |
|
2461 | + * @since 1.0.19 |
|
2462 | + * @param string $value state. |
|
2463 | + */ |
|
2464 | + public function set_user_state( $value ) { |
|
2465 | + $this->set_state( $value ); |
|
2426 | 2466 | } |
2427 | 2467 | |
2428 | 2468 | /** |
2429 | - * Alias of self::set_country(). |
|
2430 | - * |
|
2431 | - * @since 1.0.19 |
|
2432 | - * @param string $value country. |
|
2433 | - */ |
|
2434 | - public function set_user_country( $value ) { |
|
2435 | - $this->set_country( $value ); |
|
2469 | + * Alias of self::set_state(). |
|
2470 | + * |
|
2471 | + * @since 1.0.19 |
|
2472 | + * @param string $value state. |
|
2473 | + */ |
|
2474 | + public function set_customer_state( $value ) { |
|
2475 | + $this->set_state( $value ); |
|
2436 | 2476 | } |
2437 | 2477 | |
2438 | 2478 | /** |
2439 | - * Alias of self::set_country(). |
|
2440 | - * |
|
2441 | - * @since 1.0.19 |
|
2442 | - * @param string $value country. |
|
2443 | - */ |
|
2444 | - public function set_customer_country( $value ) { |
|
2445 | - $this->set_country( $value ); |
|
2479 | + * Set the customer's city. |
|
2480 | + * |
|
2481 | + * @since 1.0.19 |
|
2482 | + * @param string $value city. |
|
2483 | + */ |
|
2484 | + public function set_city( $value ) { |
|
2485 | + $this->set_prop( 'city', $value ); |
|
2446 | 2486 | } |
2447 | 2487 | |
2448 | 2488 | /** |
2449 | - * Set the customer's state. |
|
2450 | - * |
|
2451 | - * @since 1.0.19 |
|
2452 | - * @param string $value state. |
|
2453 | - */ |
|
2454 | - public function set_state( $value ) { |
|
2455 | - $this->set_prop( 'state', $value ); |
|
2489 | + * Alias of self::set_city(). |
|
2490 | + * |
|
2491 | + * @since 1.0.19 |
|
2492 | + * @param string $value city. |
|
2493 | + */ |
|
2494 | + public function set_user_city( $value ) { |
|
2495 | + $this->set_city( $value ); |
|
2456 | 2496 | } |
2457 | 2497 | |
2458 | 2498 | /** |
2459 | - * Alias of self::set_state(). |
|
2460 | - * |
|
2461 | - * @since 1.0.19 |
|
2462 | - * @param string $value state. |
|
2463 | - */ |
|
2464 | - public function set_user_state( $value ) { |
|
2465 | - $this->set_state( $value ); |
|
2499 | + * Alias of self::set_city(). |
|
2500 | + * |
|
2501 | + * @since 1.0.19 |
|
2502 | + * @param string $value city. |
|
2503 | + */ |
|
2504 | + public function set_customer_city( $value ) { |
|
2505 | + $this->set_city( $value ); |
|
2466 | 2506 | } |
2467 | 2507 | |
2468 | 2508 | /** |
2469 | - * Alias of self::set_state(). |
|
2470 | - * |
|
2471 | - * @since 1.0.19 |
|
2472 | - * @param string $value state. |
|
2473 | - */ |
|
2474 | - public function set_customer_state( $value ) { |
|
2475 | - $this->set_state( $value ); |
|
2509 | + * Set the customer's zip code. |
|
2510 | + * |
|
2511 | + * @since 1.0.19 |
|
2512 | + * @param string $value zip. |
|
2513 | + */ |
|
2514 | + public function set_zip( $value ) { |
|
2515 | + $this->set_prop( 'zip', $value ); |
|
2476 | 2516 | } |
2477 | 2517 | |
2478 | 2518 | /** |
2479 | - * Set the customer's city. |
|
2480 | - * |
|
2481 | - * @since 1.0.19 |
|
2482 | - * @param string $value city. |
|
2483 | - */ |
|
2484 | - public function set_city( $value ) { |
|
2485 | - $this->set_prop( 'city', $value ); |
|
2519 | + * Alias of self::set_zip(). |
|
2520 | + * |
|
2521 | + * @since 1.0.19 |
|
2522 | + * @param string $value zip. |
|
2523 | + */ |
|
2524 | + public function set_user_zip( $value ) { |
|
2525 | + $this->set_zip( $value ); |
|
2486 | 2526 | } |
2487 | 2527 | |
2488 | 2528 | /** |
2489 | - * Alias of self::set_city(). |
|
2490 | - * |
|
2491 | - * @since 1.0.19 |
|
2492 | - * @param string $value city. |
|
2493 | - */ |
|
2494 | - public function set_user_city( $value ) { |
|
2495 | - $this->set_city( $value ); |
|
2529 | + * Alias of self::set_zip(). |
|
2530 | + * |
|
2531 | + * @since 1.0.19 |
|
2532 | + * @param string $value zip. |
|
2533 | + */ |
|
2534 | + public function set_customer_zip( $value ) { |
|
2535 | + $this->set_zip( $value ); |
|
2496 | 2536 | } |
2497 | 2537 | |
2498 | 2538 | /** |
2499 | - * Alias of self::set_city(). |
|
2500 | - * |
|
2501 | - * @since 1.0.19 |
|
2502 | - * @param string $value city. |
|
2503 | - */ |
|
2504 | - public function set_customer_city( $value ) { |
|
2505 | - $this->set_city( $value ); |
|
2539 | + * Set the customer's company. |
|
2540 | + * |
|
2541 | + * @since 1.0.19 |
|
2542 | + * @param string $value company. |
|
2543 | + */ |
|
2544 | + public function set_company( $value ) { |
|
2545 | + $this->set_prop( 'company', $value ); |
|
2506 | 2546 | } |
2507 | 2547 | |
2508 | 2548 | /** |
2509 | - * Set the customer's zip code. |
|
2510 | - * |
|
2511 | - * @since 1.0.19 |
|
2512 | - * @param string $value zip. |
|
2513 | - */ |
|
2514 | - public function set_zip( $value ) { |
|
2515 | - $this->set_prop( 'zip', $value ); |
|
2549 | + * Alias of self::set_company(). |
|
2550 | + * |
|
2551 | + * @since 1.0.19 |
|
2552 | + * @param string $value company. |
|
2553 | + */ |
|
2554 | + public function set_user_company( $value ) { |
|
2555 | + $this->set_company( $value ); |
|
2516 | 2556 | } |
2517 | 2557 | |
2518 | 2558 | /** |
2519 | - * Alias of self::set_zip(). |
|
2520 | - * |
|
2521 | - * @since 1.0.19 |
|
2522 | - * @param string $value zip. |
|
2523 | - */ |
|
2524 | - public function set_user_zip( $value ) { |
|
2525 | - $this->set_zip( $value ); |
|
2559 | + * Alias of self::set_company(). |
|
2560 | + * |
|
2561 | + * @since 1.0.19 |
|
2562 | + * @param string $value company. |
|
2563 | + */ |
|
2564 | + public function set_customer_company( $value ) { |
|
2565 | + $this->set_company( $value ); |
|
2526 | 2566 | } |
2527 | 2567 | |
2528 | 2568 | /** |
2529 | - * Alias of self::set_zip(). |
|
2530 | - * |
|
2531 | - * @since 1.0.19 |
|
2532 | - * @param string $value zip. |
|
2533 | - */ |
|
2534 | - public function set_customer_zip( $value ) { |
|
2535 | - $this->set_zip( $value ); |
|
2569 | + * Set the customer's var number. |
|
2570 | + * |
|
2571 | + * @since 1.0.19 |
|
2572 | + * @param string $value var number. |
|
2573 | + */ |
|
2574 | + public function set_vat_number( $value ) { |
|
2575 | + $this->set_prop( 'vat_number', $value ); |
|
2536 | 2576 | } |
2537 | 2577 | |
2538 | 2578 | /** |
2539 | - * Set the customer's company. |
|
2540 | - * |
|
2541 | - * @since 1.0.19 |
|
2542 | - * @param string $value company. |
|
2543 | - */ |
|
2544 | - public function set_company( $value ) { |
|
2545 | - $this->set_prop( 'company', $value ); |
|
2579 | + * Alias of self::set_vat_number(). |
|
2580 | + * |
|
2581 | + * @since 1.0.19 |
|
2582 | + * @param string $value var number. |
|
2583 | + */ |
|
2584 | + public function set_user_vat_number( $value ) { |
|
2585 | + $this->set_vat_number( $value ); |
|
2546 | 2586 | } |
2547 | 2587 | |
2548 | 2588 | /** |
2549 | - * Alias of self::set_company(). |
|
2550 | - * |
|
2551 | - * @since 1.0.19 |
|
2552 | - * @param string $value company. |
|
2553 | - */ |
|
2554 | - public function set_user_company( $value ) { |
|
2555 | - $this->set_company( $value ); |
|
2589 | + * Alias of self::set_vat_number(). |
|
2590 | + * |
|
2591 | + * @since 1.0.19 |
|
2592 | + * @param string $value var number. |
|
2593 | + */ |
|
2594 | + public function set_customer_vat_number( $value ) { |
|
2595 | + $this->set_vat_number( $value ); |
|
2556 | 2596 | } |
2557 | 2597 | |
2558 | 2598 | /** |
2559 | - * Alias of self::set_company(). |
|
2560 | - * |
|
2561 | - * @since 1.0.19 |
|
2562 | - * @param string $value company. |
|
2563 | - */ |
|
2564 | - public function set_customer_company( $value ) { |
|
2565 | - $this->set_company( $value ); |
|
2599 | + * Set the customer's vat rate. |
|
2600 | + * |
|
2601 | + * @since 1.0.19 |
|
2602 | + * @param string $value var rate. |
|
2603 | + */ |
|
2604 | + public function set_vat_rate( $value ) { |
|
2605 | + $this->set_prop( 'vat_rate', $value ); |
|
2566 | 2606 | } |
2567 | 2607 | |
2568 | 2608 | /** |
2569 | - * Set the customer's var number. |
|
2570 | - * |
|
2571 | - * @since 1.0.19 |
|
2572 | - * @param string $value var number. |
|
2573 | - */ |
|
2574 | - public function set_vat_number( $value ) { |
|
2575 | - $this->set_prop( 'vat_number', $value ); |
|
2609 | + * Alias of self::set_vat_rate(). |
|
2610 | + * |
|
2611 | + * @since 1.0.19 |
|
2612 | + * @param string $value var number. |
|
2613 | + */ |
|
2614 | + public function set_user_vat_rate( $value ) { |
|
2615 | + $this->set_vat_rate( $value ); |
|
2576 | 2616 | } |
2577 | 2617 | |
2578 | 2618 | /** |
2579 | - * Alias of self::set_vat_number(). |
|
2580 | - * |
|
2581 | - * @since 1.0.19 |
|
2582 | - * @param string $value var number. |
|
2583 | - */ |
|
2584 | - public function set_user_vat_number( $value ) { |
|
2585 | - $this->set_vat_number( $value ); |
|
2619 | + * Alias of self::set_vat_rate(). |
|
2620 | + * |
|
2621 | + * @since 1.0.19 |
|
2622 | + * @param string $value var number. |
|
2623 | + */ |
|
2624 | + public function set_customer_vat_rate( $value ) { |
|
2625 | + $this->set_vat_rate( $value ); |
|
2586 | 2626 | } |
2587 | 2627 | |
2588 | 2628 | /** |
2589 | - * Alias of self::set_vat_number(). |
|
2590 | - * |
|
2591 | - * @since 1.0.19 |
|
2592 | - * @param string $value var number. |
|
2593 | - */ |
|
2594 | - public function set_customer_vat_number( $value ) { |
|
2595 | - $this->set_vat_number( $value ); |
|
2629 | + * Set the customer's address. |
|
2630 | + * |
|
2631 | + * @since 1.0.19 |
|
2632 | + * @param string $value address. |
|
2633 | + */ |
|
2634 | + public function set_address( $value ) { |
|
2635 | + $this->set_prop( 'address', $value ); |
|
2596 | 2636 | } |
2597 | 2637 | |
2598 | 2638 | /** |
2599 | - * Set the customer's vat rate. |
|
2600 | - * |
|
2601 | - * @since 1.0.19 |
|
2602 | - * @param string $value var rate. |
|
2603 | - */ |
|
2604 | - public function set_vat_rate( $value ) { |
|
2605 | - $this->set_prop( 'vat_rate', $value ); |
|
2639 | + * Alias of self::set_address(). |
|
2640 | + * |
|
2641 | + * @since 1.0.19 |
|
2642 | + * @param string $value address. |
|
2643 | + */ |
|
2644 | + public function set_user_address( $value ) { |
|
2645 | + $this->set_address( $value ); |
|
2606 | 2646 | } |
2607 | 2647 | |
2608 | 2648 | /** |
2609 | - * Alias of self::set_vat_rate(). |
|
2610 | - * |
|
2611 | - * @since 1.0.19 |
|
2612 | - * @param string $value var number. |
|
2613 | - */ |
|
2614 | - public function set_user_vat_rate( $value ) { |
|
2615 | - $this->set_vat_rate( $value ); |
|
2649 | + * Alias of self::set_address(). |
|
2650 | + * |
|
2651 | + * @since 1.0.19 |
|
2652 | + * @param string $value address. |
|
2653 | + */ |
|
2654 | + public function set_customer_address( $value ) { |
|
2655 | + $this->set_address( $value ); |
|
2616 | 2656 | } |
2617 | 2657 | |
2618 | 2658 | /** |
2619 | - * Alias of self::set_vat_rate(). |
|
2620 | - * |
|
2621 | - * @since 1.0.19 |
|
2622 | - * @param string $value var number. |
|
2623 | - */ |
|
2624 | - public function set_customer_vat_rate( $value ) { |
|
2625 | - $this->set_vat_rate( $value ); |
|
2659 | + * Set whether the customer has viewed the invoice or not. |
|
2660 | + * |
|
2661 | + * @since 1.0.19 |
|
2662 | + * @param int|bool $value confirmed. |
|
2663 | + */ |
|
2664 | + public function set_is_viewed( $value ) { |
|
2665 | + $this->set_prop( 'is_viewed', $value ); |
|
2626 | 2666 | } |
2627 | 2667 | |
2628 | 2668 | /** |
2629 | - * Set the customer's address. |
|
2630 | - * |
|
2631 | - * @since 1.0.19 |
|
2632 | - * @param string $value address. |
|
2633 | - */ |
|
2634 | - public function set_address( $value ) { |
|
2635 | - $this->set_prop( 'address', $value ); |
|
2669 | + * Set extra email recipients. |
|
2670 | + * |
|
2671 | + * @since 1.0.19 |
|
2672 | + * @param string $value email recipients. |
|
2673 | + */ |
|
2674 | + public function set_email_cc( $value ) { |
|
2675 | + $this->set_prop( 'email_cc', $value ); |
|
2636 | 2676 | } |
2637 | 2677 | |
2638 | 2678 | /** |
2639 | - * Alias of self::set_address(). |
|
2640 | - * |
|
2641 | - * @since 1.0.19 |
|
2642 | - * @param string $value address. |
|
2643 | - */ |
|
2644 | - public function set_user_address( $value ) { |
|
2645 | - $this->set_address( $value ); |
|
2679 | + * Set the invoice template. |
|
2680 | + * |
|
2681 | + * @since 1.0.19 |
|
2682 | + * @param string $value template. |
|
2683 | + */ |
|
2684 | + public function set_template( $value ) { |
|
2685 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | + $this->set_prop( 'template', $value ); |
|
2687 | + } |
|
2646 | 2688 | } |
2647 | 2689 | |
2648 | 2690 | /** |
2649 | - * Alias of self::set_address(). |
|
2650 | - * |
|
2651 | - * @since 1.0.19 |
|
2652 | - * @param string $value address. |
|
2653 | - */ |
|
2654 | - public function set_customer_address( $value ) { |
|
2655 | - $this->set_address( $value ); |
|
2691 | + * Set the invoice source. |
|
2692 | + * |
|
2693 | + * @since 1.0.19 |
|
2694 | + * @param string $value email recipients. |
|
2695 | + */ |
|
2696 | + public function created_via( $value ) { |
|
2697 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2656 | 2698 | } |
2657 | 2699 | |
2658 | 2700 | /** |
2659 | - * Set whether the customer has viewed the invoice or not. |
|
2660 | - * |
|
2661 | - * @since 1.0.19 |
|
2662 | - * @param int|bool $value confirmed. |
|
2663 | - */ |
|
2664 | - public function set_is_viewed( $value ) { |
|
2665 | - $this->set_prop( 'is_viewed', $value ); |
|
2666 | - } |
|
2667 | - |
|
2668 | - /** |
|
2669 | - * Set extra email recipients. |
|
2670 | - * |
|
2671 | - * @since 1.0.19 |
|
2672 | - * @param string $value email recipients. |
|
2673 | - */ |
|
2674 | - public function set_email_cc( $value ) { |
|
2675 | - $this->set_prop( 'email_cc', $value ); |
|
2676 | - } |
|
2677 | - |
|
2678 | - /** |
|
2679 | - * Set the invoice template. |
|
2680 | - * |
|
2681 | - * @since 1.0.19 |
|
2682 | - * @param string $value template. |
|
2683 | - */ |
|
2684 | - public function set_template( $value ) { |
|
2685 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | - $this->set_prop( 'template', $value ); |
|
2687 | - } |
|
2688 | - } |
|
2689 | - |
|
2690 | - /** |
|
2691 | - * Set the invoice source. |
|
2692 | - * |
|
2693 | - * @since 1.0.19 |
|
2694 | - * @param string $value email recipients. |
|
2695 | - */ |
|
2696 | - public function created_via( $value ) { |
|
2697 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2698 | - } |
|
2699 | - |
|
2700 | - /** |
|
2701 | - * Set the customer's address confirmed status. |
|
2702 | - * |
|
2703 | - * @since 1.0.19 |
|
2704 | - * @param int|bool $value confirmed. |
|
2705 | - */ |
|
2706 | - public function set_address_confirmed( $value ) { |
|
2707 | - $this->set_prop( 'address_confirmed', $value ); |
|
2701 | + * Set the customer's address confirmed status. |
|
2702 | + * |
|
2703 | + * @since 1.0.19 |
|
2704 | + * @param int|bool $value confirmed. |
|
2705 | + */ |
|
2706 | + public function set_address_confirmed( $value ) { |
|
2707 | + $this->set_prop( 'address_confirmed', $value ); |
|
2708 | 2708 | } |
2709 | 2709 | |
2710 | 2710 | /** |
2711 | - * Alias of self::set_address_confirmed(). |
|
2712 | - * |
|
2713 | - * @since 1.0.19 |
|
2714 | - * @param int|bool $value confirmed. |
|
2715 | - */ |
|
2716 | - public function set_user_address_confirmed( $value ) { |
|
2717 | - $this->set_address_confirmed( $value ); |
|
2711 | + * Alias of self::set_address_confirmed(). |
|
2712 | + * |
|
2713 | + * @since 1.0.19 |
|
2714 | + * @param int|bool $value confirmed. |
|
2715 | + */ |
|
2716 | + public function set_user_address_confirmed( $value ) { |
|
2717 | + $this->set_address_confirmed( $value ); |
|
2718 | 2718 | } |
2719 | 2719 | |
2720 | 2720 | /** |
2721 | - * Alias of self::set_address_confirmed(). |
|
2722 | - * |
|
2723 | - * @since 1.0.19 |
|
2724 | - * @param int|bool $value confirmed. |
|
2725 | - */ |
|
2726 | - public function set_customer_address_confirmed( $value ) { |
|
2727 | - $this->set_address_confirmed( $value ); |
|
2721 | + * Alias of self::set_address_confirmed(). |
|
2722 | + * |
|
2723 | + * @since 1.0.19 |
|
2724 | + * @param int|bool $value confirmed. |
|
2725 | + */ |
|
2726 | + public function set_customer_address_confirmed( $value ) { |
|
2727 | + $this->set_address_confirmed( $value ); |
|
2728 | 2728 | } |
2729 | 2729 | |
2730 | 2730 | /** |
2731 | - * Set the invoice sub total. |
|
2732 | - * |
|
2733 | - * @since 1.0.19 |
|
2734 | - * @param float $value sub total. |
|
2735 | - */ |
|
2736 | - public function set_subtotal( $value ) { |
|
2737 | - $this->set_prop( 'subtotal', $value ); |
|
2731 | + * Set the invoice sub total. |
|
2732 | + * |
|
2733 | + * @since 1.0.19 |
|
2734 | + * @param float $value sub total. |
|
2735 | + */ |
|
2736 | + public function set_subtotal( $value ) { |
|
2737 | + $this->set_prop( 'subtotal', $value ); |
|
2738 | 2738 | } |
2739 | 2739 | |
2740 | 2740 | /** |
2741 | - * Set the invoice discount amount. |
|
2742 | - * |
|
2743 | - * @since 1.0.19 |
|
2744 | - * @param float $value discount total. |
|
2745 | - */ |
|
2746 | - public function set_total_discount( $value ) { |
|
2747 | - $this->set_prop( 'total_discount', $value ); |
|
2741 | + * Set the invoice discount amount. |
|
2742 | + * |
|
2743 | + * @since 1.0.19 |
|
2744 | + * @param float $value discount total. |
|
2745 | + */ |
|
2746 | + public function set_total_discount( $value ) { |
|
2747 | + $this->set_prop( 'total_discount', $value ); |
|
2748 | 2748 | } |
2749 | 2749 | |
2750 | 2750 | /** |
2751 | - * Alias of self::set_total_discount(). |
|
2752 | - * |
|
2753 | - * @since 1.0.19 |
|
2754 | - * @param float $value discount total. |
|
2755 | - */ |
|
2756 | - public function set_discount( $value ) { |
|
2757 | - $this->set_total_discount( $value ); |
|
2751 | + * Alias of self::set_total_discount(). |
|
2752 | + * |
|
2753 | + * @since 1.0.19 |
|
2754 | + * @param float $value discount total. |
|
2755 | + */ |
|
2756 | + public function set_discount( $value ) { |
|
2757 | + $this->set_total_discount( $value ); |
|
2758 | 2758 | } |
2759 | 2759 | |
2760 | 2760 | /** |
2761 | - * Set the invoice tax amount. |
|
2762 | - * |
|
2763 | - * @since 1.0.19 |
|
2764 | - * @param float $value tax total. |
|
2765 | - */ |
|
2766 | - public function set_total_tax( $value ) { |
|
2767 | - $this->set_prop( 'total_tax', $value ); |
|
2761 | + * Set the invoice tax amount. |
|
2762 | + * |
|
2763 | + * @since 1.0.19 |
|
2764 | + * @param float $value tax total. |
|
2765 | + */ |
|
2766 | + public function set_total_tax( $value ) { |
|
2767 | + $this->set_prop( 'total_tax', $value ); |
|
2768 | 2768 | } |
2769 | 2769 | |
2770 | 2770 | /** |
2771 | - * Alias of self::set_total_tax(). |
|
2772 | - * |
|
2773 | - * @since 1.0.19 |
|
2774 | - * @param float $value tax total. |
|
2775 | - */ |
|
2776 | - public function set_tax_total( $value ) { |
|
2777 | - $this->set_total_tax( $value ); |
|
2771 | + * Alias of self::set_total_tax(). |
|
2772 | + * |
|
2773 | + * @since 1.0.19 |
|
2774 | + * @param float $value tax total. |
|
2775 | + */ |
|
2776 | + public function set_tax_total( $value ) { |
|
2777 | + $this->set_total_tax( $value ); |
|
2778 | 2778 | } |
2779 | 2779 | |
2780 | 2780 | /** |
2781 | - * Set the invoice fees amount. |
|
2782 | - * |
|
2783 | - * @since 1.0.19 |
|
2784 | - * @param float $value fees total. |
|
2785 | - */ |
|
2786 | - public function set_total_fees( $value ) { |
|
2787 | - $this->set_prop( 'total_fees', $value ); |
|
2781 | + * Set the invoice fees amount. |
|
2782 | + * |
|
2783 | + * @since 1.0.19 |
|
2784 | + * @param float $value fees total. |
|
2785 | + */ |
|
2786 | + public function set_total_fees( $value ) { |
|
2787 | + $this->set_prop( 'total_fees', $value ); |
|
2788 | 2788 | } |
2789 | 2789 | |
2790 | 2790 | /** |
2791 | - * Alias of self::set_total_fees(). |
|
2792 | - * |
|
2793 | - * @since 1.0.19 |
|
2794 | - * @param float $value fees total. |
|
2795 | - */ |
|
2796 | - public function set_fees_total( $value ) { |
|
2797 | - $this->set_total_fees( $value ); |
|
2791 | + * Alias of self::set_total_fees(). |
|
2792 | + * |
|
2793 | + * @since 1.0.19 |
|
2794 | + * @param float $value fees total. |
|
2795 | + */ |
|
2796 | + public function set_fees_total( $value ) { |
|
2797 | + $this->set_total_fees( $value ); |
|
2798 | 2798 | } |
2799 | 2799 | |
2800 | 2800 | /** |
2801 | - * Set the invoice fees. |
|
2802 | - * |
|
2803 | - * @since 1.0.19 |
|
2804 | - * @param array $value fees. |
|
2805 | - */ |
|
2806 | - public function set_fees( $value ) { |
|
2801 | + * Set the invoice fees. |
|
2802 | + * |
|
2803 | + * @since 1.0.19 |
|
2804 | + * @param array $value fees. |
|
2805 | + */ |
|
2806 | + public function set_fees( $value ) { |
|
2807 | 2807 | |
2808 | - if ( ! is_array( $value ) ) { |
|
2809 | - $value = array(); |
|
2810 | - } |
|
2808 | + if ( ! is_array( $value ) ) { |
|
2809 | + $value = array(); |
|
2810 | + } |
|
2811 | 2811 | |
2812 | - $this->set_prop( 'fees', $value ); |
|
2812 | + $this->set_prop( 'fees', $value ); |
|
2813 | 2813 | |
2814 | 2814 | } |
2815 | 2815 | |
2816 | 2816 | /** |
2817 | - * Set the invoice taxes. |
|
2818 | - * |
|
2819 | - * @since 1.0.19 |
|
2820 | - * @param array $value taxes. |
|
2821 | - */ |
|
2822 | - public function set_taxes( $value ) { |
|
2817 | + * Set the invoice taxes. |
|
2818 | + * |
|
2819 | + * @since 1.0.19 |
|
2820 | + * @param array $value taxes. |
|
2821 | + */ |
|
2822 | + public function set_taxes( $value ) { |
|
2823 | 2823 | |
2824 | - if ( ! is_array( $value ) ) { |
|
2825 | - $value = array(); |
|
2826 | - } |
|
2824 | + if ( ! is_array( $value ) ) { |
|
2825 | + $value = array(); |
|
2826 | + } |
|
2827 | 2827 | |
2828 | - $this->set_prop( 'taxes', $value ); |
|
2828 | + $this->set_prop( 'taxes', $value ); |
|
2829 | 2829 | |
2830 | 2830 | } |
2831 | 2831 | |
2832 | 2832 | /** |
2833 | - * Set the invoice discounts. |
|
2834 | - * |
|
2835 | - * @since 1.0.19 |
|
2836 | - * @param array $value discounts. |
|
2837 | - */ |
|
2838 | - public function set_discounts( $value ) { |
|
2833 | + * Set the invoice discounts. |
|
2834 | + * |
|
2835 | + * @since 1.0.19 |
|
2836 | + * @param array $value discounts. |
|
2837 | + */ |
|
2838 | + public function set_discounts( $value ) { |
|
2839 | 2839 | |
2840 | - if ( ! is_array( $value ) ) { |
|
2841 | - $value = array(); |
|
2842 | - } |
|
2840 | + if ( ! is_array( $value ) ) { |
|
2841 | + $value = array(); |
|
2842 | + } |
|
2843 | 2843 | |
2844 | - $this->set_prop( 'discounts', $value ); |
|
2844 | + $this->set_prop( 'discounts', $value ); |
|
2845 | 2845 | } |
2846 | 2846 | |
2847 | 2847 | /** |
2848 | - * Set the invoice items. |
|
2849 | - * |
|
2850 | - * @since 1.0.19 |
|
2851 | - * @param GetPaid_Form_Item[] $value items. |
|
2852 | - */ |
|
2853 | - public function set_items( $value ) { |
|
2848 | + * Set the invoice items. |
|
2849 | + * |
|
2850 | + * @since 1.0.19 |
|
2851 | + * @param GetPaid_Form_Item[] $value items. |
|
2852 | + */ |
|
2853 | + public function set_items( $value ) { |
|
2854 | 2854 | |
2855 | 2855 | // Remove existing items. |
2856 | 2856 | $this->set_prop( 'items', array() ); |
@@ -2867,95 +2867,95 @@ discard block |
||
2867 | 2867 | } |
2868 | 2868 | |
2869 | 2869 | /** |
2870 | - * Set the payment form. |
|
2871 | - * |
|
2872 | - * @since 1.0.19 |
|
2873 | - * @param int $value payment form. |
|
2874 | - */ |
|
2875 | - public function set_payment_form( $value ) { |
|
2876 | - $this->set_prop( 'payment_form', $value ); |
|
2870 | + * Set the payment form. |
|
2871 | + * |
|
2872 | + * @since 1.0.19 |
|
2873 | + * @param int $value payment form. |
|
2874 | + */ |
|
2875 | + public function set_payment_form( $value ) { |
|
2876 | + $this->set_prop( 'payment_form', $value ); |
|
2877 | 2877 | } |
2878 | 2878 | |
2879 | 2879 | /** |
2880 | - * Set the submission id. |
|
2881 | - * |
|
2882 | - * @since 1.0.19 |
|
2883 | - * @param string $value submission id. |
|
2884 | - */ |
|
2885 | - public function set_submission_id( $value ) { |
|
2886 | - $this->set_prop( 'submission_id', $value ); |
|
2880 | + * Set the submission id. |
|
2881 | + * |
|
2882 | + * @since 1.0.19 |
|
2883 | + * @param string $value submission id. |
|
2884 | + */ |
|
2885 | + public function set_submission_id( $value ) { |
|
2886 | + $this->set_prop( 'submission_id', $value ); |
|
2887 | 2887 | } |
2888 | 2888 | |
2889 | 2889 | /** |
2890 | - * Set the discount code. |
|
2891 | - * |
|
2892 | - * @since 1.0.19 |
|
2893 | - * @param string $value discount code. |
|
2894 | - */ |
|
2895 | - public function set_discount_code( $value ) { |
|
2896 | - $this->set_prop( 'discount_code', $value ); |
|
2890 | + * Set the discount code. |
|
2891 | + * |
|
2892 | + * @since 1.0.19 |
|
2893 | + * @param string $value discount code. |
|
2894 | + */ |
|
2895 | + public function set_discount_code( $value ) { |
|
2896 | + $this->set_prop( 'discount_code', $value ); |
|
2897 | 2897 | } |
2898 | 2898 | |
2899 | 2899 | /** |
2900 | - * Set the gateway. |
|
2901 | - * |
|
2902 | - * @since 1.0.19 |
|
2903 | - * @param string $value gateway. |
|
2904 | - */ |
|
2905 | - public function set_gateway( $value ) { |
|
2906 | - $this->set_prop( 'gateway', $value ); |
|
2900 | + * Set the gateway. |
|
2901 | + * |
|
2902 | + * @since 1.0.19 |
|
2903 | + * @param string $value gateway. |
|
2904 | + */ |
|
2905 | + public function set_gateway( $value ) { |
|
2906 | + $this->set_prop( 'gateway', $value ); |
|
2907 | 2907 | } |
2908 | 2908 | |
2909 | 2909 | /** |
2910 | - * Set the transaction id. |
|
2911 | - * |
|
2912 | - * @since 1.0.19 |
|
2913 | - * @param string $value transaction id. |
|
2914 | - */ |
|
2915 | - public function set_transaction_id( $value ) { |
|
2916 | - if ( ! empty( $value ) ) { |
|
2917 | - $this->set_prop( 'transaction_id', $value ); |
|
2918 | - } |
|
2910 | + * Set the transaction id. |
|
2911 | + * |
|
2912 | + * @since 1.0.19 |
|
2913 | + * @param string $value transaction id. |
|
2914 | + */ |
|
2915 | + public function set_transaction_id( $value ) { |
|
2916 | + if ( ! empty( $value ) ) { |
|
2917 | + $this->set_prop( 'transaction_id', $value ); |
|
2918 | + } |
|
2919 | 2919 | } |
2920 | 2920 | |
2921 | 2921 | /** |
2922 | - * Set the currency id. |
|
2923 | - * |
|
2924 | - * @since 1.0.19 |
|
2925 | - * @param string $value currency id. |
|
2926 | - */ |
|
2927 | - public function set_currency( $value ) { |
|
2928 | - $this->set_prop( 'currency', $value ); |
|
2922 | + * Set the currency id. |
|
2923 | + * |
|
2924 | + * @since 1.0.19 |
|
2925 | + * @param string $value currency id. |
|
2926 | + */ |
|
2927 | + public function set_currency( $value ) { |
|
2928 | + $this->set_prop( 'currency', $value ); |
|
2929 | 2929 | } |
2930 | 2930 | |
2931 | - /** |
|
2932 | - * Set whether to disable taxes. |
|
2933 | - * |
|
2934 | - * @since 1.0.19 |
|
2935 | - * @param bool $value value. |
|
2936 | - */ |
|
2937 | - public function set_disable_taxes( $value ) { |
|
2938 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2939 | - } |
|
2931 | + /** |
|
2932 | + * Set whether to disable taxes. |
|
2933 | + * |
|
2934 | + * @since 1.0.19 |
|
2935 | + * @param bool $value value. |
|
2936 | + */ |
|
2937 | + public function set_disable_taxes( $value ) { |
|
2938 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2939 | + } |
|
2940 | 2940 | |
2941 | 2941 | /** |
2942 | - * Set the subscription id. |
|
2943 | - * |
|
2944 | - * @since 1.0.19 |
|
2945 | - * @param string $value subscription id. |
|
2946 | - */ |
|
2947 | - public function set_subscription_id( $value ) { |
|
2948 | - $this->set_prop( 'subscription_id', $value ); |
|
2949 | - } |
|
2942 | + * Set the subscription id. |
|
2943 | + * |
|
2944 | + * @since 1.0.19 |
|
2945 | + * @param string $value subscription id. |
|
2946 | + */ |
|
2947 | + public function set_subscription_id( $value ) { |
|
2948 | + $this->set_prop( 'subscription_id', $value ); |
|
2949 | + } |
|
2950 | 2950 | |
2951 | - /** |
|
2952 | - * Set the remote subscription id. |
|
2953 | - * |
|
2954 | - * @since 1.0.19 |
|
2955 | - * @param string $value subscription id. |
|
2956 | - */ |
|
2957 | - public function set_remote_subscription_id( $value ) { |
|
2958 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
2951 | + /** |
|
2952 | + * Set the remote subscription id. |
|
2953 | + * |
|
2954 | + * @since 1.0.19 |
|
2955 | + * @param string $value subscription id. |
|
2956 | + */ |
|
2957 | + public function set_remote_subscription_id( $value ) { |
|
2958 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
2959 | 2959 | } |
2960 | 2960 | |
2961 | 2961 | /* |
@@ -2994,24 +2994,24 @@ discard block |
||
2994 | 2994 | */ |
2995 | 2995 | public function is_taxable() { |
2996 | 2996 | return ! $this->get_disable_taxes(); |
2997 | - } |
|
2997 | + } |
|
2998 | 2998 | |
2999 | - /** |
|
3000 | - * @deprecated |
|
3001 | - */ |
|
3002 | - public function has_vat() { |
|
2999 | + /** |
|
3000 | + * @deprecated |
|
3001 | + */ |
|
3002 | + public function has_vat() { |
|
3003 | 3003 | return $this->is_taxable(); |
3004 | - } |
|
3004 | + } |
|
3005 | 3005 | |
3006 | - /** |
|
3007 | - * Checks to see if the invoice requires payment. |
|
3008 | - */ |
|
3009 | - public function is_free() { |
|
3006 | + /** |
|
3007 | + * Checks to see if the invoice requires payment. |
|
3008 | + */ |
|
3009 | + public function is_free() { |
|
3010 | 3010 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
3011 | 3011 | |
3012 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3013 | - $is_free = false; |
|
3014 | - } |
|
3012 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3013 | + $is_free = false; |
|
3014 | + } |
|
3015 | 3015 | |
3016 | 3016 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
3017 | 3017 | } |
@@ -3022,46 +3022,46 @@ discard block |
||
3022 | 3022 | public function is_paid() { |
3023 | 3023 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
3024 | 3024 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
3025 | - } |
|
3025 | + } |
|
3026 | 3026 | |
3027 | - /** |
|
3027 | + /** |
|
3028 | 3028 | * Checks if the invoice needs payment. |
3029 | 3029 | */ |
3030 | - public function needs_payment() { |
|
3031 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3030 | + public function needs_payment() { |
|
3031 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3032 | 3032 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
3033 | 3033 | } |
3034 | 3034 | |
3035 | - /** |
|
3035 | + /** |
|
3036 | 3036 | * Checks if the invoice is refunded. |
3037 | 3037 | */ |
3038 | - public function is_refunded() { |
|
3038 | + public function is_refunded() { |
|
3039 | 3039 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
3040 | 3040 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
3041 | - } |
|
3041 | + } |
|
3042 | 3042 | |
3043 | - /** |
|
3043 | + /** |
|
3044 | 3044 | * Checks if the invoice is held. |
3045 | 3045 | */ |
3046 | - public function is_held() { |
|
3046 | + public function is_held() { |
|
3047 | 3047 | $is_held = $this->has_status( 'wpi-onhold' ); |
3048 | 3048 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
3049 | - } |
|
3049 | + } |
|
3050 | 3050 | |
3051 | - /** |
|
3051 | + /** |
|
3052 | 3052 | * Checks if the invoice is due. |
3053 | 3053 | */ |
3054 | - public function is_due() { |
|
3055 | - $due_date = $this->get_due_date(); |
|
3056 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3057 | - } |
|
3054 | + public function is_due() { |
|
3055 | + $due_date = $this->get_due_date(); |
|
3056 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3057 | + } |
|
3058 | 3058 | |
3059 | - /** |
|
3059 | + /** |
|
3060 | 3060 | * Checks if the invoice is draft. |
3061 | 3061 | */ |
3062 | - public function is_draft() { |
|
3062 | + public function is_draft() { |
|
3063 | 3063 | return $this->has_status( 'draft, auto-draft' ); |
3064 | - } |
|
3064 | + } |
|
3065 | 3065 | |
3066 | 3066 | /** |
3067 | 3067 | * Checks if the invoice has a given status. |
@@ -3069,9 +3069,9 @@ discard block |
||
3069 | 3069 | public function has_status( $status ) { |
3070 | 3070 | $status = wpinv_parse_list( $status ); |
3071 | 3071 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
3072 | - } |
|
3072 | + } |
|
3073 | 3073 | |
3074 | - /** |
|
3074 | + /** |
|
3075 | 3075 | * Checks if the invoice is of a given type. |
3076 | 3076 | */ |
3077 | 3077 | public function is_type( $type ) { |
@@ -3094,25 +3094,25 @@ discard block |
||
3094 | 3094 | */ |
3095 | 3095 | public function has_free_trial() { |
3096 | 3096 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
3097 | - } |
|
3097 | + } |
|
3098 | 3098 | |
3099 | - /** |
|
3099 | + /** |
|
3100 | 3100 | * @deprecated |
3101 | 3101 | */ |
3102 | 3102 | public function is_free_trial() { |
3103 | 3103 | $this->has_free_trial(); |
3104 | 3104 | } |
3105 | 3105 | |
3106 | - /** |
|
3106 | + /** |
|
3107 | 3107 | * Check if the initial payment if 0. |
3108 | 3108 | * |
3109 | 3109 | */ |
3110 | - public function is_initial_free() { |
|
3110 | + public function is_initial_free() { |
|
3111 | 3111 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
3112 | 3112 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
3113 | 3113 | } |
3114 | 3114 | |
3115 | - /** |
|
3115 | + /** |
|
3116 | 3116 | * Check if the recurring item has a free trial. |
3117 | 3117 | * |
3118 | 3118 | */ |
@@ -3125,21 +3125,21 @@ discard block |
||
3125 | 3125 | |
3126 | 3126 | $item = $this->get_recurring( true ); |
3127 | 3127 | return $item->has_free_trial(); |
3128 | - } |
|
3128 | + } |
|
3129 | 3129 | |
3130 | - /** |
|
3130 | + /** |
|
3131 | 3131 | * Check if the free trial is a result of a discount. |
3132 | 3132 | */ |
3133 | 3133 | public function is_free_trial_from_discount() { |
3134 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3135 | - } |
|
3134 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3135 | + } |
|
3136 | 3136 | |
3137 | - /** |
|
3137 | + /** |
|
3138 | 3138 | * @deprecated |
3139 | 3139 | */ |
3140 | 3140 | public function discount_first_payment_only() { |
3141 | 3141 | |
3142 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3142 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3143 | 3143 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
3144 | 3144 | return true; |
3145 | 3145 | } |
@@ -3164,28 +3164,28 @@ discard block |
||
3164 | 3164 | */ |
3165 | 3165 | public function add_item( $item ) { |
3166 | 3166 | |
3167 | - if ( is_array( $item ) ) { |
|
3168 | - $item = $this->process_array_item( $item ); |
|
3169 | - } |
|
3167 | + if ( is_array( $item ) ) { |
|
3168 | + $item = $this->process_array_item( $item ); |
|
3169 | + } |
|
3170 | 3170 | |
3171 | - if ( is_numeric( $item ) ) { |
|
3172 | - $item = new GetPaid_Form_Item( $item ); |
|
3173 | - } |
|
3171 | + if ( is_numeric( $item ) ) { |
|
3172 | + $item = new GetPaid_Form_Item( $item ); |
|
3173 | + } |
|
3174 | 3174 | |
3175 | 3175 | // Make sure that it is available for purchase. |
3176 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3177 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3176 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3177 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3178 | 3178 | } |
3179 | 3179 | |
3180 | 3180 | // Do we have a recurring item? |
3181 | - if ( $item->is_recurring() ) { |
|
3181 | + if ( $item->is_recurring() ) { |
|
3182 | 3182 | |
3183 | - // An invoice can only contain one recurring item. |
|
3184 | - if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
3185 | - return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3186 | - } |
|
3183 | + // An invoice can only contain one recurring item. |
|
3184 | + if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
3185 | + return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3186 | + } |
|
3187 | 3187 | |
3188 | - $this->recurring_item = $item->get_id(); |
|
3188 | + $this->recurring_item = $item->get_id(); |
|
3189 | 3189 | } |
3190 | 3190 | |
3191 | 3191 | // Invoice id. |
@@ -3196,60 +3196,60 @@ discard block |
||
3196 | 3196 | $items[ (int) $item->get_id() ] = $item; |
3197 | 3197 | |
3198 | 3198 | $this->set_prop( 'items', $items ); |
3199 | - return true; |
|
3200 | - } |
|
3199 | + return true; |
|
3200 | + } |
|
3201 | 3201 | |
3202 | - /** |
|
3203 | - * Converts an array to an item. |
|
3204 | - * |
|
3205 | - * @since 1.0.19 |
|
3206 | - * @return GetPaid_Form_Item |
|
3207 | - */ |
|
3208 | - protected function process_array_item( $array ) { |
|
3202 | + /** |
|
3203 | + * Converts an array to an item. |
|
3204 | + * |
|
3205 | + * @since 1.0.19 |
|
3206 | + * @return GetPaid_Form_Item |
|
3207 | + */ |
|
3208 | + protected function process_array_item( $array ) { |
|
3209 | 3209 | |
3210 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3211 | - $item = new GetPaid_Form_Item( $item_id ); |
|
3210 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3211 | + $item = new GetPaid_Form_Item( $item_id ); |
|
3212 | 3212 | |
3213 | - // Set item data. |
|
3214 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3215 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
3216 | - $method = "set_$key"; |
|
3217 | - $item->$method( $array[ "item_$key" ] ); |
|
3218 | - } |
|
3219 | - } |
|
3213 | + // Set item data. |
|
3214 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3215 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
3216 | + $method = "set_$key"; |
|
3217 | + $item->$method( $array[ "item_$key" ] ); |
|
3218 | + } |
|
3219 | + } |
|
3220 | 3220 | |
3221 | - if ( isset( $array['quantity'] ) ) { |
|
3222 | - $item->set_quantity( $array['quantity'] ); |
|
3223 | - } |
|
3221 | + if ( isset( $array['quantity'] ) ) { |
|
3222 | + $item->set_quantity( $array['quantity'] ); |
|
3223 | + } |
|
3224 | 3224 | |
3225 | - // Set item meta. |
|
3226 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3227 | - $item->set_item_meta( $array['meta'] ); |
|
3228 | - } |
|
3225 | + // Set item meta. |
|
3226 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3227 | + $item->set_item_meta( $array['meta'] ); |
|
3228 | + } |
|
3229 | 3229 | |
3230 | - return $item; |
|
3230 | + return $item; |
|
3231 | 3231 | |
3232 | - } |
|
3232 | + } |
|
3233 | 3233 | |
3234 | 3234 | /** |
3235 | - * Retrieves a specific item. |
|
3236 | - * |
|
3237 | - * @since 1.0.19 |
|
3238 | - */ |
|
3239 | - public function get_item( $item_id ) { |
|
3240 | - $items = $this->get_items(); |
|
3241 | - $item_id = (int) $item_id; |
|
3242 | - return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
3235 | + * Retrieves a specific item. |
|
3236 | + * |
|
3237 | + * @since 1.0.19 |
|
3238 | + */ |
|
3239 | + public function get_item( $item_id ) { |
|
3240 | + $items = $this->get_items(); |
|
3241 | + $item_id = (int) $item_id; |
|
3242 | + return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
3243 | 3243 | } |
3244 | 3244 | |
3245 | 3245 | /** |
3246 | - * Removes a specific item. |
|
3247 | - * |
|
3248 | - * @since 1.0.19 |
|
3249 | - */ |
|
3250 | - public function remove_item( $item_id ) { |
|
3251 | - $items = $this->get_items(); |
|
3252 | - $item_id = (int) $item_id; |
|
3246 | + * Removes a specific item. |
|
3247 | + * |
|
3248 | + * @since 1.0.19 |
|
3249 | + */ |
|
3250 | + public function remove_item( $item_id ) { |
|
3251 | + $items = $this->get_items(); |
|
3252 | + $item_id = (int) $item_id; |
|
3253 | 3253 | |
3254 | 3254 | if ( $item_id == $this->recurring_item ) { |
3255 | 3255 | $this->recurring_item = null; |
@@ -3262,35 +3262,35 @@ discard block |
||
3262 | 3262 | } |
3263 | 3263 | |
3264 | 3264 | /** |
3265 | - * Adds a fee to the invoice. |
|
3266 | - * |
|
3267 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3268 | - * @since 1.0.19 |
|
3269 | - */ |
|
3265 | + * Adds a fee to the invoice. |
|
3266 | + * |
|
3267 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3268 | + * @since 1.0.19 |
|
3269 | + */ |
|
3270 | 3270 | public function add_fee( $fee ) { |
3271 | 3271 | |
3272 | - $fees = $this->get_fees(); |
|
3273 | - $fees[ $fee['name'] ] = $fee; |
|
3274 | - $this->set_prop( 'fees', $fees ); |
|
3272 | + $fees = $this->get_fees(); |
|
3273 | + $fees[ $fee['name'] ] = $fee; |
|
3274 | + $this->set_prop( 'fees', $fees ); |
|
3275 | 3275 | |
3276 | 3276 | } |
3277 | 3277 | |
3278 | 3278 | /** |
3279 | - * Retrieves a specific fee. |
|
3280 | - * |
|
3281 | - * @since 1.0.19 |
|
3282 | - */ |
|
3283 | - public function get_fee( $fee ) { |
|
3279 | + * Retrieves a specific fee. |
|
3280 | + * |
|
3281 | + * @since 1.0.19 |
|
3282 | + */ |
|
3283 | + public function get_fee( $fee ) { |
|
3284 | 3284 | $fees = $this->get_fees(); |
3285 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3285 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3286 | 3286 | } |
3287 | 3287 | |
3288 | 3288 | /** |
3289 | - * Removes a specific fee. |
|
3290 | - * |
|
3291 | - * @since 1.0.19 |
|
3292 | - */ |
|
3293 | - public function remove_fee( $fee ) { |
|
3289 | + * Removes a specific fee. |
|
3290 | + * |
|
3291 | + * @since 1.0.19 |
|
3292 | + */ |
|
3293 | + public function remove_fee( $fee ) { |
|
3294 | 3294 | $fees = $this->get_fees(); |
3295 | 3295 | if ( isset( $fees[ $fee ] ) ) { |
3296 | 3296 | unset( $fees[ $fee ] ); |
@@ -3298,43 +3298,43 @@ discard block |
||
3298 | 3298 | } |
3299 | 3299 | } |
3300 | 3300 | |
3301 | - /** |
|
3302 | - * Adds a discount to the invoice. |
|
3303 | - * |
|
3304 | - * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
3305 | - * @since 1.0.19 |
|
3306 | - */ |
|
3307 | - public function add_discount( $discount ) { |
|
3301 | + /** |
|
3302 | + * Adds a discount to the invoice. |
|
3303 | + * |
|
3304 | + * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
3305 | + * @since 1.0.19 |
|
3306 | + */ |
|
3307 | + public function add_discount( $discount ) { |
|
3308 | 3308 | |
3309 | - $discounts = $this->get_discounts(); |
|
3310 | - $discounts[ $discount['name'] ] = $discount; |
|
3311 | - $this->set_prop( 'discounts', $discounts ); |
|
3309 | + $discounts = $this->get_discounts(); |
|
3310 | + $discounts[ $discount['name'] ] = $discount; |
|
3311 | + $this->set_prop( 'discounts', $discounts ); |
|
3312 | 3312 | |
3313 | - } |
|
3313 | + } |
|
3314 | 3314 | |
3315 | 3315 | /** |
3316 | - * Retrieves a specific discount. |
|
3317 | - * |
|
3318 | - * @since 1.0.19 |
|
3319 | - * @return float |
|
3320 | - */ |
|
3321 | - public function get_discount( $discount = false ) { |
|
3316 | + * Retrieves a specific discount. |
|
3317 | + * |
|
3318 | + * @since 1.0.19 |
|
3319 | + * @return float |
|
3320 | + */ |
|
3321 | + public function get_discount( $discount = false ) { |
|
3322 | 3322 | |
3323 | - // Backwards compatibilty. |
|
3324 | - if ( empty( $discount ) ) { |
|
3325 | - return $this->get_total_discount(); |
|
3326 | - } |
|
3323 | + // Backwards compatibilty. |
|
3324 | + if ( empty( $discount ) ) { |
|
3325 | + return $this->get_total_discount(); |
|
3326 | + } |
|
3327 | 3327 | |
3328 | 3328 | $discounts = $this->get_discounts(); |
3329 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3329 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3330 | 3330 | } |
3331 | 3331 | |
3332 | 3332 | /** |
3333 | - * Removes a specific discount. |
|
3334 | - * |
|
3335 | - * @since 1.0.19 |
|
3336 | - */ |
|
3337 | - public function remove_discount( $discount ) { |
|
3333 | + * Removes a specific discount. |
|
3334 | + * |
|
3335 | + * @since 1.0.19 |
|
3336 | + */ |
|
3337 | + public function remove_discount( $discount ) { |
|
3338 | 3338 | $discounts = $this->get_discounts(); |
3339 | 3339 | if ( isset( $discounts[ $discount ] ) ) { |
3340 | 3340 | unset( $discounts[ $discount ] ); |
@@ -3351,34 +3351,34 @@ discard block |
||
3351 | 3351 | if ( $this->is_taxable() ) { |
3352 | 3352 | |
3353 | 3353 | $taxes = $this->get_taxes(); |
3354 | - $taxes[ $tax['name'] ] = $tax; |
|
3355 | - $this->set_prop( 'taxes', $tax ); |
|
3354 | + $taxes[ $tax['name'] ] = $tax; |
|
3355 | + $this->set_prop( 'taxes', $tax ); |
|
3356 | 3356 | |
3357 | 3357 | } |
3358 | 3358 | } |
3359 | 3359 | |
3360 | 3360 | /** |
3361 | - * Retrieves a specific tax. |
|
3362 | - * |
|
3363 | - * @since 1.0.19 |
|
3364 | - */ |
|
3365 | - public function get_tax( $tax = null ) { |
|
3361 | + * Retrieves a specific tax. |
|
3362 | + * |
|
3363 | + * @since 1.0.19 |
|
3364 | + */ |
|
3365 | + public function get_tax( $tax = null ) { |
|
3366 | 3366 | |
3367 | - // Backwards compatility. |
|
3368 | - if ( empty( $tax ) ) { |
|
3369 | - return $this->get_total_tax(); |
|
3370 | - } |
|
3367 | + // Backwards compatility. |
|
3368 | + if ( empty( $tax ) ) { |
|
3369 | + return $this->get_total_tax(); |
|
3370 | + } |
|
3371 | 3371 | |
3372 | 3372 | $taxes = $this->get_taxes(); |
3373 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3373 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3374 | 3374 | } |
3375 | 3375 | |
3376 | 3376 | /** |
3377 | - * Removes a specific tax. |
|
3378 | - * |
|
3379 | - * @since 1.0.19 |
|
3380 | - */ |
|
3381 | - public function remove_tax( $tax ) { |
|
3377 | + * Removes a specific tax. |
|
3378 | + * |
|
3379 | + * @since 1.0.19 |
|
3380 | + */ |
|
3381 | + public function remove_tax( $tax ) { |
|
3382 | 3382 | $taxes = $this->get_taxes(); |
3383 | 3383 | if ( isset( $taxes[ $tax ] ) ) { |
3384 | 3384 | unset( $taxes[ $tax ] ); |
@@ -3387,134 +3387,134 @@ discard block |
||
3387 | 3387 | } |
3388 | 3388 | |
3389 | 3389 | /** |
3390 | - * Recalculates the invoice subtotal. |
|
3391 | - * |
|
3392 | - * @since 1.0.19 |
|
3393 | - * @return float The recalculated subtotal |
|
3394 | - */ |
|
3395 | - public function recalculate_subtotal() { |
|
3390 | + * Recalculates the invoice subtotal. |
|
3391 | + * |
|
3392 | + * @since 1.0.19 |
|
3393 | + * @return float The recalculated subtotal |
|
3394 | + */ |
|
3395 | + public function recalculate_subtotal() { |
|
3396 | 3396 | $items = $this->get_items(); |
3397 | - $subtotal = 0; |
|
3398 | - $recurring = 0; |
|
3397 | + $subtotal = 0; |
|
3398 | + $recurring = 0; |
|
3399 | 3399 | |
3400 | 3400 | foreach ( $items as $item ) { |
3401 | - $subtotal += $item->get_sub_total(); |
|
3402 | - $recurring += $item->get_recurring_sub_total(); |
|
3401 | + $subtotal += $item->get_sub_total(); |
|
3402 | + $recurring += $item->get_recurring_sub_total(); |
|
3403 | 3403 | } |
3404 | 3404 | |
3405 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3406 | - $this->set_subtotal( $current ); |
|
3405 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3406 | + $this->set_subtotal( $current ); |
|
3407 | 3407 | |
3408 | - $this->totals['subtotal'] = array( |
|
3409 | - 'initial' => $subtotal, |
|
3410 | - 'recurring' => $recurring, |
|
3411 | - ); |
|
3408 | + $this->totals['subtotal'] = array( |
|
3409 | + 'initial' => $subtotal, |
|
3410 | + 'recurring' => $recurring, |
|
3411 | + ); |
|
3412 | 3412 | |
3413 | 3413 | return $current; |
3414 | 3414 | } |
3415 | 3415 | |
3416 | 3416 | /** |
3417 | - * Recalculates the invoice discount total. |
|
3418 | - * |
|
3419 | - * @since 1.0.19 |
|
3420 | - * @return float The recalculated discount |
|
3421 | - */ |
|
3422 | - public function recalculate_total_discount() { |
|
3417 | + * Recalculates the invoice discount total. |
|
3418 | + * |
|
3419 | + * @since 1.0.19 |
|
3420 | + * @return float The recalculated discount |
|
3421 | + */ |
|
3422 | + public function recalculate_total_discount() { |
|
3423 | 3423 | $discounts = $this->get_discounts(); |
3424 | - $discount = 0; |
|
3425 | - $recurring = 0; |
|
3424 | + $discount = 0; |
|
3425 | + $recurring = 0; |
|
3426 | 3426 | |
3427 | 3427 | foreach ( $discounts as $data ) { |
3428 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3429 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3430 | - } |
|
3428 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3429 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3430 | + } |
|
3431 | 3431 | |
3432 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
3432 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
3433 | 3433 | |
3434 | - $this->set_total_discount( $current ); |
|
3434 | + $this->set_total_discount( $current ); |
|
3435 | 3435 | |
3436 | - $this->totals['discount'] = array( |
|
3437 | - 'initial' => $discount, |
|
3438 | - 'recurring' => $recurring, |
|
3439 | - ); |
|
3436 | + $this->totals['discount'] = array( |
|
3437 | + 'initial' => $discount, |
|
3438 | + 'recurring' => $recurring, |
|
3439 | + ); |
|
3440 | 3440 | |
3441 | - return $current; |
|
3441 | + return $current; |
|
3442 | 3442 | |
3443 | 3443 | } |
3444 | 3444 | |
3445 | 3445 | /** |
3446 | - * Recalculates the invoice tax total. |
|
3447 | - * |
|
3448 | - * @since 1.0.19 |
|
3449 | - * @return float The recalculated tax |
|
3450 | - */ |
|
3451 | - public function recalculate_total_tax() { |
|
3446 | + * Recalculates the invoice tax total. |
|
3447 | + * |
|
3448 | + * @since 1.0.19 |
|
3449 | + * @return float The recalculated tax |
|
3450 | + */ |
|
3451 | + public function recalculate_total_tax() { |
|
3452 | 3452 | $taxes = $this->get_taxes(); |
3453 | - $tax = 0; |
|
3454 | - $recurring = 0; |
|
3453 | + $tax = 0; |
|
3454 | + $recurring = 0; |
|
3455 | 3455 | |
3456 | 3456 | foreach ( $taxes as $data ) { |
3457 | - $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
3458 | - $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
3459 | - } |
|
3457 | + $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
3458 | + $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
3459 | + } |
|
3460 | 3460 | |
3461 | - $current = $this->is_renewal() ? $recurring : $tax; |
|
3462 | - $this->set_total_tax( $current ); |
|
3461 | + $current = $this->is_renewal() ? $recurring : $tax; |
|
3462 | + $this->set_total_tax( $current ); |
|
3463 | 3463 | |
3464 | - $this->totals['tax'] = array( |
|
3465 | - 'initial' => $tax, |
|
3466 | - 'recurring' => $recurring, |
|
3467 | - ); |
|
3464 | + $this->totals['tax'] = array( |
|
3465 | + 'initial' => $tax, |
|
3466 | + 'recurring' => $recurring, |
|
3467 | + ); |
|
3468 | 3468 | |
3469 | - return $current; |
|
3469 | + return $current; |
|
3470 | 3470 | |
3471 | 3471 | } |
3472 | 3472 | |
3473 | 3473 | /** |
3474 | - * Recalculates the invoice fees total. |
|
3475 | - * |
|
3476 | - * @since 1.0.19 |
|
3477 | - * @return float The recalculated fee |
|
3478 | - */ |
|
3479 | - public function recalculate_total_fees() { |
|
3480 | - $fees = $this->get_fees(); |
|
3481 | - $fee = 0; |
|
3482 | - $recurring = 0; |
|
3474 | + * Recalculates the invoice fees total. |
|
3475 | + * |
|
3476 | + * @since 1.0.19 |
|
3477 | + * @return float The recalculated fee |
|
3478 | + */ |
|
3479 | + public function recalculate_total_fees() { |
|
3480 | + $fees = $this->get_fees(); |
|
3481 | + $fee = 0; |
|
3482 | + $recurring = 0; |
|
3483 | 3483 | |
3484 | 3484 | foreach ( $fees as $data ) { |
3485 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3486 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3487 | - } |
|
3485 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3486 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3487 | + } |
|
3488 | 3488 | |
3489 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
3490 | - $this->set_total_fees( $current ); |
|
3489 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
3490 | + $this->set_total_fees( $current ); |
|
3491 | 3491 | |
3492 | - $this->totals['fee'] = array( |
|
3493 | - 'initial' => $fee, |
|
3494 | - 'recurring' => $recurring, |
|
3495 | - ); |
|
3492 | + $this->totals['fee'] = array( |
|
3493 | + 'initial' => $fee, |
|
3494 | + 'recurring' => $recurring, |
|
3495 | + ); |
|
3496 | 3496 | |
3497 | 3497 | $this->set_total_fees( $fee ); |
3498 | 3498 | return $current; |
3499 | 3499 | } |
3500 | 3500 | |
3501 | 3501 | /** |
3502 | - * Recalculates the invoice total. |
|
3503 | - * |
|
3504 | - * @since 1.0.19 |
|
3502 | + * Recalculates the invoice total. |
|
3503 | + * |
|
3504 | + * @since 1.0.19 |
|
3505 | 3505 | * @return float The invoice total |
3506 | - */ |
|
3507 | - public function recalculate_total() { |
|
3506 | + */ |
|
3507 | + public function recalculate_total() { |
|
3508 | 3508 | $this->recalculate_subtotal(); |
3509 | 3509 | $this->recalculate_total_fees(); |
3510 | 3510 | $this->recalculate_total_discount(); |
3511 | 3511 | $this->recalculate_total_tax(); |
3512 | - return $this->get_total(); |
|
3513 | - } |
|
3512 | + return $this->get_total(); |
|
3513 | + } |
|
3514 | 3514 | |
3515 | - /** |
|
3516 | - * @deprecated |
|
3517 | - */ |
|
3515 | + /** |
|
3516 | + * @deprecated |
|
3517 | + */ |
|
3518 | 3518 | public function recalculate_totals() { |
3519 | 3519 | $this->recalculate_total(); |
3520 | 3520 | $this->save( true ); |
@@ -3532,7 +3532,7 @@ discard block |
||
3532 | 3532 | * Adds a note to an invoice. |
3533 | 3533 | * |
3534 | 3534 | * @param string $note The note being added. |
3535 | - * @return int|false The new note's ID on success, false on failure. |
|
3535 | + * @return int|false The new note's ID on success, false on failure. |
|
3536 | 3536 | * |
3537 | 3537 | */ |
3538 | 3538 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3542,21 +3542,21 @@ discard block |
||
3542 | 3542 | return false; |
3543 | 3543 | } |
3544 | 3544 | |
3545 | - $author = 'System'; |
|
3546 | - $author_email = '[email protected]'; |
|
3545 | + $author = 'System'; |
|
3546 | + $author_email = '[email protected]'; |
|
3547 | 3547 | |
3548 | - // If this is an admin comment or it has been added by the user. |
|
3549 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3550 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
3548 | + // If this is an admin comment or it has been added by the user. |
|
3549 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3550 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
3551 | 3551 | $author = $user->display_name; |
3552 | 3552 | $author_email = $user->user_email; |
3553 | - } |
|
3553 | + } |
|
3554 | 3554 | |
3555 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3555 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3556 | 3556 | |
3557 | - } |
|
3557 | + } |
|
3558 | 3558 | |
3559 | - /** |
|
3559 | + /** |
|
3560 | 3560 | * Generates a unique key for the invoice. |
3561 | 3561 | */ |
3562 | 3562 | public function generate_key( $string = '' ) { |
@@ -3576,113 +3576,113 @@ discard block |
||
3576 | 3576 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
3577 | 3577 | } |
3578 | 3578 | |
3579 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3580 | - |
|
3581 | - } |
|
3582 | - |
|
3583 | - /** |
|
3584 | - * Handle the status transition. |
|
3585 | - */ |
|
3586 | - protected function status_transition() { |
|
3587 | - $status_transition = $this->status_transition; |
|
3588 | - |
|
3589 | - // Reset status transition variable. |
|
3590 | - $this->status_transition = false; |
|
3579 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3591 | 3580 | |
3592 | - if ( $status_transition ) { |
|
3593 | - try { |
|
3594 | - |
|
3595 | - // Fire a hook for the status change. |
|
3596 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3597 | - |
|
3598 | - // @deprecated this is deprecated and will be removed in the future. |
|
3599 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3600 | - |
|
3601 | - if ( ! empty( $status_transition['from'] ) ) { |
|
3602 | - |
|
3603 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
3604 | - $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3605 | - |
|
3606 | - // Fire another hook. |
|
3607 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3608 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3609 | - |
|
3610 | - // @deprecated this is deprecated and will be removed in the future. |
|
3611 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3612 | - |
|
3613 | - // Note the transition occurred. |
|
3614 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3615 | - |
|
3616 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3617 | - if ( |
|
3618 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3619 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3620 | - ) { |
|
3621 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3622 | - } |
|
3623 | - |
|
3624 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3625 | - if ( |
|
3626 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3627 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3628 | - ) { |
|
3629 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3630 | - } |
|
3631 | - } else { |
|
3632 | - /* translators: %s: new invoice status */ |
|
3633 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3634 | - |
|
3635 | - // Note the transition occurred. |
|
3636 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3581 | + } |
|
3637 | 3582 | |
3638 | - } |
|
3639 | - } catch ( Exception $e ) { |
|
3640 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3641 | - } |
|
3642 | - } |
|
3643 | - } |
|
3583 | + /** |
|
3584 | + * Handle the status transition. |
|
3585 | + */ |
|
3586 | + protected function status_transition() { |
|
3587 | + $status_transition = $this->status_transition; |
|
3588 | + |
|
3589 | + // Reset status transition variable. |
|
3590 | + $this->status_transition = false; |
|
3591 | + |
|
3592 | + if ( $status_transition ) { |
|
3593 | + try { |
|
3594 | + |
|
3595 | + // Fire a hook for the status change. |
|
3596 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3597 | + |
|
3598 | + // @deprecated this is deprecated and will be removed in the future. |
|
3599 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3600 | + |
|
3601 | + if ( ! empty( $status_transition['from'] ) ) { |
|
3602 | + |
|
3603 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
3604 | + $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3605 | + |
|
3606 | + // Fire another hook. |
|
3607 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3608 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3609 | + |
|
3610 | + // @deprecated this is deprecated and will be removed in the future. |
|
3611 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3612 | + |
|
3613 | + // Note the transition occurred. |
|
3614 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3615 | + |
|
3616 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3617 | + if ( |
|
3618 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3619 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3620 | + ) { |
|
3621 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3622 | + } |
|
3623 | + |
|
3624 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3625 | + if ( |
|
3626 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3627 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3628 | + ) { |
|
3629 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3630 | + } |
|
3631 | + } else { |
|
3632 | + /* translators: %s: new invoice status */ |
|
3633 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3634 | + |
|
3635 | + // Note the transition occurred. |
|
3636 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3637 | + |
|
3638 | + } |
|
3639 | + } catch ( Exception $e ) { |
|
3640 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3641 | + } |
|
3642 | + } |
|
3643 | + } |
|
3644 | 3644 | |
3645 | - /** |
|
3646 | - * Updates an invoice status. |
|
3647 | - */ |
|
3648 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3645 | + /** |
|
3646 | + * Updates an invoice status. |
|
3647 | + */ |
|
3648 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3649 | 3649 | |
3650 | - // Fires before updating a status. |
|
3651 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3650 | + // Fires before updating a status. |
|
3651 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3652 | 3652 | |
3653 | - // Update the status. |
|
3654 | - $this->set_status( $new_status, $note, $manual ); |
|
3653 | + // Update the status. |
|
3654 | + $this->set_status( $new_status, $note, $manual ); |
|
3655 | 3655 | |
3656 | - // Save the order. |
|
3657 | - return $this->save(); |
|
3656 | + // Save the order. |
|
3657 | + return $this->save(); |
|
3658 | 3658 | |
3659 | - } |
|
3659 | + } |
|
3660 | 3660 | |
3661 | - /** |
|
3662 | - * @deprecated |
|
3663 | - */ |
|
3664 | - public function refresh_item_ids() { |
|
3661 | + /** |
|
3662 | + * @deprecated |
|
3663 | + */ |
|
3664 | + public function refresh_item_ids() { |
|
3665 | 3665 | $item_ids = implode( ',', array_unique( array_keys( $this->get_items() ) ) ); |
3666 | 3666 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
3667 | - } |
|
3667 | + } |
|
3668 | 3668 | |
3669 | - /** |
|
3670 | - * @deprecated |
|
3671 | - */ |
|
3672 | - public function update_items( $temp = false ) { |
|
3669 | + /** |
|
3670 | + * @deprecated |
|
3671 | + */ |
|
3672 | + public function update_items( $temp = false ) { |
|
3673 | 3673 | |
3674 | - $this->set_items( $this->get_items() ); |
|
3674 | + $this->set_items( $this->get_items() ); |
|
3675 | 3675 | |
3676 | - if ( ! $temp ) { |
|
3677 | - $this->save(); |
|
3678 | - } |
|
3676 | + if ( ! $temp ) { |
|
3677 | + $this->save(); |
|
3678 | + } |
|
3679 | 3679 | |
3680 | 3680 | return $this; |
3681 | - } |
|
3681 | + } |
|
3682 | 3682 | |
3683 | - /** |
|
3684 | - * @deprecated |
|
3685 | - */ |
|
3683 | + /** |
|
3684 | + * @deprecated |
|
3685 | + */ |
|
3686 | 3686 | public function validate_discount() { |
3687 | 3687 | |
3688 | 3688 | $discount_code = $this->get_discount_code(); |
@@ -3698,93 +3698,93 @@ discard block |
||
3698 | 3698 | |
3699 | 3699 | } |
3700 | 3700 | |
3701 | - /** |
|
3702 | - * Refunds an invoice. |
|
3703 | - */ |
|
3701 | + /** |
|
3702 | + * Refunds an invoice. |
|
3703 | + */ |
|
3704 | 3704 | public function refund() { |
3705 | - $this->set_status( 'wpi-refunded' ); |
|
3705 | + $this->set_status( 'wpi-refunded' ); |
|
3706 | 3706 | $this->save(); |
3707 | - } |
|
3707 | + } |
|
3708 | 3708 | |
3709 | - /** |
|
3710 | - * Marks an invoice as paid. |
|
3711 | - * |
|
3712 | - * @param string $transaction_id |
|
3713 | - */ |
|
3709 | + /** |
|
3710 | + * Marks an invoice as paid. |
|
3711 | + * |
|
3712 | + * @param string $transaction_id |
|
3713 | + */ |
|
3714 | 3714 | public function mark_paid( $transaction_id = null, $note = '' ) { |
3715 | 3715 | |
3716 | - // Set the transaction id. |
|
3717 | - if ( empty( $transaction_id ) ) { |
|
3718 | - $transaction_id = $this->generate_key('trans_'); |
|
3719 | - } |
|
3716 | + // Set the transaction id. |
|
3717 | + if ( empty( $transaction_id ) ) { |
|
3718 | + $transaction_id = $this->generate_key('trans_'); |
|
3719 | + } |
|
3720 | 3720 | |
3721 | - if ( ! $this->get_transaction_id() ) { |
|
3722 | - $this->set_transaction_id( $transaction_id ); |
|
3723 | - } |
|
3721 | + if ( ! $this->get_transaction_id() ) { |
|
3722 | + $this->set_transaction_id( $transaction_id ); |
|
3723 | + } |
|
3724 | 3724 | |
3725 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3726 | - return $this->save(); |
|
3727 | - } |
|
3725 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3726 | + return $this->save(); |
|
3727 | + } |
|
3728 | 3728 | |
3729 | - // Set the completed date. |
|
3730 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
3729 | + // Set the completed date. |
|
3730 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
3731 | 3731 | |
3732 | - // Set the new status. |
|
3733 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3734 | - if ( $this->is_renewal() ) { |
|
3732 | + // Set the new status. |
|
3733 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3734 | + if ( $this->is_renewal() ) { |
|
3735 | 3735 | |
3736 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3737 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3736 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3737 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3738 | 3738 | |
3739 | - if ( 'none' == $this->get_gateway() ) { |
|
3740 | - $_note = $note; |
|
3741 | - } |
|
3739 | + if ( 'none' == $this->get_gateway() ) { |
|
3740 | + $_note = $note; |
|
3741 | + } |
|
3742 | 3742 | |
3743 | - $this->set_status( 'wpi-renewal', $_note ); |
|
3743 | + $this->set_status( 'wpi-renewal', $_note ); |
|
3744 | 3744 | |
3745 | - } else { |
|
3745 | + } else { |
|
3746 | 3746 | |
3747 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3748 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3747 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3748 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3749 | 3749 | |
3750 | - if ( 'none' == $this->get_gateway() ) { |
|
3751 | - $_note = $note; |
|
3752 | - } |
|
3750 | + if ( 'none' == $this->get_gateway() ) { |
|
3751 | + $_note = $note; |
|
3752 | + } |
|
3753 | 3753 | |
3754 | - $this->set_status( 'publish', $_note ); |
|
3754 | + $this->set_status( 'publish', $_note ); |
|
3755 | 3755 | |
3756 | - } |
|
3756 | + } |
|
3757 | 3757 | |
3758 | - // Set checkout mode. |
|
3759 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3760 | - $this->set_mode( $mode ); |
|
3758 | + // Set checkout mode. |
|
3759 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3760 | + $this->set_mode( $mode ); |
|
3761 | 3761 | |
3762 | - // Save the invoice. |
|
3762 | + // Save the invoice. |
|
3763 | 3763 | $this->save(); |
3764 | - } |
|
3765 | - |
|
3766 | - /** |
|
3767 | - * Save data to the database. |
|
3768 | - * |
|
3769 | - * @since 1.0.19 |
|
3770 | - * @return int invoice ID |
|
3771 | - */ |
|
3772 | - public function save() { |
|
3773 | - $this->maybe_set_date_paid(); |
|
3774 | - $this->maybe_set_key(); |
|
3775 | - parent::save(); |
|
3776 | - $this->clear_cache(); |
|
3777 | - $this->status_transition(); |
|
3778 | - return $this->get_id(); |
|
3779 | - } |
|
3780 | - |
|
3781 | - /** |
|
3764 | + } |
|
3765 | + |
|
3766 | + /** |
|
3767 | + * Save data to the database. |
|
3768 | + * |
|
3769 | + * @since 1.0.19 |
|
3770 | + * @return int invoice ID |
|
3771 | + */ |
|
3772 | + public function save() { |
|
3773 | + $this->maybe_set_date_paid(); |
|
3774 | + $this->maybe_set_key(); |
|
3775 | + parent::save(); |
|
3776 | + $this->clear_cache(); |
|
3777 | + $this->status_transition(); |
|
3778 | + return $this->get_id(); |
|
3779 | + } |
|
3780 | + |
|
3781 | + /** |
|
3782 | 3782 | * Clears the subscription's cache. |
3783 | 3783 | */ |
3784 | 3784 | public function clear_cache() { |
3785 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3786 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3787 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3788 | - } |
|
3785 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3786 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3787 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3788 | + } |
|
3789 | 3789 | |
3790 | 3790 | } |