@@ -12,493 +12,493 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Invoice_Notification_Emails { |
14 | 14 | |
15 | - /** |
|
16 | - * The array of invoice email actions. |
|
17 | - * |
|
18 | - * @param array |
|
19 | - */ |
|
20 | - public $invoice_actions; |
|
21 | - |
|
22 | - /** |
|
23 | - * Class constructor |
|
24 | - * |
|
25 | - */ |
|
26 | - public function __construct() { |
|
27 | - |
|
28 | - $this->invoice_actions = apply_filters( |
|
29 | - 'getpaid_notification_email_invoice_triggers', |
|
30 | - array( |
|
31 | - 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
32 | - 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
33 | - 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
34 | - 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
35 | - 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
36 | - 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
37 | - 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
38 | - 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
39 | - 'getpaid_new_customer_note' => 'user_note', |
|
40 | - 'getpaid_daily_maintenance' => 'overdue', |
|
41 | - ) |
|
42 | - ); |
|
43 | - |
|
44 | - $this->init_hooks(); |
|
45 | - |
|
46 | - } |
|
47 | - |
|
48 | - /** |
|
49 | - * Registers email hooks. |
|
50 | - */ |
|
51 | - public function init_hooks() { |
|
52 | - |
|
53 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
54 | - add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
55 | - |
|
56 | - foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
57 | - $this->init_email_type_hook( $hook, $email_type ); |
|
58 | - } |
|
59 | - } |
|
60 | - |
|
61 | - /** |
|
62 | - * Registers an email hook for an invoice action. |
|
63 | - * |
|
64 | - * @param string $hook |
|
65 | - * @param string|array $email_type |
|
66 | - */ |
|
67 | - public function init_email_type_hook( $hook, $email_type ) { |
|
68 | - |
|
69 | - $email_type = wpinv_parse_list( $email_type ); |
|
70 | - |
|
71 | - foreach ( $email_type as $type ) { |
|
72 | - |
|
73 | - $email = new GetPaid_Notification_Email( $type ); |
|
74 | - |
|
75 | - // Abort if it is not active. |
|
76 | - if ( ! $email->is_active() ) { |
|
77 | - continue; |
|
78 | - } |
|
79 | - |
|
80 | - if ( method_exists( $this, $type ) ) { |
|
81 | - add_action( $hook, array( $this, $type ), 100, 2 ); |
|
82 | - continue; |
|
83 | - } |
|
84 | - |
|
85 | - do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook ); |
|
86 | - } |
|
87 | - |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Filters invoice merge tags. |
|
92 | - * |
|
93 | - * @param array $merge_tags |
|
94 | - * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
95 | - */ |
|
96 | - public function invoice_merge_tags( $merge_tags, $object ) { |
|
97 | - |
|
98 | - if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
99 | - return array_merge( |
|
100 | - $merge_tags, |
|
101 | - $this->get_invoice_merge_tags( $object ) |
|
102 | - ); |
|
103 | - } |
|
104 | - |
|
105 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
106 | - return array_merge( |
|
107 | - $merge_tags, |
|
108 | - $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
109 | - ); |
|
110 | - } |
|
111 | - |
|
112 | - return $merge_tags; |
|
113 | - |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Generates invoice merge tags. |
|
118 | - * |
|
119 | - * @param WPInv_Invoice $invoice |
|
120 | - * @return array |
|
121 | - */ |
|
122 | - public function get_invoice_merge_tags( $invoice ) { |
|
123 | - |
|
124 | - // Abort if it does not exist. |
|
125 | - if ( ! $invoice->get_id() ) { |
|
126 | - return array(); |
|
127 | - } |
|
128 | - |
|
129 | - $due_date = $invoice->get_due_date(); |
|
130 | - $due_date = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ); |
|
131 | - $merge_tags = array( |
|
132 | - '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
133 | - '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
134 | - '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
135 | - '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
136 | - '{email}' => sanitize_email( $invoice->get_email() ), |
|
137 | - '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
138 | - '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
139 | - '{invoice_total}' => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ), |
|
140 | - '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
141 | - '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
142 | - '{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ), |
|
143 | - '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
144 | - '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
145 | - '{invoice_quote}' => sanitize_text_field( strtolower( $invoice->get_label() ) ), |
|
146 | - '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_label() ) ), |
|
147 | - '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
148 | - '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
149 | - '{is_was}' => $due_date < time() ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
150 | - ); |
|
151 | - |
|
152 | - $payment_form_data = $invoice->get_meta( 'payment_form_data', true ); |
|
153 | - |
|
154 | - if ( is_array( $payment_form_data ) ) { |
|
155 | - |
|
156 | - foreach ( $payment_form_data as $label => $value ) { |
|
157 | - |
|
158 | - $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) ); |
|
159 | - $value = is_array( $value ) ? implode( ', ', $value ) : $value; |
|
160 | - |
|
161 | - if ( is_scalar( $value ) ) { |
|
162 | - $merge_tags[ "{{$label}}" ] = wp_kses_post( $value ); |
|
163 | - } |
|
164 | - } |
|
165 | - } |
|
166 | - |
|
167 | - return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice ); |
|
168 | - } |
|
169 | - |
|
170 | - /** |
|
171 | - * Helper function to send an email. |
|
172 | - * |
|
173 | - * @param WPInv_Invoice $invoice |
|
174 | - * @param GetPaid_Notification_Email $email |
|
175 | - * @param string $type |
|
176 | - * @param string|array $recipients |
|
177 | - * @param array $extra_args Extra template args. |
|
178 | - */ |
|
179 | - public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
180 | - |
|
181 | - do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
182 | - |
|
183 | - $skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' ); |
|
184 | - if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) { |
|
185 | - return; |
|
186 | - } |
|
187 | - |
|
188 | - $mailer = new GetPaid_Notification_Email_Sender(); |
|
189 | - $merge_tags = $email->get_merge_tags(); |
|
190 | - |
|
191 | - $result = $mailer->send( |
|
192 | - apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
193 | - $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
194 | - $email->get_content( $merge_tags, $extra_args ), |
|
195 | - $email->get_attachments() |
|
196 | - ); |
|
197 | - |
|
198 | - // Maybe send a copy to the admin. |
|
199 | - if ( $email->include_admin_bcc() ) { |
|
200 | - $mailer->send( |
|
201 | - wpinv_get_admin_email(), |
|
202 | - $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
203 | - $email->get_content( $merge_tags ), |
|
204 | - $email->get_attachments() |
|
205 | - ); |
|
206 | - } |
|
207 | - |
|
208 | - if ( $result ) { |
|
209 | - $invoice->add_system_note( |
|
210 | - sprintf( |
|
211 | - // translators: %1 is the email type, %2 is the invoice recipient. |
|
212 | - __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ), |
|
213 | - sanitize_key( $type ), |
|
214 | - $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
215 | - ) |
|
216 | - ); |
|
217 | - } else { |
|
218 | - $invoice->add_system_note( |
|
219 | - sprintf( |
|
220 | - // translators: %1 is the email type, %2 is the invoice recipient. |
|
221 | - __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ), |
|
222 | - sanitize_key( $type ), |
|
223 | - $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
224 | - ) |
|
225 | - ); |
|
226 | - } |
|
227 | - |
|
228 | - do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
229 | - |
|
230 | - return $result; |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Also send emails to any cc users. |
|
235 | - * |
|
236 | - * @param array $recipients |
|
237 | - * @param GetPaid_Notification_Email $email |
|
238 | - */ |
|
239 | - public function filter_email_recipients( $recipients, $email ) { |
|
240 | - |
|
241 | - if ( ! $email->is_admin_email() ) { |
|
242 | - $cc = $email->object->get_email_cc(); |
|
243 | - $cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true ); |
|
244 | - |
|
245 | - if ( ! empty( $cc ) ) { |
|
246 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
247 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
248 | - } |
|
249 | - |
|
250 | - if ( ! empty( $cc_2 ) ) { |
|
251 | - $cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) ); |
|
252 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) ); |
|
253 | - } |
|
254 | - } |
|
255 | - |
|
256 | - return $recipients; |
|
257 | - |
|
258 | - } |
|
259 | - |
|
260 | - /** |
|
261 | - * Sends a new invoice notification. |
|
262 | - * |
|
263 | - * @param WPInv_Invoice $invoice |
|
264 | - */ |
|
265 | - public function new_invoice( $invoice ) { |
|
266 | - |
|
267 | - // Only send this email for invoices created via the admin page. |
|
268 | - if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
269 | - return; |
|
270 | - } |
|
271 | - |
|
272 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
273 | - $recipient = wpinv_get_admin_email(); |
|
274 | - |
|
275 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
276 | - |
|
277 | - } |
|
278 | - |
|
279 | - /** |
|
280 | - * Sends a cancelled invoice notification. |
|
281 | - * |
|
282 | - * @param WPInv_Invoice $invoice |
|
283 | - */ |
|
284 | - public function cancelled_invoice( $invoice ) { |
|
285 | - |
|
286 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
287 | - $recipient = $invoice->get_email(); |
|
288 | - |
|
289 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
290 | - } |
|
291 | - |
|
292 | - /** |
|
293 | - * Sends a failed invoice notification. |
|
294 | - * |
|
295 | - * @param WPInv_Invoice $invoice |
|
296 | - */ |
|
297 | - public function failed_invoice( $invoice ) { |
|
298 | - |
|
299 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
300 | - $recipient = wpinv_get_admin_email(); |
|
301 | - |
|
302 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
303 | - |
|
304 | - } |
|
305 | - |
|
306 | - /** |
|
307 | - * Sends a notification whenever an invoice is put on hold. |
|
308 | - * |
|
309 | - * @param WPInv_Invoice $invoice |
|
310 | - */ |
|
311 | - public function onhold_invoice( $invoice ) { |
|
312 | - |
|
313 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
314 | - $recipient = $invoice->get_email(); |
|
315 | - |
|
316 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
317 | - |
|
318 | - } |
|
319 | - |
|
320 | - /** |
|
321 | - * Sends a notification whenever an invoice is marked as processing payment. |
|
322 | - * |
|
323 | - * @param WPInv_Invoice $invoice |
|
324 | - */ |
|
325 | - public function processing_invoice( $invoice ) { |
|
326 | - |
|
327 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
328 | - $recipient = $invoice->get_email(); |
|
329 | - |
|
330 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
331 | - |
|
332 | - } |
|
333 | - |
|
334 | - /** |
|
335 | - * Sends a notification whenever an invoice is paid. |
|
336 | - * |
|
337 | - * @param WPInv_Invoice $invoice |
|
338 | - */ |
|
339 | - public function completed_invoice( $invoice ) { |
|
340 | - |
|
341 | - // (Maybe) abort if it is a renewal invoice. |
|
342 | - if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
343 | - return; |
|
344 | - } |
|
345 | - |
|
346 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
347 | - $recipient = $invoice->get_email(); |
|
348 | - |
|
349 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
350 | - |
|
351 | - } |
|
15 | + /** |
|
16 | + * The array of invoice email actions. |
|
17 | + * |
|
18 | + * @param array |
|
19 | + */ |
|
20 | + public $invoice_actions; |
|
21 | + |
|
22 | + /** |
|
23 | + * Class constructor |
|
24 | + * |
|
25 | + */ |
|
26 | + public function __construct() { |
|
27 | + |
|
28 | + $this->invoice_actions = apply_filters( |
|
29 | + 'getpaid_notification_email_invoice_triggers', |
|
30 | + array( |
|
31 | + 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
32 | + 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
33 | + 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
34 | + 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
35 | + 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
36 | + 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
37 | + 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
38 | + 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
39 | + 'getpaid_new_customer_note' => 'user_note', |
|
40 | + 'getpaid_daily_maintenance' => 'overdue', |
|
41 | + ) |
|
42 | + ); |
|
43 | + |
|
44 | + $this->init_hooks(); |
|
45 | + |
|
46 | + } |
|
47 | + |
|
48 | + /** |
|
49 | + * Registers email hooks. |
|
50 | + */ |
|
51 | + public function init_hooks() { |
|
52 | + |
|
53 | + add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
54 | + add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
55 | + |
|
56 | + foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
57 | + $this->init_email_type_hook( $hook, $email_type ); |
|
58 | + } |
|
59 | + } |
|
60 | + |
|
61 | + /** |
|
62 | + * Registers an email hook for an invoice action. |
|
63 | + * |
|
64 | + * @param string $hook |
|
65 | + * @param string|array $email_type |
|
66 | + */ |
|
67 | + public function init_email_type_hook( $hook, $email_type ) { |
|
68 | + |
|
69 | + $email_type = wpinv_parse_list( $email_type ); |
|
70 | + |
|
71 | + foreach ( $email_type as $type ) { |
|
72 | + |
|
73 | + $email = new GetPaid_Notification_Email( $type ); |
|
74 | + |
|
75 | + // Abort if it is not active. |
|
76 | + if ( ! $email->is_active() ) { |
|
77 | + continue; |
|
78 | + } |
|
79 | + |
|
80 | + if ( method_exists( $this, $type ) ) { |
|
81 | + add_action( $hook, array( $this, $type ), 100, 2 ); |
|
82 | + continue; |
|
83 | + } |
|
84 | + |
|
85 | + do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook ); |
|
86 | + } |
|
87 | + |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Filters invoice merge tags. |
|
92 | + * |
|
93 | + * @param array $merge_tags |
|
94 | + * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
95 | + */ |
|
96 | + public function invoice_merge_tags( $merge_tags, $object ) { |
|
97 | + |
|
98 | + if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
99 | + return array_merge( |
|
100 | + $merge_tags, |
|
101 | + $this->get_invoice_merge_tags( $object ) |
|
102 | + ); |
|
103 | + } |
|
104 | + |
|
105 | + if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
106 | + return array_merge( |
|
107 | + $merge_tags, |
|
108 | + $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
109 | + ); |
|
110 | + } |
|
111 | + |
|
112 | + return $merge_tags; |
|
113 | + |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Generates invoice merge tags. |
|
118 | + * |
|
119 | + * @param WPInv_Invoice $invoice |
|
120 | + * @return array |
|
121 | + */ |
|
122 | + public function get_invoice_merge_tags( $invoice ) { |
|
123 | + |
|
124 | + // Abort if it does not exist. |
|
125 | + if ( ! $invoice->get_id() ) { |
|
126 | + return array(); |
|
127 | + } |
|
128 | + |
|
129 | + $due_date = $invoice->get_due_date(); |
|
130 | + $due_date = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ); |
|
131 | + $merge_tags = array( |
|
132 | + '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
133 | + '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
134 | + '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
135 | + '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
136 | + '{email}' => sanitize_email( $invoice->get_email() ), |
|
137 | + '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
138 | + '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
139 | + '{invoice_total}' => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ), |
|
140 | + '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
141 | + '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
142 | + '{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ), |
|
143 | + '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
144 | + '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
145 | + '{invoice_quote}' => sanitize_text_field( strtolower( $invoice->get_label() ) ), |
|
146 | + '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_label() ) ), |
|
147 | + '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
148 | + '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
149 | + '{is_was}' => $due_date < time() ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
150 | + ); |
|
151 | + |
|
152 | + $payment_form_data = $invoice->get_meta( 'payment_form_data', true ); |
|
153 | + |
|
154 | + if ( is_array( $payment_form_data ) ) { |
|
155 | + |
|
156 | + foreach ( $payment_form_data as $label => $value ) { |
|
157 | + |
|
158 | + $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) ); |
|
159 | + $value = is_array( $value ) ? implode( ', ', $value ) : $value; |
|
160 | + |
|
161 | + if ( is_scalar( $value ) ) { |
|
162 | + $merge_tags[ "{{$label}}" ] = wp_kses_post( $value ); |
|
163 | + } |
|
164 | + } |
|
165 | + } |
|
166 | + |
|
167 | + return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice ); |
|
168 | + } |
|
352 | 169 | |
353 | - /** |
|
354 | - * Sends a notification whenever an invoice is refunded. |
|
355 | - * |
|
356 | - * @param WPInv_Invoice $invoice |
|
357 | - */ |
|
358 | - public function refunded_invoice( $invoice ) { |
|
359 | - |
|
360 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
361 | - $recipient = $invoice->get_email(); |
|
362 | - |
|
363 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
364 | - |
|
365 | - } |
|
170 | + /** |
|
171 | + * Helper function to send an email. |
|
172 | + * |
|
173 | + * @param WPInv_Invoice $invoice |
|
174 | + * @param GetPaid_Notification_Email $email |
|
175 | + * @param string $type |
|
176 | + * @param string|array $recipients |
|
177 | + * @param array $extra_args Extra template args. |
|
178 | + */ |
|
179 | + public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
366 | 180 | |
367 | - /** |
|
368 | - * Notifies a user about new invoices |
|
369 | - * |
|
370 | - * @param WPInv_Invoice $invoice |
|
371 | - * @param bool $force |
|
372 | - */ |
|
373 | - public function user_invoice( $invoice, $force = false ) { |
|
181 | + do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
374 | 182 | |
375 | - if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
|
376 | - return; |
|
377 | - } |
|
378 | - |
|
379 | - // Only send this email for invoices created via the admin page. |
|
380 | - if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
|
381 | - return; |
|
382 | - } |
|
383 | - |
|
384 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
385 | - $recipient = $invoice->get_email(); |
|
386 | - |
|
387 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
388 | - |
|
389 | - } |
|
390 | - |
|
391 | - /** |
|
392 | - * Checks if an invoice is a payment form invoice. |
|
393 | - * |
|
394 | - * @param int $invoice |
|
395 | - * @return bool |
|
396 | - */ |
|
397 | - public function is_payment_form_invoice( $invoice ) { |
|
398 | - $created_via = get_post_meta( $invoice, 'wpinv_created_via', true ); |
|
399 | - $is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via; |
|
400 | - $is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice ); |
|
401 | - return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice; |
|
402 | - } |
|
403 | - |
|
404 | - /** |
|
405 | - * Notifies admin about new invoice notes |
|
406 | - * |
|
407 | - * @param WPInv_Invoice $invoice |
|
408 | - * @param string $note |
|
409 | - */ |
|
410 | - public function user_note( $invoice, $note ) { |
|
411 | - |
|
412 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
413 | - $recipient = $invoice->get_email(); |
|
414 | - |
|
415 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
416 | - |
|
417 | - } |
|
418 | - |
|
419 | - /** |
|
420 | - * (Force) Sends overdue notices. |
|
421 | - * |
|
422 | - * @param WPInv_Invoice $invoice |
|
423 | - */ |
|
424 | - public function force_send_overdue_notice( $invoice ) { |
|
425 | - $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
426 | - return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
427 | - } |
|
428 | - |
|
429 | - /** |
|
430 | - * Sends overdue notices. |
|
431 | - * |
|
432 | - * @TODO: Create an invoices query class. |
|
433 | - */ |
|
434 | - public function overdue() { |
|
435 | - global $wpdb; |
|
436 | - |
|
437 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
438 | - |
|
439 | - // Fetch reminder days. |
|
440 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
441 | - |
|
442 | - // Abort if non is set. |
|
443 | - if ( empty( $reminder_days ) ) { |
|
444 | - return; |
|
445 | - } |
|
446 | - |
|
447 | - // Retrieve date query. |
|
448 | - $date_query = $this->get_date_query( $reminder_days ); |
|
449 | - |
|
450 | - // Invoices table. |
|
451 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
452 | - |
|
453 | - // Fetch invoices. |
|
454 | - $invoices = $wpdb->get_col( |
|
455 | - "SELECT posts.ID FROM $wpdb->posts as posts |
|
183 | + $skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' ); |
|
184 | + if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) { |
|
185 | + return; |
|
186 | + } |
|
187 | + |
|
188 | + $mailer = new GetPaid_Notification_Email_Sender(); |
|
189 | + $merge_tags = $email->get_merge_tags(); |
|
190 | + |
|
191 | + $result = $mailer->send( |
|
192 | + apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
193 | + $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
194 | + $email->get_content( $merge_tags, $extra_args ), |
|
195 | + $email->get_attachments() |
|
196 | + ); |
|
197 | + |
|
198 | + // Maybe send a copy to the admin. |
|
199 | + if ( $email->include_admin_bcc() ) { |
|
200 | + $mailer->send( |
|
201 | + wpinv_get_admin_email(), |
|
202 | + $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
203 | + $email->get_content( $merge_tags ), |
|
204 | + $email->get_attachments() |
|
205 | + ); |
|
206 | + } |
|
207 | + |
|
208 | + if ( $result ) { |
|
209 | + $invoice->add_system_note( |
|
210 | + sprintf( |
|
211 | + // translators: %1 is the email type, %2 is the invoice recipient. |
|
212 | + __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ), |
|
213 | + sanitize_key( $type ), |
|
214 | + $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
215 | + ) |
|
216 | + ); |
|
217 | + } else { |
|
218 | + $invoice->add_system_note( |
|
219 | + sprintf( |
|
220 | + // translators: %1 is the email type, %2 is the invoice recipient. |
|
221 | + __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ), |
|
222 | + sanitize_key( $type ), |
|
223 | + $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
224 | + ) |
|
225 | + ); |
|
226 | + } |
|
227 | + |
|
228 | + do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
229 | + |
|
230 | + return $result; |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Also send emails to any cc users. |
|
235 | + * |
|
236 | + * @param array $recipients |
|
237 | + * @param GetPaid_Notification_Email $email |
|
238 | + */ |
|
239 | + public function filter_email_recipients( $recipients, $email ) { |
|
240 | + |
|
241 | + if ( ! $email->is_admin_email() ) { |
|
242 | + $cc = $email->object->get_email_cc(); |
|
243 | + $cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true ); |
|
244 | + |
|
245 | + if ( ! empty( $cc ) ) { |
|
246 | + $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
247 | + $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
248 | + } |
|
249 | + |
|
250 | + if ( ! empty( $cc_2 ) ) { |
|
251 | + $cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) ); |
|
252 | + $recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) ); |
|
253 | + } |
|
254 | + } |
|
255 | + |
|
256 | + return $recipients; |
|
257 | + |
|
258 | + } |
|
259 | + |
|
260 | + /** |
|
261 | + * Sends a new invoice notification. |
|
262 | + * |
|
263 | + * @param WPInv_Invoice $invoice |
|
264 | + */ |
|
265 | + public function new_invoice( $invoice ) { |
|
266 | + |
|
267 | + // Only send this email for invoices created via the admin page. |
|
268 | + if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
269 | + return; |
|
270 | + } |
|
271 | + |
|
272 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
273 | + $recipient = wpinv_get_admin_email(); |
|
274 | + |
|
275 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
276 | + |
|
277 | + } |
|
278 | + |
|
279 | + /** |
|
280 | + * Sends a cancelled invoice notification. |
|
281 | + * |
|
282 | + * @param WPInv_Invoice $invoice |
|
283 | + */ |
|
284 | + public function cancelled_invoice( $invoice ) { |
|
285 | + |
|
286 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
287 | + $recipient = $invoice->get_email(); |
|
288 | + |
|
289 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
290 | + } |
|
291 | + |
|
292 | + /** |
|
293 | + * Sends a failed invoice notification. |
|
294 | + * |
|
295 | + * @param WPInv_Invoice $invoice |
|
296 | + */ |
|
297 | + public function failed_invoice( $invoice ) { |
|
298 | + |
|
299 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
300 | + $recipient = wpinv_get_admin_email(); |
|
301 | + |
|
302 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
303 | + |
|
304 | + } |
|
305 | + |
|
306 | + /** |
|
307 | + * Sends a notification whenever an invoice is put on hold. |
|
308 | + * |
|
309 | + * @param WPInv_Invoice $invoice |
|
310 | + */ |
|
311 | + public function onhold_invoice( $invoice ) { |
|
312 | + |
|
313 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
314 | + $recipient = $invoice->get_email(); |
|
315 | + |
|
316 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
317 | + |
|
318 | + } |
|
319 | + |
|
320 | + /** |
|
321 | + * Sends a notification whenever an invoice is marked as processing payment. |
|
322 | + * |
|
323 | + * @param WPInv_Invoice $invoice |
|
324 | + */ |
|
325 | + public function processing_invoice( $invoice ) { |
|
326 | + |
|
327 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
328 | + $recipient = $invoice->get_email(); |
|
329 | + |
|
330 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
331 | + |
|
332 | + } |
|
333 | + |
|
334 | + /** |
|
335 | + * Sends a notification whenever an invoice is paid. |
|
336 | + * |
|
337 | + * @param WPInv_Invoice $invoice |
|
338 | + */ |
|
339 | + public function completed_invoice( $invoice ) { |
|
340 | + |
|
341 | + // (Maybe) abort if it is a renewal invoice. |
|
342 | + if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
343 | + return; |
|
344 | + } |
|
345 | + |
|
346 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
347 | + $recipient = $invoice->get_email(); |
|
348 | + |
|
349 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
350 | + |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * Sends a notification whenever an invoice is refunded. |
|
355 | + * |
|
356 | + * @param WPInv_Invoice $invoice |
|
357 | + */ |
|
358 | + public function refunded_invoice( $invoice ) { |
|
359 | + |
|
360 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
361 | + $recipient = $invoice->get_email(); |
|
362 | + |
|
363 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
364 | + |
|
365 | + } |
|
366 | + |
|
367 | + /** |
|
368 | + * Notifies a user about new invoices |
|
369 | + * |
|
370 | + * @param WPInv_Invoice $invoice |
|
371 | + * @param bool $force |
|
372 | + */ |
|
373 | + public function user_invoice( $invoice, $force = false ) { |
|
374 | + |
|
375 | + if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
|
376 | + return; |
|
377 | + } |
|
378 | + |
|
379 | + // Only send this email for invoices created via the admin page. |
|
380 | + if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
|
381 | + return; |
|
382 | + } |
|
383 | + |
|
384 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
385 | + $recipient = $invoice->get_email(); |
|
386 | + |
|
387 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
388 | + |
|
389 | + } |
|
390 | + |
|
391 | + /** |
|
392 | + * Checks if an invoice is a payment form invoice. |
|
393 | + * |
|
394 | + * @param int $invoice |
|
395 | + * @return bool |
|
396 | + */ |
|
397 | + public function is_payment_form_invoice( $invoice ) { |
|
398 | + $created_via = get_post_meta( $invoice, 'wpinv_created_via', true ); |
|
399 | + $is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via; |
|
400 | + $is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice ); |
|
401 | + return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice; |
|
402 | + } |
|
403 | + |
|
404 | + /** |
|
405 | + * Notifies admin about new invoice notes |
|
406 | + * |
|
407 | + * @param WPInv_Invoice $invoice |
|
408 | + * @param string $note |
|
409 | + */ |
|
410 | + public function user_note( $invoice, $note ) { |
|
411 | + |
|
412 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
413 | + $recipient = $invoice->get_email(); |
|
414 | + |
|
415 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
416 | + |
|
417 | + } |
|
418 | + |
|
419 | + /** |
|
420 | + * (Force) Sends overdue notices. |
|
421 | + * |
|
422 | + * @param WPInv_Invoice $invoice |
|
423 | + */ |
|
424 | + public function force_send_overdue_notice( $invoice ) { |
|
425 | + $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
426 | + return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
427 | + } |
|
428 | + |
|
429 | + /** |
|
430 | + * Sends overdue notices. |
|
431 | + * |
|
432 | + * @TODO: Create an invoices query class. |
|
433 | + */ |
|
434 | + public function overdue() { |
|
435 | + global $wpdb; |
|
436 | + |
|
437 | + $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
438 | + |
|
439 | + // Fetch reminder days. |
|
440 | + $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
441 | + |
|
442 | + // Abort if non is set. |
|
443 | + if ( empty( $reminder_days ) ) { |
|
444 | + return; |
|
445 | + } |
|
446 | + |
|
447 | + // Retrieve date query. |
|
448 | + $date_query = $this->get_date_query( $reminder_days ); |
|
449 | + |
|
450 | + // Invoices table. |
|
451 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
452 | + |
|
453 | + // Fetch invoices. |
|
454 | + $invoices = $wpdb->get_col( |
|
455 | + "SELECT posts.ID FROM $wpdb->posts as posts |
|
456 | 456 | LEFT JOIN $table as invoices ON invoices.post_id = posts.ID |
457 | 457 | WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query" |
458 | 458 | ); |
459 | 459 | |
460 | - foreach ( $invoices as $invoice ) { |
|
460 | + foreach ( $invoices as $invoice ) { |
|
461 | 461 | |
462 | - // Only send this email for invoices created via the admin page. |
|
463 | - if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
464 | - $invoice = new WPInv_Invoice( $invoice ); |
|
465 | - $email->object = $invoice; |
|
462 | + // Only send this email for invoices created via the admin page. |
|
463 | + if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
464 | + $invoice = new WPInv_Invoice( $invoice ); |
|
465 | + $email->object = $invoice; |
|
466 | 466 | |
467 | - if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) { |
|
468 | - $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
469 | - } |
|
470 | - } |
|
471 | - } |
|
467 | + if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) { |
|
468 | + $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
469 | + } |
|
470 | + } |
|
471 | + } |
|
472 | 472 | |
473 | - } |
|
473 | + } |
|
474 | 474 | |
475 | - /** |
|
476 | - * Calculates the date query for an invoices query |
|
477 | - * |
|
478 | - * @param array $reminder_days |
|
479 | - * @return string |
|
480 | - */ |
|
481 | - public function get_date_query( $reminder_days ) { |
|
475 | + /** |
|
476 | + * Calculates the date query for an invoices query |
|
477 | + * |
|
478 | + * @param array $reminder_days |
|
479 | + * @return string |
|
480 | + */ |
|
481 | + public function get_date_query( $reminder_days ) { |
|
482 | 482 | |
483 | - $date_query = array( |
|
484 | - 'relation' => 'OR', |
|
485 | - ); |
|
483 | + $date_query = array( |
|
484 | + 'relation' => 'OR', |
|
485 | + ); |
|
486 | 486 | |
487 | - foreach ( $reminder_days as $days ) { |
|
488 | - $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
487 | + foreach ( $reminder_days as $days ) { |
|
488 | + $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
489 | 489 | |
490 | - $date_query[] = array( |
|
491 | - 'year' => $date['year'], |
|
492 | - 'month' => $date['month'], |
|
493 | - 'day' => $date['day'], |
|
494 | - ); |
|
490 | + $date_query[] = array( |
|
491 | + 'year' => $date['year'], |
|
492 | + 'month' => $date['month'], |
|
493 | + 'day' => $date['day'], |
|
494 | + ); |
|
495 | 495 | |
496 | - } |
|
496 | + } |
|
497 | 497 | |
498 | - $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
498 | + $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
499 | 499 | |
500 | - return $date_query->get_sql(); |
|
500 | + return $date_query->get_sql(); |
|
501 | 501 | |
502 | - } |
|
502 | + } |
|
503 | 503 | |
504 | 504 | } |
@@ -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 | * This class handles invoice notificaiton emails. |
@@ -28,7 +28,7 @@ discard block |
||
28 | 28 | $this->invoice_actions = apply_filters( |
29 | 29 | 'getpaid_notification_email_invoice_triggers', |
30 | 30 | array( |
31 | - 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
31 | + 'getpaid_new_invoice' => array('new_invoice', 'user_invoice'), |
|
32 | 32 | 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
33 | 33 | 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
34 | 34 | 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
@@ -50,11 +50,11 @@ discard block |
||
50 | 50 | */ |
51 | 51 | public function init_hooks() { |
52 | 52 | |
53 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
54 | - add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
53 | + add_filter('getpaid_get_email_merge_tags', array($this, 'invoice_merge_tags'), 10, 2); |
|
54 | + add_filter('getpaid_invoice_email_recipients', array($this, 'filter_email_recipients'), 10, 2); |
|
55 | 55 | |
56 | - foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
57 | - $this->init_email_type_hook( $hook, $email_type ); |
|
56 | + foreach ($this->invoice_actions as $hook => $email_type) { |
|
57 | + $this->init_email_type_hook($hook, $email_type); |
|
58 | 58 | } |
59 | 59 | } |
60 | 60 | |
@@ -64,25 +64,25 @@ discard block |
||
64 | 64 | * @param string $hook |
65 | 65 | * @param string|array $email_type |
66 | 66 | */ |
67 | - public function init_email_type_hook( $hook, $email_type ) { |
|
67 | + public function init_email_type_hook($hook, $email_type) { |
|
68 | 68 | |
69 | - $email_type = wpinv_parse_list( $email_type ); |
|
69 | + $email_type = wpinv_parse_list($email_type); |
|
70 | 70 | |
71 | - foreach ( $email_type as $type ) { |
|
71 | + foreach ($email_type as $type) { |
|
72 | 72 | |
73 | - $email = new GetPaid_Notification_Email( $type ); |
|
73 | + $email = new GetPaid_Notification_Email($type); |
|
74 | 74 | |
75 | 75 | // Abort if it is not active. |
76 | - if ( ! $email->is_active() ) { |
|
76 | + if (!$email->is_active()) { |
|
77 | 77 | continue; |
78 | 78 | } |
79 | 79 | |
80 | - if ( method_exists( $this, $type ) ) { |
|
81 | - add_action( $hook, array( $this, $type ), 100, 2 ); |
|
80 | + if (method_exists($this, $type)) { |
|
81 | + add_action($hook, array($this, $type), 100, 2); |
|
82 | 82 | continue; |
83 | 83 | } |
84 | 84 | |
85 | - do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook ); |
|
85 | + do_action('getpaid_invoice_init_email_type_hook', $type, $hook); |
|
86 | 86 | } |
87 | 87 | |
88 | 88 | } |
@@ -93,19 +93,19 @@ discard block |
||
93 | 93 | * @param array $merge_tags |
94 | 94 | * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
95 | 95 | */ |
96 | - public function invoice_merge_tags( $merge_tags, $object ) { |
|
96 | + public function invoice_merge_tags($merge_tags, $object) { |
|
97 | 97 | |
98 | - if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
98 | + if (is_a($object, 'WPInv_Invoice')) { |
|
99 | 99 | return array_merge( |
100 | 100 | $merge_tags, |
101 | - $this->get_invoice_merge_tags( $object ) |
|
101 | + $this->get_invoice_merge_tags($object) |
|
102 | 102 | ); |
103 | 103 | } |
104 | 104 | |
105 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
105 | + if (is_a($object, 'WPInv_Subscription')) { |
|
106 | 106 | return array_merge( |
107 | 107 | $merge_tags, |
108 | - $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
108 | + $this->get_invoice_merge_tags($object->get_parent_payment()) |
|
109 | 109 | ); |
110 | 110 | } |
111 | 111 | |
@@ -119,52 +119,52 @@ discard block |
||
119 | 119 | * @param WPInv_Invoice $invoice |
120 | 120 | * @return array |
121 | 121 | */ |
122 | - public function get_invoice_merge_tags( $invoice ) { |
|
122 | + public function get_invoice_merge_tags($invoice) { |
|
123 | 123 | |
124 | 124 | // Abort if it does not exist. |
125 | - if ( ! $invoice->get_id() ) { |
|
125 | + if (!$invoice->get_id()) { |
|
126 | 126 | return array(); |
127 | 127 | } |
128 | 128 | |
129 | 129 | $due_date = $invoice->get_due_date(); |
130 | - $due_date = empty( $due_date ) ? time() + MINUTE_IN_SECONDS : strtotime( $due_date ) + ( (int) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ); |
|
130 | + $due_date = empty($due_date) ? time() + MINUTE_IN_SECONDS : strtotime($due_date) + ((int) get_option('gmt_offset') * HOUR_IN_SECONDS); |
|
131 | 131 | $merge_tags = array( |
132 | - '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
133 | - '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
134 | - '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
135 | - '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
136 | - '{email}' => sanitize_email( $invoice->get_email() ), |
|
137 | - '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
138 | - '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
139 | - '{invoice_total}' => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ), |
|
140 | - '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
141 | - '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
142 | - '{invoice_receipt_link}' => esc_url( $invoice->get_receipt_url() ), |
|
143 | - '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
144 | - '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
145 | - '{invoice_quote}' => sanitize_text_field( strtolower( $invoice->get_label() ) ), |
|
146 | - '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_label() ) ), |
|
147 | - '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
148 | - '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
149 | - '{is_was}' => $due_date < time() ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
132 | + '{name}' => sanitize_text_field($invoice->get_user_full_name()), |
|
133 | + '{full_name}' => sanitize_text_field($invoice->get_user_full_name()), |
|
134 | + '{first_name}' => sanitize_text_field($invoice->get_first_name()), |
|
135 | + '{last_name}' => sanitize_text_field($invoice->get_last_name()), |
|
136 | + '{email}' => sanitize_email($invoice->get_email()), |
|
137 | + '{invoice_number}' => sanitize_text_field($invoice->get_number()), |
|
138 | + '{invoice_currency}' => sanitize_text_field($invoice->get_currency()), |
|
139 | + '{invoice_total}' => sanitize_text_field(wpinv_price($invoice->get_total(), $invoice->get_currency())), |
|
140 | + '{invoice_link}' => esc_url($invoice->get_view_url()), |
|
141 | + '{invoice_pay_link}' => esc_url($invoice->get_checkout_payment_url()), |
|
142 | + '{invoice_receipt_link}' => esc_url($invoice->get_receipt_url()), |
|
143 | + '{invoice_date}' => getpaid_format_date_value($invoice->get_date_created()), |
|
144 | + '{invoice_due_date}' => getpaid_format_date_value($invoice->get_due_date(), __('on receipt', 'invoicing')), |
|
145 | + '{invoice_quote}' => sanitize_text_field(strtolower($invoice->get_label())), |
|
146 | + '{invoice_label}' => sanitize_text_field(ucfirst($invoice->get_label())), |
|
147 | + '{invoice_description}' => wp_kses_post($invoice->get_description()), |
|
148 | + '{subscription_name}' => wp_kses_post($invoice->get_subscription_name()), |
|
149 | + '{is_was}' => $due_date < time() ? __('was', 'invoicing') : __('is', 'invoicing'), |
|
150 | 150 | ); |
151 | 151 | |
152 | - $payment_form_data = $invoice->get_meta( 'payment_form_data', true ); |
|
152 | + $payment_form_data = $invoice->get_meta('payment_form_data', true); |
|
153 | 153 | |
154 | - if ( is_array( $payment_form_data ) ) { |
|
154 | + if (is_array($payment_form_data)) { |
|
155 | 155 | |
156 | - foreach ( $payment_form_data as $label => $value ) { |
|
156 | + foreach ($payment_form_data as $label => $value) { |
|
157 | 157 | |
158 | - $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) ); |
|
159 | - $value = is_array( $value ) ? implode( ', ', $value ) : $value; |
|
158 | + $label = preg_replace('/[^a-z0-9]+/', '_', strtolower($label)); |
|
159 | + $value = is_array($value) ? implode(', ', $value) : $value; |
|
160 | 160 | |
161 | - if ( is_scalar( $value ) ) { |
|
162 | - $merge_tags[ "{{$label}}" ] = wp_kses_post( $value ); |
|
161 | + if (is_scalar($value)) { |
|
162 | + $merge_tags["{{$label}}"] = wp_kses_post($value); |
|
163 | 163 | } |
164 | 164 | } |
165 | 165 | } |
166 | 166 | |
167 | - return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice ); |
|
167 | + return apply_filters('getpaid_invoice_email_merge_tags', $merge_tags, $invoice); |
|
168 | 168 | } |
169 | 169 | |
170 | 170 | /** |
@@ -176,12 +176,12 @@ discard block |
||
176 | 176 | * @param string|array $recipients |
177 | 177 | * @param array $extra_args Extra template args. |
178 | 178 | */ |
179 | - public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
179 | + public function send_email($invoice, $email, $type, $recipients, $extra_args = array()) { |
|
180 | 180 | |
181 | - do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
181 | + do_action('getpaid_before_send_invoice_notification', $type, $invoice, $email); |
|
182 | 182 | |
183 | - $skip = $invoice->is_free() && wpinv_get_option( 'skip_email_free_invoice' ); |
|
184 | - if ( apply_filters( 'getpaid_skip_invoice_email', $skip, $type, $invoice ) ) { |
|
183 | + $skip = $invoice->is_free() && wpinv_get_option('skip_email_free_invoice'); |
|
184 | + if (apply_filters('getpaid_skip_invoice_email', $skip, $type, $invoice)) { |
|
185 | 185 | return; |
186 | 186 | } |
187 | 187 | |
@@ -189,43 +189,43 @@ discard block |
||
189 | 189 | $merge_tags = $email->get_merge_tags(); |
190 | 190 | |
191 | 191 | $result = $mailer->send( |
192 | - apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
193 | - $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
194 | - $email->get_content( $merge_tags, $extra_args ), |
|
192 | + apply_filters('getpaid_invoice_email_recipients', wpinv_parse_list($recipients), $email), |
|
193 | + $email->add_merge_tags($email->get_subject(), $merge_tags), |
|
194 | + $email->get_content($merge_tags, $extra_args), |
|
195 | 195 | $email->get_attachments() |
196 | 196 | ); |
197 | 197 | |
198 | 198 | // Maybe send a copy to the admin. |
199 | - if ( $email->include_admin_bcc() ) { |
|
199 | + if ($email->include_admin_bcc()) { |
|
200 | 200 | $mailer->send( |
201 | 201 | wpinv_get_admin_email(), |
202 | - $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
203 | - $email->get_content( $merge_tags ), |
|
202 | + $email->add_merge_tags($email->get_subject() . __(' - ADMIN BCC COPY', 'invoicing'), $merge_tags), |
|
203 | + $email->get_content($merge_tags), |
|
204 | 204 | $email->get_attachments() |
205 | 205 | ); |
206 | 206 | } |
207 | 207 | |
208 | - if ( $result ) { |
|
208 | + if ($result) { |
|
209 | 209 | $invoice->add_system_note( |
210 | 210 | sprintf( |
211 | 211 | // translators: %1 is the email type, %2 is the invoice recipient. |
212 | - __( 'Successfully sent %1$s notification email to %2$s.', 'invoicing' ), |
|
213 | - sanitize_key( $type ), |
|
214 | - $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
212 | + __('Successfully sent %1$s notification email to %2$s.', 'invoicing'), |
|
213 | + sanitize_key($type), |
|
214 | + $email->is_admin_email() ? __('admin', 'invoicing') : __('the customer', 'invoicing') |
|
215 | 215 | ) |
216 | 216 | ); |
217 | 217 | } else { |
218 | 218 | $invoice->add_system_note( |
219 | 219 | sprintf( |
220 | 220 | // translators: %1 is the email type, %2 is the invoice recipient. |
221 | - __( 'Failed sending %1$s notification email to %2$s.', 'invoicing' ), |
|
222 | - sanitize_key( $type ), |
|
223 | - $email->is_admin_email() ? __( 'admin', 'invoicing' ) : __( 'the customer', 'invoicing' ) |
|
221 | + __('Failed sending %1$s notification email to %2$s.', 'invoicing'), |
|
222 | + sanitize_key($type), |
|
223 | + $email->is_admin_email() ? __('admin', 'invoicing') : __('the customer', 'invoicing') |
|
224 | 224 | ) |
225 | 225 | ); |
226 | 226 | } |
227 | 227 | |
228 | - do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
228 | + do_action('getpaid_after_send_invoice_notification', $type, $invoice, $email); |
|
229 | 229 | |
230 | 230 | return $result; |
231 | 231 | } |
@@ -236,20 +236,20 @@ discard block |
||
236 | 236 | * @param array $recipients |
237 | 237 | * @param GetPaid_Notification_Email $email |
238 | 238 | */ |
239 | - public function filter_email_recipients( $recipients, $email ) { |
|
239 | + public function filter_email_recipients($recipients, $email) { |
|
240 | 240 | |
241 | - if ( ! $email->is_admin_email() ) { |
|
241 | + if (!$email->is_admin_email()) { |
|
242 | 242 | $cc = $email->object->get_email_cc(); |
243 | - $cc_2 = get_user_meta( $email->object->get_user_id(), '_wpinv_email_cc', true ); |
|
243 | + $cc_2 = get_user_meta($email->object->get_user_id(), '_wpinv_email_cc', true); |
|
244 | 244 | |
245 | - if ( ! empty( $cc ) ) { |
|
246 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
247 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
245 | + if (!empty($cc)) { |
|
246 | + $cc = array_map('sanitize_email', wpinv_parse_list($cc)); |
|
247 | + $recipients = array_filter(array_unique(array_merge($recipients, $cc))); |
|
248 | 248 | } |
249 | 249 | |
250 | - if ( ! empty( $cc_2 ) ) { |
|
251 | - $cc_2 = array_map( 'sanitize_email', wpinv_parse_list( $cc_2 ) ); |
|
252 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc_2 ) ) ); |
|
250 | + if (!empty($cc_2)) { |
|
251 | + $cc_2 = array_map('sanitize_email', wpinv_parse_list($cc_2)); |
|
252 | + $recipients = array_filter(array_unique(array_merge($recipients, $cc_2))); |
|
253 | 253 | } |
254 | 254 | } |
255 | 255 | |
@@ -262,17 +262,17 @@ discard block |
||
262 | 262 | * |
263 | 263 | * @param WPInv_Invoice $invoice |
264 | 264 | */ |
265 | - public function new_invoice( $invoice ) { |
|
265 | + public function new_invoice($invoice) { |
|
266 | 266 | |
267 | 267 | // Only send this email for invoices created via the admin page. |
268 | - if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_paid() || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
268 | + if (!$invoice->is_type('invoice') || $invoice->is_paid() || $this->is_payment_form_invoice($invoice->get_id())) { |
|
269 | 269 | return; |
270 | 270 | } |
271 | 271 | |
272 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
272 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
273 | 273 | $recipient = wpinv_get_admin_email(); |
274 | 274 | |
275 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
275 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
276 | 276 | |
277 | 277 | } |
278 | 278 | |
@@ -281,12 +281,12 @@ discard block |
||
281 | 281 | * |
282 | 282 | * @param WPInv_Invoice $invoice |
283 | 283 | */ |
284 | - public function cancelled_invoice( $invoice ) { |
|
284 | + public function cancelled_invoice($invoice) { |
|
285 | 285 | |
286 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
286 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
287 | 287 | $recipient = $invoice->get_email(); |
288 | 288 | |
289 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
289 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
290 | 290 | } |
291 | 291 | |
292 | 292 | /** |
@@ -294,12 +294,12 @@ discard block |
||
294 | 294 | * |
295 | 295 | * @param WPInv_Invoice $invoice |
296 | 296 | */ |
297 | - public function failed_invoice( $invoice ) { |
|
297 | + public function failed_invoice($invoice) { |
|
298 | 298 | |
299 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
299 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
300 | 300 | $recipient = wpinv_get_admin_email(); |
301 | 301 | |
302 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
302 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
303 | 303 | |
304 | 304 | } |
305 | 305 | |
@@ -308,12 +308,12 @@ discard block |
||
308 | 308 | * |
309 | 309 | * @param WPInv_Invoice $invoice |
310 | 310 | */ |
311 | - public function onhold_invoice( $invoice ) { |
|
311 | + public function onhold_invoice($invoice) { |
|
312 | 312 | |
313 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
313 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
314 | 314 | $recipient = $invoice->get_email(); |
315 | 315 | |
316 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
316 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
317 | 317 | |
318 | 318 | } |
319 | 319 | |
@@ -322,12 +322,12 @@ discard block |
||
322 | 322 | * |
323 | 323 | * @param WPInv_Invoice $invoice |
324 | 324 | */ |
325 | - public function processing_invoice( $invoice ) { |
|
325 | + public function processing_invoice($invoice) { |
|
326 | 326 | |
327 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
327 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
328 | 328 | $recipient = $invoice->get_email(); |
329 | 329 | |
330 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
330 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
331 | 331 | |
332 | 332 | } |
333 | 333 | |
@@ -336,17 +336,17 @@ discard block |
||
336 | 336 | * |
337 | 337 | * @param WPInv_Invoice $invoice |
338 | 338 | */ |
339 | - public function completed_invoice( $invoice ) { |
|
339 | + public function completed_invoice($invoice) { |
|
340 | 340 | |
341 | 341 | // (Maybe) abort if it is a renewal invoice. |
342 | - if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
342 | + if ($invoice->is_renewal() && !wpinv_get_option('email_completed_invoice_renewal_active', false)) { |
|
343 | 343 | return; |
344 | 344 | } |
345 | 345 | |
346 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
346 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
347 | 347 | $recipient = $invoice->get_email(); |
348 | 348 | |
349 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
349 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
350 | 350 | |
351 | 351 | } |
352 | 352 | |
@@ -355,12 +355,12 @@ discard block |
||
355 | 355 | * |
356 | 356 | * @param WPInv_Invoice $invoice |
357 | 357 | */ |
358 | - public function refunded_invoice( $invoice ) { |
|
358 | + public function refunded_invoice($invoice) { |
|
359 | 359 | |
360 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
360 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
361 | 361 | $recipient = $invoice->get_email(); |
362 | 362 | |
363 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
363 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
364 | 364 | |
365 | 365 | } |
366 | 366 | |
@@ -370,21 +370,21 @@ discard block |
||
370 | 370 | * @param WPInv_Invoice $invoice |
371 | 371 | * @param bool $force |
372 | 372 | */ |
373 | - public function user_invoice( $invoice, $force = false ) { |
|
373 | + public function user_invoice($invoice, $force = false) { |
|
374 | 374 | |
375 | - if ( ! $force && ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
|
375 | + if (!$force && !empty($GLOBALS['wpinv_skip_invoice_notification'])) { |
|
376 | 376 | return; |
377 | 377 | } |
378 | 378 | |
379 | 379 | // Only send this email for invoices created via the admin page. |
380 | - if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $invoice->is_paid() ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
|
380 | + if (!$invoice->is_type('invoice') || (empty($force) && $invoice->is_paid()) || (empty($force) && $this->is_payment_form_invoice($invoice->get_id()))) { |
|
381 | 381 | return; |
382 | 382 | } |
383 | 383 | |
384 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
384 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
385 | 385 | $recipient = $invoice->get_email(); |
386 | 386 | |
387 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
387 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient); |
|
388 | 388 | |
389 | 389 | } |
390 | 390 | |
@@ -394,11 +394,11 @@ discard block |
||
394 | 394 | * @param int $invoice |
395 | 395 | * @return bool |
396 | 396 | */ |
397 | - public function is_payment_form_invoice( $invoice ) { |
|
398 | - $created_via = get_post_meta( $invoice, 'wpinv_created_via', true ); |
|
397 | + public function is_payment_form_invoice($invoice) { |
|
398 | + $created_via = get_post_meta($invoice, 'wpinv_created_via', true); |
|
399 | 399 | $is_payment_form_invoice = 'payment_form' === $created_via || 'geodirectory' === $created_via; |
400 | - $is_payment_form_invoice = apply_filters( 'getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice ); |
|
401 | - return empty( $_GET['getpaid-admin-action'] ) && $is_payment_form_invoice; |
|
400 | + $is_payment_form_invoice = apply_filters('getpaid_invoice_notifications_is_payment_form_invoice', $is_payment_form_invoice, $invoice); |
|
401 | + return empty($_GET['getpaid-admin-action']) && $is_payment_form_invoice; |
|
402 | 402 | } |
403 | 403 | |
404 | 404 | /** |
@@ -407,12 +407,12 @@ discard block |
||
407 | 407 | * @param WPInv_Invoice $invoice |
408 | 408 | * @param string $note |
409 | 409 | */ |
410 | - public function user_note( $invoice, $note ) { |
|
410 | + public function user_note($invoice, $note) { |
|
411 | 411 | |
412 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
412 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $invoice); |
|
413 | 413 | $recipient = $invoice->get_email(); |
414 | 414 | |
415 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
415 | + return $this->send_email($invoice, $email, __FUNCTION__, $recipient, array('customer_note' => $note)); |
|
416 | 416 | |
417 | 417 | } |
418 | 418 | |
@@ -421,9 +421,9 @@ discard block |
||
421 | 421 | * |
422 | 422 | * @param WPInv_Invoice $invoice |
423 | 423 | */ |
424 | - public function force_send_overdue_notice( $invoice ) { |
|
425 | - $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
426 | - return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
424 | + public function force_send_overdue_notice($invoice) { |
|
425 | + $email = new GetPaid_Notification_Email('overdue', $invoice); |
|
426 | + return $this->send_email($invoice, $email, 'overdue', $invoice->get_email()); |
|
427 | 427 | } |
428 | 428 | |
429 | 429 | /** |
@@ -434,38 +434,38 @@ discard block |
||
434 | 434 | public function overdue() { |
435 | 435 | global $wpdb; |
436 | 436 | |
437 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
437 | + $email = new GetPaid_Notification_Email(__FUNCTION__); |
|
438 | 438 | |
439 | 439 | // Fetch reminder days. |
440 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
440 | + $reminder_days = array_unique(wp_parse_id_list($email->get_option('days'))); |
|
441 | 441 | |
442 | 442 | // Abort if non is set. |
443 | - if ( empty( $reminder_days ) ) { |
|
443 | + if (empty($reminder_days)) { |
|
444 | 444 | return; |
445 | 445 | } |
446 | 446 | |
447 | 447 | // Retrieve date query. |
448 | - $date_query = $this->get_date_query( $reminder_days ); |
|
448 | + $date_query = $this->get_date_query($reminder_days); |
|
449 | 449 | |
450 | 450 | // Invoices table. |
451 | 451 | $table = $wpdb->prefix . 'getpaid_invoices'; |
452 | 452 | |
453 | 453 | // Fetch invoices. |
454 | - $invoices = $wpdb->get_col( |
|
454 | + $invoices = $wpdb->get_col( |
|
455 | 455 | "SELECT posts.ID FROM $wpdb->posts as posts |
456 | 456 | LEFT JOIN $table as invoices ON invoices.post_id = posts.ID |
457 | 457 | WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query" |
458 | 458 | ); |
459 | 459 | |
460 | - foreach ( $invoices as $invoice ) { |
|
460 | + foreach ($invoices as $invoice) { |
|
461 | 461 | |
462 | 462 | // Only send this email for invoices created via the admin page. |
463 | - if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
464 | - $invoice = new WPInv_Invoice( $invoice ); |
|
463 | + if (!$this->is_payment_form_invoice($invoice)) { |
|
464 | + $invoice = new WPInv_Invoice($invoice); |
|
465 | 465 | $email->object = $invoice; |
466 | 466 | |
467 | - if ( $invoice->needs_payment() && ! $invoice->is_renewal() ) { |
|
468 | - $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
467 | + if ($invoice->needs_payment() && !$invoice->is_renewal()) { |
|
468 | + $this->send_email($invoice, $email, __FUNCTION__, $invoice->get_email()); |
|
469 | 469 | } |
470 | 470 | } |
471 | 471 | } |
@@ -478,14 +478,14 @@ discard block |
||
478 | 478 | * @param array $reminder_days |
479 | 479 | * @return string |
480 | 480 | */ |
481 | - public function get_date_query( $reminder_days ) { |
|
481 | + public function get_date_query($reminder_days) { |
|
482 | 482 | |
483 | 483 | $date_query = array( |
484 | 484 | 'relation' => 'OR', |
485 | 485 | ); |
486 | 486 | |
487 | - foreach ( $reminder_days as $days ) { |
|
488 | - $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
487 | + foreach ($reminder_days as $days) { |
|
488 | + $date = date_parse(date('Y-m-d', strtotime("-$days days", current_time('timestamp')))); |
|
489 | 489 | |
490 | 490 | $date_query[] = array( |
491 | 491 | 'year' => $date['year'], |
@@ -495,7 +495,7 @@ discard block |
||
495 | 495 | |
496 | 496 | } |
497 | 497 | |
498 | - $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
498 | + $date_query = new WP_Date_Query($date_query, 'invoices.due_date'); |
|
499 | 499 | |
500 | 500 | return $date_query->get_sql(); |
501 | 501 |
@@ -4,7 +4,7 @@ discard block |
||
4 | 4 | * |
5 | 5 | */ |
6 | 6 | if ( ! defined( 'ABSPATH' ) ) { |
7 | - exit; |
|
7 | + exit; |
|
8 | 8 | } |
9 | 9 | |
10 | 10 | /** |
@@ -14,228 +14,228 @@ discard block |
||
14 | 14 | */ |
15 | 15 | class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP { |
16 | 16 | |
17 | - /** |
|
18 | - * Data stored in meta keys, but not considered "meta" for an item. |
|
19 | - * |
|
20 | - * @since 1.0.19 |
|
21 | - * @var array |
|
22 | - */ |
|
23 | - protected $internal_meta_keys = array( |
|
24 | - '_wpinv_price', |
|
25 | - '_wpinv_vat_rule', |
|
26 | - '_wpinv_vat_class', |
|
27 | - '_wpinv_type', |
|
28 | - '_wpinv_custom_id', |
|
29 | - '_wpinv_custom_name', |
|
30 | - '_wpinv_custom_singular_name', |
|
31 | - '_wpinv_editable', |
|
32 | - '_wpinv_dynamic_pricing', |
|
33 | - '_minimum_price', |
|
34 | - '_wpinv_is_recurring', |
|
35 | - '_wpinv_recurring_period', |
|
36 | - '_wpinv_recurring_interval', |
|
37 | - '_wpinv_recurring_limit', |
|
38 | - '_wpinv_free_trial', |
|
39 | - '_wpinv_trial_period', |
|
40 | - '_wpinv_trial_interval', |
|
41 | - ); |
|
42 | - |
|
43 | - /** |
|
44 | - * A map of meta keys to data props. |
|
45 | - * |
|
46 | - * @since 1.0.19 |
|
47 | - * |
|
48 | - * @var array |
|
49 | - */ |
|
50 | - protected $meta_key_to_props = array( |
|
51 | - '_wpinv_price' => 'price', |
|
52 | - '_wpinv_vat_rule' => 'vat_rule', |
|
53 | - '_wpinv_vat_class' => 'vat_class', |
|
54 | - '_wpinv_type' => 'type', |
|
55 | - '_wpinv_custom_id' => 'custom_id', |
|
56 | - '_wpinv_custom_name' => 'custom_name', |
|
57 | - '_wpinv_custom_singular_name' => 'custom_singular_name', |
|
58 | - '_wpinv_editable' => 'is_editable', |
|
59 | - '_wpinv_dynamic_pricing' => 'is_dynamic_pricing', |
|
60 | - '_minimum_price' => 'minimum_price', |
|
61 | - '_wpinv_custom_name' => 'custom_name', |
|
62 | - '_wpinv_is_recurring' => 'is_recurring', |
|
63 | - '_wpinv_recurring_period' => 'recurring_period', |
|
64 | - '_wpinv_recurring_interval' => 'recurring_interval', |
|
65 | - '_wpinv_recurring_limit' => 'recurring_limit', |
|
66 | - '_wpinv_free_trial' => 'is_free_trial', |
|
67 | - '_wpinv_trial_period' => 'trial_period', |
|
68 | - '_wpinv_trial_interval' => 'trial_interval', |
|
69 | - '_wpinv_version' => 'version', |
|
70 | - ); |
|
71 | - |
|
72 | - /* |
|
17 | + /** |
|
18 | + * Data stored in meta keys, but not considered "meta" for an item. |
|
19 | + * |
|
20 | + * @since 1.0.19 |
|
21 | + * @var array |
|
22 | + */ |
|
23 | + protected $internal_meta_keys = array( |
|
24 | + '_wpinv_price', |
|
25 | + '_wpinv_vat_rule', |
|
26 | + '_wpinv_vat_class', |
|
27 | + '_wpinv_type', |
|
28 | + '_wpinv_custom_id', |
|
29 | + '_wpinv_custom_name', |
|
30 | + '_wpinv_custom_singular_name', |
|
31 | + '_wpinv_editable', |
|
32 | + '_wpinv_dynamic_pricing', |
|
33 | + '_minimum_price', |
|
34 | + '_wpinv_is_recurring', |
|
35 | + '_wpinv_recurring_period', |
|
36 | + '_wpinv_recurring_interval', |
|
37 | + '_wpinv_recurring_limit', |
|
38 | + '_wpinv_free_trial', |
|
39 | + '_wpinv_trial_period', |
|
40 | + '_wpinv_trial_interval', |
|
41 | + ); |
|
42 | + |
|
43 | + /** |
|
44 | + * A map of meta keys to data props. |
|
45 | + * |
|
46 | + * @since 1.0.19 |
|
47 | + * |
|
48 | + * @var array |
|
49 | + */ |
|
50 | + protected $meta_key_to_props = array( |
|
51 | + '_wpinv_price' => 'price', |
|
52 | + '_wpinv_vat_rule' => 'vat_rule', |
|
53 | + '_wpinv_vat_class' => 'vat_class', |
|
54 | + '_wpinv_type' => 'type', |
|
55 | + '_wpinv_custom_id' => 'custom_id', |
|
56 | + '_wpinv_custom_name' => 'custom_name', |
|
57 | + '_wpinv_custom_singular_name' => 'custom_singular_name', |
|
58 | + '_wpinv_editable' => 'is_editable', |
|
59 | + '_wpinv_dynamic_pricing' => 'is_dynamic_pricing', |
|
60 | + '_minimum_price' => 'minimum_price', |
|
61 | + '_wpinv_custom_name' => 'custom_name', |
|
62 | + '_wpinv_is_recurring' => 'is_recurring', |
|
63 | + '_wpinv_recurring_period' => 'recurring_period', |
|
64 | + '_wpinv_recurring_interval' => 'recurring_interval', |
|
65 | + '_wpinv_recurring_limit' => 'recurring_limit', |
|
66 | + '_wpinv_free_trial' => 'is_free_trial', |
|
67 | + '_wpinv_trial_period' => 'trial_period', |
|
68 | + '_wpinv_trial_interval' => 'trial_interval', |
|
69 | + '_wpinv_version' => 'version', |
|
70 | + ); |
|
71 | + |
|
72 | + /* |
|
73 | 73 | |-------------------------------------------------------------------------- |
74 | 74 | | CRUD Methods |
75 | 75 | |-------------------------------------------------------------------------- |
76 | 76 | */ |
77 | 77 | |
78 | - /** |
|
79 | - * Method to create a new item in the database. |
|
80 | - * |
|
81 | - * @param WPInv_Item $item Item object. |
|
82 | - */ |
|
83 | - public function create( &$item ) { |
|
84 | - $item->set_version( WPINV_VERSION ); |
|
85 | - $item->set_date_created( current_time( 'mysql' ) ); |
|
86 | - |
|
87 | - // Create a new post. |
|
88 | - $id = wp_insert_post( |
|
89 | - apply_filters( |
|
90 | - 'getpaid_new_item_data', |
|
91 | - array( |
|
92 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
93 | - 'post_type' => 'wpi_item', |
|
94 | - 'post_status' => $this->get_post_status( $item ), |
|
95 | - 'ping_status' => 'closed', |
|
96 | - 'post_author' => $item->get_author( 'edit' ), |
|
97 | - 'post_title' => $item->get_name( 'edit' ), |
|
98 | - 'post_parent' => $item->get_parent_id(), |
|
99 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
100 | - ) |
|
101 | - ), |
|
102 | - true |
|
103 | - ); |
|
104 | - |
|
105 | - if ( $id && ! is_wp_error( $id ) ) { |
|
106 | - $item->set_id( $id ); |
|
107 | - $this->update_post_meta( $item ); |
|
108 | - $item->save_meta_data(); |
|
109 | - $item->apply_changes(); |
|
110 | - $this->clear_caches( $item ); |
|
111 | - do_action( 'getpaid_new_item', $item ); |
|
112 | - return true; |
|
113 | - } |
|
114 | - |
|
115 | - if ( is_wp_error( $id ) ) { |
|
116 | - $item->last_error = $id->get_error_message(); |
|
117 | - } |
|
118 | - |
|
119 | - return false; |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * Method to read an item from the database. |
|
124 | - * |
|
125 | - * @param WPInv_Item $item Item object. |
|
126 | - * |
|
127 | - */ |
|
128 | - public function read( &$item ) { |
|
129 | - |
|
130 | - $item->set_defaults(); |
|
131 | - $item_object = get_post( $item->get_id() ); |
|
132 | - |
|
133 | - if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) { |
|
134 | - $item->last_error = __( 'Invalid item.', 'invoicing' ); |
|
135 | - $item->set_id( 0 ); |
|
136 | - return false; |
|
137 | - } |
|
138 | - |
|
139 | - $item->set_props( |
|
140 | - array( |
|
141 | - 'parent_id' => $item_object->post_parent, |
|
142 | - 'date_created' => 0 < $item_object->post_date ? $item_object->post_date : null, |
|
143 | - 'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null, |
|
144 | - 'status' => $item_object->post_status, |
|
145 | - 'name' => $item_object->post_title, |
|
146 | - 'description' => $item_object->post_excerpt, |
|
147 | - 'author' => $item_object->post_author, |
|
148 | - ) |
|
149 | - ); |
|
150 | - |
|
151 | - $this->read_object_data( $item, $item_object ); |
|
152 | - $item->read_meta_data(); |
|
153 | - $item->set_object_read( true ); |
|
154 | - do_action( 'getpaid_read_item', $item ); |
|
155 | - |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * Method to update an item in the database. |
|
160 | - * |
|
161 | - * @param WPInv_Item $item Item object. |
|
162 | - */ |
|
163 | - public function update( &$item ) { |
|
164 | - $item->save_meta_data(); |
|
165 | - $item->set_version( WPINV_VERSION ); |
|
166 | - |
|
167 | - if ( null === $item->get_date_created( 'edit' ) ) { |
|
168 | - $item->set_date_created( current_time( 'mysql' ) ); |
|
169 | - } |
|
170 | - |
|
171 | - // Grab the current status so we can compare. |
|
172 | - $previous_status = get_post_status( $item->get_id() ); |
|
173 | - |
|
174 | - $changes = $item->get_changes(); |
|
175 | - |
|
176 | - // Only update the post when the post data changes. |
|
177 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
178 | - $post_data = array( |
|
179 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
180 | - 'post_status' => $item->get_status( 'edit' ), |
|
181 | - 'post_parent' => $item->get_parent_id( 'edit' ), |
|
182 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
183 | - 'post_modified' => $item->get_date_modified( 'edit' ), |
|
184 | - 'post_title' => $item->get_name( 'edit' ), |
|
185 | - 'post_author' => $item->get_author( 'edit' ), |
|
186 | - ); |
|
187 | - |
|
188 | - /** |
|
189 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
190 | - * to update data, since wp_update_post spawns more calls to the |
|
191 | - * save_post action. |
|
192 | - * |
|
193 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
194 | - * or an update purely from CRUD. |
|
195 | - */ |
|
196 | - if ( doing_action( 'save_post' ) ) { |
|
197 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) ); |
|
198 | - clean_post_cache( $item->get_id() ); |
|
199 | - } else { |
|
200 | - wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) ); |
|
201 | - } |
|
202 | - $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
203 | - } |
|
204 | - $this->update_post_meta( $item ); |
|
205 | - $item->apply_changes(); |
|
206 | - $this->clear_caches( $item ); |
|
207 | - |
|
208 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
209 | - $new_status = $item->get_status( 'edit' ); |
|
210 | - |
|
211 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
212 | - do_action( 'getpaid_new_item', $item ); |
|
213 | - } else { |
|
214 | - do_action( 'getpaid_update_item', $item ); |
|
215 | - } |
|
216 | - |
|
217 | - } |
|
218 | - |
|
219 | - /* |
|
78 | + /** |
|
79 | + * Method to create a new item in the database. |
|
80 | + * |
|
81 | + * @param WPInv_Item $item Item object. |
|
82 | + */ |
|
83 | + public function create( &$item ) { |
|
84 | + $item->set_version( WPINV_VERSION ); |
|
85 | + $item->set_date_created( current_time( 'mysql' ) ); |
|
86 | + |
|
87 | + // Create a new post. |
|
88 | + $id = wp_insert_post( |
|
89 | + apply_filters( |
|
90 | + 'getpaid_new_item_data', |
|
91 | + array( |
|
92 | + 'post_date' => $item->get_date_created( 'edit' ), |
|
93 | + 'post_type' => 'wpi_item', |
|
94 | + 'post_status' => $this->get_post_status( $item ), |
|
95 | + 'ping_status' => 'closed', |
|
96 | + 'post_author' => $item->get_author( 'edit' ), |
|
97 | + 'post_title' => $item->get_name( 'edit' ), |
|
98 | + 'post_parent' => $item->get_parent_id(), |
|
99 | + 'post_excerpt' => $item->get_description( 'edit' ), |
|
100 | + ) |
|
101 | + ), |
|
102 | + true |
|
103 | + ); |
|
104 | + |
|
105 | + if ( $id && ! is_wp_error( $id ) ) { |
|
106 | + $item->set_id( $id ); |
|
107 | + $this->update_post_meta( $item ); |
|
108 | + $item->save_meta_data(); |
|
109 | + $item->apply_changes(); |
|
110 | + $this->clear_caches( $item ); |
|
111 | + do_action( 'getpaid_new_item', $item ); |
|
112 | + return true; |
|
113 | + } |
|
114 | + |
|
115 | + if ( is_wp_error( $id ) ) { |
|
116 | + $item->last_error = $id->get_error_message(); |
|
117 | + } |
|
118 | + |
|
119 | + return false; |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * Method to read an item from the database. |
|
124 | + * |
|
125 | + * @param WPInv_Item $item Item object. |
|
126 | + * |
|
127 | + */ |
|
128 | + public function read( &$item ) { |
|
129 | + |
|
130 | + $item->set_defaults(); |
|
131 | + $item_object = get_post( $item->get_id() ); |
|
132 | + |
|
133 | + if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) { |
|
134 | + $item->last_error = __( 'Invalid item.', 'invoicing' ); |
|
135 | + $item->set_id( 0 ); |
|
136 | + return false; |
|
137 | + } |
|
138 | + |
|
139 | + $item->set_props( |
|
140 | + array( |
|
141 | + 'parent_id' => $item_object->post_parent, |
|
142 | + 'date_created' => 0 < $item_object->post_date ? $item_object->post_date : null, |
|
143 | + 'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null, |
|
144 | + 'status' => $item_object->post_status, |
|
145 | + 'name' => $item_object->post_title, |
|
146 | + 'description' => $item_object->post_excerpt, |
|
147 | + 'author' => $item_object->post_author, |
|
148 | + ) |
|
149 | + ); |
|
150 | + |
|
151 | + $this->read_object_data( $item, $item_object ); |
|
152 | + $item->read_meta_data(); |
|
153 | + $item->set_object_read( true ); |
|
154 | + do_action( 'getpaid_read_item', $item ); |
|
155 | + |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * Method to update an item in the database. |
|
160 | + * |
|
161 | + * @param WPInv_Item $item Item object. |
|
162 | + */ |
|
163 | + public function update( &$item ) { |
|
164 | + $item->save_meta_data(); |
|
165 | + $item->set_version( WPINV_VERSION ); |
|
166 | + |
|
167 | + if ( null === $item->get_date_created( 'edit' ) ) { |
|
168 | + $item->set_date_created( current_time( 'mysql' ) ); |
|
169 | + } |
|
170 | + |
|
171 | + // Grab the current status so we can compare. |
|
172 | + $previous_status = get_post_status( $item->get_id() ); |
|
173 | + |
|
174 | + $changes = $item->get_changes(); |
|
175 | + |
|
176 | + // Only update the post when the post data changes. |
|
177 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
178 | + $post_data = array( |
|
179 | + 'post_date' => $item->get_date_created( 'edit' ), |
|
180 | + 'post_status' => $item->get_status( 'edit' ), |
|
181 | + 'post_parent' => $item->get_parent_id( 'edit' ), |
|
182 | + 'post_excerpt' => $item->get_description( 'edit' ), |
|
183 | + 'post_modified' => $item->get_date_modified( 'edit' ), |
|
184 | + 'post_title' => $item->get_name( 'edit' ), |
|
185 | + 'post_author' => $item->get_author( 'edit' ), |
|
186 | + ); |
|
187 | + |
|
188 | + /** |
|
189 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
190 | + * to update data, since wp_update_post spawns more calls to the |
|
191 | + * save_post action. |
|
192 | + * |
|
193 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
194 | + * or an update purely from CRUD. |
|
195 | + */ |
|
196 | + if ( doing_action( 'save_post' ) ) { |
|
197 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) ); |
|
198 | + clean_post_cache( $item->get_id() ); |
|
199 | + } else { |
|
200 | + wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) ); |
|
201 | + } |
|
202 | + $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
203 | + } |
|
204 | + $this->update_post_meta( $item ); |
|
205 | + $item->apply_changes(); |
|
206 | + $this->clear_caches( $item ); |
|
207 | + |
|
208 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
209 | + $new_status = $item->get_status( 'edit' ); |
|
210 | + |
|
211 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
212 | + do_action( 'getpaid_new_item', $item ); |
|
213 | + } else { |
|
214 | + do_action( 'getpaid_update_item', $item ); |
|
215 | + } |
|
216 | + |
|
217 | + } |
|
218 | + |
|
219 | + /* |
|
220 | 220 | |-------------------------------------------------------------------------- |
221 | 221 | | Additional Methods |
222 | 222 | |-------------------------------------------------------------------------- |
223 | 223 | */ |
224 | 224 | |
225 | - /** |
|
226 | - * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class. |
|
227 | - * |
|
228 | - * @param WPInv_Item $item WPInv_Item object. |
|
229 | - * @since 1.0.19 |
|
230 | - */ |
|
231 | - protected function update_post_meta( &$item ) { |
|
225 | + /** |
|
226 | + * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class. |
|
227 | + * |
|
228 | + * @param WPInv_Item $item WPInv_Item object. |
|
229 | + * @since 1.0.19 |
|
230 | + */ |
|
231 | + protected function update_post_meta( &$item ) { |
|
232 | 232 | |
233 | - // Ensure that we have a custom id. |
|
233 | + // Ensure that we have a custom id. |
|
234 | 234 | if ( ! $item->get_custom_id() ) { |
235 | 235 | $item->set_custom_id( $item->get_id() ); |
236 | - } |
|
236 | + } |
|
237 | 237 | |
238 | - parent::update_post_meta( $item ); |
|
239 | - } |
|
238 | + parent::update_post_meta( $item ); |
|
239 | + } |
|
240 | 240 | |
241 | 241 | } |
@@ -3,7 +3,7 @@ discard block |
||
3 | 3 | * GetPaid_Item_Data_Store class file. |
4 | 4 | * |
5 | 5 | */ |
6 | -if ( ! defined( 'ABSPATH' ) ) { |
|
6 | +if (!defined('ABSPATH')) { |
|
7 | 7 | exit; |
8 | 8 | } |
9 | 9 | |
@@ -80,39 +80,39 @@ discard block |
||
80 | 80 | * |
81 | 81 | * @param WPInv_Item $item Item object. |
82 | 82 | */ |
83 | - public function create( &$item ) { |
|
84 | - $item->set_version( WPINV_VERSION ); |
|
85 | - $item->set_date_created( current_time( 'mysql' ) ); |
|
83 | + public function create(&$item) { |
|
84 | + $item->set_version(WPINV_VERSION); |
|
85 | + $item->set_date_created(current_time('mysql')); |
|
86 | 86 | |
87 | 87 | // Create a new post. |
88 | 88 | $id = wp_insert_post( |
89 | 89 | apply_filters( |
90 | 90 | 'getpaid_new_item_data', |
91 | 91 | array( |
92 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
92 | + 'post_date' => $item->get_date_created('edit'), |
|
93 | 93 | 'post_type' => 'wpi_item', |
94 | - 'post_status' => $this->get_post_status( $item ), |
|
94 | + 'post_status' => $this->get_post_status($item), |
|
95 | 95 | 'ping_status' => 'closed', |
96 | - 'post_author' => $item->get_author( 'edit' ), |
|
97 | - 'post_title' => $item->get_name( 'edit' ), |
|
96 | + 'post_author' => $item->get_author('edit'), |
|
97 | + 'post_title' => $item->get_name('edit'), |
|
98 | 98 | 'post_parent' => $item->get_parent_id(), |
99 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
99 | + 'post_excerpt' => $item->get_description('edit'), |
|
100 | 100 | ) |
101 | 101 | ), |
102 | 102 | true |
103 | 103 | ); |
104 | 104 | |
105 | - if ( $id && ! is_wp_error( $id ) ) { |
|
106 | - $item->set_id( $id ); |
|
107 | - $this->update_post_meta( $item ); |
|
105 | + if ($id && !is_wp_error($id)) { |
|
106 | + $item->set_id($id); |
|
107 | + $this->update_post_meta($item); |
|
108 | 108 | $item->save_meta_data(); |
109 | 109 | $item->apply_changes(); |
110 | - $this->clear_caches( $item ); |
|
111 | - do_action( 'getpaid_new_item', $item ); |
|
110 | + $this->clear_caches($item); |
|
111 | + do_action('getpaid_new_item', $item); |
|
112 | 112 | return true; |
113 | 113 | } |
114 | 114 | |
115 | - if ( is_wp_error( $id ) ) { |
|
115 | + if (is_wp_error($id)) { |
|
116 | 116 | $item->last_error = $id->get_error_message(); |
117 | 117 | } |
118 | 118 | |
@@ -125,14 +125,14 @@ discard block |
||
125 | 125 | * @param WPInv_Item $item Item object. |
126 | 126 | * |
127 | 127 | */ |
128 | - public function read( &$item ) { |
|
128 | + public function read(&$item) { |
|
129 | 129 | |
130 | 130 | $item->set_defaults(); |
131 | - $item_object = get_post( $item->get_id() ); |
|
131 | + $item_object = get_post($item->get_id()); |
|
132 | 132 | |
133 | - if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) { |
|
134 | - $item->last_error = __( 'Invalid item.', 'invoicing' ); |
|
135 | - $item->set_id( 0 ); |
|
133 | + if (!$item->get_id() || !$item_object || $item_object->post_type != 'wpi_item') { |
|
134 | + $item->last_error = __('Invalid item.', 'invoicing'); |
|
135 | + $item->set_id(0); |
|
136 | 136 | return false; |
137 | 137 | } |
138 | 138 | |
@@ -148,10 +148,10 @@ discard block |
||
148 | 148 | ) |
149 | 149 | ); |
150 | 150 | |
151 | - $this->read_object_data( $item, $item_object ); |
|
151 | + $this->read_object_data($item, $item_object); |
|
152 | 152 | $item->read_meta_data(); |
153 | - $item->set_object_read( true ); |
|
154 | - do_action( 'getpaid_read_item', $item ); |
|
153 | + $item->set_object_read(true); |
|
154 | + do_action('getpaid_read_item', $item); |
|
155 | 155 | |
156 | 156 | } |
157 | 157 | |
@@ -160,29 +160,29 @@ discard block |
||
160 | 160 | * |
161 | 161 | * @param WPInv_Item $item Item object. |
162 | 162 | */ |
163 | - public function update( &$item ) { |
|
163 | + public function update(&$item) { |
|
164 | 164 | $item->save_meta_data(); |
165 | - $item->set_version( WPINV_VERSION ); |
|
165 | + $item->set_version(WPINV_VERSION); |
|
166 | 166 | |
167 | - if ( null === $item->get_date_created( 'edit' ) ) { |
|
168 | - $item->set_date_created( current_time( 'mysql' ) ); |
|
167 | + if (null === $item->get_date_created('edit')) { |
|
168 | + $item->set_date_created(current_time('mysql')); |
|
169 | 169 | } |
170 | 170 | |
171 | 171 | // Grab the current status so we can compare. |
172 | - $previous_status = get_post_status( $item->get_id() ); |
|
172 | + $previous_status = get_post_status($item->get_id()); |
|
173 | 173 | |
174 | 174 | $changes = $item->get_changes(); |
175 | 175 | |
176 | 176 | // Only update the post when the post data changes. |
177 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
177 | + if (array_intersect(array('date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author'), array_keys($changes))) { |
|
178 | 178 | $post_data = array( |
179 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
180 | - 'post_status' => $item->get_status( 'edit' ), |
|
181 | - 'post_parent' => $item->get_parent_id( 'edit' ), |
|
182 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
183 | - 'post_modified' => $item->get_date_modified( 'edit' ), |
|
184 | - 'post_title' => $item->get_name( 'edit' ), |
|
185 | - 'post_author' => $item->get_author( 'edit' ), |
|
179 | + 'post_date' => $item->get_date_created('edit'), |
|
180 | + 'post_status' => $item->get_status('edit'), |
|
181 | + 'post_parent' => $item->get_parent_id('edit'), |
|
182 | + 'post_excerpt' => $item->get_description('edit'), |
|
183 | + 'post_modified' => $item->get_date_modified('edit'), |
|
184 | + 'post_title' => $item->get_name('edit'), |
|
185 | + 'post_author' => $item->get_author('edit'), |
|
186 | 186 | ); |
187 | 187 | |
188 | 188 | /** |
@@ -193,25 +193,25 @@ discard block |
||
193 | 193 | * This ensures hooks are fired by either WP itself (admin screen save), |
194 | 194 | * or an update purely from CRUD. |
195 | 195 | */ |
196 | - if ( doing_action( 'save_post' ) ) { |
|
197 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) ); |
|
198 | - clean_post_cache( $item->get_id() ); |
|
196 | + if (doing_action('save_post')) { |
|
197 | + $GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $item->get_id())); |
|
198 | + clean_post_cache($item->get_id()); |
|
199 | 199 | } else { |
200 | - wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) ); |
|
200 | + wp_update_post(array_merge(array('ID' => $item->get_id()), $post_data)); |
|
201 | 201 | } |
202 | - $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
202 | + $item->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
203 | 203 | } |
204 | - $this->update_post_meta( $item ); |
|
204 | + $this->update_post_meta($item); |
|
205 | 205 | $item->apply_changes(); |
206 | - $this->clear_caches( $item ); |
|
206 | + $this->clear_caches($item); |
|
207 | 207 | |
208 | 208 | // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
209 | - $new_status = $item->get_status( 'edit' ); |
|
209 | + $new_status = $item->get_status('edit'); |
|
210 | 210 | |
211 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
212 | - do_action( 'getpaid_new_item', $item ); |
|
211 | + if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) { |
|
212 | + do_action('getpaid_new_item', $item); |
|
213 | 213 | } else { |
214 | - do_action( 'getpaid_update_item', $item ); |
|
214 | + do_action('getpaid_update_item', $item); |
|
215 | 215 | } |
216 | 216 | |
217 | 217 | } |
@@ -228,14 +228,14 @@ discard block |
||
228 | 228 | * @param WPInv_Item $item WPInv_Item object. |
229 | 229 | * @since 1.0.19 |
230 | 230 | */ |
231 | - protected function update_post_meta( &$item ) { |
|
231 | + protected function update_post_meta(&$item) { |
|
232 | 232 | |
233 | 233 | // Ensure that we have a custom id. |
234 | - if ( ! $item->get_custom_id() ) { |
|
235 | - $item->set_custom_id( $item->get_id() ); |
|
234 | + if (!$item->get_custom_id()) { |
|
235 | + $item->set_custom_id($item->get_id()); |
|
236 | 236 | } |
237 | 237 | |
238 | - parent::update_post_meta( $item ); |
|
238 | + parent::update_post_meta($item); |
|
239 | 239 | } |
240 | 240 | |
241 | 241 | } |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
3 | - exit; |
|
3 | + exit; |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | /** |
@@ -10,199 +10,199 @@ discard block |
||
10 | 10 | class GetPaid_Payment_Form_Submission { |
11 | 11 | |
12 | 12 | /** |
13 | - * Submission ID |
|
14 | - * |
|
15 | - * @var string |
|
16 | - */ |
|
17 | - public $id = null; |
|
18 | - |
|
19 | - /** |
|
20 | - * The raw submission data. |
|
21 | - * |
|
22 | - * @var array |
|
23 | - */ |
|
24 | - protected $data = null; |
|
25 | - |
|
26 | - /** |
|
27 | - * Submission totals |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - protected $totals = array( |
|
32 | - |
|
33 | - 'subtotal' => array( |
|
34 | - 'initial' => 0, |
|
35 | - 'recurring' => 0, |
|
36 | - ), |
|
37 | - |
|
38 | - 'discount' => array( |
|
39 | - 'initial' => 0, |
|
40 | - 'recurring' => 0, |
|
41 | - ), |
|
42 | - |
|
43 | - 'fees' => array( |
|
44 | - 'initial' => 0, |
|
45 | - 'recurring' => 0, |
|
46 | - ), |
|
47 | - |
|
48 | - 'taxes' => array( |
|
49 | - 'initial' => 0, |
|
50 | - 'recurring' => 0, |
|
51 | - ), |
|
52 | - |
|
53 | - 'shipping' => array( |
|
54 | - 'initial' => 0, |
|
55 | - 'recurring' => 0, |
|
56 | - ), |
|
57 | - |
|
58 | - ); |
|
59 | - |
|
60 | - /** |
|
61 | - * Sets the associated payment form. |
|
62 | - * |
|
63 | - * @var GetPaid_Payment_Form |
|
64 | - */ |
|
13 | + * Submission ID |
|
14 | + * |
|
15 | + * @var string |
|
16 | + */ |
|
17 | + public $id = null; |
|
18 | + |
|
19 | + /** |
|
20 | + * The raw submission data. |
|
21 | + * |
|
22 | + * @var array |
|
23 | + */ |
|
24 | + protected $data = null; |
|
25 | + |
|
26 | + /** |
|
27 | + * Submission totals |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + protected $totals = array( |
|
32 | + |
|
33 | + 'subtotal' => array( |
|
34 | + 'initial' => 0, |
|
35 | + 'recurring' => 0, |
|
36 | + ), |
|
37 | + |
|
38 | + 'discount' => array( |
|
39 | + 'initial' => 0, |
|
40 | + 'recurring' => 0, |
|
41 | + ), |
|
42 | + |
|
43 | + 'fees' => array( |
|
44 | + 'initial' => 0, |
|
45 | + 'recurring' => 0, |
|
46 | + ), |
|
47 | + |
|
48 | + 'taxes' => array( |
|
49 | + 'initial' => 0, |
|
50 | + 'recurring' => 0, |
|
51 | + ), |
|
52 | + |
|
53 | + 'shipping' => array( |
|
54 | + 'initial' => 0, |
|
55 | + 'recurring' => 0, |
|
56 | + ), |
|
57 | + |
|
58 | + ); |
|
59 | + |
|
60 | + /** |
|
61 | + * Sets the associated payment form. |
|
62 | + * |
|
63 | + * @var GetPaid_Payment_Form |
|
64 | + */ |
|
65 | 65 | protected $payment_form = null; |
66 | 66 | |
67 | 67 | /** |
68 | - * The country for the submission. |
|
69 | - * |
|
70 | - * @var string |
|
71 | - */ |
|
72 | - public $country = null; |
|
73 | - |
|
74 | - /** |
|
75 | - * The state for the submission. |
|
76 | - * |
|
77 | - * @since 1.0.19 |
|
78 | - * @var string |
|
79 | - */ |
|
80 | - public $state = null; |
|
81 | - |
|
82 | - /** |
|
83 | - * The invoice associated with the submission. |
|
84 | - * |
|
85 | - * @var WPInv_Invoice |
|
86 | - */ |
|
87 | - protected $invoice = null; |
|
88 | - |
|
89 | - /** |
|
90 | - * The recurring item for the submission. |
|
91 | - * |
|
92 | - * @var int |
|
93 | - */ |
|
94 | - public $has_recurring = 0; |
|
95 | - |
|
96 | - /** |
|
97 | - * An array of fees for the submission. |
|
98 | - * |
|
99 | - * @var array |
|
100 | - */ |
|
101 | - protected $fees = array(); |
|
102 | - |
|
103 | - /** |
|
104 | - * An array of discounts for the submission. |
|
105 | - * |
|
106 | - * @var array |
|
107 | - */ |
|
108 | - protected $discounts = array(); |
|
109 | - |
|
110 | - /** |
|
111 | - * An array of taxes for the submission. |
|
112 | - * |
|
113 | - * @var array |
|
114 | - */ |
|
115 | - protected $taxes = array(); |
|
116 | - |
|
117 | - /** |
|
118 | - * An array of items for the submission. |
|
119 | - * |
|
120 | - * @var GetPaid_Form_Item[] |
|
121 | - */ |
|
122 | - protected $items = array(); |
|
123 | - |
|
124 | - /** |
|
125 | - * The last error. |
|
126 | - * |
|
127 | - * @var string |
|
128 | - */ |
|
129 | - public $last_error = null; |
|
130 | - |
|
131 | - /** |
|
132 | - * The last error code. |
|
133 | - * |
|
134 | - * @var string |
|
135 | - */ |
|
136 | - public $last_error_code = null; |
|
137 | - |
|
138 | - /** |
|
139 | - * Class constructor. |
|
140 | - * |
|
141 | - */ |
|
142 | - public function __construct() { |
|
143 | - |
|
144 | - // Set the state and country to the default state and country. |
|
145 | - $this->country = wpinv_default_billing_country(); |
|
146 | - $this->state = wpinv_get_default_state(); |
|
147 | - |
|
148 | - // Do we have an actual submission? |
|
149 | - if ( isset( $_POST['getpaid_payment_form_submission'] ) ) { |
|
150 | - $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) ); |
|
151 | - } |
|
152 | - |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * Loads submission data. |
|
157 | - * |
|
158 | - * @param array $data |
|
159 | - */ |
|
160 | - public function load_data( $data ) { |
|
161 | - |
|
162 | - // Allow plugins to filter the data. |
|
163 | - $data = apply_filters( 'getpaid_submission_data', $data, $this ); |
|
164 | - |
|
165 | - // Cache it... |
|
166 | - $this->data = $data; |
|
167 | - |
|
168 | - // Then generate a unique id from the data. |
|
169 | - $this->id = md5( wp_json_encode( $data ) ); |
|
170 | - |
|
171 | - // Finally, process the submission. |
|
172 | - try { |
|
173 | - |
|
174 | - // Each process is passed an instance of the class (with reference) |
|
175 | - // and should throw an Exception whenever it encounters one. |
|
176 | - $processors = apply_filters( |
|
177 | - 'getpaid_payment_form_submission_processors', |
|
178 | - array( |
|
179 | - array( $this, 'process_payment_form' ), |
|
180 | - array( $this, 'process_invoice' ), |
|
181 | - array( $this, 'process_fees' ), |
|
182 | - array( $this, 'process_items' ), |
|
183 | - array( $this, 'process_discount' ), |
|
184 | - array( $this, 'process_taxes' ), |
|
185 | - ), |
|
186 | - $this |
|
187 | - ); |
|
188 | - |
|
189 | - foreach ( $processors as $processor ) { |
|
190 | - call_user_func_array( $processor, array( &$this ) ); |
|
191 | - } |
|
192 | - } catch ( GetPaid_Payment_Exception $e ) { |
|
193 | - $this->last_error = $e->getMessage(); |
|
194 | - $this->last_error_code = $e->getErrorCode(); |
|
195 | - } catch ( Exception $e ) { |
|
196 | - $this->last_error = $e->getMessage(); |
|
197 | - $this->last_error_code = $e->getCode(); |
|
198 | - } |
|
199 | - |
|
200 | - // Fired when we are done processing a submission. |
|
201 | - do_action_ref_array( 'getpaid_process_submission', array( &$this ) ); |
|
202 | - |
|
203 | - } |
|
204 | - |
|
205 | - /* |
|
68 | + * The country for the submission. |
|
69 | + * |
|
70 | + * @var string |
|
71 | + */ |
|
72 | + public $country = null; |
|
73 | + |
|
74 | + /** |
|
75 | + * The state for the submission. |
|
76 | + * |
|
77 | + * @since 1.0.19 |
|
78 | + * @var string |
|
79 | + */ |
|
80 | + public $state = null; |
|
81 | + |
|
82 | + /** |
|
83 | + * The invoice associated with the submission. |
|
84 | + * |
|
85 | + * @var WPInv_Invoice |
|
86 | + */ |
|
87 | + protected $invoice = null; |
|
88 | + |
|
89 | + /** |
|
90 | + * The recurring item for the submission. |
|
91 | + * |
|
92 | + * @var int |
|
93 | + */ |
|
94 | + public $has_recurring = 0; |
|
95 | + |
|
96 | + /** |
|
97 | + * An array of fees for the submission. |
|
98 | + * |
|
99 | + * @var array |
|
100 | + */ |
|
101 | + protected $fees = array(); |
|
102 | + |
|
103 | + /** |
|
104 | + * An array of discounts for the submission. |
|
105 | + * |
|
106 | + * @var array |
|
107 | + */ |
|
108 | + protected $discounts = array(); |
|
109 | + |
|
110 | + /** |
|
111 | + * An array of taxes for the submission. |
|
112 | + * |
|
113 | + * @var array |
|
114 | + */ |
|
115 | + protected $taxes = array(); |
|
116 | + |
|
117 | + /** |
|
118 | + * An array of items for the submission. |
|
119 | + * |
|
120 | + * @var GetPaid_Form_Item[] |
|
121 | + */ |
|
122 | + protected $items = array(); |
|
123 | + |
|
124 | + /** |
|
125 | + * The last error. |
|
126 | + * |
|
127 | + * @var string |
|
128 | + */ |
|
129 | + public $last_error = null; |
|
130 | + |
|
131 | + /** |
|
132 | + * The last error code. |
|
133 | + * |
|
134 | + * @var string |
|
135 | + */ |
|
136 | + public $last_error_code = null; |
|
137 | + |
|
138 | + /** |
|
139 | + * Class constructor. |
|
140 | + * |
|
141 | + */ |
|
142 | + public function __construct() { |
|
143 | + |
|
144 | + // Set the state and country to the default state and country. |
|
145 | + $this->country = wpinv_default_billing_country(); |
|
146 | + $this->state = wpinv_get_default_state(); |
|
147 | + |
|
148 | + // Do we have an actual submission? |
|
149 | + if ( isset( $_POST['getpaid_payment_form_submission'] ) ) { |
|
150 | + $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) ); |
|
151 | + } |
|
152 | + |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * Loads submission data. |
|
157 | + * |
|
158 | + * @param array $data |
|
159 | + */ |
|
160 | + public function load_data( $data ) { |
|
161 | + |
|
162 | + // Allow plugins to filter the data. |
|
163 | + $data = apply_filters( 'getpaid_submission_data', $data, $this ); |
|
164 | + |
|
165 | + // Cache it... |
|
166 | + $this->data = $data; |
|
167 | + |
|
168 | + // Then generate a unique id from the data. |
|
169 | + $this->id = md5( wp_json_encode( $data ) ); |
|
170 | + |
|
171 | + // Finally, process the submission. |
|
172 | + try { |
|
173 | + |
|
174 | + // Each process is passed an instance of the class (with reference) |
|
175 | + // and should throw an Exception whenever it encounters one. |
|
176 | + $processors = apply_filters( |
|
177 | + 'getpaid_payment_form_submission_processors', |
|
178 | + array( |
|
179 | + array( $this, 'process_payment_form' ), |
|
180 | + array( $this, 'process_invoice' ), |
|
181 | + array( $this, 'process_fees' ), |
|
182 | + array( $this, 'process_items' ), |
|
183 | + array( $this, 'process_discount' ), |
|
184 | + array( $this, 'process_taxes' ), |
|
185 | + ), |
|
186 | + $this |
|
187 | + ); |
|
188 | + |
|
189 | + foreach ( $processors as $processor ) { |
|
190 | + call_user_func_array( $processor, array( &$this ) ); |
|
191 | + } |
|
192 | + } catch ( GetPaid_Payment_Exception $e ) { |
|
193 | + $this->last_error = $e->getMessage(); |
|
194 | + $this->last_error_code = $e->getErrorCode(); |
|
195 | + } catch ( Exception $e ) { |
|
196 | + $this->last_error = $e->getMessage(); |
|
197 | + $this->last_error_code = $e->getCode(); |
|
198 | + } |
|
199 | + |
|
200 | + // Fired when we are done processing a submission. |
|
201 | + do_action_ref_array( 'getpaid_process_submission', array( &$this ) ); |
|
202 | + |
|
203 | + } |
|
204 | + |
|
205 | + /* |
|
206 | 206 | |-------------------------------------------------------------------------- |
207 | 207 | | Payment Forms. |
208 | 208 | |-------------------------------------------------------------------------- |
@@ -211,39 +211,39 @@ discard block |
||
211 | 211 | | submission has an active payment form etc. |
212 | 212 | */ |
213 | 213 | |
214 | - /** |
|
215 | - * Prepares the submission's payment form. |
|
216 | - * |
|
217 | - * @since 1.0.19 |
|
218 | - */ |
|
219 | - public function process_payment_form() { |
|
214 | + /** |
|
215 | + * Prepares the submission's payment form. |
|
216 | + * |
|
217 | + * @since 1.0.19 |
|
218 | + */ |
|
219 | + public function process_payment_form() { |
|
220 | 220 | |
221 | - // Every submission needs an active payment form. |
|
222 | - if ( empty( $this->data['form_id'] ) ) { |
|
223 | - throw new Exception( __( 'Missing payment form', 'invoicing' ) ); |
|
224 | - } |
|
221 | + // Every submission needs an active payment form. |
|
222 | + if ( empty( $this->data['form_id'] ) ) { |
|
223 | + throw new Exception( __( 'Missing payment form', 'invoicing' ) ); |
|
224 | + } |
|
225 | 225 | |
226 | - // Fetch the payment form. |
|
227 | - $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] ); |
|
226 | + // Fetch the payment form. |
|
227 | + $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] ); |
|
228 | 228 | |
229 | - if ( ! $this->payment_form->is_active() ) { |
|
230 | - throw new Exception( __( 'Payment form not active', 'invoicing' ) ); |
|
231 | - } |
|
229 | + if ( ! $this->payment_form->is_active() ) { |
|
230 | + throw new Exception( __( 'Payment form not active', 'invoicing' ) ); |
|
231 | + } |
|
232 | 232 | |
233 | - do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) ); |
|
234 | - } |
|
233 | + do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) ); |
|
234 | + } |
|
235 | 235 | |
236 | 236 | /** |
237 | - * Returns the payment form. |
|
238 | - * |
|
239 | - * @since 1.0.19 |
|
240 | - * @return GetPaid_Payment_Form |
|
241 | - */ |
|
242 | - public function get_payment_form() { |
|
243 | - return $this->payment_form; |
|
244 | - } |
|
237 | + * Returns the payment form. |
|
238 | + * |
|
239 | + * @since 1.0.19 |
|
240 | + * @return GetPaid_Payment_Form |
|
241 | + */ |
|
242 | + public function get_payment_form() { |
|
243 | + return $this->payment_form; |
|
244 | + } |
|
245 | 245 | |
246 | - /* |
|
246 | + /* |
|
247 | 247 | |-------------------------------------------------------------------------- |
248 | 248 | | Invoices. |
249 | 249 | |-------------------------------------------------------------------------- |
@@ -252,95 +252,95 @@ discard block |
||
252 | 252 | | might be for an existing invoice. |
253 | 253 | */ |
254 | 254 | |
255 | - /** |
|
256 | - * Prepares the submission's invoice. |
|
257 | - * |
|
258 | - * @since 1.0.19 |
|
259 | - */ |
|
260 | - public function process_invoice() { |
|
261 | - |
|
262 | - // Abort if there is no invoice. |
|
263 | - if ( empty( $this->data['invoice_id'] ) ) { |
|
264 | - |
|
265 | - // Check if we are resuming a payment. |
|
266 | - if ( empty( $this->data['maybe_use_invoice'] ) ) { |
|
267 | - return; |
|
268 | - } |
|
269 | - |
|
270 | - $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] ); |
|
271 | - if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) { |
|
272 | - return; |
|
273 | - } |
|
274 | - } |
|
275 | - |
|
276 | - // If the submission is for an existing invoice, ensure that it exists |
|
277 | - // and that it is not paid for. |
|
278 | - if ( empty( $invoice ) ) { |
|
279 | - $invoice = wpinv_get_invoice( $this->data['invoice_id'] ); |
|
280 | - } |
|
255 | + /** |
|
256 | + * Prepares the submission's invoice. |
|
257 | + * |
|
258 | + * @since 1.0.19 |
|
259 | + */ |
|
260 | + public function process_invoice() { |
|
261 | + |
|
262 | + // Abort if there is no invoice. |
|
263 | + if ( empty( $this->data['invoice_id'] ) ) { |
|
264 | + |
|
265 | + // Check if we are resuming a payment. |
|
266 | + if ( empty( $this->data['maybe_use_invoice'] ) ) { |
|
267 | + return; |
|
268 | + } |
|
269 | + |
|
270 | + $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] ); |
|
271 | + if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) { |
|
272 | + return; |
|
273 | + } |
|
274 | + } |
|
275 | + |
|
276 | + // If the submission is for an existing invoice, ensure that it exists |
|
277 | + // and that it is not paid for. |
|
278 | + if ( empty( $invoice ) ) { |
|
279 | + $invoice = wpinv_get_invoice( $this->data['invoice_id'] ); |
|
280 | + } |
|
281 | 281 | |
282 | 282 | if ( empty( $invoice ) ) { |
283 | - throw new Exception( __( 'Invalid invoice', 'invoicing' ) ); |
|
284 | - } |
|
285 | - |
|
286 | - if ( $invoice->is_paid() ) { |
|
287 | - throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) ); |
|
288 | - } |
|
289 | - |
|
290 | - $this->payment_form->invoice = $invoice; |
|
291 | - if ( ! $this->payment_form->is_default() ) { |
|
292 | - |
|
293 | - $items = array(); |
|
294 | - $item_ids = array(); |
|
295 | - |
|
296 | - foreach ( $invoice->get_items() as $item ) { |
|
297 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
298 | - $item_ids[] = $item->get_id(); |
|
299 | - $items[] = $item; |
|
300 | - } |
|
301 | - } |
|
302 | - |
|
303 | - foreach ( $this->payment_form->get_items() as $item ) { |
|
304 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
305 | - $item_ids[] = $item->get_id(); |
|
306 | - $items[] = $item; |
|
307 | - } |
|
308 | - } |
|
309 | - |
|
310 | - $this->payment_form->set_items( $items ); |
|
311 | - |
|
312 | - } else { |
|
313 | - $this->payment_form->set_items( $invoice->get_items() ); |
|
314 | - } |
|
315 | - |
|
316 | - $this->country = $invoice->get_country(); |
|
317 | - $this->state = $invoice->get_state(); |
|
318 | - $this->invoice = $invoice; |
|
319 | - |
|
320 | - do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) ); |
|
321 | - } |
|
322 | - |
|
323 | - /** |
|
324 | - * Returns the associated invoice. |
|
325 | - * |
|
326 | - * @since 1.0.19 |
|
327 | - * @return WPInv_Invoice |
|
328 | - */ |
|
329 | - public function get_invoice() { |
|
330 | - return $this->invoice; |
|
331 | - } |
|
332 | - |
|
333 | - /** |
|
334 | - * Checks whether there is an invoice associated with this submission. |
|
335 | - * |
|
336 | - * @since 1.0.19 |
|
337 | - * @return bool |
|
338 | - */ |
|
339 | - public function has_invoice() { |
|
340 | - return ! empty( $this->invoice ); |
|
341 | - } |
|
342 | - |
|
343 | - /* |
|
283 | + throw new Exception( __( 'Invalid invoice', 'invoicing' ) ); |
|
284 | + } |
|
285 | + |
|
286 | + if ( $invoice->is_paid() ) { |
|
287 | + throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) ); |
|
288 | + } |
|
289 | + |
|
290 | + $this->payment_form->invoice = $invoice; |
|
291 | + if ( ! $this->payment_form->is_default() ) { |
|
292 | + |
|
293 | + $items = array(); |
|
294 | + $item_ids = array(); |
|
295 | + |
|
296 | + foreach ( $invoice->get_items() as $item ) { |
|
297 | + if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
298 | + $item_ids[] = $item->get_id(); |
|
299 | + $items[] = $item; |
|
300 | + } |
|
301 | + } |
|
302 | + |
|
303 | + foreach ( $this->payment_form->get_items() as $item ) { |
|
304 | + if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
305 | + $item_ids[] = $item->get_id(); |
|
306 | + $items[] = $item; |
|
307 | + } |
|
308 | + } |
|
309 | + |
|
310 | + $this->payment_form->set_items( $items ); |
|
311 | + |
|
312 | + } else { |
|
313 | + $this->payment_form->set_items( $invoice->get_items() ); |
|
314 | + } |
|
315 | + |
|
316 | + $this->country = $invoice->get_country(); |
|
317 | + $this->state = $invoice->get_state(); |
|
318 | + $this->invoice = $invoice; |
|
319 | + |
|
320 | + do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) ); |
|
321 | + } |
|
322 | + |
|
323 | + /** |
|
324 | + * Returns the associated invoice. |
|
325 | + * |
|
326 | + * @since 1.0.19 |
|
327 | + * @return WPInv_Invoice |
|
328 | + */ |
|
329 | + public function get_invoice() { |
|
330 | + return $this->invoice; |
|
331 | + } |
|
332 | + |
|
333 | + /** |
|
334 | + * Checks whether there is an invoice associated with this submission. |
|
335 | + * |
|
336 | + * @since 1.0.19 |
|
337 | + * @return bool |
|
338 | + */ |
|
339 | + public function has_invoice() { |
|
340 | + return ! empty( $this->invoice ); |
|
341 | + } |
|
342 | + |
|
343 | + /* |
|
344 | 344 | |-------------------------------------------------------------------------- |
345 | 345 | | Items. |
346 | 346 | |-------------------------------------------------------------------------- |
@@ -349,129 +349,129 @@ discard block |
||
349 | 349 | | recurring item. But can have an unlimited number of non-recurring items. |
350 | 350 | */ |
351 | 351 | |
352 | - /** |
|
353 | - * Prepares the submission's items. |
|
354 | - * |
|
355 | - * @since 1.0.19 |
|
356 | - */ |
|
357 | - public function process_items() { |
|
358 | - |
|
359 | - $processor = new GetPaid_Payment_Form_Submission_Items( $this ); |
|
360 | - |
|
361 | - foreach ( $processor->items as $item ) { |
|
362 | - $this->add_item( $item ); |
|
363 | - } |
|
364 | - |
|
365 | - do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) ); |
|
366 | - } |
|
367 | - |
|
368 | - /** |
|
369 | - * Adds an item to the submission. |
|
370 | - * |
|
371 | - * @since 1.0.19 |
|
372 | - * @param GetPaid_Form_Item $item |
|
373 | - */ |
|
374 | - public function add_item( $item ) { |
|
375 | - |
|
376 | - // Make sure that it is available for purchase. |
|
377 | - if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) { |
|
378 | - return; |
|
379 | - } |
|
380 | - |
|
381 | - // Each submission can only contain one recurring item. |
|
382 | - if ( $item->is_recurring() ) { |
|
383 | - $this->has_recurring = $item->get_id(); |
|
384 | - } |
|
385 | - |
|
386 | - // Update the items and totals. |
|
387 | - $this->items[ $item->get_id() ] = $item; |
|
388 | - $this->totals['subtotal']['initial'] += $item->get_sub_total(); |
|
389 | - $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total(); |
|
390 | - |
|
391 | - } |
|
392 | - |
|
393 | - /** |
|
394 | - * Removes a specific item. |
|
395 | - * |
|
396 | - * You should not call this method after the discounts and taxes |
|
397 | - * have been calculated. |
|
398 | - * |
|
399 | - * @since 1.0.19 |
|
400 | - */ |
|
401 | - public function remove_item( $item_id ) { |
|
402 | - |
|
403 | - if ( isset( $this->items[ $item_id ] ) ) { |
|
404 | - $this->totals['subtotal']['initial'] -= $this->items[ $item_id ]->get_sub_total(); |
|
405 | - $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total(); |
|
406 | - |
|
407 | - if ( $this->items[ $item_id ]->is_recurring() ) { |
|
408 | - $this->has_recurring = 0; |
|
409 | - } |
|
410 | - |
|
411 | - unset( $this->items[ $item_id ] ); |
|
412 | - } |
|
413 | - |
|
414 | - } |
|
415 | - |
|
416 | - /** |
|
417 | - * Returns the subtotal. |
|
418 | - * |
|
419 | - * @since 1.0.19 |
|
420 | - */ |
|
421 | - public function get_subtotal() { |
|
422 | - |
|
423 | - if ( wpinv_prices_include_tax() ) { |
|
424 | - return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial']; |
|
425 | - } |
|
426 | - |
|
427 | - return $this->totals['subtotal']['initial']; |
|
428 | - } |
|
429 | - |
|
430 | - /** |
|
431 | - * Returns the recurring subtotal. |
|
432 | - * |
|
433 | - * @since 1.0.19 |
|
434 | - */ |
|
435 | - public function get_recurring_subtotal() { |
|
436 | - |
|
437 | - if ( wpinv_prices_include_tax() ) { |
|
438 | - return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring']; |
|
439 | - } |
|
440 | - |
|
441 | - return $this->totals['subtotal']['recurring']; |
|
442 | - } |
|
443 | - |
|
444 | - /** |
|
445 | - * Returns all items. |
|
446 | - * |
|
447 | - * @since 1.0.19 |
|
448 | - * @return GetPaid_Form_Item[] |
|
449 | - */ |
|
450 | - public function get_items() { |
|
451 | - return $this->items; |
|
452 | - } |
|
453 | - |
|
454 | - /** |
|
455 | - * Checks if there's a single subscription group in the submission. |
|
456 | - * |
|
457 | - * @since 2.3.0 |
|
458 | - * @return bool |
|
459 | - */ |
|
460 | - public function has_subscription_group() { |
|
461 | - return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) ); |
|
462 | - } |
|
463 | - |
|
464 | - /** |
|
465 | - * Checks if there are multipe subscription groups in the submission. |
|
466 | - * |
|
467 | - * @since 2.3.0 |
|
468 | - * @return bool |
|
469 | - */ |
|
470 | - public function has_multiple_subscription_groups() { |
|
471 | - return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) ); |
|
472 | - } |
|
473 | - |
|
474 | - /* |
|
352 | + /** |
|
353 | + * Prepares the submission's items. |
|
354 | + * |
|
355 | + * @since 1.0.19 |
|
356 | + */ |
|
357 | + public function process_items() { |
|
358 | + |
|
359 | + $processor = new GetPaid_Payment_Form_Submission_Items( $this ); |
|
360 | + |
|
361 | + foreach ( $processor->items as $item ) { |
|
362 | + $this->add_item( $item ); |
|
363 | + } |
|
364 | + |
|
365 | + do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) ); |
|
366 | + } |
|
367 | + |
|
368 | + /** |
|
369 | + * Adds an item to the submission. |
|
370 | + * |
|
371 | + * @since 1.0.19 |
|
372 | + * @param GetPaid_Form_Item $item |
|
373 | + */ |
|
374 | + public function add_item( $item ) { |
|
375 | + |
|
376 | + // Make sure that it is available for purchase. |
|
377 | + if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) { |
|
378 | + return; |
|
379 | + } |
|
380 | + |
|
381 | + // Each submission can only contain one recurring item. |
|
382 | + if ( $item->is_recurring() ) { |
|
383 | + $this->has_recurring = $item->get_id(); |
|
384 | + } |
|
385 | + |
|
386 | + // Update the items and totals. |
|
387 | + $this->items[ $item->get_id() ] = $item; |
|
388 | + $this->totals['subtotal']['initial'] += $item->get_sub_total(); |
|
389 | + $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total(); |
|
390 | + |
|
391 | + } |
|
392 | + |
|
393 | + /** |
|
394 | + * Removes a specific item. |
|
395 | + * |
|
396 | + * You should not call this method after the discounts and taxes |
|
397 | + * have been calculated. |
|
398 | + * |
|
399 | + * @since 1.0.19 |
|
400 | + */ |
|
401 | + public function remove_item( $item_id ) { |
|
402 | + |
|
403 | + if ( isset( $this->items[ $item_id ] ) ) { |
|
404 | + $this->totals['subtotal']['initial'] -= $this->items[ $item_id ]->get_sub_total(); |
|
405 | + $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total(); |
|
406 | + |
|
407 | + if ( $this->items[ $item_id ]->is_recurring() ) { |
|
408 | + $this->has_recurring = 0; |
|
409 | + } |
|
410 | + |
|
411 | + unset( $this->items[ $item_id ] ); |
|
412 | + } |
|
413 | + |
|
414 | + } |
|
415 | + |
|
416 | + /** |
|
417 | + * Returns the subtotal. |
|
418 | + * |
|
419 | + * @since 1.0.19 |
|
420 | + */ |
|
421 | + public function get_subtotal() { |
|
422 | + |
|
423 | + if ( wpinv_prices_include_tax() ) { |
|
424 | + return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial']; |
|
425 | + } |
|
426 | + |
|
427 | + return $this->totals['subtotal']['initial']; |
|
428 | + } |
|
429 | + |
|
430 | + /** |
|
431 | + * Returns the recurring subtotal. |
|
432 | + * |
|
433 | + * @since 1.0.19 |
|
434 | + */ |
|
435 | + public function get_recurring_subtotal() { |
|
436 | + |
|
437 | + if ( wpinv_prices_include_tax() ) { |
|
438 | + return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring']; |
|
439 | + } |
|
440 | + |
|
441 | + return $this->totals['subtotal']['recurring']; |
|
442 | + } |
|
443 | + |
|
444 | + /** |
|
445 | + * Returns all items. |
|
446 | + * |
|
447 | + * @since 1.0.19 |
|
448 | + * @return GetPaid_Form_Item[] |
|
449 | + */ |
|
450 | + public function get_items() { |
|
451 | + return $this->items; |
|
452 | + } |
|
453 | + |
|
454 | + /** |
|
455 | + * Checks if there's a single subscription group in the submission. |
|
456 | + * |
|
457 | + * @since 2.3.0 |
|
458 | + * @return bool |
|
459 | + */ |
|
460 | + public function has_subscription_group() { |
|
461 | + return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) ); |
|
462 | + } |
|
463 | + |
|
464 | + /** |
|
465 | + * Checks if there are multipe subscription groups in the submission. |
|
466 | + * |
|
467 | + * @since 2.3.0 |
|
468 | + * @return bool |
|
469 | + */ |
|
470 | + public function has_multiple_subscription_groups() { |
|
471 | + return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) ); |
|
472 | + } |
|
473 | + |
|
474 | + /* |
|
475 | 475 | |-------------------------------------------------------------------------- |
476 | 476 | | Taxes |
477 | 477 | |-------------------------------------------------------------------------- |
@@ -480,128 +480,128 @@ discard block |
||
480 | 480 | | or only one-time. |
481 | 481 | */ |
482 | 482 | |
483 | - /** |
|
484 | - * Prepares the submission's taxes. |
|
485 | - * |
|
486 | - * @since 1.0.19 |
|
487 | - */ |
|
488 | - public function process_taxes() { |
|
489 | - |
|
490 | - // Abort if we're not using taxes. |
|
491 | - if ( ! $this->use_taxes() ) { |
|
492 | - return; |
|
493 | - } |
|
494 | - |
|
495 | - // If a custom country && state has been passed in, use it to calculate taxes. |
|
496 | - $country = $this->get_field( 'wpinv_country', 'billing' ); |
|
497 | - if ( ! empty( $country ) ) { |
|
498 | - $this->country = $country; |
|
499 | - } |
|
500 | - |
|
501 | - $state = $this->get_field( 'wpinv_state', 'billing' ); |
|
502 | - if ( ! empty( $state ) ) { |
|
503 | - $this->state = $state; |
|
504 | - } |
|
505 | - |
|
506 | - // Confirm if the provided country and the ip country are similar. |
|
507 | - $address_confirmed = $this->get_field( 'confirm-address' ); |
|
508 | - if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) { |
|
509 | - throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) ); |
|
510 | - } |
|
511 | - |
|
512 | - // Abort if the country is not taxable. |
|
513 | - if ( ! wpinv_is_country_taxable( $this->country ) ) { |
|
514 | - return; |
|
515 | - } |
|
516 | - |
|
517 | - $processor = new GetPaid_Payment_Form_Submission_Taxes( $this ); |
|
518 | - |
|
519 | - foreach ( $processor->taxes as $tax ) { |
|
520 | - $this->add_tax( $tax ); |
|
521 | - } |
|
522 | - |
|
523 | - do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) ); |
|
524 | - } |
|
525 | - |
|
526 | - /** |
|
527 | - * Adds a tax to the submission. |
|
528 | - * |
|
529 | - * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required. |
|
530 | - * @since 1.0.19 |
|
531 | - */ |
|
532 | - public function add_tax( $tax ) { |
|
533 | - |
|
534 | - if ( wpinv_round_tax_per_tax_rate() ) { |
|
535 | - $tax['initial_tax'] = wpinv_round_amount( $tax['initial_tax'] ); |
|
536 | - $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] ); |
|
537 | - } |
|
538 | - |
|
539 | - $this->taxes[ $tax['name'] ] = $tax; |
|
540 | - $this->totals['taxes']['initial'] += wpinv_sanitize_amount( $tax['initial_tax'] ); |
|
541 | - $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] ); |
|
542 | - |
|
543 | - } |
|
544 | - |
|
545 | - /** |
|
546 | - * Removes a specific tax. |
|
547 | - * |
|
548 | - * @since 1.0.19 |
|
549 | - */ |
|
550 | - public function remove_tax( $tax_name ) { |
|
551 | - |
|
552 | - if ( isset( $this->taxes[ $tax_name ] ) ) { |
|
553 | - $this->totals['taxes']['initial'] -= $this->taxes[ $tax_name ]['initial_tax']; |
|
554 | - $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax']; |
|
555 | - unset( $this->taxes[ $tax_name ] ); |
|
556 | - } |
|
557 | - |
|
558 | - } |
|
559 | - |
|
560 | - /** |
|
561 | - * Whether or not we'll use taxes for the submission. |
|
562 | - * |
|
563 | - * @since 1.0.19 |
|
564 | - */ |
|
565 | - public function use_taxes() { |
|
566 | - |
|
567 | - $use_taxes = wpinv_use_taxes(); |
|
568 | - |
|
569 | - if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) { |
|
570 | - $use_taxes = false; |
|
571 | - } |
|
572 | - |
|
573 | - return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this ); |
|
574 | - |
|
575 | - } |
|
576 | - |
|
577 | - /** |
|
578 | - * Returns the tax. |
|
579 | - * |
|
580 | - * @since 1.0.19 |
|
581 | - */ |
|
582 | - public function get_tax() { |
|
583 | - return $this->totals['taxes']['initial']; |
|
584 | - } |
|
585 | - |
|
586 | - /** |
|
587 | - * Returns the recurring tax. |
|
588 | - * |
|
589 | - * @since 1.0.19 |
|
590 | - */ |
|
591 | - public function get_recurring_tax() { |
|
592 | - return $this->totals['taxes']['recurring']; |
|
593 | - } |
|
594 | - |
|
595 | - /** |
|
596 | - * Returns all taxes. |
|
597 | - * |
|
598 | - * @since 1.0.19 |
|
599 | - */ |
|
600 | - public function get_taxes() { |
|
601 | - return $this->taxes; |
|
602 | - } |
|
603 | - |
|
604 | - /* |
|
483 | + /** |
|
484 | + * Prepares the submission's taxes. |
|
485 | + * |
|
486 | + * @since 1.0.19 |
|
487 | + */ |
|
488 | + public function process_taxes() { |
|
489 | + |
|
490 | + // Abort if we're not using taxes. |
|
491 | + if ( ! $this->use_taxes() ) { |
|
492 | + return; |
|
493 | + } |
|
494 | + |
|
495 | + // If a custom country && state has been passed in, use it to calculate taxes. |
|
496 | + $country = $this->get_field( 'wpinv_country', 'billing' ); |
|
497 | + if ( ! empty( $country ) ) { |
|
498 | + $this->country = $country; |
|
499 | + } |
|
500 | + |
|
501 | + $state = $this->get_field( 'wpinv_state', 'billing' ); |
|
502 | + if ( ! empty( $state ) ) { |
|
503 | + $this->state = $state; |
|
504 | + } |
|
505 | + |
|
506 | + // Confirm if the provided country and the ip country are similar. |
|
507 | + $address_confirmed = $this->get_field( 'confirm-address' ); |
|
508 | + if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) { |
|
509 | + throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) ); |
|
510 | + } |
|
511 | + |
|
512 | + // Abort if the country is not taxable. |
|
513 | + if ( ! wpinv_is_country_taxable( $this->country ) ) { |
|
514 | + return; |
|
515 | + } |
|
516 | + |
|
517 | + $processor = new GetPaid_Payment_Form_Submission_Taxes( $this ); |
|
518 | + |
|
519 | + foreach ( $processor->taxes as $tax ) { |
|
520 | + $this->add_tax( $tax ); |
|
521 | + } |
|
522 | + |
|
523 | + do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) ); |
|
524 | + } |
|
525 | + |
|
526 | + /** |
|
527 | + * Adds a tax to the submission. |
|
528 | + * |
|
529 | + * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required. |
|
530 | + * @since 1.0.19 |
|
531 | + */ |
|
532 | + public function add_tax( $tax ) { |
|
533 | + |
|
534 | + if ( wpinv_round_tax_per_tax_rate() ) { |
|
535 | + $tax['initial_tax'] = wpinv_round_amount( $tax['initial_tax'] ); |
|
536 | + $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] ); |
|
537 | + } |
|
538 | + |
|
539 | + $this->taxes[ $tax['name'] ] = $tax; |
|
540 | + $this->totals['taxes']['initial'] += wpinv_sanitize_amount( $tax['initial_tax'] ); |
|
541 | + $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] ); |
|
542 | + |
|
543 | + } |
|
544 | + |
|
545 | + /** |
|
546 | + * Removes a specific tax. |
|
547 | + * |
|
548 | + * @since 1.0.19 |
|
549 | + */ |
|
550 | + public function remove_tax( $tax_name ) { |
|
551 | + |
|
552 | + if ( isset( $this->taxes[ $tax_name ] ) ) { |
|
553 | + $this->totals['taxes']['initial'] -= $this->taxes[ $tax_name ]['initial_tax']; |
|
554 | + $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax']; |
|
555 | + unset( $this->taxes[ $tax_name ] ); |
|
556 | + } |
|
557 | + |
|
558 | + } |
|
559 | + |
|
560 | + /** |
|
561 | + * Whether or not we'll use taxes for the submission. |
|
562 | + * |
|
563 | + * @since 1.0.19 |
|
564 | + */ |
|
565 | + public function use_taxes() { |
|
566 | + |
|
567 | + $use_taxes = wpinv_use_taxes(); |
|
568 | + |
|
569 | + if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) { |
|
570 | + $use_taxes = false; |
|
571 | + } |
|
572 | + |
|
573 | + return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this ); |
|
574 | + |
|
575 | + } |
|
576 | + |
|
577 | + /** |
|
578 | + * Returns the tax. |
|
579 | + * |
|
580 | + * @since 1.0.19 |
|
581 | + */ |
|
582 | + public function get_tax() { |
|
583 | + return $this->totals['taxes']['initial']; |
|
584 | + } |
|
585 | + |
|
586 | + /** |
|
587 | + * Returns the recurring tax. |
|
588 | + * |
|
589 | + * @since 1.0.19 |
|
590 | + */ |
|
591 | + public function get_recurring_tax() { |
|
592 | + return $this->totals['taxes']['recurring']; |
|
593 | + } |
|
594 | + |
|
595 | + /** |
|
596 | + * Returns all taxes. |
|
597 | + * |
|
598 | + * @since 1.0.19 |
|
599 | + */ |
|
600 | + public function get_taxes() { |
|
601 | + return $this->taxes; |
|
602 | + } |
|
603 | + |
|
604 | + /* |
|
605 | 605 | |-------------------------------------------------------------------------- |
606 | 606 | | Discounts |
607 | 607 | |-------------------------------------------------------------------------- |
@@ -610,99 +610,99 @@ discard block |
||
610 | 610 | | or only one-time. They also do not have to come from a discount code. |
611 | 611 | */ |
612 | 612 | |
613 | - /** |
|
614 | - * Prepares the submission's discount. |
|
615 | - * |
|
616 | - * @since 1.0.19 |
|
617 | - */ |
|
618 | - public function process_discount() { |
|
619 | - |
|
620 | - $initial_total = $this->get_subtotal() + $this->get_fee() + $this->get_tax(); |
|
621 | - $recurring_total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax(); |
|
622 | - $processor = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total ); |
|
623 | - |
|
624 | - foreach ( $processor->discounts as $discount ) { |
|
625 | - $this->add_discount( $discount ); |
|
626 | - } |
|
627 | - |
|
628 | - do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) ); |
|
629 | - } |
|
630 | - |
|
631 | - /** |
|
632 | - * Adds a discount to the submission. |
|
633 | - * |
|
634 | - * @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. |
|
635 | - * @since 1.0.19 |
|
636 | - */ |
|
637 | - public function add_discount( $discount ) { |
|
638 | - $this->discounts[ $discount['name'] ] = $discount; |
|
639 | - $this->totals['discount']['initial'] += wpinv_sanitize_amount( $discount['initial_discount'] ); |
|
640 | - $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] ); |
|
641 | - } |
|
642 | - |
|
643 | - /** |
|
644 | - * Removes a discount from the submission. |
|
645 | - * |
|
646 | - * @since 1.0.19 |
|
647 | - */ |
|
648 | - public function remove_discount( $name ) { |
|
649 | - |
|
650 | - if ( isset( $this->discounts[ $name ] ) ) { |
|
651 | - $this->totals['discount']['initial'] -= $this->discounts[ $name ]['initial_discount']; |
|
652 | - $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount']; |
|
653 | - unset( $this->discounts[ $name ] ); |
|
654 | - } |
|
655 | - |
|
656 | - } |
|
657 | - |
|
658 | - /** |
|
659 | - * Checks whether there is a discount code associated with this submission. |
|
660 | - * |
|
661 | - * @since 1.0.19 |
|
662 | - * @return bool |
|
663 | - */ |
|
664 | - public function has_discount_code() { |
|
665 | - return ! empty( $this->discounts['discount_code'] ); |
|
666 | - } |
|
667 | - |
|
668 | - /** |
|
669 | - * Returns the discount code. |
|
670 | - * |
|
671 | - * @since 1.0.19 |
|
672 | - * @return string |
|
673 | - */ |
|
674 | - public function get_discount_code() { |
|
675 | - return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : ''; |
|
676 | - } |
|
677 | - |
|
678 | - /** |
|
679 | - * Returns the discount. |
|
680 | - * |
|
681 | - * @since 1.0.19 |
|
682 | - */ |
|
683 | - public function get_discount() { |
|
684 | - return $this->totals['discount']['initial']; |
|
685 | - } |
|
686 | - |
|
687 | - /** |
|
688 | - * Returns the recurring discount. |
|
689 | - * |
|
690 | - * @since 1.0.19 |
|
691 | - */ |
|
692 | - public function get_recurring_discount() { |
|
693 | - return $this->totals['discount']['recurring']; |
|
694 | - } |
|
695 | - |
|
696 | - /** |
|
697 | - * Returns all discounts. |
|
698 | - * |
|
699 | - * @since 1.0.19 |
|
700 | - */ |
|
701 | - public function get_discounts() { |
|
702 | - return $this->discounts; |
|
703 | - } |
|
704 | - |
|
705 | - /* |
|
613 | + /** |
|
614 | + * Prepares the submission's discount. |
|
615 | + * |
|
616 | + * @since 1.0.19 |
|
617 | + */ |
|
618 | + public function process_discount() { |
|
619 | + |
|
620 | + $initial_total = $this->get_subtotal() + $this->get_fee() + $this->get_tax(); |
|
621 | + $recurring_total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax(); |
|
622 | + $processor = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total ); |
|
623 | + |
|
624 | + foreach ( $processor->discounts as $discount ) { |
|
625 | + $this->add_discount( $discount ); |
|
626 | + } |
|
627 | + |
|
628 | + do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) ); |
|
629 | + } |
|
630 | + |
|
631 | + /** |
|
632 | + * Adds a discount to the submission. |
|
633 | + * |
|
634 | + * @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. |
|
635 | + * @since 1.0.19 |
|
636 | + */ |
|
637 | + public function add_discount( $discount ) { |
|
638 | + $this->discounts[ $discount['name'] ] = $discount; |
|
639 | + $this->totals['discount']['initial'] += wpinv_sanitize_amount( $discount['initial_discount'] ); |
|
640 | + $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] ); |
|
641 | + } |
|
642 | + |
|
643 | + /** |
|
644 | + * Removes a discount from the submission. |
|
645 | + * |
|
646 | + * @since 1.0.19 |
|
647 | + */ |
|
648 | + public function remove_discount( $name ) { |
|
649 | + |
|
650 | + if ( isset( $this->discounts[ $name ] ) ) { |
|
651 | + $this->totals['discount']['initial'] -= $this->discounts[ $name ]['initial_discount']; |
|
652 | + $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount']; |
|
653 | + unset( $this->discounts[ $name ] ); |
|
654 | + } |
|
655 | + |
|
656 | + } |
|
657 | + |
|
658 | + /** |
|
659 | + * Checks whether there is a discount code associated with this submission. |
|
660 | + * |
|
661 | + * @since 1.0.19 |
|
662 | + * @return bool |
|
663 | + */ |
|
664 | + public function has_discount_code() { |
|
665 | + return ! empty( $this->discounts['discount_code'] ); |
|
666 | + } |
|
667 | + |
|
668 | + /** |
|
669 | + * Returns the discount code. |
|
670 | + * |
|
671 | + * @since 1.0.19 |
|
672 | + * @return string |
|
673 | + */ |
|
674 | + public function get_discount_code() { |
|
675 | + return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : ''; |
|
676 | + } |
|
677 | + |
|
678 | + /** |
|
679 | + * Returns the discount. |
|
680 | + * |
|
681 | + * @since 1.0.19 |
|
682 | + */ |
|
683 | + public function get_discount() { |
|
684 | + return $this->totals['discount']['initial']; |
|
685 | + } |
|
686 | + |
|
687 | + /** |
|
688 | + * Returns the recurring discount. |
|
689 | + * |
|
690 | + * @since 1.0.19 |
|
691 | + */ |
|
692 | + public function get_recurring_discount() { |
|
693 | + return $this->totals['discount']['recurring']; |
|
694 | + } |
|
695 | + |
|
696 | + /** |
|
697 | + * Returns all discounts. |
|
698 | + * |
|
699 | + * @since 1.0.19 |
|
700 | + */ |
|
701 | + public function get_discounts() { |
|
702 | + return $this->discounts; |
|
703 | + } |
|
704 | + |
|
705 | + /* |
|
706 | 706 | |-------------------------------------------------------------------------- |
707 | 707 | | Fees |
708 | 708 | |-------------------------------------------------------------------------- |
@@ -712,100 +712,100 @@ discard block |
||
712 | 712 | | fees. |
713 | 713 | */ |
714 | 714 | |
715 | - /** |
|
716 | - * Prepares the submission's fees. |
|
717 | - * |
|
718 | - * @since 1.0.19 |
|
719 | - */ |
|
720 | - public function process_fees() { |
|
721 | - |
|
722 | - $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this ); |
|
723 | - |
|
724 | - foreach ( $fees_processor->fees as $fee ) { |
|
725 | - $this->add_fee( $fee ); |
|
726 | - } |
|
727 | - |
|
728 | - do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) ); |
|
729 | - } |
|
730 | - |
|
731 | - /** |
|
732 | - * Adds a fee to the submission. |
|
733 | - * |
|
734 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
735 | - * @since 1.0.19 |
|
736 | - */ |
|
737 | - public function add_fee( $fee ) { |
|
738 | - |
|
739 | - if ( $fee['name'] == 'shipping' ) { |
|
740 | - $this->totals['shipping']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
741 | - $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
742 | - return; |
|
743 | - } |
|
744 | - |
|
745 | - $this->fees[ $fee['name'] ] = $fee; |
|
746 | - $this->totals['fees']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
747 | - $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
748 | - |
|
749 | - } |
|
750 | - |
|
751 | - /** |
|
752 | - * Removes a fee from the submission. |
|
753 | - * |
|
754 | - * @since 1.0.19 |
|
755 | - */ |
|
756 | - public function remove_fee( $name ) { |
|
757 | - |
|
758 | - if ( isset( $this->fees[ $name ] ) ) { |
|
759 | - $this->totals['fees']['initial'] -= $this->fees[ $name ]['initial_fee']; |
|
760 | - $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee']; |
|
761 | - unset( $this->fees[ $name ] ); |
|
762 | - } |
|
763 | - |
|
764 | - if ( 'shipping' == $name ) { |
|
765 | - $this->totals['shipping']['initial'] = 0; |
|
766 | - $this->totals['shipping']['recurring'] = 0; |
|
767 | - } |
|
768 | - |
|
769 | - } |
|
770 | - |
|
771 | - /** |
|
772 | - * Returns the fees. |
|
773 | - * |
|
774 | - * @since 1.0.19 |
|
775 | - */ |
|
776 | - public function get_fee() { |
|
777 | - return $this->totals['fees']['initial']; |
|
778 | - } |
|
779 | - |
|
780 | - /** |
|
781 | - * Returns the recurring fees. |
|
782 | - * |
|
783 | - * @since 1.0.19 |
|
784 | - */ |
|
785 | - public function get_recurring_fee() { |
|
786 | - return $this->totals['fees']['recurring']; |
|
787 | - } |
|
788 | - |
|
789 | - /** |
|
790 | - * Returns all fees. |
|
791 | - * |
|
792 | - * @since 1.0.19 |
|
793 | - */ |
|
794 | - public function get_fees() { |
|
795 | - return $this->fees; |
|
796 | - } |
|
797 | - |
|
798 | - /** |
|
799 | - * Checks if there are any fees for the form. |
|
800 | - * |
|
801 | - * @return bool |
|
802 | - * @since 1.0.19 |
|
803 | - */ |
|
804 | - public function has_fees() { |
|
805 | - return count( $this->fees ) !== 0; |
|
806 | - } |
|
807 | - |
|
808 | - /* |
|
715 | + /** |
|
716 | + * Prepares the submission's fees. |
|
717 | + * |
|
718 | + * @since 1.0.19 |
|
719 | + */ |
|
720 | + public function process_fees() { |
|
721 | + |
|
722 | + $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this ); |
|
723 | + |
|
724 | + foreach ( $fees_processor->fees as $fee ) { |
|
725 | + $this->add_fee( $fee ); |
|
726 | + } |
|
727 | + |
|
728 | + do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) ); |
|
729 | + } |
|
730 | + |
|
731 | + /** |
|
732 | + * Adds a fee to the submission. |
|
733 | + * |
|
734 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
735 | + * @since 1.0.19 |
|
736 | + */ |
|
737 | + public function add_fee( $fee ) { |
|
738 | + |
|
739 | + if ( $fee['name'] == 'shipping' ) { |
|
740 | + $this->totals['shipping']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
741 | + $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
742 | + return; |
|
743 | + } |
|
744 | + |
|
745 | + $this->fees[ $fee['name'] ] = $fee; |
|
746 | + $this->totals['fees']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
747 | + $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
748 | + |
|
749 | + } |
|
750 | + |
|
751 | + /** |
|
752 | + * Removes a fee from the submission. |
|
753 | + * |
|
754 | + * @since 1.0.19 |
|
755 | + */ |
|
756 | + public function remove_fee( $name ) { |
|
757 | + |
|
758 | + if ( isset( $this->fees[ $name ] ) ) { |
|
759 | + $this->totals['fees']['initial'] -= $this->fees[ $name ]['initial_fee']; |
|
760 | + $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee']; |
|
761 | + unset( $this->fees[ $name ] ); |
|
762 | + } |
|
763 | + |
|
764 | + if ( 'shipping' == $name ) { |
|
765 | + $this->totals['shipping']['initial'] = 0; |
|
766 | + $this->totals['shipping']['recurring'] = 0; |
|
767 | + } |
|
768 | + |
|
769 | + } |
|
770 | + |
|
771 | + /** |
|
772 | + * Returns the fees. |
|
773 | + * |
|
774 | + * @since 1.0.19 |
|
775 | + */ |
|
776 | + public function get_fee() { |
|
777 | + return $this->totals['fees']['initial']; |
|
778 | + } |
|
779 | + |
|
780 | + /** |
|
781 | + * Returns the recurring fees. |
|
782 | + * |
|
783 | + * @since 1.0.19 |
|
784 | + */ |
|
785 | + public function get_recurring_fee() { |
|
786 | + return $this->totals['fees']['recurring']; |
|
787 | + } |
|
788 | + |
|
789 | + /** |
|
790 | + * Returns all fees. |
|
791 | + * |
|
792 | + * @since 1.0.19 |
|
793 | + */ |
|
794 | + public function get_fees() { |
|
795 | + return $this->fees; |
|
796 | + } |
|
797 | + |
|
798 | + /** |
|
799 | + * Checks if there are any fees for the form. |
|
800 | + * |
|
801 | + * @return bool |
|
802 | + * @since 1.0.19 |
|
803 | + */ |
|
804 | + public function has_fees() { |
|
805 | + return count( $this->fees ) !== 0; |
|
806 | + } |
|
807 | + |
|
808 | + /* |
|
809 | 809 | |-------------------------------------------------------------------------- |
810 | 810 | | MISC |
811 | 811 | |-------------------------------------------------------------------------- |
@@ -813,147 +813,147 @@ discard block |
||
813 | 813 | | Extra submission functions. |
814 | 814 | */ |
815 | 815 | |
816 | - /** |
|
817 | - * Returns the shipping amount. |
|
818 | - * |
|
819 | - * @since 1.0.19 |
|
820 | - */ |
|
821 | - public function get_shipping() { |
|
822 | - return $this->totals['shipping']['initial']; |
|
823 | - } |
|
824 | - |
|
825 | - /** |
|
826 | - * Returns the recurring shipping. |
|
827 | - * |
|
828 | - * @since 1.0.19 |
|
829 | - */ |
|
830 | - public function get_recurring_shipping() { |
|
831 | - return $this->totals['shipping']['recurring']; |
|
832 | - } |
|
833 | - |
|
834 | - /** |
|
835 | - * Checks if there are any shipping fees for the form. |
|
836 | - * |
|
837 | - * @return bool |
|
838 | - * @since 1.0.19 |
|
839 | - */ |
|
840 | - public function has_shipping() { |
|
841 | - return apply_filters( 'getpaid_payment_form_has_shipping', false, $this ); |
|
842 | - } |
|
843 | - |
|
844 | - /** |
|
845 | - * Checks if this is the initial fetch. |
|
846 | - * |
|
847 | - * @return bool |
|
848 | - * @since 1.0.19 |
|
849 | - */ |
|
850 | - public function is_initial_fetch() { |
|
851 | - return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] ); |
|
852 | - } |
|
853 | - |
|
854 | - /** |
|
855 | - * Returns the total amount to collect for this submission. |
|
856 | - * |
|
857 | - * @since 1.0.19 |
|
858 | - */ |
|
859 | - public function get_total() { |
|
860 | - $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount(); |
|
861 | - return max( $total, 0 ); |
|
862 | - } |
|
863 | - |
|
864 | - /** |
|
865 | - * Returns the recurring total amount to collect for this submission. |
|
866 | - * |
|
867 | - * @since 1.0.19 |
|
868 | - */ |
|
869 | - public function get_recurring_total() { |
|
870 | - $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount(); |
|
871 | - return max( $total, 0 ); |
|
872 | - } |
|
873 | - |
|
874 | - /** |
|
875 | - * Whether payment details should be collected for this submission. |
|
876 | - * |
|
877 | - * @since 1.0.19 |
|
878 | - */ |
|
879 | - public function should_collect_payment_details() { |
|
880 | - $initial = $this->get_total(); |
|
881 | - $recurring = $this->get_recurring_total(); |
|
882 | - |
|
883 | - if ( $this->has_recurring == 0 ) { |
|
884 | - $recurring = 0; |
|
885 | - } |
|
886 | - |
|
887 | - $collect = $initial > 0 || $recurring > 0; |
|
888 | - return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this ); |
|
889 | - } |
|
890 | - |
|
891 | - /** |
|
892 | - * Returns the billing email of the user. |
|
893 | - * |
|
894 | - * @since 1.0.19 |
|
895 | - */ |
|
896 | - public function get_billing_email() { |
|
897 | - return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this ); |
|
898 | - } |
|
899 | - |
|
900 | - /** |
|
901 | - * Checks if the submitter has a billing email. |
|
902 | - * |
|
903 | - * @since 1.0.19 |
|
904 | - */ |
|
905 | - public function has_billing_email() { |
|
906 | - $billing_email = $this->get_billing_email(); |
|
907 | - return ! empty( $billing_email ) && is_email( $billing_email ); |
|
908 | - } |
|
909 | - |
|
910 | - /** |
|
911 | - * Returns the appropriate currency for the submission. |
|
912 | - * |
|
913 | - * @since 1.0.19 |
|
914 | - * @return string |
|
915 | - */ |
|
916 | - public function get_currency() { |
|
917 | - return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency(); |
|
918 | - } |
|
919 | - |
|
920 | - /** |
|
921 | - * Returns the raw submission data. |
|
922 | - * |
|
923 | - * @since 1.0.19 |
|
924 | - * @return array |
|
925 | - */ |
|
926 | - public function get_data() { |
|
927 | - return $this->data; |
|
928 | - } |
|
929 | - |
|
930 | - /** |
|
931 | - * Returns a field from the submission data |
|
932 | - * |
|
933 | - * @param string $field |
|
934 | - * @since 1.0.19 |
|
935 | - * @return mixed|null |
|
936 | - */ |
|
937 | - public function get_field( $field, $sub_array_key = null ) { |
|
938 | - return getpaid_get_array_field( $this->data, $field, $sub_array_key ); |
|
939 | - } |
|
940 | - |
|
941 | - /** |
|
942 | - * Checks if a required field is set. |
|
943 | - * |
|
944 | - * @since 1.0.19 |
|
945 | - */ |
|
946 | - public function is_required_field_set( $field ) { |
|
947 | - return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] ); |
|
948 | - } |
|
949 | - |
|
950 | - /** |
|
951 | - * Formats an amount |
|
952 | - * |
|
953 | - * @since 1.0.19 |
|
954 | - */ |
|
955 | - public function format_amount( $amount ) { |
|
956 | - return wpinv_price( $amount, $this->get_currency() ); |
|
957 | - } |
|
816 | + /** |
|
817 | + * Returns the shipping amount. |
|
818 | + * |
|
819 | + * @since 1.0.19 |
|
820 | + */ |
|
821 | + public function get_shipping() { |
|
822 | + return $this->totals['shipping']['initial']; |
|
823 | + } |
|
824 | + |
|
825 | + /** |
|
826 | + * Returns the recurring shipping. |
|
827 | + * |
|
828 | + * @since 1.0.19 |
|
829 | + */ |
|
830 | + public function get_recurring_shipping() { |
|
831 | + return $this->totals['shipping']['recurring']; |
|
832 | + } |
|
833 | + |
|
834 | + /** |
|
835 | + * Checks if there are any shipping fees for the form. |
|
836 | + * |
|
837 | + * @return bool |
|
838 | + * @since 1.0.19 |
|
839 | + */ |
|
840 | + public function has_shipping() { |
|
841 | + return apply_filters( 'getpaid_payment_form_has_shipping', false, $this ); |
|
842 | + } |
|
843 | + |
|
844 | + /** |
|
845 | + * Checks if this is the initial fetch. |
|
846 | + * |
|
847 | + * @return bool |
|
848 | + * @since 1.0.19 |
|
849 | + */ |
|
850 | + public function is_initial_fetch() { |
|
851 | + return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] ); |
|
852 | + } |
|
853 | + |
|
854 | + /** |
|
855 | + * Returns the total amount to collect for this submission. |
|
856 | + * |
|
857 | + * @since 1.0.19 |
|
858 | + */ |
|
859 | + public function get_total() { |
|
860 | + $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount(); |
|
861 | + return max( $total, 0 ); |
|
862 | + } |
|
863 | + |
|
864 | + /** |
|
865 | + * Returns the recurring total amount to collect for this submission. |
|
866 | + * |
|
867 | + * @since 1.0.19 |
|
868 | + */ |
|
869 | + public function get_recurring_total() { |
|
870 | + $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount(); |
|
871 | + return max( $total, 0 ); |
|
872 | + } |
|
873 | + |
|
874 | + /** |
|
875 | + * Whether payment details should be collected for this submission. |
|
876 | + * |
|
877 | + * @since 1.0.19 |
|
878 | + */ |
|
879 | + public function should_collect_payment_details() { |
|
880 | + $initial = $this->get_total(); |
|
881 | + $recurring = $this->get_recurring_total(); |
|
882 | + |
|
883 | + if ( $this->has_recurring == 0 ) { |
|
884 | + $recurring = 0; |
|
885 | + } |
|
886 | + |
|
887 | + $collect = $initial > 0 || $recurring > 0; |
|
888 | + return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this ); |
|
889 | + } |
|
890 | + |
|
891 | + /** |
|
892 | + * Returns the billing email of the user. |
|
893 | + * |
|
894 | + * @since 1.0.19 |
|
895 | + */ |
|
896 | + public function get_billing_email() { |
|
897 | + return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this ); |
|
898 | + } |
|
899 | + |
|
900 | + /** |
|
901 | + * Checks if the submitter has a billing email. |
|
902 | + * |
|
903 | + * @since 1.0.19 |
|
904 | + */ |
|
905 | + public function has_billing_email() { |
|
906 | + $billing_email = $this->get_billing_email(); |
|
907 | + return ! empty( $billing_email ) && is_email( $billing_email ); |
|
908 | + } |
|
909 | + |
|
910 | + /** |
|
911 | + * Returns the appropriate currency for the submission. |
|
912 | + * |
|
913 | + * @since 1.0.19 |
|
914 | + * @return string |
|
915 | + */ |
|
916 | + public function get_currency() { |
|
917 | + return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency(); |
|
918 | + } |
|
919 | + |
|
920 | + /** |
|
921 | + * Returns the raw submission data. |
|
922 | + * |
|
923 | + * @since 1.0.19 |
|
924 | + * @return array |
|
925 | + */ |
|
926 | + public function get_data() { |
|
927 | + return $this->data; |
|
928 | + } |
|
929 | + |
|
930 | + /** |
|
931 | + * Returns a field from the submission data |
|
932 | + * |
|
933 | + * @param string $field |
|
934 | + * @since 1.0.19 |
|
935 | + * @return mixed|null |
|
936 | + */ |
|
937 | + public function get_field( $field, $sub_array_key = null ) { |
|
938 | + return getpaid_get_array_field( $this->data, $field, $sub_array_key ); |
|
939 | + } |
|
940 | + |
|
941 | + /** |
|
942 | + * Checks if a required field is set. |
|
943 | + * |
|
944 | + * @since 1.0.19 |
|
945 | + */ |
|
946 | + public function is_required_field_set( $field ) { |
|
947 | + return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] ); |
|
948 | + } |
|
949 | + |
|
950 | + /** |
|
951 | + * Formats an amount |
|
952 | + * |
|
953 | + * @since 1.0.19 |
|
954 | + */ |
|
955 | + public function format_amount( $amount ) { |
|
956 | + return wpinv_price( $amount, $this->get_currency() ); |
|
957 | + } |
|
958 | 958 | |
959 | 959 | } |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -if ( ! defined( 'ABSPATH' ) ) { |
|
2 | +if (!defined('ABSPATH')) { |
|
3 | 3 | exit; |
4 | 4 | } |
5 | 5 | |
@@ -146,8 +146,8 @@ discard block |
||
146 | 146 | $this->state = wpinv_get_default_state(); |
147 | 147 | |
148 | 148 | // Do we have an actual submission? |
149 | - if ( isset( $_POST['getpaid_payment_form_submission'] ) ) { |
|
150 | - $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) ); |
|
149 | + if (isset($_POST['getpaid_payment_form_submission'])) { |
|
150 | + $this->load_data(wp_kses_post_deep(wp_unslash($_POST))); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | } |
@@ -157,16 +157,16 @@ discard block |
||
157 | 157 | * |
158 | 158 | * @param array $data |
159 | 159 | */ |
160 | - public function load_data( $data ) { |
|
160 | + public function load_data($data) { |
|
161 | 161 | |
162 | 162 | // Allow plugins to filter the data. |
163 | - $data = apply_filters( 'getpaid_submission_data', $data, $this ); |
|
163 | + $data = apply_filters('getpaid_submission_data', $data, $this); |
|
164 | 164 | |
165 | 165 | // Cache it... |
166 | 166 | $this->data = $data; |
167 | 167 | |
168 | 168 | // Then generate a unique id from the data. |
169 | - $this->id = md5( wp_json_encode( $data ) ); |
|
169 | + $this->id = md5(wp_json_encode($data)); |
|
170 | 170 | |
171 | 171 | // Finally, process the submission. |
172 | 172 | try { |
@@ -176,29 +176,29 @@ discard block |
||
176 | 176 | $processors = apply_filters( |
177 | 177 | 'getpaid_payment_form_submission_processors', |
178 | 178 | array( |
179 | - array( $this, 'process_payment_form' ), |
|
180 | - array( $this, 'process_invoice' ), |
|
181 | - array( $this, 'process_fees' ), |
|
182 | - array( $this, 'process_items' ), |
|
183 | - array( $this, 'process_discount' ), |
|
184 | - array( $this, 'process_taxes' ), |
|
179 | + array($this, 'process_payment_form'), |
|
180 | + array($this, 'process_invoice'), |
|
181 | + array($this, 'process_fees'), |
|
182 | + array($this, 'process_items'), |
|
183 | + array($this, 'process_discount'), |
|
184 | + array($this, 'process_taxes'), |
|
185 | 185 | ), |
186 | 186 | $this |
187 | 187 | ); |
188 | 188 | |
189 | - foreach ( $processors as $processor ) { |
|
190 | - call_user_func_array( $processor, array( &$this ) ); |
|
189 | + foreach ($processors as $processor) { |
|
190 | + call_user_func_array($processor, array(&$this)); |
|
191 | 191 | } |
192 | - } catch ( GetPaid_Payment_Exception $e ) { |
|
192 | + } catch (GetPaid_Payment_Exception $e) { |
|
193 | 193 | $this->last_error = $e->getMessage(); |
194 | 194 | $this->last_error_code = $e->getErrorCode(); |
195 | - } catch ( Exception $e ) { |
|
195 | + } catch (Exception $e) { |
|
196 | 196 | $this->last_error = $e->getMessage(); |
197 | 197 | $this->last_error_code = $e->getCode(); |
198 | 198 | } |
199 | 199 | |
200 | 200 | // Fired when we are done processing a submission. |
201 | - do_action_ref_array( 'getpaid_process_submission', array( &$this ) ); |
|
201 | + do_action_ref_array('getpaid_process_submission', array(&$this)); |
|
202 | 202 | |
203 | 203 | } |
204 | 204 | |
@@ -219,18 +219,18 @@ discard block |
||
219 | 219 | public function process_payment_form() { |
220 | 220 | |
221 | 221 | // Every submission needs an active payment form. |
222 | - if ( empty( $this->data['form_id'] ) ) { |
|
223 | - throw new Exception( __( 'Missing payment form', 'invoicing' ) ); |
|
222 | + if (empty($this->data['form_id'])) { |
|
223 | + throw new Exception(__('Missing payment form', 'invoicing')); |
|
224 | 224 | } |
225 | 225 | |
226 | 226 | // Fetch the payment form. |
227 | - $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] ); |
|
227 | + $this->payment_form = new GetPaid_Payment_Form($this->data['form_id']); |
|
228 | 228 | |
229 | - if ( ! $this->payment_form->is_active() ) { |
|
230 | - throw new Exception( __( 'Payment form not active', 'invoicing' ) ); |
|
229 | + if (!$this->payment_form->is_active()) { |
|
230 | + throw new Exception(__('Payment form not active', 'invoicing')); |
|
231 | 231 | } |
232 | 232 | |
233 | - do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) ); |
|
233 | + do_action_ref_array('getpaid_submissions_process_payment_form', array(&$this)); |
|
234 | 234 | } |
235 | 235 | |
236 | 236 | /** |
@@ -260,64 +260,64 @@ discard block |
||
260 | 260 | public function process_invoice() { |
261 | 261 | |
262 | 262 | // Abort if there is no invoice. |
263 | - if ( empty( $this->data['invoice_id'] ) ) { |
|
263 | + if (empty($this->data['invoice_id'])) { |
|
264 | 264 | |
265 | 265 | // Check if we are resuming a payment. |
266 | - if ( empty( $this->data['maybe_use_invoice'] ) ) { |
|
266 | + if (empty($this->data['maybe_use_invoice'])) { |
|
267 | 267 | return; |
268 | 268 | } |
269 | 269 | |
270 | - $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] ); |
|
271 | - if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) { |
|
270 | + $invoice = wpinv_get_invoice($this->data['maybe_use_invoice']); |
|
271 | + if (empty($invoice) || !$invoice->has_status('draft, auto-draft, wpi-pending')) { |
|
272 | 272 | return; |
273 | 273 | } |
274 | 274 | } |
275 | 275 | |
276 | 276 | // If the submission is for an existing invoice, ensure that it exists |
277 | 277 | // and that it is not paid for. |
278 | - if ( empty( $invoice ) ) { |
|
279 | - $invoice = wpinv_get_invoice( $this->data['invoice_id'] ); |
|
278 | + if (empty($invoice)) { |
|
279 | + $invoice = wpinv_get_invoice($this->data['invoice_id']); |
|
280 | 280 | } |
281 | 281 | |
282 | - if ( empty( $invoice ) ) { |
|
283 | - throw new Exception( __( 'Invalid invoice', 'invoicing' ) ); |
|
282 | + if (empty($invoice)) { |
|
283 | + throw new Exception(__('Invalid invoice', 'invoicing')); |
|
284 | 284 | } |
285 | 285 | |
286 | - if ( $invoice->is_paid() ) { |
|
287 | - throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) ); |
|
286 | + if ($invoice->is_paid()) { |
|
287 | + throw new Exception(__('This invoice is already paid for.', 'invoicing')); |
|
288 | 288 | } |
289 | 289 | |
290 | 290 | $this->payment_form->invoice = $invoice; |
291 | - if ( ! $this->payment_form->is_default() ) { |
|
291 | + if (!$this->payment_form->is_default()) { |
|
292 | 292 | |
293 | 293 | $items = array(); |
294 | 294 | $item_ids = array(); |
295 | 295 | |
296 | - foreach ( $invoice->get_items() as $item ) { |
|
297 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
296 | + foreach ($invoice->get_items() as $item) { |
|
297 | + if (!in_array($item->get_id(), $item_ids)) { |
|
298 | 298 | $item_ids[] = $item->get_id(); |
299 | 299 | $items[] = $item; |
300 | 300 | } |
301 | 301 | } |
302 | 302 | |
303 | - foreach ( $this->payment_form->get_items() as $item ) { |
|
304 | - if ( ! in_array( $item->get_id(), $item_ids ) ) { |
|
303 | + foreach ($this->payment_form->get_items() as $item) { |
|
304 | + if (!in_array($item->get_id(), $item_ids)) { |
|
305 | 305 | $item_ids[] = $item->get_id(); |
306 | 306 | $items[] = $item; |
307 | 307 | } |
308 | 308 | } |
309 | 309 | |
310 | - $this->payment_form->set_items( $items ); |
|
310 | + $this->payment_form->set_items($items); |
|
311 | 311 | |
312 | 312 | } else { |
313 | - $this->payment_form->set_items( $invoice->get_items() ); |
|
313 | + $this->payment_form->set_items($invoice->get_items()); |
|
314 | 314 | } |
315 | 315 | |
316 | 316 | $this->country = $invoice->get_country(); |
317 | 317 | $this->state = $invoice->get_state(); |
318 | 318 | $this->invoice = $invoice; |
319 | 319 | |
320 | - do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) ); |
|
320 | + do_action_ref_array('getpaid_submissions_process_invoice', array(&$this)); |
|
321 | 321 | } |
322 | 322 | |
323 | 323 | /** |
@@ -337,7 +337,7 @@ discard block |
||
337 | 337 | * @return bool |
338 | 338 | */ |
339 | 339 | public function has_invoice() { |
340 | - return ! empty( $this->invoice ); |
|
340 | + return !empty($this->invoice); |
|
341 | 341 | } |
342 | 342 | |
343 | 343 | /* |
@@ -356,13 +356,13 @@ discard block |
||
356 | 356 | */ |
357 | 357 | public function process_items() { |
358 | 358 | |
359 | - $processor = new GetPaid_Payment_Form_Submission_Items( $this ); |
|
359 | + $processor = new GetPaid_Payment_Form_Submission_Items($this); |
|
360 | 360 | |
361 | - foreach ( $processor->items as $item ) { |
|
362 | - $this->add_item( $item ); |
|
361 | + foreach ($processor->items as $item) { |
|
362 | + $this->add_item($item); |
|
363 | 363 | } |
364 | 364 | |
365 | - do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) ); |
|
365 | + do_action_ref_array('getpaid_submissions_process_items', array(&$this)); |
|
366 | 366 | } |
367 | 367 | |
368 | 368 | /** |
@@ -371,20 +371,20 @@ discard block |
||
371 | 371 | * @since 1.0.19 |
372 | 372 | * @param GetPaid_Form_Item $item |
373 | 373 | */ |
374 | - public function add_item( $item ) { |
|
374 | + public function add_item($item) { |
|
375 | 375 | |
376 | 376 | // Make sure that it is available for purchase. |
377 | - if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) { |
|
377 | + if (!$item->can_purchase() || isset($this->items[$item->get_id()])) { |
|
378 | 378 | return; |
379 | 379 | } |
380 | 380 | |
381 | 381 | // Each submission can only contain one recurring item. |
382 | - if ( $item->is_recurring() ) { |
|
382 | + if ($item->is_recurring()) { |
|
383 | 383 | $this->has_recurring = $item->get_id(); |
384 | 384 | } |
385 | 385 | |
386 | 386 | // Update the items and totals. |
387 | - $this->items[ $item->get_id() ] = $item; |
|
387 | + $this->items[$item->get_id()] = $item; |
|
388 | 388 | $this->totals['subtotal']['initial'] += $item->get_sub_total(); |
389 | 389 | $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total(); |
390 | 390 | |
@@ -398,17 +398,17 @@ discard block |
||
398 | 398 | * |
399 | 399 | * @since 1.0.19 |
400 | 400 | */ |
401 | - public function remove_item( $item_id ) { |
|
401 | + public function remove_item($item_id) { |
|
402 | 402 | |
403 | - if ( isset( $this->items[ $item_id ] ) ) { |
|
404 | - $this->totals['subtotal']['initial'] -= $this->items[ $item_id ]->get_sub_total(); |
|
405 | - $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total(); |
|
403 | + if (isset($this->items[$item_id])) { |
|
404 | + $this->totals['subtotal']['initial'] -= $this->items[$item_id]->get_sub_total(); |
|
405 | + $this->totals['subtotal']['recurring'] -= $this->items[$item_id]->get_recurring_sub_total(); |
|
406 | 406 | |
407 | - if ( $this->items[ $item_id ]->is_recurring() ) { |
|
407 | + if ($this->items[$item_id]->is_recurring()) { |
|
408 | 408 | $this->has_recurring = 0; |
409 | 409 | } |
410 | 410 | |
411 | - unset( $this->items[ $item_id ] ); |
|
411 | + unset($this->items[$item_id]); |
|
412 | 412 | } |
413 | 413 | |
414 | 414 | } |
@@ -420,7 +420,7 @@ discard block |
||
420 | 420 | */ |
421 | 421 | public function get_subtotal() { |
422 | 422 | |
423 | - if ( wpinv_prices_include_tax() ) { |
|
423 | + if (wpinv_prices_include_tax()) { |
|
424 | 424 | return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial']; |
425 | 425 | } |
426 | 426 | |
@@ -434,7 +434,7 @@ discard block |
||
434 | 434 | */ |
435 | 435 | public function get_recurring_subtotal() { |
436 | 436 | |
437 | - if ( wpinv_prices_include_tax() ) { |
|
437 | + if (wpinv_prices_include_tax()) { |
|
438 | 438 | return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring']; |
439 | 439 | } |
440 | 440 | |
@@ -458,7 +458,7 @@ discard block |
||
458 | 458 | * @return bool |
459 | 459 | */ |
460 | 460 | public function has_subscription_group() { |
461 | - return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) ); |
|
461 | + return $this->has_recurring && getpaid_should_group_subscriptions($this) && 1 == count(getpaid_get_subscription_groups($this)); |
|
462 | 462 | } |
463 | 463 | |
464 | 464 | /** |
@@ -468,7 +468,7 @@ discard block |
||
468 | 468 | * @return bool |
469 | 469 | */ |
470 | 470 | public function has_multiple_subscription_groups() { |
471 | - return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) ); |
|
471 | + return $this->has_recurring && 1 < count(getpaid_get_subscription_groups($this)); |
|
472 | 472 | } |
473 | 473 | |
474 | 474 | /* |
@@ -488,39 +488,39 @@ discard block |
||
488 | 488 | public function process_taxes() { |
489 | 489 | |
490 | 490 | // Abort if we're not using taxes. |
491 | - if ( ! $this->use_taxes() ) { |
|
491 | + if (!$this->use_taxes()) { |
|
492 | 492 | return; |
493 | 493 | } |
494 | 494 | |
495 | 495 | // If a custom country && state has been passed in, use it to calculate taxes. |
496 | - $country = $this->get_field( 'wpinv_country', 'billing' ); |
|
497 | - if ( ! empty( $country ) ) { |
|
496 | + $country = $this->get_field('wpinv_country', 'billing'); |
|
497 | + if (!empty($country)) { |
|
498 | 498 | $this->country = $country; |
499 | 499 | } |
500 | 500 | |
501 | - $state = $this->get_field( 'wpinv_state', 'billing' ); |
|
502 | - if ( ! empty( $state ) ) { |
|
501 | + $state = $this->get_field('wpinv_state', 'billing'); |
|
502 | + if (!empty($state)) { |
|
503 | 503 | $this->state = $state; |
504 | 504 | } |
505 | 505 | |
506 | 506 | // Confirm if the provided country and the ip country are similar. |
507 | - $address_confirmed = $this->get_field( 'confirm-address' ); |
|
508 | - if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) { |
|
509 | - throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) ); |
|
507 | + $address_confirmed = $this->get_field('confirm-address'); |
|
508 | + if (isset($_POST['billing']['country']) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty($address_confirmed)) { |
|
509 | + throw new Exception(__('The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing')); |
|
510 | 510 | } |
511 | 511 | |
512 | 512 | // Abort if the country is not taxable. |
513 | - if ( ! wpinv_is_country_taxable( $this->country ) ) { |
|
513 | + if (!wpinv_is_country_taxable($this->country)) { |
|
514 | 514 | return; |
515 | 515 | } |
516 | 516 | |
517 | - $processor = new GetPaid_Payment_Form_Submission_Taxes( $this ); |
|
517 | + $processor = new GetPaid_Payment_Form_Submission_Taxes($this); |
|
518 | 518 | |
519 | - foreach ( $processor->taxes as $tax ) { |
|
520 | - $this->add_tax( $tax ); |
|
519 | + foreach ($processor->taxes as $tax) { |
|
520 | + $this->add_tax($tax); |
|
521 | 521 | } |
522 | 522 | |
523 | - do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) ); |
|
523 | + do_action_ref_array('getpaid_submissions_process_taxes', array(&$this)); |
|
524 | 524 | } |
525 | 525 | |
526 | 526 | /** |
@@ -529,16 +529,16 @@ discard block |
||
529 | 529 | * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required. |
530 | 530 | * @since 1.0.19 |
531 | 531 | */ |
532 | - public function add_tax( $tax ) { |
|
532 | + public function add_tax($tax) { |
|
533 | 533 | |
534 | - if ( wpinv_round_tax_per_tax_rate() ) { |
|
535 | - $tax['initial_tax'] = wpinv_round_amount( $tax['initial_tax'] ); |
|
536 | - $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] ); |
|
534 | + if (wpinv_round_tax_per_tax_rate()) { |
|
535 | + $tax['initial_tax'] = wpinv_round_amount($tax['initial_tax']); |
|
536 | + $tax['recurring_tax'] = wpinv_round_amount($tax['recurring_tax']); |
|
537 | 537 | } |
538 | 538 | |
539 | - $this->taxes[ $tax['name'] ] = $tax; |
|
540 | - $this->totals['taxes']['initial'] += wpinv_sanitize_amount( $tax['initial_tax'] ); |
|
541 | - $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] ); |
|
539 | + $this->taxes[$tax['name']] = $tax; |
|
540 | + $this->totals['taxes']['initial'] += wpinv_sanitize_amount($tax['initial_tax']); |
|
541 | + $this->totals['taxes']['recurring'] += wpinv_sanitize_amount($tax['recurring_tax']); |
|
542 | 542 | |
543 | 543 | } |
544 | 544 | |
@@ -547,12 +547,12 @@ discard block |
||
547 | 547 | * |
548 | 548 | * @since 1.0.19 |
549 | 549 | */ |
550 | - public function remove_tax( $tax_name ) { |
|
550 | + public function remove_tax($tax_name) { |
|
551 | 551 | |
552 | - if ( isset( $this->taxes[ $tax_name ] ) ) { |
|
553 | - $this->totals['taxes']['initial'] -= $this->taxes[ $tax_name ]['initial_tax']; |
|
554 | - $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax']; |
|
555 | - unset( $this->taxes[ $tax_name ] ); |
|
552 | + if (isset($this->taxes[$tax_name])) { |
|
553 | + $this->totals['taxes']['initial'] -= $this->taxes[$tax_name]['initial_tax']; |
|
554 | + $this->totals['taxes']['recurring'] -= $this->taxes[$tax_name]['recurring_tax']; |
|
555 | + unset($this->taxes[$tax_name]); |
|
556 | 556 | } |
557 | 557 | |
558 | 558 | } |
@@ -566,11 +566,11 @@ discard block |
||
566 | 566 | |
567 | 567 | $use_taxes = wpinv_use_taxes(); |
568 | 568 | |
569 | - if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) { |
|
569 | + if ($this->has_invoice() && !$this->invoice->is_taxable()) { |
|
570 | 570 | $use_taxes = false; |
571 | 571 | } |
572 | 572 | |
573 | - return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this ); |
|
573 | + return apply_filters('getpaid_submission_use_taxes', $use_taxes, $this); |
|
574 | 574 | |
575 | 575 | } |
576 | 576 | |
@@ -619,13 +619,13 @@ discard block |
||
619 | 619 | |
620 | 620 | $initial_total = $this->get_subtotal() + $this->get_fee() + $this->get_tax(); |
621 | 621 | $recurring_total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax(); |
622 | - $processor = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total ); |
|
622 | + $processor = new GetPaid_Payment_Form_Submission_Discount($this, $initial_total, $recurring_total); |
|
623 | 623 | |
624 | - foreach ( $processor->discounts as $discount ) { |
|
625 | - $this->add_discount( $discount ); |
|
624 | + foreach ($processor->discounts as $discount) { |
|
625 | + $this->add_discount($discount); |
|
626 | 626 | } |
627 | 627 | |
628 | - do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) ); |
|
628 | + do_action_ref_array('getpaid_submissions_process_discounts', array(&$this)); |
|
629 | 629 | } |
630 | 630 | |
631 | 631 | /** |
@@ -634,10 +634,10 @@ discard block |
||
634 | 634 | * @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. |
635 | 635 | * @since 1.0.19 |
636 | 636 | */ |
637 | - public function add_discount( $discount ) { |
|
638 | - $this->discounts[ $discount['name'] ] = $discount; |
|
639 | - $this->totals['discount']['initial'] += wpinv_sanitize_amount( $discount['initial_discount'] ); |
|
640 | - $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] ); |
|
637 | + public function add_discount($discount) { |
|
638 | + $this->discounts[$discount['name']] = $discount; |
|
639 | + $this->totals['discount']['initial'] += wpinv_sanitize_amount($discount['initial_discount']); |
|
640 | + $this->totals['discount']['recurring'] += wpinv_sanitize_amount($discount['recurring_discount']); |
|
641 | 641 | } |
642 | 642 | |
643 | 643 | /** |
@@ -645,12 +645,12 @@ discard block |
||
645 | 645 | * |
646 | 646 | * @since 1.0.19 |
647 | 647 | */ |
648 | - public function remove_discount( $name ) { |
|
648 | + public function remove_discount($name) { |
|
649 | 649 | |
650 | - if ( isset( $this->discounts[ $name ] ) ) { |
|
651 | - $this->totals['discount']['initial'] -= $this->discounts[ $name ]['initial_discount']; |
|
652 | - $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount']; |
|
653 | - unset( $this->discounts[ $name ] ); |
|
650 | + if (isset($this->discounts[$name])) { |
|
651 | + $this->totals['discount']['initial'] -= $this->discounts[$name]['initial_discount']; |
|
652 | + $this->totals['discount']['recurring'] -= $this->discounts[$name]['recurring_discount']; |
|
653 | + unset($this->discounts[$name]); |
|
654 | 654 | } |
655 | 655 | |
656 | 656 | } |
@@ -662,7 +662,7 @@ discard block |
||
662 | 662 | * @return bool |
663 | 663 | */ |
664 | 664 | public function has_discount_code() { |
665 | - return ! empty( $this->discounts['discount_code'] ); |
|
665 | + return !empty($this->discounts['discount_code']); |
|
666 | 666 | } |
667 | 667 | |
668 | 668 | /** |
@@ -719,13 +719,13 @@ discard block |
||
719 | 719 | */ |
720 | 720 | public function process_fees() { |
721 | 721 | |
722 | - $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this ); |
|
722 | + $fees_processor = new GetPaid_Payment_Form_Submission_Fees($this); |
|
723 | 723 | |
724 | - foreach ( $fees_processor->fees as $fee ) { |
|
725 | - $this->add_fee( $fee ); |
|
724 | + foreach ($fees_processor->fees as $fee) { |
|
725 | + $this->add_fee($fee); |
|
726 | 726 | } |
727 | 727 | |
728 | - do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) ); |
|
728 | + do_action_ref_array('getpaid_submissions_process_fees', array(&$this)); |
|
729 | 729 | } |
730 | 730 | |
731 | 731 | /** |
@@ -734,17 +734,17 @@ discard block |
||
734 | 734 | * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
735 | 735 | * @since 1.0.19 |
736 | 736 | */ |
737 | - public function add_fee( $fee ) { |
|
737 | + public function add_fee($fee) { |
|
738 | 738 | |
739 | - if ( $fee['name'] == 'shipping' ) { |
|
740 | - $this->totals['shipping']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
741 | - $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
739 | + if ($fee['name'] == 'shipping') { |
|
740 | + $this->totals['shipping']['initial'] += wpinv_sanitize_amount($fee['initial_fee']); |
|
741 | + $this->totals['shipping']['recurring'] += wpinv_sanitize_amount($fee['recurring_fee']); |
|
742 | 742 | return; |
743 | 743 | } |
744 | 744 | |
745 | - $this->fees[ $fee['name'] ] = $fee; |
|
746 | - $this->totals['fees']['initial'] += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
747 | - $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] ); |
|
745 | + $this->fees[$fee['name']] = $fee; |
|
746 | + $this->totals['fees']['initial'] += wpinv_sanitize_amount($fee['initial_fee']); |
|
747 | + $this->totals['fees']['recurring'] += wpinv_sanitize_amount($fee['recurring_fee']); |
|
748 | 748 | |
749 | 749 | } |
750 | 750 | |
@@ -753,15 +753,15 @@ discard block |
||
753 | 753 | * |
754 | 754 | * @since 1.0.19 |
755 | 755 | */ |
756 | - public function remove_fee( $name ) { |
|
756 | + public function remove_fee($name) { |
|
757 | 757 | |
758 | - if ( isset( $this->fees[ $name ] ) ) { |
|
759 | - $this->totals['fees']['initial'] -= $this->fees[ $name ]['initial_fee']; |
|
760 | - $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee']; |
|
761 | - unset( $this->fees[ $name ] ); |
|
758 | + if (isset($this->fees[$name])) { |
|
759 | + $this->totals['fees']['initial'] -= $this->fees[$name]['initial_fee']; |
|
760 | + $this->totals['fees']['recurring'] -= $this->fees[$name]['recurring_fee']; |
|
761 | + unset($this->fees[$name]); |
|
762 | 762 | } |
763 | 763 | |
764 | - if ( 'shipping' == $name ) { |
|
764 | + if ('shipping' == $name) { |
|
765 | 765 | $this->totals['shipping']['initial'] = 0; |
766 | 766 | $this->totals['shipping']['recurring'] = 0; |
767 | 767 | } |
@@ -802,7 +802,7 @@ discard block |
||
802 | 802 | * @since 1.0.19 |
803 | 803 | */ |
804 | 804 | public function has_fees() { |
805 | - return count( $this->fees ) !== 0; |
|
805 | + return count($this->fees) !== 0; |
|
806 | 806 | } |
807 | 807 | |
808 | 808 | /* |
@@ -838,7 +838,7 @@ discard block |
||
838 | 838 | * @since 1.0.19 |
839 | 839 | */ |
840 | 840 | public function has_shipping() { |
841 | - return apply_filters( 'getpaid_payment_form_has_shipping', false, $this ); |
|
841 | + return apply_filters('getpaid_payment_form_has_shipping', false, $this); |
|
842 | 842 | } |
843 | 843 | |
844 | 844 | /** |
@@ -848,7 +848,7 @@ discard block |
||
848 | 848 | * @since 1.0.19 |
849 | 849 | */ |
850 | 850 | public function is_initial_fetch() { |
851 | - return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] ); |
|
851 | + return isset($this->data['initial_state']) && empty($this->data['initial_state']); |
|
852 | 852 | } |
853 | 853 | |
854 | 854 | /** |
@@ -858,7 +858,7 @@ discard block |
||
858 | 858 | */ |
859 | 859 | public function get_total() { |
860 | 860 | $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount(); |
861 | - return max( $total, 0 ); |
|
861 | + return max($total, 0); |
|
862 | 862 | } |
863 | 863 | |
864 | 864 | /** |
@@ -868,7 +868,7 @@ discard block |
||
868 | 868 | */ |
869 | 869 | public function get_recurring_total() { |
870 | 870 | $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount(); |
871 | - return max( $total, 0 ); |
|
871 | + return max($total, 0); |
|
872 | 872 | } |
873 | 873 | |
874 | 874 | /** |
@@ -880,12 +880,12 @@ discard block |
||
880 | 880 | $initial = $this->get_total(); |
881 | 881 | $recurring = $this->get_recurring_total(); |
882 | 882 | |
883 | - if ( $this->has_recurring == 0 ) { |
|
883 | + if ($this->has_recurring == 0) { |
|
884 | 884 | $recurring = 0; |
885 | 885 | } |
886 | 886 | |
887 | 887 | $collect = $initial > 0 || $recurring > 0; |
888 | - return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this ); |
|
888 | + return apply_filters('getpaid_submission_should_collect_payment_details', $collect, $this); |
|
889 | 889 | } |
890 | 890 | |
891 | 891 | /** |
@@ -894,7 +894,7 @@ discard block |
||
894 | 894 | * @since 1.0.19 |
895 | 895 | */ |
896 | 896 | public function get_billing_email() { |
897 | - return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this ); |
|
897 | + return apply_filters('getpaid_get_submission_billing_email', $this->get_field('billing_email'), $this); |
|
898 | 898 | } |
899 | 899 | |
900 | 900 | /** |
@@ -904,7 +904,7 @@ discard block |
||
904 | 904 | */ |
905 | 905 | public function has_billing_email() { |
906 | 906 | $billing_email = $this->get_billing_email(); |
907 | - return ! empty( $billing_email ) && is_email( $billing_email ); |
|
907 | + return !empty($billing_email) && is_email($billing_email); |
|
908 | 908 | } |
909 | 909 | |
910 | 910 | /** |
@@ -934,8 +934,8 @@ discard block |
||
934 | 934 | * @since 1.0.19 |
935 | 935 | * @return mixed|null |
936 | 936 | */ |
937 | - public function get_field( $field, $sub_array_key = null ) { |
|
938 | - return getpaid_get_array_field( $this->data, $field, $sub_array_key ); |
|
937 | + public function get_field($field, $sub_array_key = null) { |
|
938 | + return getpaid_get_array_field($this->data, $field, $sub_array_key); |
|
939 | 939 | } |
940 | 940 | |
941 | 941 | /** |
@@ -943,8 +943,8 @@ discard block |
||
943 | 943 | * |
944 | 944 | * @since 1.0.19 |
945 | 945 | */ |
946 | - public function is_required_field_set( $field ) { |
|
947 | - return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] ); |
|
946 | + public function is_required_field_set($field) { |
|
947 | + return empty($field['required']) || !empty($this->data[$field['id']]); |
|
948 | 948 | } |
949 | 949 | |
950 | 950 | /** |
@@ -952,8 +952,8 @@ discard block |
||
952 | 952 | * |
953 | 953 | * @since 1.0.19 |
954 | 954 | */ |
955 | - public function format_amount( $amount ) { |
|
956 | - return wpinv_price( $amount, $this->get_currency() ); |
|
955 | + public function format_amount($amount) { |
|
956 | + return wpinv_price($amount, $this->get_currency()); |
|
957 | 957 | } |
958 | 958 | |
959 | 959 | } |
@@ -52,27 +52,27 @@ |
||
52 | 52 | |
53 | 53 | // Total Fee. |
54 | 54 | if ( 'fee' === $key ) { |
55 | - wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() ); |
|
55 | + wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() ); |
|
56 | 56 | } |
57 | 57 | |
58 | 58 | // Total discount. |
59 | 59 | if ( 'discount' === $key ) { |
60 | - wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() ); |
|
60 | + wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() ); |
|
61 | 61 | } |
62 | 62 | |
63 | 63 | // Shipping. |
64 | 64 | if ( 'shipping' === $key ) { |
65 | - wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() ); |
|
65 | + wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() ); |
|
66 | 66 | } |
67 | 67 | |
68 | 68 | // Sub total. |
69 | 69 | if ( 'subtotal' === $key ) { |
70 | - wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() ); |
|
70 | + wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() ); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | // Total. |
74 | 74 | if ( 'total' === $key ) { |
75 | - wpinv_the_price( $invoice->get_total(), $invoice->get_currency() ); |
|
75 | + wpinv_the_price( $invoice->get_total(), $invoice->get_currency() ); |
|
76 | 76 | } |
77 | 77 | |
78 | 78 | // Fires when printing a cart total. |
@@ -9,26 +9,26 @@ discard block |
||
9 | 9 | * @var WPInv_Invoice $invoice |
10 | 10 | */ |
11 | 11 | |
12 | -defined( 'ABSPATH' ) || exit; |
|
12 | +defined('ABSPATH') || exit; |
|
13 | 13 | |
14 | 14 | // Totals rows. |
15 | -$totals = getpaid_invoice_totals_rows( $invoice ); |
|
15 | +$totals = getpaid_invoice_totals_rows($invoice); |
|
16 | 16 | |
17 | -do_action( 'getpaid_before_invoice_line_totals', $invoice, $totals ); |
|
17 | +do_action('getpaid_before_invoice_line_totals', $invoice, $totals); |
|
18 | 18 | |
19 | 19 | ?> |
20 | 20 | <div class='getpaid-invoice-line-totals'> |
21 | 21 | <div class="row"> |
22 | 22 | <div class="col-12 offset-sm-6 col-sm-6 border-sm-left pl-sm-0"> |
23 | 23 | |
24 | - <?php foreach ( $totals as $key => $label ) : ?> |
|
24 | + <?php foreach ($totals as $key => $label) : ?> |
|
25 | 25 | |
26 | - <div class="getpaid-invoice-line-totals-col <?php echo esc_attr( $key ); ?>"> |
|
26 | + <div class="getpaid-invoice-line-totals-col <?php echo esc_attr($key); ?>"> |
|
27 | 27 | |
28 | 28 | <div class="form-row row"> |
29 | 29 | |
30 | 30 | <div class="col-8 getpaid-invoice-line-totals-label"> |
31 | - <?php echo esc_html( $label ); ?> |
|
31 | + <?php echo esc_html($label); ?> |
|
32 | 32 | </div> |
33 | 33 | |
34 | 34 | <div class="col-4 getpaid-invoice-line-totals-value pl-0"> |
@@ -36,62 +36,62 @@ discard block |
||
36 | 36 | <?php |
37 | 37 | |
38 | 38 | // Total tax. |
39 | - if ( 'tax' === $key ) { |
|
40 | - wpinv_the_price( $invoice->get_total_tax(), $invoice->get_currency() ); |
|
39 | + if ('tax' === $key) { |
|
40 | + wpinv_the_price($invoice->get_total_tax(), $invoice->get_currency()); |
|
41 | 41 | |
42 | - if ( wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) { |
|
42 | + if (wpinv_use_taxes() && !$invoice->get_disable_taxes()) { |
|
43 | 43 | |
44 | 44 | $taxes = $invoice->get_total_tax(); |
45 | - if ( empty( $taxes ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) { |
|
45 | + if (empty($taxes) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction($invoice->get_country())) { |
|
46 | 46 | echo ' <em class="text-muted small">'; |
47 | - _x( '(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing' ); |
|
47 | + _x('(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing'); |
|
48 | 48 | echo '</em>'; |
49 | 49 | } |
50 | 50 | } |
51 | 51 | } |
52 | 52 | |
53 | 53 | // Check if field starts with tax__. |
54 | - if ( 0 === strpos( $key, 'tax__' ) ) { |
|
55 | - $tax_amount = $invoice->get_tax_total_by_name( str_replace( 'tax__', '', $key ) ); |
|
56 | - wpinv_the_price( $tax_amount, $invoice->get_currency() ); |
|
54 | + if (0 === strpos($key, 'tax__')) { |
|
55 | + $tax_amount = $invoice->get_tax_total_by_name(str_replace('tax__', '', $key)); |
|
56 | + wpinv_the_price($tax_amount, $invoice->get_currency()); |
|
57 | 57 | |
58 | - if ( wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) { |
|
58 | + if (wpinv_use_taxes() && !$invoice->get_disable_taxes()) { |
|
59 | 59 | |
60 | - if ( empty( $tax_amount ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) { |
|
60 | + if (empty($tax_amount) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction($invoice->get_country())) { |
|
61 | 61 | echo ' <em class="text-muted small">'; |
62 | - _x( '(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing' ); |
|
62 | + _x('(Reverse charged)', 'This is a legal term for reverse charging tax in the EU', 'invoicing'); |
|
63 | 63 | echo '</em>'; |
64 | 64 | } |
65 | 65 | } |
66 | 66 | } |
67 | 67 | |
68 | 68 | // Total Fee. |
69 | - if ( 'fee' === $key ) { |
|
70 | - wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() ); |
|
69 | + if ('fee' === $key) { |
|
70 | + wpinv_the_price($invoice->get_total_fees(), $invoice->get_currency()); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | // Total discount. |
74 | - if ( 'discount' === $key ) { |
|
75 | - wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() ); |
|
74 | + if ('discount' === $key) { |
|
75 | + wpinv_the_price($invoice->get_total_discount(), $invoice->get_currency()); |
|
76 | 76 | } |
77 | 77 | |
78 | 78 | // Shipping. |
79 | - if ( 'shipping' === $key ) { |
|
80 | - wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() ); |
|
79 | + if ('shipping' === $key) { |
|
80 | + wpinv_the_price($invoice->get_shipping(), $invoice->get_currency()); |
|
81 | 81 | } |
82 | 82 | |
83 | 83 | // Sub total. |
84 | - if ( 'subtotal' === $key ) { |
|
85 | - wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() ); |
|
84 | + if ('subtotal' === $key) { |
|
85 | + wpinv_the_price($invoice->get_subtotal(), $invoice->get_currency()); |
|
86 | 86 | } |
87 | 87 | |
88 | 88 | // Total. |
89 | - if ( 'total' === $key ) { |
|
90 | - wpinv_the_price( $invoice->get_total(), $invoice->get_currency() ); |
|
89 | + if ('total' === $key) { |
|
90 | + wpinv_the_price($invoice->get_total(), $invoice->get_currency()); |
|
91 | 91 | } |
92 | 92 | |
93 | 93 | // Fires when printing a cart total. |
94 | - do_action( "getpaid_invoice_cart_totals_$key", $invoice ); |
|
94 | + do_action("getpaid_invoice_cart_totals_$key", $invoice); |
|
95 | 95 | |
96 | 96 | ?> |
97 | 97 | |
@@ -105,4 +105,4 @@ discard block |
||
105 | 105 | </div> |
106 | 106 | </div> <!-- end .getpaid-invoice-line-totals --> |
107 | 107 | |
108 | -<?php do_action( 'getpaid_after_invoice_line_totals', $invoice, $totals ); ?> |
|
108 | +<?php do_action('getpaid_after_invoice_line_totals', $invoice, $totals); ?> |
@@ -18,688 +18,688 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * Route base. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $rest_base = 'reports/sales'; |
|
27 | - |
|
28 | - /** |
|
29 | - * The report data. |
|
30 | - * |
|
31 | - * @var stdClass |
|
32 | - */ |
|
33 | - public $report_data; |
|
34 | - |
|
35 | - /** |
|
36 | - * The report range. |
|
37 | - * |
|
38 | - * @var array |
|
39 | - */ |
|
40 | - public $report_range; |
|
41 | - |
|
42 | - /** |
|
43 | - * Registers the routes for the objects of the controller. |
|
44 | - * |
|
45 | - * @since 2.0.0 |
|
46 | - * |
|
47 | - * @see register_rest_route() |
|
48 | - */ |
|
49 | - public function register_namespace_routes( $namespace ) { |
|
50 | - |
|
51 | - // Get sales report. |
|
52 | - register_rest_route( |
|
53 | - $namespace, |
|
54 | - $this->rest_base, |
|
55 | - array( |
|
56 | - array( |
|
57 | - 'methods' => WP_REST_Server::READABLE, |
|
58 | - 'callback' => array( $this, 'get_items' ), |
|
59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | - 'args' => $this->get_collection_params(), |
|
61 | - ), |
|
62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
63 | - ) |
|
64 | - ); |
|
65 | - |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Makes sure the current user has access to READ the report APIs. |
|
70 | - * |
|
71 | - * @since 2.0.0 |
|
72 | - * @param WP_REST_Request $request Full data about the request. |
|
73 | - * @return WP_Error|boolean |
|
74 | - */ |
|
75 | - public function get_items_permissions_check( $request ) { |
|
76 | - |
|
77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | - } |
|
80 | - |
|
81 | - return true; |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * Get sales reports. |
|
86 | - * |
|
87 | - * @param WP_REST_Request $request |
|
88 | - * @return array|WP_Error |
|
89 | - */ |
|
90 | - public function get_items( $request ) { |
|
91 | - $data = array(); |
|
92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | - |
|
95 | - return rest_ensure_response( $data ); |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Prepare a report sales object for serialization. |
|
100 | - * |
|
101 | - * @param null $_ |
|
102 | - * @param WP_REST_Request $request Request object. |
|
103 | - * @return WP_REST_Response $response Response data. |
|
104 | - */ |
|
105 | - public function prepare_item_for_response( $_, $request ) { |
|
106 | - |
|
107 | - // Set report range. |
|
108 | - $this->report_range = $this->get_date_range( $request ); |
|
109 | - |
|
110 | - $report_data = $this->get_report_data(); |
|
111 | - $period_totals = array(); |
|
112 | - |
|
113 | - // Setup period totals by ensuring each period in the interval has data. |
|
114 | - $start_date = strtotime( $this->report_range['after'] ); |
|
115 | - |
|
116 | - if ( 'month' === $this->groupby ) { |
|
117 | - $start_date = strtotime( gmdate( 'Y-m-01', $start_date ) ); |
|
118 | - } |
|
119 | - |
|
120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | - |
|
122 | - switch ( $this->groupby ) { |
|
123 | - case 'day': |
|
124 | - $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | - break; |
|
126 | - default: |
|
127 | - $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | - break; |
|
129 | - } |
|
130 | - |
|
131 | - // Set the defaults for each period. |
|
132 | - $period_totals[ $time ] = array( |
|
133 | - 'invoices' => 0, |
|
134 | - 'items' => 0, |
|
135 | - 'refunded_items' => 0, |
|
136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | - ); |
|
142 | - |
|
143 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | - } |
|
147 | - } |
|
148 | - } |
|
149 | - |
|
150 | - // add total sales, total invoice count, total tax for each period |
|
151 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | - foreach ( $report_data->invoices as $invoice ) { |
|
153 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
154 | - |
|
155 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | - continue; |
|
157 | - } |
|
158 | - |
|
159 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
163 | - |
|
164 | - } |
|
165 | - |
|
166 | - foreach ( $report_data->refunds as $invoice ) { |
|
167 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
168 | - |
|
169 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | - continue; |
|
171 | - } |
|
172 | - |
|
173 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
177 | - |
|
178 | - } |
|
179 | - |
|
180 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
182 | - |
|
183 | - if ( isset( $period_totals[ $time ] ) ) { |
|
184 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - // Add total invoice items for each period. |
|
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | - |
|
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | - } |
|
195 | - } |
|
196 | - |
|
197 | - // Add total discount for each period. |
|
198 | - foreach ( $report_data->coupons as $discount ) { |
|
199 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) ); |
|
200 | - |
|
201 | - if ( isset( $period_totals[ $time ] ) ) { |
|
202 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | - } |
|
204 | - } |
|
205 | - |
|
206 | - // Extra fields. |
|
207 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | - |
|
209 | - // Abort unprepared. |
|
210 | - if ( ! isset( $report_data->$key ) ) { |
|
211 | - continue; |
|
212 | - } |
|
213 | - |
|
214 | - // Abort defaults. |
|
215 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | - continue; |
|
217 | - } |
|
218 | - |
|
219 | - // Set values. |
|
220 | - foreach ( $report_data->$key as $item ) { |
|
221 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) ); |
|
222 | - |
|
223 | - if ( isset( $period_totals[ $time ] ) ) { |
|
224 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - unset( $report_data->$key ); |
|
229 | - } |
|
230 | - |
|
231 | - $report_data->totals = $period_totals; |
|
232 | - $report_data->grouped_by = $this->groupby; |
|
233 | - $report_data->interval = max( $this->interval, 1 ); |
|
234 | - $report_data->currency = wpinv_get_currency(); |
|
235 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | - $report_data->currency_position = wpinv_currency_position(); |
|
237 | - $report_data->decimal_places = wpinv_decimals(); |
|
238 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | - $report_data->start_date = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ); |
|
241 | - $report_data->end_date = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ); |
|
242 | - $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) ); |
|
243 | - $report_data->end_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) ); |
|
244 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | - |
|
246 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | - $data = $report_data; |
|
248 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | - $data = $this->filter_response_by_context( $data, $context ); |
|
251 | - |
|
252 | - // Wrap the data in a response object. |
|
253 | - $response = rest_ensure_response( $data ); |
|
254 | - $response->add_links( |
|
21 | + /** |
|
22 | + * Route base. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $rest_base = 'reports/sales'; |
|
27 | + |
|
28 | + /** |
|
29 | + * The report data. |
|
30 | + * |
|
31 | + * @var stdClass |
|
32 | + */ |
|
33 | + public $report_data; |
|
34 | + |
|
35 | + /** |
|
36 | + * The report range. |
|
37 | + * |
|
38 | + * @var array |
|
39 | + */ |
|
40 | + public $report_range; |
|
41 | + |
|
42 | + /** |
|
43 | + * Registers the routes for the objects of the controller. |
|
44 | + * |
|
45 | + * @since 2.0.0 |
|
46 | + * |
|
47 | + * @see register_rest_route() |
|
48 | + */ |
|
49 | + public function register_namespace_routes( $namespace ) { |
|
50 | + |
|
51 | + // Get sales report. |
|
52 | + register_rest_route( |
|
53 | + $namespace, |
|
54 | + $this->rest_base, |
|
255 | 55 | array( |
256 | - 'about' => array( |
|
257 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | - ), |
|
56 | + array( |
|
57 | + 'methods' => WP_REST_Server::READABLE, |
|
58 | + 'callback' => array( $this, 'get_items' ), |
|
59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
60 | + 'args' => $this->get_collection_params(), |
|
61 | + ), |
|
62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
259 | 63 | ) |
260 | 64 | ); |
261 | 65 | |
262 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Get report data. |
|
267 | - * |
|
268 | - * @return stdClass |
|
269 | - */ |
|
270 | - public function get_report_data() { |
|
271 | - if ( empty( $this->report_data ) ) { |
|
272 | - $this->query_report_data(); |
|
273 | - } |
|
274 | - return $this->report_data; |
|
275 | - } |
|
276 | - |
|
277 | - /** |
|
278 | - * Get all data needed for this report and store in the class. |
|
279 | - */ |
|
280 | - protected function query_report_data() { |
|
281 | - |
|
282 | - // Prepare reports. |
|
283 | - $this->report_data = (object) array( |
|
284 | - 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | - 'previous_range' => $this->previous_range, |
|
291 | - ); |
|
292 | - |
|
293 | - // Calculated totals. |
|
294 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | - |
|
307 | - // Calculate average based on net. |
|
308 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | - |
|
311 | - // Total invoices in this period, even if refunded. |
|
312 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | - |
|
314 | - // Items invoiced in this period, even if refunded. |
|
315 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | - |
|
317 | - // 3rd party filtering of report data |
|
318 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | - } |
|
320 | - |
|
321 | - /** |
|
322 | - * Prepares invoice counts. |
|
323 | - * |
|
324 | - * @return array. |
|
325 | - */ |
|
326 | - protected function query_invoice_counts() { |
|
327 | - |
|
328 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | - array( |
|
330 | - 'data' => array( |
|
331 | - 'ID' => array( |
|
332 | - 'type' => 'post_data', |
|
333 | - 'function' => 'COUNT', |
|
334 | - 'name' => 'count', |
|
335 | - 'distinct' => true, |
|
336 | - ), |
|
337 | - 'post_date' => array( |
|
338 | - 'type' => 'post_data', |
|
339 | - 'function' => 'MIN', |
|
340 | - 'name' => 'post_date', |
|
341 | - ), |
|
342 | - ), |
|
343 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | - 'order_by' => 'post_date ASC', |
|
345 | - 'query_type' => 'get_results', |
|
346 | - 'filter_range' => $this->report_range, |
|
347 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | - ) |
|
349 | - ); |
|
350 | - |
|
351 | - } |
|
352 | - |
|
353 | - /** |
|
354 | - * Prepares coupon counts. |
|
355 | - * |
|
356 | - * @return array. |
|
357 | - */ |
|
358 | - protected function query_coupon_counts() { |
|
359 | - |
|
360 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | - array( |
|
362 | - 'data' => array( |
|
363 | - 'discount' => array( |
|
364 | - 'type' => 'invoice_data', |
|
365 | - 'function' => 'SUM', |
|
366 | - 'name' => 'discount_amount', |
|
367 | - ), |
|
368 | - 'post_date' => array( |
|
369 | - 'type' => 'post_data', |
|
370 | - 'function' => 'MIN', |
|
371 | - 'name' => 'post_date', |
|
372 | - ), |
|
373 | - ), |
|
374 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | - 'order_by' => 'post_date ASC', |
|
376 | - 'query_type' => 'get_results', |
|
377 | - 'filter_range' => $this->report_range, |
|
378 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | - ) |
|
380 | - ); |
|
381 | - |
|
382 | - } |
|
383 | - |
|
384 | - /** |
|
385 | - * Prepares item counts. |
|
386 | - * |
|
387 | - * @return array. |
|
388 | - */ |
|
389 | - protected function query_item_counts() { |
|
390 | - |
|
391 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
392 | - array( |
|
393 | - 'data' => array( |
|
394 | - 'quantity' => array( |
|
395 | - 'type' => 'invoice_item', |
|
396 | - 'function' => 'SUM', |
|
397 | - 'name' => 'invoice_item_count', |
|
398 | - ), |
|
399 | - 'post_date' => array( |
|
400 | - 'type' => 'post_data', |
|
401 | - 'function' => 'MIN', |
|
402 | - 'name' => 'post_date', |
|
403 | - ), |
|
404 | - ), |
|
405 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | - 'order_by' => 'post_date ASC', |
|
407 | - 'query_type' => 'get_results', |
|
408 | - 'filter_range' => $this->report_range, |
|
409 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
410 | - ) |
|
411 | - ); |
|
412 | - |
|
413 | - } |
|
414 | - |
|
415 | - /** |
|
416 | - * Prepares refunded item counts. |
|
417 | - * |
|
418 | - * @return array. |
|
419 | - */ |
|
420 | - protected function count_refunded_items() { |
|
421 | - |
|
422 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | - array( |
|
424 | - 'data' => array( |
|
425 | - 'quantity' => array( |
|
426 | - 'type' => 'invoice_item', |
|
427 | - 'function' => 'SUM', |
|
428 | - 'name' => 'invoice_item_count', |
|
429 | - ), |
|
430 | - ), |
|
431 | - 'query_type' => 'get_var', |
|
432 | - 'filter_range' => $this->report_range, |
|
433 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | - ) |
|
435 | - ); |
|
436 | - |
|
437 | - } |
|
438 | - |
|
439 | - /** |
|
440 | - * Prepares daily invoice totals. |
|
441 | - * |
|
442 | - * @return array. |
|
443 | - */ |
|
444 | - protected function query_invoice_totals() { |
|
445 | - |
|
446 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | - array( |
|
448 | - 'data' => array( |
|
449 | - 'total' => array( |
|
450 | - 'type' => 'invoice_data', |
|
451 | - 'function' => 'SUM', |
|
452 | - 'name' => 'total_sales', |
|
453 | - ), |
|
454 | - 'tax' => array( |
|
455 | - 'type' => 'invoice_data', |
|
456 | - 'function' => 'SUM', |
|
457 | - 'name' => 'total_tax', |
|
458 | - ), |
|
459 | - 'discount' => array( |
|
460 | - 'type' => 'invoice_data', |
|
461 | - 'function' => 'SUM', |
|
462 | - 'name' => 'total_discount', |
|
463 | - ), |
|
464 | - 'fees_total' => array( |
|
465 | - 'type' => 'invoice_data', |
|
466 | - 'function' => 'SUM', |
|
467 | - 'name' => 'total_fees', |
|
468 | - ), |
|
469 | - 'subtotal' => array( |
|
470 | - 'type' => 'invoice_data', |
|
471 | - 'function' => 'SUM', |
|
472 | - 'name' => 'subtotal', |
|
473 | - ), |
|
474 | - 'post_date' => array( |
|
475 | - 'type' => 'post_data', |
|
476 | - 'function' => '', |
|
477 | - 'name' => 'post_date', |
|
478 | - ), |
|
479 | - ), |
|
480 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | - 'order_by' => 'post_date ASC', |
|
482 | - 'query_type' => 'get_results', |
|
483 | - 'filter_range' => $this->report_range, |
|
484 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | - ) |
|
486 | - ); |
|
487 | - |
|
488 | - } |
|
489 | - |
|
490 | - /** |
|
491 | - * Prepares daily invoice totals. |
|
492 | - * |
|
493 | - * @return array. |
|
494 | - */ |
|
495 | - protected function query_refunded_totals() { |
|
496 | - |
|
497 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | - array( |
|
499 | - 'data' => array( |
|
500 | - 'total' => array( |
|
501 | - 'type' => 'invoice_data', |
|
502 | - 'function' => 'SUM', |
|
503 | - 'name' => 'total_sales', |
|
504 | - ), |
|
505 | - 'tax' => array( |
|
506 | - 'type' => 'invoice_data', |
|
507 | - 'function' => 'SUM', |
|
508 | - 'name' => 'total_tax', |
|
509 | - ), |
|
510 | - 'discount' => array( |
|
511 | - 'type' => 'invoice_data', |
|
512 | - 'function' => 'SUM', |
|
513 | - 'name' => 'total_discount', |
|
514 | - ), |
|
515 | - 'fees_total' => array( |
|
516 | - 'type' => 'invoice_data', |
|
517 | - 'function' => 'SUM', |
|
518 | - 'name' => 'total_fees', |
|
519 | - ), |
|
520 | - 'subtotal' => array( |
|
521 | - 'type' => 'invoice_data', |
|
522 | - 'function' => 'SUM', |
|
523 | - 'name' => 'subtotal', |
|
524 | - ), |
|
525 | - 'post_date' => array( |
|
526 | - 'type' => 'post_data', |
|
527 | - 'function' => '', |
|
528 | - 'name' => 'post_date', |
|
529 | - ), |
|
530 | - ), |
|
531 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | - 'order_by' => 'post_date ASC', |
|
533 | - 'query_type' => 'get_results', |
|
534 | - 'filter_range' => $this->report_range, |
|
535 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | - ) |
|
537 | - ); |
|
538 | - |
|
539 | - } |
|
540 | - |
|
541 | - /** |
|
542 | - * Get the Report's schema, conforming to JSON Schema. |
|
543 | - * |
|
544 | - * @return array |
|
545 | - */ |
|
546 | - public function get_item_schema() { |
|
547 | - |
|
548 | - $schema = array( |
|
549 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | - 'title' => 'sales_report', |
|
551 | - 'type' => 'object', |
|
552 | - 'properties' => array( |
|
553 | - 'total_sales' => array( |
|
554 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | - 'type' => 'string', |
|
556 | - 'context' => array( 'view' ), |
|
557 | - 'readonly' => true, |
|
558 | - ), |
|
559 | - 'net_sales' => array( |
|
560 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | - 'type' => 'string', |
|
562 | - 'context' => array( 'view' ), |
|
563 | - 'readonly' => true, |
|
564 | - ), |
|
565 | - 'average_sales' => array( |
|
566 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | - 'type' => 'string', |
|
568 | - 'context' => array( 'view' ), |
|
569 | - 'readonly' => true, |
|
570 | - ), |
|
571 | - 'average_total_sales' => array( |
|
572 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | - 'type' => 'string', |
|
574 | - 'context' => array( 'view' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'total_invoices' => array( |
|
578 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | - 'type' => 'integer', |
|
580 | - 'context' => array( 'view' ), |
|
581 | - 'readonly' => true, |
|
582 | - ), |
|
583 | - 'total_items' => array( |
|
584 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | - 'type' => 'integer', |
|
586 | - 'context' => array( 'view' ), |
|
587 | - 'readonly' => true, |
|
588 | - ), |
|
589 | - 'refunded_items' => array( |
|
590 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | - 'type' => 'integer', |
|
592 | - 'context' => array( 'view' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'total_tax' => array( |
|
596 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | - 'type' => 'string', |
|
598 | - 'context' => array( 'view' ), |
|
599 | - 'readonly' => true, |
|
600 | - ), |
|
601 | - 'total_refunded_tax' => array( |
|
602 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | - 'type' => 'string', |
|
604 | - 'context' => array( 'view' ), |
|
605 | - 'readonly' => true, |
|
606 | - ), |
|
607 | - 'total_fees' => array( |
|
608 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | - 'type' => 'string', |
|
610 | - 'context' => array( 'view' ), |
|
611 | - 'readonly' => true, |
|
612 | - ), |
|
613 | - 'total_refunds' => array( |
|
614 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | - 'type' => 'integer', |
|
616 | - 'context' => array( 'view' ), |
|
617 | - 'readonly' => true, |
|
618 | - ), |
|
619 | - 'net_refunds' => array( |
|
620 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | - 'type' => 'integer', |
|
622 | - 'context' => array( 'view' ), |
|
623 | - 'readonly' => true, |
|
624 | - ), |
|
625 | - 'total_discount' => array( |
|
626 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | - 'type' => 'integer', |
|
628 | - 'context' => array( 'view' ), |
|
629 | - 'readonly' => true, |
|
630 | - ), |
|
631 | - 'totals' => array( |
|
632 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | - 'type' => 'array', |
|
634 | - 'items' => array( |
|
635 | - 'type' => 'array', |
|
636 | - ), |
|
637 | - 'context' => array( 'view' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
640 | - 'interval' => array( |
|
641 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | - 'type' => 'integer', |
|
643 | - 'context' => array( 'view' ), |
|
644 | - 'readonly' => true, |
|
645 | - ), |
|
646 | - 'previous_range' => array( |
|
647 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | - 'type' => 'array', |
|
649 | - 'items' => array( |
|
650 | - 'type' => 'string', |
|
651 | - ), |
|
652 | - 'context' => array( 'view' ), |
|
653 | - 'readonly' => true, |
|
654 | - ), |
|
655 | - 'grouped_by' => array( |
|
656 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | - 'type' => 'string', |
|
658 | - 'context' => array( 'view' ), |
|
659 | - 'enum' => array( 'day', 'month' ), |
|
660 | - 'readonly' => true, |
|
661 | - ), |
|
662 | - 'currency' => array( |
|
663 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | - 'type' => 'string', |
|
665 | - 'context' => array( 'view' ), |
|
666 | - 'readonly' => true, |
|
667 | - ), |
|
668 | - 'currency_symbol' => array( |
|
669 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | - 'type' => 'string', |
|
671 | - 'context' => array( 'view' ), |
|
672 | - 'readonly' => true, |
|
673 | - ), |
|
674 | - 'currency_position' => array( |
|
675 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | - 'type' => 'string', |
|
677 | - 'context' => array( 'view' ), |
|
678 | - 'readonly' => true, |
|
679 | - ), |
|
680 | - 'decimal_places' => array( |
|
681 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | - 'type' => 'string', |
|
683 | - 'context' => array( 'view' ), |
|
684 | - 'readonly' => true, |
|
685 | - ), |
|
686 | - 'thousands_sep' => array( |
|
687 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | - 'type' => 'string', |
|
689 | - 'context' => array( 'view' ), |
|
690 | - 'readonly' => true, |
|
691 | - ), |
|
692 | - 'decimals_sep' => array( |
|
693 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | - 'type' => 'string', |
|
695 | - 'context' => array( 'view' ), |
|
696 | - 'readonly' => true, |
|
697 | - ), |
|
698 | - ), |
|
699 | - ); |
|
700 | - |
|
701 | - return $this->add_additional_fields_schema( $schema ); |
|
702 | - |
|
703 | - } |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Makes sure the current user has access to READ the report APIs. |
|
70 | + * |
|
71 | + * @since 2.0.0 |
|
72 | + * @param WP_REST_Request $request Full data about the request. |
|
73 | + * @return WP_Error|boolean |
|
74 | + */ |
|
75 | + public function get_items_permissions_check( $request ) { |
|
76 | + |
|
77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
79 | + } |
|
80 | + |
|
81 | + return true; |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * Get sales reports. |
|
86 | + * |
|
87 | + * @param WP_REST_Request $request |
|
88 | + * @return array|WP_Error |
|
89 | + */ |
|
90 | + public function get_items( $request ) { |
|
91 | + $data = array(); |
|
92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
94 | + |
|
95 | + return rest_ensure_response( $data ); |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Prepare a report sales object for serialization. |
|
100 | + * |
|
101 | + * @param null $_ |
|
102 | + * @param WP_REST_Request $request Request object. |
|
103 | + * @return WP_REST_Response $response Response data. |
|
104 | + */ |
|
105 | + public function prepare_item_for_response( $_, $request ) { |
|
106 | + |
|
107 | + // Set report range. |
|
108 | + $this->report_range = $this->get_date_range( $request ); |
|
109 | + |
|
110 | + $report_data = $this->get_report_data(); |
|
111 | + $period_totals = array(); |
|
112 | + |
|
113 | + // Setup period totals by ensuring each period in the interval has data. |
|
114 | + $start_date = strtotime( $this->report_range['after'] ); |
|
115 | + |
|
116 | + if ( 'month' === $this->groupby ) { |
|
117 | + $start_date = strtotime( gmdate( 'Y-m-01', $start_date ) ); |
|
118 | + } |
|
119 | + |
|
120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
121 | + |
|
122 | + switch ( $this->groupby ) { |
|
123 | + case 'day': |
|
124 | + $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
125 | + break; |
|
126 | + default: |
|
127 | + $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
128 | + break; |
|
129 | + } |
|
130 | + |
|
131 | + // Set the defaults for each period. |
|
132 | + $period_totals[ $time ] = array( |
|
133 | + 'invoices' => 0, |
|
134 | + 'items' => 0, |
|
135 | + 'refunded_items' => 0, |
|
136 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
141 | + ); |
|
142 | + |
|
143 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | + if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
146 | + } |
|
147 | + } |
|
148 | + } |
|
149 | + |
|
150 | + // add total sales, total invoice count, total tax for each period |
|
151 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | + foreach ( $report_data->invoices as $invoice ) { |
|
153 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
154 | + |
|
155 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
156 | + continue; |
|
157 | + } |
|
158 | + |
|
159 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
163 | + |
|
164 | + } |
|
165 | + |
|
166 | + foreach ( $report_data->refunds as $invoice ) { |
|
167 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
168 | + |
|
169 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
170 | + continue; |
|
171 | + } |
|
172 | + |
|
173 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
177 | + |
|
178 | + } |
|
179 | + |
|
180 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | + $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
182 | + |
|
183 | + if ( isset( $period_totals[ $time ] ) ) { |
|
184 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + // Add total invoice items for each period. |
|
189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
191 | + |
|
192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | + } |
|
195 | + } |
|
196 | + |
|
197 | + // Add total discount for each period. |
|
198 | + foreach ( $report_data->coupons as $discount ) { |
|
199 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) ); |
|
200 | + |
|
201 | + if ( isset( $period_totals[ $time ] ) ) { |
|
202 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
203 | + } |
|
204 | + } |
|
205 | + |
|
206 | + // Extra fields. |
|
207 | + foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
208 | + |
|
209 | + // Abort unprepared. |
|
210 | + if ( ! isset( $report_data->$key ) ) { |
|
211 | + continue; |
|
212 | + } |
|
213 | + |
|
214 | + // Abort defaults. |
|
215 | + if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
216 | + continue; |
|
217 | + } |
|
218 | + |
|
219 | + // Set values. |
|
220 | + foreach ( $report_data->$key as $item ) { |
|
221 | + $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) ); |
|
222 | + |
|
223 | + if ( isset( $period_totals[ $time ] ) ) { |
|
224 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + unset( $report_data->$key ); |
|
229 | + } |
|
230 | + |
|
231 | + $report_data->totals = $period_totals; |
|
232 | + $report_data->grouped_by = $this->groupby; |
|
233 | + $report_data->interval = max( $this->interval, 1 ); |
|
234 | + $report_data->currency = wpinv_get_currency(); |
|
235 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
236 | + $report_data->currency_position = wpinv_currency_position(); |
|
237 | + $report_data->decimal_places = wpinv_decimals(); |
|
238 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
239 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
240 | + $report_data->start_date = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ); |
|
241 | + $report_data->end_date = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ); |
|
242 | + $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) ); |
|
243 | + $report_data->end_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) ); |
|
244 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
245 | + |
|
246 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
247 | + $data = $report_data; |
|
248 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | + $data = $this->filter_response_by_context( $data, $context ); |
|
251 | + |
|
252 | + // Wrap the data in a response object. |
|
253 | + $response = rest_ensure_response( $data ); |
|
254 | + $response->add_links( |
|
255 | + array( |
|
256 | + 'about' => array( |
|
257 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
258 | + ), |
|
259 | + ) |
|
260 | + ); |
|
261 | + |
|
262 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Get report data. |
|
267 | + * |
|
268 | + * @return stdClass |
|
269 | + */ |
|
270 | + public function get_report_data() { |
|
271 | + if ( empty( $this->report_data ) ) { |
|
272 | + $this->query_report_data(); |
|
273 | + } |
|
274 | + return $this->report_data; |
|
275 | + } |
|
276 | + |
|
277 | + /** |
|
278 | + * Get all data needed for this report and store in the class. |
|
279 | + */ |
|
280 | + protected function query_report_data() { |
|
281 | + |
|
282 | + // Prepare reports. |
|
283 | + $this->report_data = (object) array( |
|
284 | + 'invoice_counts' => $this->query_invoice_counts(), //count, post_date |
|
285 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
286 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
287 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
288 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
289 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
290 | + 'previous_range' => $this->previous_range, |
|
291 | + ); |
|
292 | + |
|
293 | + // Calculated totals. |
|
294 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
306 | + |
|
307 | + // Calculate average based on net. |
|
308 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
310 | + |
|
311 | + // Total invoices in this period, even if refunded. |
|
312 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
313 | + |
|
314 | + // Items invoiced in this period, even if refunded. |
|
315 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
316 | + |
|
317 | + // 3rd party filtering of report data |
|
318 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
319 | + } |
|
320 | + |
|
321 | + /** |
|
322 | + * Prepares invoice counts. |
|
323 | + * |
|
324 | + * @return array. |
|
325 | + */ |
|
326 | + protected function query_invoice_counts() { |
|
327 | + |
|
328 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
329 | + array( |
|
330 | + 'data' => array( |
|
331 | + 'ID' => array( |
|
332 | + 'type' => 'post_data', |
|
333 | + 'function' => 'COUNT', |
|
334 | + 'name' => 'count', |
|
335 | + 'distinct' => true, |
|
336 | + ), |
|
337 | + 'post_date' => array( |
|
338 | + 'type' => 'post_data', |
|
339 | + 'function' => 'MIN', |
|
340 | + 'name' => 'post_date', |
|
341 | + ), |
|
342 | + ), |
|
343 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
344 | + 'order_by' => 'post_date ASC', |
|
345 | + 'query_type' => 'get_results', |
|
346 | + 'filter_range' => $this->report_range, |
|
347 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
348 | + ) |
|
349 | + ); |
|
350 | + |
|
351 | + } |
|
352 | + |
|
353 | + /** |
|
354 | + * Prepares coupon counts. |
|
355 | + * |
|
356 | + * @return array. |
|
357 | + */ |
|
358 | + protected function query_coupon_counts() { |
|
359 | + |
|
360 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
361 | + array( |
|
362 | + 'data' => array( |
|
363 | + 'discount' => array( |
|
364 | + 'type' => 'invoice_data', |
|
365 | + 'function' => 'SUM', |
|
366 | + 'name' => 'discount_amount', |
|
367 | + ), |
|
368 | + 'post_date' => array( |
|
369 | + 'type' => 'post_data', |
|
370 | + 'function' => 'MIN', |
|
371 | + 'name' => 'post_date', |
|
372 | + ), |
|
373 | + ), |
|
374 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
375 | + 'order_by' => 'post_date ASC', |
|
376 | + 'query_type' => 'get_results', |
|
377 | + 'filter_range' => $this->report_range, |
|
378 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
379 | + ) |
|
380 | + ); |
|
381 | + |
|
382 | + } |
|
383 | + |
|
384 | + /** |
|
385 | + * Prepares item counts. |
|
386 | + * |
|
387 | + * @return array. |
|
388 | + */ |
|
389 | + protected function query_item_counts() { |
|
390 | + |
|
391 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
392 | + array( |
|
393 | + 'data' => array( |
|
394 | + 'quantity' => array( |
|
395 | + 'type' => 'invoice_item', |
|
396 | + 'function' => 'SUM', |
|
397 | + 'name' => 'invoice_item_count', |
|
398 | + ), |
|
399 | + 'post_date' => array( |
|
400 | + 'type' => 'post_data', |
|
401 | + 'function' => 'MIN', |
|
402 | + 'name' => 'post_date', |
|
403 | + ), |
|
404 | + ), |
|
405 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
406 | + 'order_by' => 'post_date ASC', |
|
407 | + 'query_type' => 'get_results', |
|
408 | + 'filter_range' => $this->report_range, |
|
409 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
410 | + ) |
|
411 | + ); |
|
412 | + |
|
413 | + } |
|
414 | + |
|
415 | + /** |
|
416 | + * Prepares refunded item counts. |
|
417 | + * |
|
418 | + * @return array. |
|
419 | + */ |
|
420 | + protected function count_refunded_items() { |
|
421 | + |
|
422 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
423 | + array( |
|
424 | + 'data' => array( |
|
425 | + 'quantity' => array( |
|
426 | + 'type' => 'invoice_item', |
|
427 | + 'function' => 'SUM', |
|
428 | + 'name' => 'invoice_item_count', |
|
429 | + ), |
|
430 | + ), |
|
431 | + 'query_type' => 'get_var', |
|
432 | + 'filter_range' => $this->report_range, |
|
433 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
434 | + ) |
|
435 | + ); |
|
436 | + |
|
437 | + } |
|
438 | + |
|
439 | + /** |
|
440 | + * Prepares daily invoice totals. |
|
441 | + * |
|
442 | + * @return array. |
|
443 | + */ |
|
444 | + protected function query_invoice_totals() { |
|
445 | + |
|
446 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
447 | + array( |
|
448 | + 'data' => array( |
|
449 | + 'total' => array( |
|
450 | + 'type' => 'invoice_data', |
|
451 | + 'function' => 'SUM', |
|
452 | + 'name' => 'total_sales', |
|
453 | + ), |
|
454 | + 'tax' => array( |
|
455 | + 'type' => 'invoice_data', |
|
456 | + 'function' => 'SUM', |
|
457 | + 'name' => 'total_tax', |
|
458 | + ), |
|
459 | + 'discount' => array( |
|
460 | + 'type' => 'invoice_data', |
|
461 | + 'function' => 'SUM', |
|
462 | + 'name' => 'total_discount', |
|
463 | + ), |
|
464 | + 'fees_total' => array( |
|
465 | + 'type' => 'invoice_data', |
|
466 | + 'function' => 'SUM', |
|
467 | + 'name' => 'total_fees', |
|
468 | + ), |
|
469 | + 'subtotal' => array( |
|
470 | + 'type' => 'invoice_data', |
|
471 | + 'function' => 'SUM', |
|
472 | + 'name' => 'subtotal', |
|
473 | + ), |
|
474 | + 'post_date' => array( |
|
475 | + 'type' => 'post_data', |
|
476 | + 'function' => '', |
|
477 | + 'name' => 'post_date', |
|
478 | + ), |
|
479 | + ), |
|
480 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
481 | + 'order_by' => 'post_date ASC', |
|
482 | + 'query_type' => 'get_results', |
|
483 | + 'filter_range' => $this->report_range, |
|
484 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
485 | + ) |
|
486 | + ); |
|
487 | + |
|
488 | + } |
|
489 | + |
|
490 | + /** |
|
491 | + * Prepares daily invoice totals. |
|
492 | + * |
|
493 | + * @return array. |
|
494 | + */ |
|
495 | + protected function query_refunded_totals() { |
|
496 | + |
|
497 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
498 | + array( |
|
499 | + 'data' => array( |
|
500 | + 'total' => array( |
|
501 | + 'type' => 'invoice_data', |
|
502 | + 'function' => 'SUM', |
|
503 | + 'name' => 'total_sales', |
|
504 | + ), |
|
505 | + 'tax' => array( |
|
506 | + 'type' => 'invoice_data', |
|
507 | + 'function' => 'SUM', |
|
508 | + 'name' => 'total_tax', |
|
509 | + ), |
|
510 | + 'discount' => array( |
|
511 | + 'type' => 'invoice_data', |
|
512 | + 'function' => 'SUM', |
|
513 | + 'name' => 'total_discount', |
|
514 | + ), |
|
515 | + 'fees_total' => array( |
|
516 | + 'type' => 'invoice_data', |
|
517 | + 'function' => 'SUM', |
|
518 | + 'name' => 'total_fees', |
|
519 | + ), |
|
520 | + 'subtotal' => array( |
|
521 | + 'type' => 'invoice_data', |
|
522 | + 'function' => 'SUM', |
|
523 | + 'name' => 'subtotal', |
|
524 | + ), |
|
525 | + 'post_date' => array( |
|
526 | + 'type' => 'post_data', |
|
527 | + 'function' => '', |
|
528 | + 'name' => 'post_date', |
|
529 | + ), |
|
530 | + ), |
|
531 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
532 | + 'order_by' => 'post_date ASC', |
|
533 | + 'query_type' => 'get_results', |
|
534 | + 'filter_range' => $this->report_range, |
|
535 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
536 | + ) |
|
537 | + ); |
|
538 | + |
|
539 | + } |
|
540 | + |
|
541 | + /** |
|
542 | + * Get the Report's schema, conforming to JSON Schema. |
|
543 | + * |
|
544 | + * @return array |
|
545 | + */ |
|
546 | + public function get_item_schema() { |
|
547 | + |
|
548 | + $schema = array( |
|
549 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
550 | + 'title' => 'sales_report', |
|
551 | + 'type' => 'object', |
|
552 | + 'properties' => array( |
|
553 | + 'total_sales' => array( |
|
554 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
555 | + 'type' => 'string', |
|
556 | + 'context' => array( 'view' ), |
|
557 | + 'readonly' => true, |
|
558 | + ), |
|
559 | + 'net_sales' => array( |
|
560 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
561 | + 'type' => 'string', |
|
562 | + 'context' => array( 'view' ), |
|
563 | + 'readonly' => true, |
|
564 | + ), |
|
565 | + 'average_sales' => array( |
|
566 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
567 | + 'type' => 'string', |
|
568 | + 'context' => array( 'view' ), |
|
569 | + 'readonly' => true, |
|
570 | + ), |
|
571 | + 'average_total_sales' => array( |
|
572 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
573 | + 'type' => 'string', |
|
574 | + 'context' => array( 'view' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'total_invoices' => array( |
|
578 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
579 | + 'type' => 'integer', |
|
580 | + 'context' => array( 'view' ), |
|
581 | + 'readonly' => true, |
|
582 | + ), |
|
583 | + 'total_items' => array( |
|
584 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
585 | + 'type' => 'integer', |
|
586 | + 'context' => array( 'view' ), |
|
587 | + 'readonly' => true, |
|
588 | + ), |
|
589 | + 'refunded_items' => array( |
|
590 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
591 | + 'type' => 'integer', |
|
592 | + 'context' => array( 'view' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'total_tax' => array( |
|
596 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
597 | + 'type' => 'string', |
|
598 | + 'context' => array( 'view' ), |
|
599 | + 'readonly' => true, |
|
600 | + ), |
|
601 | + 'total_refunded_tax' => array( |
|
602 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
603 | + 'type' => 'string', |
|
604 | + 'context' => array( 'view' ), |
|
605 | + 'readonly' => true, |
|
606 | + ), |
|
607 | + 'total_fees' => array( |
|
608 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
609 | + 'type' => 'string', |
|
610 | + 'context' => array( 'view' ), |
|
611 | + 'readonly' => true, |
|
612 | + ), |
|
613 | + 'total_refunds' => array( |
|
614 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
615 | + 'type' => 'integer', |
|
616 | + 'context' => array( 'view' ), |
|
617 | + 'readonly' => true, |
|
618 | + ), |
|
619 | + 'net_refunds' => array( |
|
620 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
621 | + 'type' => 'integer', |
|
622 | + 'context' => array( 'view' ), |
|
623 | + 'readonly' => true, |
|
624 | + ), |
|
625 | + 'total_discount' => array( |
|
626 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
627 | + 'type' => 'integer', |
|
628 | + 'context' => array( 'view' ), |
|
629 | + 'readonly' => true, |
|
630 | + ), |
|
631 | + 'totals' => array( |
|
632 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
633 | + 'type' => 'array', |
|
634 | + 'items' => array( |
|
635 | + 'type' => 'array', |
|
636 | + ), |
|
637 | + 'context' => array( 'view' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | + 'interval' => array( |
|
641 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
642 | + 'type' => 'integer', |
|
643 | + 'context' => array( 'view' ), |
|
644 | + 'readonly' => true, |
|
645 | + ), |
|
646 | + 'previous_range' => array( |
|
647 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
648 | + 'type' => 'array', |
|
649 | + 'items' => array( |
|
650 | + 'type' => 'string', |
|
651 | + ), |
|
652 | + 'context' => array( 'view' ), |
|
653 | + 'readonly' => true, |
|
654 | + ), |
|
655 | + 'grouped_by' => array( |
|
656 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
657 | + 'type' => 'string', |
|
658 | + 'context' => array( 'view' ), |
|
659 | + 'enum' => array( 'day', 'month' ), |
|
660 | + 'readonly' => true, |
|
661 | + ), |
|
662 | + 'currency' => array( |
|
663 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
664 | + 'type' => 'string', |
|
665 | + 'context' => array( 'view' ), |
|
666 | + 'readonly' => true, |
|
667 | + ), |
|
668 | + 'currency_symbol' => array( |
|
669 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
670 | + 'type' => 'string', |
|
671 | + 'context' => array( 'view' ), |
|
672 | + 'readonly' => true, |
|
673 | + ), |
|
674 | + 'currency_position' => array( |
|
675 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
676 | + 'type' => 'string', |
|
677 | + 'context' => array( 'view' ), |
|
678 | + 'readonly' => true, |
|
679 | + ), |
|
680 | + 'decimal_places' => array( |
|
681 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
682 | + 'type' => 'string', |
|
683 | + 'context' => array( 'view' ), |
|
684 | + 'readonly' => true, |
|
685 | + ), |
|
686 | + 'thousands_sep' => array( |
|
687 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
688 | + 'type' => 'string', |
|
689 | + 'context' => array( 'view' ), |
|
690 | + 'readonly' => true, |
|
691 | + ), |
|
692 | + 'decimals_sep' => array( |
|
693 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
694 | + 'type' => 'string', |
|
695 | + 'context' => array( 'view' ), |
|
696 | + 'readonly' => true, |
|
697 | + ), |
|
698 | + ), |
|
699 | + ); |
|
700 | + |
|
701 | + return $this->add_additional_fields_schema( $schema ); |
|
702 | + |
|
703 | + } |
|
704 | 704 | |
705 | 705 | } |
@@ -9,7 +9,7 @@ discard block |
||
9 | 9 | * @since 2.0.0 |
10 | 10 | */ |
11 | 11 | |
12 | -defined( 'ABSPATH' ) || exit; |
|
12 | +defined('ABSPATH') || exit; |
|
13 | 13 | |
14 | 14 | /** |
15 | 15 | * GetPaid REST reports controller class. |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | * |
47 | 47 | * @see register_rest_route() |
48 | 48 | */ |
49 | - public function register_namespace_routes( $namespace ) { |
|
49 | + public function register_namespace_routes($namespace) { |
|
50 | 50 | |
51 | 51 | // Get sales report. |
52 | 52 | register_rest_route( |
@@ -55,11 +55,11 @@ discard block |
||
55 | 55 | array( |
56 | 56 | array( |
57 | 57 | 'methods' => WP_REST_Server::READABLE, |
58 | - 'callback' => array( $this, 'get_items' ), |
|
59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
58 | + 'callback' => array($this, 'get_items'), |
|
59 | + 'permission_callback' => array($this, 'get_items_permissions_check'), |
|
60 | 60 | 'args' => $this->get_collection_params(), |
61 | 61 | ), |
62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
62 | + 'schema' => array($this, 'get_public_item_schema'), |
|
63 | 63 | ) |
64 | 64 | ); |
65 | 65 | |
@@ -72,10 +72,10 @@ discard block |
||
72 | 72 | * @param WP_REST_Request $request Full data about the request. |
73 | 73 | * @return WP_Error|boolean |
74 | 74 | */ |
75 | - public function get_items_permissions_check( $request ) { |
|
75 | + public function get_items_permissions_check($request) { |
|
76 | 76 | |
77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
77 | + if (!wpinv_current_user_can_manage_invoicing()) { |
|
78 | + return new WP_Error('rest_cannot_view', __('Sorry, you cannot list resources.', 'invoicing'), array('status' => rest_authorization_required_code())); |
|
79 | 79 | } |
80 | 80 | |
81 | 81 | return true; |
@@ -87,12 +87,12 @@ discard block |
||
87 | 87 | * @param WP_REST_Request $request |
88 | 88 | * @return array|WP_Error |
89 | 89 | */ |
90 | - public function get_items( $request ) { |
|
90 | + public function get_items($request) { |
|
91 | 91 | $data = array(); |
92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
92 | + $item = $this->prepare_item_for_response(null, $request); |
|
93 | + $data[] = $this->prepare_response_for_collection($item); |
|
94 | 94 | |
95 | - return rest_ensure_response( $data ); |
|
95 | + return rest_ensure_response($data); |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | /** |
@@ -102,164 +102,164 @@ discard block |
||
102 | 102 | * @param WP_REST_Request $request Request object. |
103 | 103 | * @return WP_REST_Response $response Response data. |
104 | 104 | */ |
105 | - public function prepare_item_for_response( $_, $request ) { |
|
105 | + public function prepare_item_for_response($_, $request) { |
|
106 | 106 | |
107 | 107 | // Set report range. |
108 | - $this->report_range = $this->get_date_range( $request ); |
|
108 | + $this->report_range = $this->get_date_range($request); |
|
109 | 109 | |
110 | 110 | $report_data = $this->get_report_data(); |
111 | 111 | $period_totals = array(); |
112 | 112 | |
113 | 113 | // Setup period totals by ensuring each period in the interval has data. |
114 | - $start_date = strtotime( $this->report_range['after'] ); |
|
114 | + $start_date = strtotime($this->report_range['after']); |
|
115 | 115 | |
116 | - if ( 'month' === $this->groupby ) { |
|
117 | - $start_date = strtotime( gmdate( 'Y-m-01', $start_date ) ); |
|
116 | + if ('month' === $this->groupby) { |
|
117 | + $start_date = strtotime(gmdate('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 = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
124 | + $time = gmdate('Y-m-d', strtotime("+{$i} DAY", $start_date)); |
|
125 | 125 | break; |
126 | 126 | default: |
127 | - $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
127 | + $time = gmdate('Y-m', strtotime("+{$i} MONTH", $start_date)); |
|
128 | 128 | break; |
129 | 129 | } |
130 | 130 | |
131 | 131 | // Set the defaults for each period. |
132 | - $period_totals[ $time ] = array( |
|
132 | + $period_totals[$time] = array( |
|
133 | 133 | 'invoices' => 0, |
134 | 134 | 'items' => 0, |
135 | 135 | 'refunded_items' => 0, |
136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
136 | + 'refunded_tax' => wpinv_round_amount(0.00), |
|
137 | + 'subtotal' => wpinv_round_amount(0.00), |
|
138 | + 'refunded_subtotal' => wpinv_round_amount(0.00), |
|
139 | + 'refunded_fees' => wpinv_round_amount(0.00), |
|
140 | + 'discount' => wpinv_round_amount(0.00), |
|
141 | 141 | ); |
142 | 142 | |
143 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
143 | + foreach (array_keys(wpinv_get_report_graphs()) as $key) { |
|
144 | + if (!isset($period_totals[$time][$key])) { |
|
145 | + $period_totals[$time][$key] = wpinv_round_amount(0.00); |
|
146 | 146 | } |
147 | 147 | } |
148 | 148 | } |
149 | 149 | |
150 | 150 | // add total sales, total invoice count, total tax for each period |
151 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
152 | - foreach ( $report_data->invoices as $invoice ) { |
|
153 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
151 | + $date_format = ('day' === $this->groupby) ? 'Y-m-d' : 'Y-m'; |
|
152 | + foreach ($report_data->invoices as $invoice) { |
|
153 | + $time = gmdate($date_format, strtotime($invoice->post_date)); |
|
154 | 154 | |
155 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
155 | + if (!isset($period_totals[$time])) { |
|
156 | 156 | continue; |
157 | 157 | } |
158 | 158 | |
159 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
160 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
161 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
162 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
159 | + $period_totals[$time]['sales'] = wpinv_round_amount($invoice->total_sales); |
|
160 | + $period_totals[$time]['tax'] = wpinv_round_amount($invoice->total_tax); |
|
161 | + $period_totals[$time]['subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
162 | + $period_totals[$time]['fees'] = wpinv_round_amount($invoice->total_fees); |
|
163 | 163 | |
164 | 164 | } |
165 | 165 | |
166 | - foreach ( $report_data->refunds as $invoice ) { |
|
167 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
166 | + foreach ($report_data->refunds as $invoice) { |
|
167 | + $time = gmdate($date_format, strtotime($invoice->post_date)); |
|
168 | 168 | |
169 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
169 | + if (!isset($period_totals[$time])) { |
|
170 | 170 | continue; |
171 | 171 | } |
172 | 172 | |
173 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
174 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
175 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
176 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
173 | + $period_totals[$time]['refunds'] = wpinv_round_amount($invoice->total_sales); |
|
174 | + $period_totals[$time]['refunded_tax'] = wpinv_round_amount($invoice->total_tax); |
|
175 | + $period_totals[$time]['refunded_subtotal'] = wpinv_round_amount($invoice->subtotal); |
|
176 | + $period_totals[$time]['refunded_fees'] = wpinv_round_amount($invoice->total_fees); |
|
177 | 177 | |
178 | 178 | } |
179 | 179 | |
180 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
181 | - $time = gmdate( $date_format, strtotime( $invoice->post_date ) ); |
|
180 | + foreach ($report_data->invoice_counts as $invoice) { |
|
181 | + $time = gmdate($date_format, strtotime($invoice->post_date)); |
|
182 | 182 | |
183 | - if ( isset( $period_totals[ $time ] ) ) { |
|
184 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
183 | + if (isset($period_totals[$time])) { |
|
184 | + $period_totals[$time]['invoices'] = (int) $invoice->count; |
|
185 | 185 | } |
186 | 186 | } |
187 | 187 | |
188 | 188 | // Add total invoice items for each period. |
189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
190 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
189 | + foreach ($report_data->invoice_items as $invoice_item) { |
|
190 | + $time = ('day' === $this->groupby) ? gmdate('Y-m-d', strtotime($invoice_item->post_date)) : gmdate('Y-m', strtotime($invoice_item->post_date)); |
|
191 | 191 | |
192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
192 | + if (isset($period_totals[$time])) { |
|
193 | + $period_totals[$time]['items'] = (int) $invoice_item->invoice_item_count; |
|
194 | 194 | } |
195 | 195 | } |
196 | 196 | |
197 | 197 | // Add total discount for each period. |
198 | - foreach ( $report_data->coupons as $discount ) { |
|
199 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) ); |
|
198 | + foreach ($report_data->coupons as $discount) { |
|
199 | + $time = ('day' === $this->groupby) ? gmdate('Y-m-d', strtotime($discount->post_date)) : gmdate('Y-m', strtotime($discount->post_date)); |
|
200 | 200 | |
201 | - if ( isset( $period_totals[ $time ] ) ) { |
|
202 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
201 | + if (isset($period_totals[$time])) { |
|
202 | + $period_totals[$time]['discount'] = wpinv_round_amount($discount->discount_amount); |
|
203 | 203 | } |
204 | 204 | } |
205 | 205 | |
206 | 206 | // Extra fields. |
207 | - foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
207 | + foreach (array_keys(wpinv_get_report_graphs()) as $key) { |
|
208 | 208 | |
209 | 209 | // Abort unprepared. |
210 | - if ( ! isset( $report_data->$key ) ) { |
|
210 | + if (!isset($report_data->$key)) { |
|
211 | 211 | continue; |
212 | 212 | } |
213 | 213 | |
214 | 214 | // Abort defaults. |
215 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
215 | + if (in_array($key, array('sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items'))) { |
|
216 | 216 | continue; |
217 | 217 | } |
218 | 218 | |
219 | 219 | // Set values. |
220 | - foreach ( $report_data->$key as $item ) { |
|
221 | - $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) ); |
|
220 | + foreach ($report_data->$key as $item) { |
|
221 | + $time = ('day' === $this->groupby) ? gmdate('Y-m-d', strtotime($item->date)) : gmdate('Y-m', strtotime($item->date)); |
|
222 | 222 | |
223 | - if ( isset( $period_totals[ $time ] ) ) { |
|
224 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
223 | + if (isset($period_totals[$time])) { |
|
224 | + $period_totals[$time][$key] = wpinv_round_amount($item->val); |
|
225 | 225 | } |
226 | 226 | } |
227 | 227 | |
228 | - unset( $report_data->$key ); |
|
228 | + unset($report_data->$key); |
|
229 | 229 | } |
230 | 230 | |
231 | 231 | $report_data->totals = $period_totals; |
232 | 232 | $report_data->grouped_by = $this->groupby; |
233 | - $report_data->interval = max( $this->interval, 1 ); |
|
233 | + $report_data->interval = max($this->interval, 1); |
|
234 | 234 | $report_data->currency = wpinv_get_currency(); |
235 | 235 | $report_data->currency_symbol = wpinv_currency_symbol(); |
236 | 236 | $report_data->currency_position = wpinv_currency_position(); |
237 | 237 | $report_data->decimal_places = wpinv_decimals(); |
238 | 238 | $report_data->thousands_sep = wpinv_thousands_separator(); |
239 | 239 | $report_data->decimals_sep = wpinv_decimal_separator(); |
240 | - $report_data->start_date = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ); |
|
241 | - $report_data->end_date = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ); |
|
242 | - $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) ); |
|
243 | - $report_data->end_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) ); |
|
240 | + $report_data->start_date = gmdate('Y-m-d', strtotime($this->report_range['after'])); |
|
241 | + $report_data->end_date = gmdate('Y-m-d', strtotime($this->report_range['before'])); |
|
242 | + $report_data->start_date_locale = getpaid_format_date(gmdate('Y-m-d', strtotime($this->report_range['after']))); |
|
243 | + $report_data->end_date_locale = getpaid_format_date(gmdate('Y-m-d', strtotime($this->report_range['before']))); |
|
244 | 244 | $report_data->decimals_sep = wpinv_decimal_separator(); |
245 | 245 | |
246 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
246 | + $context = !empty($request['context']) ? $request['context'] : 'view'; |
|
247 | 247 | $data = $report_data; |
248 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
249 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
250 | - $data = $this->filter_response_by_context( $data, $context ); |
|
248 | + unset($data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items); |
|
249 | + $data = $this->add_additional_fields_to_object((array) $data, $request); |
|
250 | + $data = $this->filter_response_by_context($data, $context); |
|
251 | 251 | |
252 | 252 | // Wrap the data in a response object. |
253 | - $response = rest_ensure_response( $data ); |
|
253 | + $response = rest_ensure_response($data); |
|
254 | 254 | $response->add_links( |
255 | 255 | array( |
256 | 256 | 'about' => array( |
257 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
257 | + 'href' => rest_url(sprintf('%s/reports', $this->namespace)), |
|
258 | 258 | ), |
259 | 259 | ) |
260 | 260 | ); |
261 | 261 | |
262 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
262 | + return apply_filters('getpaid_rest_prepare_report_sales', $response, $report_data, $request); |
|
263 | 263 | } |
264 | 264 | |
265 | 265 | /** |
@@ -268,7 +268,7 @@ discard block |
||
268 | 268 | * @return stdClass |
269 | 269 | */ |
270 | 270 | public function get_report_data() { |
271 | - if ( empty( $this->report_data ) ) { |
|
271 | + if (empty($this->report_data)) { |
|
272 | 272 | $this->query_report_data(); |
273 | 273 | } |
274 | 274 | return $this->report_data; |
@@ -291,31 +291,31 @@ discard block |
||
291 | 291 | ); |
292 | 292 | |
293 | 293 | // Calculated totals. |
294 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
295 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
296 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
297 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
298 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
299 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
300 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
301 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
302 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
303 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
304 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
305 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
294 | + $this->report_data->total_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_tax'))); |
|
295 | + $this->report_data->total_sales = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_sales'))); |
|
296 | + $this->report_data->total_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_discount'))); |
|
297 | + $this->report_data->total_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'total_fees'))); |
|
298 | + $this->report_data->subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->invoices, 'subtotal'))); |
|
299 | + $this->report_data->net_sales = wpinv_round_amount($this->report_data->total_sales - max(0, $this->report_data->total_tax)); |
|
300 | + $this->report_data->total_refunded_tax = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_tax'))); |
|
301 | + $this->report_data->total_refunds = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_sales'))); |
|
302 | + $this->report_data->refunded_discount = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_discount'))); |
|
303 | + $this->report_data->refunded_fees = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'total_fees'))); |
|
304 | + $this->report_data->refunded_subtotal = wpinv_round_amount(array_sum(wp_list_pluck($this->report_data->refunds, 'subtotal'))); |
|
305 | + $this->report_data->net_refunds = wpinv_round_amount($this->report_data->total_refunds + max(0, $this->report_data->total_refunded_tax)); |
|
306 | 306 | |
307 | 307 | // Calculate average based on net. |
308 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
309 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
308 | + $this->report_data->average_sales = wpinv_round_amount($this->report_data->net_sales / max($this->interval, 1), 2); |
|
309 | + $this->report_data->average_total_sales = wpinv_round_amount($this->report_data->total_sales / max($this->interval, 1), 2); |
|
310 | 310 | |
311 | 311 | // Total invoices in this period, even if refunded. |
312 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
312 | + $this->report_data->total_invoices = absint(array_sum(wp_list_pluck($this->report_data->invoice_counts, 'count'))); |
|
313 | 313 | |
314 | 314 | // Items invoiced in this period, even if refunded. |
315 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
315 | + $this->report_data->total_items = absint(array_sum(wp_list_pluck($this->report_data->invoice_items, 'invoice_item_count'))); |
|
316 | 316 | |
317 | 317 | // 3rd party filtering of report data |
318 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
318 | + $this->report_data = apply_filters('getpaid_rest_api_filter_report_data', $this->report_data, $this); |
|
319 | 319 | } |
320 | 320 | |
321 | 321 | /** |
@@ -340,11 +340,11 @@ discard block |
||
340 | 340 | 'name' => 'post_date', |
341 | 341 | ), |
342 | 342 | ), |
343 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
343 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
344 | 344 | 'order_by' => 'post_date ASC', |
345 | 345 | 'query_type' => 'get_results', |
346 | 346 | 'filter_range' => $this->report_range, |
347 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
347 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
348 | 348 | ) |
349 | 349 | ); |
350 | 350 | |
@@ -371,11 +371,11 @@ discard block |
||
371 | 371 | 'name' => 'post_date', |
372 | 372 | ), |
373 | 373 | ), |
374 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
374 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
375 | 375 | 'order_by' => 'post_date ASC', |
376 | 376 | 'query_type' => 'get_results', |
377 | 377 | 'filter_range' => $this->report_range, |
378 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
378 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
379 | 379 | ) |
380 | 380 | ); |
381 | 381 | |
@@ -402,11 +402,11 @@ discard block |
||
402 | 402 | 'name' => 'post_date', |
403 | 403 | ), |
404 | 404 | ), |
405 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
405 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
406 | 406 | 'order_by' => 'post_date ASC', |
407 | 407 | 'query_type' => 'get_results', |
408 | 408 | 'filter_range' => $this->report_range, |
409 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
409 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal'), |
|
410 | 410 | ) |
411 | 411 | ); |
412 | 412 | |
@@ -430,7 +430,7 @@ discard block |
||
430 | 430 | ), |
431 | 431 | 'query_type' => 'get_var', |
432 | 432 | 'filter_range' => $this->report_range, |
433 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
433 | + 'invoice_status' => array('wpi-refunded'), |
|
434 | 434 | ) |
435 | 435 | ); |
436 | 436 | |
@@ -477,11 +477,11 @@ discard block |
||
477 | 477 | 'name' => 'post_date', |
478 | 478 | ), |
479 | 479 | ), |
480 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
480 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
481 | 481 | 'order_by' => 'post_date ASC', |
482 | 482 | 'query_type' => 'get_results', |
483 | 483 | 'filter_range' => $this->report_range, |
484 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
484 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal'), |
|
485 | 485 | ) |
486 | 486 | ); |
487 | 487 | |
@@ -528,11 +528,11 @@ discard block |
||
528 | 528 | 'name' => 'post_date', |
529 | 529 | ), |
530 | 530 | ), |
531 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
531 | + 'group_by' => $this->get_group_by_sql('posts.post_date'), |
|
532 | 532 | 'order_by' => 'post_date ASC', |
533 | 533 | 'query_type' => 'get_results', |
534 | 534 | 'filter_range' => $this->report_range, |
535 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
535 | + 'invoice_status' => array('wpi-refunded'), |
|
536 | 536 | ) |
537 | 537 | ); |
538 | 538 | |
@@ -551,154 +551,154 @@ discard block |
||
551 | 551 | 'type' => 'object', |
552 | 552 | 'properties' => array( |
553 | 553 | 'total_sales' => array( |
554 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
554 | + 'description' => __('Gross sales in the period.', 'invoicing'), |
|
555 | 555 | 'type' => 'string', |
556 | - 'context' => array( 'view' ), |
|
556 | + 'context' => array('view'), |
|
557 | 557 | 'readonly' => true, |
558 | 558 | ), |
559 | 559 | 'net_sales' => array( |
560 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
560 | + 'description' => __('Net sales in the period.', 'invoicing'), |
|
561 | 561 | 'type' => 'string', |
562 | - 'context' => array( 'view' ), |
|
562 | + 'context' => array('view'), |
|
563 | 563 | 'readonly' => true, |
564 | 564 | ), |
565 | 565 | 'average_sales' => array( |
566 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
566 | + 'description' => __('Average net daily sales.', 'invoicing'), |
|
567 | 567 | 'type' => 'string', |
568 | - 'context' => array( 'view' ), |
|
568 | + 'context' => array('view'), |
|
569 | 569 | 'readonly' => true, |
570 | 570 | ), |
571 | 571 | 'average_total_sales' => array( |
572 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
572 | + 'description' => __('Average gross daily sales.', 'invoicing'), |
|
573 | 573 | 'type' => 'string', |
574 | - 'context' => array( 'view' ), |
|
574 | + 'context' => array('view'), |
|
575 | 575 | 'readonly' => true, |
576 | 576 | ), |
577 | 577 | 'total_invoices' => array( |
578 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
578 | + 'description' => __('Number of paid invoices.', 'invoicing'), |
|
579 | 579 | 'type' => 'integer', |
580 | - 'context' => array( 'view' ), |
|
580 | + 'context' => array('view'), |
|
581 | 581 | 'readonly' => true, |
582 | 582 | ), |
583 | 583 | 'total_items' => array( |
584 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
584 | + 'description' => __('Number of items purchased.', 'invoicing'), |
|
585 | 585 | 'type' => 'integer', |
586 | - 'context' => array( 'view' ), |
|
586 | + 'context' => array('view'), |
|
587 | 587 | 'readonly' => true, |
588 | 588 | ), |
589 | 589 | 'refunded_items' => array( |
590 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
590 | + 'description' => __('Number of items refunded.', 'invoicing'), |
|
591 | 591 | 'type' => 'integer', |
592 | - 'context' => array( 'view' ), |
|
592 | + 'context' => array('view'), |
|
593 | 593 | 'readonly' => true, |
594 | 594 | ), |
595 | 595 | 'total_tax' => array( |
596 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
596 | + 'description' => __('Total charged for taxes.', 'invoicing'), |
|
597 | 597 | 'type' => 'string', |
598 | - 'context' => array( 'view' ), |
|
598 | + 'context' => array('view'), |
|
599 | 599 | 'readonly' => true, |
600 | 600 | ), |
601 | 601 | 'total_refunded_tax' => array( |
602 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
602 | + 'description' => __('Total refunded for taxes.', 'invoicing'), |
|
603 | 603 | 'type' => 'string', |
604 | - 'context' => array( 'view' ), |
|
604 | + 'context' => array('view'), |
|
605 | 605 | 'readonly' => true, |
606 | 606 | ), |
607 | 607 | 'total_fees' => array( |
608 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
608 | + 'description' => __('Total fees charged.', 'invoicing'), |
|
609 | 609 | 'type' => 'string', |
610 | - 'context' => array( 'view' ), |
|
610 | + 'context' => array('view'), |
|
611 | 611 | 'readonly' => true, |
612 | 612 | ), |
613 | 613 | 'total_refunds' => array( |
614 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
614 | + 'description' => __('Total of refunded invoices.', 'invoicing'), |
|
615 | 615 | 'type' => 'integer', |
616 | - 'context' => array( 'view' ), |
|
616 | + 'context' => array('view'), |
|
617 | 617 | 'readonly' => true, |
618 | 618 | ), |
619 | 619 | 'net_refunds' => array( |
620 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
620 | + 'description' => __('Net of refunded invoices.', 'invoicing'), |
|
621 | 621 | 'type' => 'integer', |
622 | - 'context' => array( 'view' ), |
|
622 | + 'context' => array('view'), |
|
623 | 623 | 'readonly' => true, |
624 | 624 | ), |
625 | 625 | 'total_discount' => array( |
626 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
626 | + 'description' => __('Total of discounts used.', 'invoicing'), |
|
627 | 627 | 'type' => 'integer', |
628 | - 'context' => array( 'view' ), |
|
628 | + 'context' => array('view'), |
|
629 | 629 | 'readonly' => true, |
630 | 630 | ), |
631 | 631 | 'totals' => array( |
632 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
632 | + 'description' => __('Totals.', 'invoicing'), |
|
633 | 633 | 'type' => 'array', |
634 | 634 | 'items' => array( |
635 | 635 | 'type' => 'array', |
636 | 636 | ), |
637 | - 'context' => array( 'view' ), |
|
637 | + 'context' => array('view'), |
|
638 | 638 | 'readonly' => true, |
639 | 639 | ), |
640 | 640 | 'interval' => array( |
641 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
641 | + 'description' => __('Number of months/days in the report period.', 'invoicing'), |
|
642 | 642 | 'type' => 'integer', |
643 | - 'context' => array( 'view' ), |
|
643 | + 'context' => array('view'), |
|
644 | 644 | 'readonly' => true, |
645 | 645 | ), |
646 | 646 | 'previous_range' => array( |
647 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
647 | + 'description' => __('The previous report period.', 'invoicing'), |
|
648 | 648 | 'type' => 'array', |
649 | 649 | 'items' => array( |
650 | 650 | 'type' => 'string', |
651 | 651 | ), |
652 | - 'context' => array( 'view' ), |
|
652 | + 'context' => array('view'), |
|
653 | 653 | 'readonly' => true, |
654 | 654 | ), |
655 | 655 | 'grouped_by' => array( |
656 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
656 | + 'description' => __('The period used to group the totals.', 'invoicing'), |
|
657 | 657 | 'type' => 'string', |
658 | - 'context' => array( 'view' ), |
|
659 | - 'enum' => array( 'day', 'month' ), |
|
658 | + 'context' => array('view'), |
|
659 | + 'enum' => array('day', 'month'), |
|
660 | 660 | 'readonly' => true, |
661 | 661 | ), |
662 | 662 | 'currency' => array( |
663 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
663 | + 'description' => __('The default store currency.', 'invoicing'), |
|
664 | 664 | 'type' => 'string', |
665 | - 'context' => array( 'view' ), |
|
665 | + 'context' => array('view'), |
|
666 | 666 | 'readonly' => true, |
667 | 667 | ), |
668 | 668 | 'currency_symbol' => array( |
669 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
669 | + 'description' => __('The default store currency symbol.', 'invoicing'), |
|
670 | 670 | 'type' => 'string', |
671 | - 'context' => array( 'view' ), |
|
671 | + 'context' => array('view'), |
|
672 | 672 | 'readonly' => true, |
673 | 673 | ), |
674 | 674 | 'currency_position' => array( |
675 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
675 | + 'description' => __('The default store currency position.', 'invoicing'), |
|
676 | 676 | 'type' => 'string', |
677 | - 'context' => array( 'view' ), |
|
677 | + 'context' => array('view'), |
|
678 | 678 | 'readonly' => true, |
679 | 679 | ), |
680 | 680 | 'decimal_places' => array( |
681 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
681 | + 'description' => __('The default store decimal places.', 'invoicing'), |
|
682 | 682 | 'type' => 'string', |
683 | - 'context' => array( 'view' ), |
|
683 | + 'context' => array('view'), |
|
684 | 684 | 'readonly' => true, |
685 | 685 | ), |
686 | 686 | 'thousands_sep' => array( |
687 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
687 | + 'description' => __('The default store thousands separator.', 'invoicing'), |
|
688 | 688 | 'type' => 'string', |
689 | - 'context' => array( 'view' ), |
|
689 | + 'context' => array('view'), |
|
690 | 690 | 'readonly' => true, |
691 | 691 | ), |
692 | 692 | 'decimals_sep' => array( |
693 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
693 | + 'description' => __('The default store decimals separator.', 'invoicing'), |
|
694 | 694 | 'type' => 'string', |
695 | - 'context' => array( 'view' ), |
|
695 | + 'context' => array('view'), |
|
696 | 696 | 'readonly' => true, |
697 | 697 | ), |
698 | 698 | ), |
699 | 699 | ); |
700 | 700 | |
701 | - return $this->add_additional_fields_schema( $schema ); |
|
701 | + return $this->add_additional_fields_schema($schema); |
|
702 | 702 | |
703 | 703 | } |
704 | 704 |
@@ -16,496 +16,496 @@ |
||
16 | 16 | */ |
17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
18 | 18 | |
19 | - /** |
|
20 | - * Group response items by day or month. |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - public $groupby = 'day'; |
|
25 | - |
|
26 | - /** |
|
27 | - * Returns an array with arguments to request the previous report. |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - public $previous_range = array(); |
|
32 | - |
|
33 | - /** |
|
34 | - * The period interval. |
|
35 | - * |
|
36 | - * @var int |
|
37 | - */ |
|
38 | - public $interval; |
|
39 | - |
|
40 | - /** |
|
41 | - * Retrieves the before and after dates. |
|
42 | - * |
|
43 | - * @param WP_REST_Request $request Request object. |
|
44 | - * @return array The appropriate date range. |
|
45 | - */ |
|
46 | - public function get_date_range( $request ) { |
|
47 | - |
|
48 | - // Check if the period is x_days. |
|
49 | - if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) { |
|
50 | - $date_range = $this->get_x_days_date_range( absint( $matches[1] ) ); |
|
51 | - } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) { |
|
52 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
53 | - } else { |
|
54 | - $request['period'] = '7_days'; |
|
55 | - $date_range = $this->get_x_days_date_range(); |
|
56 | - } |
|
57 | - |
|
58 | - // 3 months max for day view. |
|
59 | - $before = strtotime( $date_range['before'] ); |
|
60 | - $after = strtotime( $date_range['after'] ); |
|
61 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) { |
|
62 | - $this->groupby = 'month'; |
|
63 | - } |
|
64 | - |
|
65 | - $this->prepare_interval( $date_range ); |
|
66 | - |
|
67 | - return $date_range; |
|
68 | - |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Groups by month or days. |
|
73 | - * |
|
74 | - * @param array $range Date range. |
|
75 | - * @return array The appropriate date range. |
|
76 | - */ |
|
77 | - public function prepare_interval( $range ) { |
|
78 | - |
|
79 | - $before = strtotime( $range['before'] ); |
|
80 | - $after = strtotime( $range['after'] ); |
|
81 | - if ( 'day' === $this->groupby ) { |
|
82 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
83 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
84 | - return; |
|
85 | - } |
|
86 | - |
|
87 | - $this->interval = 0; |
|
88 | - $min_date = strtotime( gmdate( 'Y-m-01', $after ) ); |
|
89 | - |
|
90 | - while ( $min_date <= $before ) { |
|
91 | - $this->interval ++; |
|
92 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
93 | - } |
|
94 | - |
|
95 | - $this->interval = max( 1, $this->interval ); |
|
96 | - |
|
97 | - } |
|
98 | - |
|
99 | - /** |
|
100 | - * Retrieves a custom date range. |
|
101 | - * |
|
102 | - * @param WP_REST_Request $request Request object. |
|
103 | - * @return array The appropriate date range. |
|
104 | - */ |
|
105 | - public function get_custom_date_range( $request ) { |
|
106 | - |
|
107 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
108 | - $before = gmdate( 'Y-m-d' ); |
|
109 | - |
|
110 | - if ( ! empty( $request['before'] ) ) { |
|
111 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
112 | - } |
|
113 | - |
|
114 | - // Set the previous date range. |
|
115 | - $difference = $before - $after; |
|
116 | - $this->previous_range = array( |
|
117 | - 'period' => 'custom', |
|
118 | - 'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ), |
|
119 | - 'after' => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ), |
|
120 | - ); |
|
121 | - |
|
122 | - // Generate the report. |
|
123 | - return array( |
|
124 | - 'before' => gmdate( 'Y-m-d', $before ), |
|
125 | - 'after' => gmdate( 'Y-m-d', $after ), |
|
126 | - ); |
|
127 | - |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Retrieves todays date range. |
|
132 | - * |
|
133 | - * @return array The appropriate date range. |
|
134 | - */ |
|
135 | - public function get_today_date_range() { |
|
136 | - |
|
137 | - // Set the previous date range. |
|
138 | - $this->previous_range = array( |
|
139 | - 'period' => 'yesterday', |
|
140 | - ); |
|
141 | - |
|
142 | - // Generate the report. |
|
143 | - return array( |
|
144 | - 'before' => gmdate( 'Y-m-d' ), |
|
145 | - 'after' => gmdate( 'Y-m-d' ), |
|
146 | - ); |
|
147 | - |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Retrieves yesterdays date range. |
|
152 | - * |
|
153 | - * @return array The appropriate date range. |
|
154 | - */ |
|
155 | - public function get_yesterday_date_range() { |
|
156 | - |
|
157 | - // Set the previous date range. |
|
158 | - $this->previous_range = array( |
|
159 | - 'period' => 'custom', |
|
160 | - 'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
161 | - 'after' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
162 | - ); |
|
163 | - |
|
164 | - // Generate the report. |
|
165 | - return array( |
|
166 | - 'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
167 | - 'after' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
168 | - ); |
|
169 | - |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Retrieves this week's date range. |
|
174 | - * |
|
175 | - * @return array The appropriate date range. |
|
176 | - */ |
|
177 | - public function get_week_date_range() { |
|
178 | - |
|
179 | - // Set the previous date range. |
|
180 | - $this->previous_range = array( |
|
181 | - 'period' => 'last_week', |
|
182 | - ); |
|
183 | - |
|
184 | - // Generate the report. |
|
185 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
186 | - return array( |
|
187 | - 'before' => gmdate( 'Y-m-d' ), |
|
188 | - 'after' => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ), |
|
189 | - ); |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * Retrieves last week's date range. |
|
194 | - * |
|
195 | - * @return array The appropriate date range. |
|
196 | - */ |
|
197 | - public function get_last_week_date_range() { |
|
198 | - |
|
199 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
200 | - $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' ); |
|
201 | - $date_range = array( |
|
202 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
203 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
204 | - ); |
|
205 | - |
|
206 | - // Set the previous date range. |
|
207 | - $week_starts = $week_starts - 7 * DAY_IN_SECONDS; |
|
208 | - $this->previous_range = array( |
|
209 | - 'period' => 'custom', |
|
210 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
211 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
212 | - ); |
|
213 | - |
|
214 | - // Generate the report. |
|
215 | - return $date_range; |
|
216 | - } |
|
217 | - |
|
218 | - /** |
|
219 | - * Retrieves last x days date range. |
|
220 | - * |
|
221 | - * @return array The appropriate date range. |
|
222 | - */ |
|
223 | - public function get_x_days_date_range( $days = 7 ) { |
|
224 | - |
|
225 | - $days--; |
|
226 | - |
|
227 | - $date_range = array( |
|
228 | - 'before' => gmdate( 'Y-m-d' ), |
|
229 | - 'after' => gmdate( 'Y-m-d', strtotime( "-$days days" ) ), |
|
230 | - ); |
|
231 | - |
|
232 | - $days++; |
|
233 | - |
|
234 | - // Set the previous date range. |
|
235 | - $this->previous_range = array( |
|
236 | - 'period' => 'custom', |
|
237 | - 'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ), |
|
238 | - 'after' => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ), |
|
239 | - ); |
|
240 | - |
|
241 | - // Generate the report. |
|
242 | - return $date_range; |
|
243 | - } |
|
244 | - |
|
245 | - /** |
|
246 | - * Retrieves this month date range. |
|
247 | - * |
|
248 | - * @return array The appropriate date range. |
|
249 | - */ |
|
250 | - public function get_month_date_range() { |
|
251 | - |
|
252 | - // Set the previous date range. |
|
253 | - $this->previous_range = array( |
|
254 | - 'period' => 'last_month', |
|
255 | - ); |
|
256 | - |
|
257 | - // Generate the report. |
|
258 | - return array( |
|
259 | - 'after' => gmdate( 'Y-m-01' ), |
|
260 | - 'before' => gmdate( 'Y-m-t' ), |
|
261 | - ); |
|
262 | - |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Retrieves last month's date range. |
|
267 | - * |
|
268 | - * @return array The appropriate date range. |
|
269 | - */ |
|
270 | - public function get_last_month_date_range() { |
|
271 | - |
|
272 | - // Set the previous date range. |
|
273 | - $this->previous_range = array( |
|
274 | - 'period' => 'custom', |
|
275 | - 'after' => gmdate( 'Y-m-01', strtotime( '-2 months' ) ), |
|
276 | - 'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ), |
|
277 | - ); |
|
278 | - |
|
279 | - // Generate the report. |
|
280 | - return array( |
|
281 | - 'after' => gmdate( 'Y-m-01', strtotime( 'last month' ) ), |
|
282 | - 'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ), |
|
283 | - ); |
|
284 | - |
|
285 | - } |
|
286 | - |
|
287 | - /** |
|
288 | - * Retrieves this quarter date range. |
|
289 | - * |
|
290 | - * @return array The available quarters. |
|
291 | - */ |
|
292 | - public function get_quarters() { |
|
293 | - |
|
294 | - $year = (int) gmdate( 'Y' ); |
|
295 | - $last_year = (int) $year - 1; |
|
296 | - return array( |
|
297 | - |
|
298 | - // Third quarter of previous year: July 1st to September 30th |
|
299 | - array( |
|
300 | - 'before' => "{$last_year}-09-30", |
|
301 | - 'after' => "{$last_year}-07-01", |
|
302 | - ), |
|
303 | - |
|
304 | - // Last quarter of previous year: October 1st to December 31st |
|
305 | - array( |
|
306 | - 'before' => "{$last_year}-12-31", |
|
307 | - 'after' => "{$last_year}-10-01", |
|
308 | - ), |
|
309 | - |
|
310 | - // First quarter: January 1st to March 31st |
|
311 | - array( |
|
312 | - 'before' => "{$year}-03-31", |
|
313 | - 'after' => "{$year}-01-01", |
|
314 | - ), |
|
315 | - |
|
316 | - // Second quarter: April 1st to June 30th |
|
317 | - array( |
|
318 | - 'before' => "{$year}-06-30", |
|
319 | - 'after' => "{$year}-04-01", |
|
320 | - ), |
|
321 | - |
|
322 | - // Third quarter: July 1st to September 30th |
|
323 | - array( |
|
324 | - 'before' => "{$year}-09-30", |
|
325 | - 'after' => "{$year}-07-01", |
|
326 | - ), |
|
327 | - |
|
328 | - // Fourth quarter: October 1st to December 31st |
|
329 | - array( |
|
330 | - 'before' => "{$year}-12-31", |
|
331 | - 'after' => "{$year}-10-01", |
|
332 | - ), |
|
333 | - ); |
|
334 | - } |
|
335 | - |
|
336 | - /** |
|
337 | - * Retrieves the current quater. |
|
338 | - * |
|
339 | - * @return int The current quarter. |
|
340 | - */ |
|
341 | - public function get_quarter() { |
|
342 | - |
|
343 | - $month = (int) gmdate( 'n' ); |
|
344 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
345 | - return $quarters[ $month - 1 ]; |
|
346 | - |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Retrieves this quarter date range. |
|
351 | - * |
|
352 | - * @return array The appropriate date range. |
|
353 | - */ |
|
354 | - public function get_quarter_date_range() { |
|
355 | - |
|
356 | - // Set the previous date range. |
|
357 | - $this->previous_range = array( |
|
358 | - 'period' => 'last_quarter', |
|
359 | - ); |
|
360 | - |
|
361 | - // Generate the report. |
|
362 | - $quarter = $this->get_quarter(); |
|
363 | - $quarters = $this->get_quarters(); |
|
364 | - return $quarters[ $quarter + 1 ]; |
|
365 | - |
|
366 | - } |
|
367 | - |
|
368 | - /** |
|
369 | - * Retrieves last quarter's date range. |
|
370 | - * |
|
371 | - * @return array The appropriate date range. |
|
372 | - */ |
|
373 | - public function get_last_quarter_date_range() { |
|
374 | - |
|
375 | - $quarters = $this->get_quarters(); |
|
376 | - $quarter = $this->get_quarter(); |
|
377 | - |
|
378 | - // Set the previous date range. |
|
379 | - $this->previous_range = array_merge( |
|
380 | - $quarters[ $quarter - 1 ], |
|
381 | - array( 'period' => 'custom' ) |
|
382 | - ); |
|
383 | - |
|
384 | - // Generate the report. |
|
385 | - return $quarters[ $quarter ]; |
|
386 | - |
|
387 | - } |
|
388 | - |
|
389 | - /** |
|
390 | - * Retrieves this year date range. |
|
391 | - * |
|
392 | - * @return array The appropriate date range. |
|
393 | - */ |
|
394 | - public function get_year_date_range() { |
|
395 | - |
|
396 | - // Set the previous date range. |
|
397 | - $this->previous_range = array( |
|
398 | - 'period' => 'last_year', |
|
399 | - ); |
|
400 | - |
|
401 | - // Generate the report. |
|
402 | - return array( |
|
403 | - 'after' => gmdate( 'Y-01-01' ), |
|
404 | - 'before' => gmdate( 'Y-12-31' ), |
|
405 | - ); |
|
406 | - |
|
407 | - } |
|
408 | - |
|
409 | - /** |
|
410 | - * Retrieves last year date range. |
|
411 | - * |
|
412 | - * @return array The appropriate date range. |
|
413 | - */ |
|
414 | - public function get_last_year_date_range() { |
|
415 | - |
|
416 | - // Set the previous date range. |
|
417 | - $this->previous_range = array( |
|
418 | - 'period' => 'custom', |
|
419 | - 'after' => gmdate( 'Y-01-01', strtotime( '-2 years' ) ), |
|
420 | - 'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ), |
|
421 | - ); |
|
422 | - |
|
423 | - // Generate the report. |
|
424 | - return array( |
|
425 | - 'after' => gmdate( 'Y-01-01', strtotime( 'last year' ) ), |
|
426 | - 'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ), |
|
427 | - ); |
|
428 | - |
|
429 | - } |
|
430 | - |
|
431 | - /** |
|
432 | - * Prepare a the request date for SQL usage. |
|
433 | - * |
|
434 | - * @param WP_REST_Request $request Request object. |
|
435 | - * @param string $date_field The date field. |
|
436 | - * @return string The appropriate SQL. |
|
437 | - */ |
|
438 | - public function get_date_range_sql( $request, $date_field ) { |
|
439 | - global $wpdb; |
|
440 | - |
|
441 | - $sql = '1=1'; |
|
442 | - $range = $this->get_date_range( $request ); |
|
443 | - |
|
444 | - if ( ! empty( $range['after'] ) ) { |
|
445 | - $sql .= ' AND ' . $wpdb->prepare( |
|
446 | - "$date_field >= %s", |
|
447 | - $range['after'] |
|
448 | - ); |
|
449 | - } |
|
450 | - |
|
451 | - if ( ! empty( $range['before'] ) ) { |
|
452 | - $sql .= ' AND ' . $wpdb->prepare( |
|
453 | - "$date_field <= %s", |
|
454 | - $range['before'] |
|
455 | - ); |
|
456 | - } |
|
457 | - |
|
458 | - return $sql; |
|
459 | - |
|
460 | - } |
|
461 | - |
|
462 | - /** |
|
463 | - * Prepares a group by query. |
|
464 | - * |
|
465 | - * @param string $date_field The date field. |
|
466 | - * @return string The appropriate SQL. |
|
467 | - */ |
|
468 | - public function get_group_by_sql( $date_field ) { |
|
469 | - |
|
470 | - if ( 'day' === $this->groupby ) { |
|
471 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
472 | - } |
|
473 | - |
|
474 | - return "YEAR($date_field), MONTH($date_field)"; |
|
475 | - } |
|
476 | - |
|
477 | - /** |
|
478 | - * Get the query params for collections. |
|
479 | - * |
|
480 | - * @return array |
|
481 | - */ |
|
482 | - public function get_collection_params() { |
|
483 | - return array( |
|
484 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
485 | - 'period' => array( |
|
486 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
487 | - 'type' => 'string', |
|
488 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
489 | - 'validate_callback' => 'rest_validate_request_arg', |
|
490 | - 'sanitize_callback' => 'sanitize_text_field', |
|
491 | - 'default' => '7_days', |
|
492 | - ), |
|
493 | - 'after' => array( |
|
494 | - /* translators: %s: date format */ |
|
495 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
496 | - 'type' => 'string', |
|
497 | - 'validate_callback' => 'rest_validate_request_arg', |
|
498 | - 'sanitize_callback' => 'sanitize_text_field', |
|
499 | - 'default' => gmdate( 'Y-m-d', strtotime( '-7 days' ) ), |
|
500 | - ), |
|
501 | - 'before' => array( |
|
502 | - /* translators: %s: date format */ |
|
503 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
504 | - 'type' => 'string', |
|
505 | - 'validate_callback' => 'rest_validate_request_arg', |
|
506 | - 'sanitize_callback' => 'sanitize_text_field', |
|
507 | - 'default' => gmdate( 'Y-m-d' ), |
|
508 | - ), |
|
509 | - ); |
|
510 | - } |
|
19 | + /** |
|
20 | + * Group response items by day or month. |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + public $groupby = 'day'; |
|
25 | + |
|
26 | + /** |
|
27 | + * Returns an array with arguments to request the previous report. |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + public $previous_range = array(); |
|
32 | + |
|
33 | + /** |
|
34 | + * The period interval. |
|
35 | + * |
|
36 | + * @var int |
|
37 | + */ |
|
38 | + public $interval; |
|
39 | + |
|
40 | + /** |
|
41 | + * Retrieves the before and after dates. |
|
42 | + * |
|
43 | + * @param WP_REST_Request $request Request object. |
|
44 | + * @return array The appropriate date range. |
|
45 | + */ |
|
46 | + public function get_date_range( $request ) { |
|
47 | + |
|
48 | + // Check if the period is x_days. |
|
49 | + if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) { |
|
50 | + $date_range = $this->get_x_days_date_range( absint( $matches[1] ) ); |
|
51 | + } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) { |
|
52 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
53 | + } else { |
|
54 | + $request['period'] = '7_days'; |
|
55 | + $date_range = $this->get_x_days_date_range(); |
|
56 | + } |
|
57 | + |
|
58 | + // 3 months max for day view. |
|
59 | + $before = strtotime( $date_range['before'] ); |
|
60 | + $after = strtotime( $date_range['after'] ); |
|
61 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) { |
|
62 | + $this->groupby = 'month'; |
|
63 | + } |
|
64 | + |
|
65 | + $this->prepare_interval( $date_range ); |
|
66 | + |
|
67 | + return $date_range; |
|
68 | + |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Groups by month or days. |
|
73 | + * |
|
74 | + * @param array $range Date range. |
|
75 | + * @return array The appropriate date range. |
|
76 | + */ |
|
77 | + public function prepare_interval( $range ) { |
|
78 | + |
|
79 | + $before = strtotime( $range['before'] ); |
|
80 | + $after = strtotime( $range['after'] ); |
|
81 | + if ( 'day' === $this->groupby ) { |
|
82 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
83 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
84 | + return; |
|
85 | + } |
|
86 | + |
|
87 | + $this->interval = 0; |
|
88 | + $min_date = strtotime( gmdate( 'Y-m-01', $after ) ); |
|
89 | + |
|
90 | + while ( $min_date <= $before ) { |
|
91 | + $this->interval ++; |
|
92 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
93 | + } |
|
94 | + |
|
95 | + $this->interval = max( 1, $this->interval ); |
|
96 | + |
|
97 | + } |
|
98 | + |
|
99 | + /** |
|
100 | + * Retrieves a custom date range. |
|
101 | + * |
|
102 | + * @param WP_REST_Request $request Request object. |
|
103 | + * @return array The appropriate date range. |
|
104 | + */ |
|
105 | + public function get_custom_date_range( $request ) { |
|
106 | + |
|
107 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
108 | + $before = gmdate( 'Y-m-d' ); |
|
109 | + |
|
110 | + if ( ! empty( $request['before'] ) ) { |
|
111 | + $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
112 | + } |
|
113 | + |
|
114 | + // Set the previous date range. |
|
115 | + $difference = $before - $after; |
|
116 | + $this->previous_range = array( |
|
117 | + 'period' => 'custom', |
|
118 | + 'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ), |
|
119 | + 'after' => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ), |
|
120 | + ); |
|
121 | + |
|
122 | + // Generate the report. |
|
123 | + return array( |
|
124 | + 'before' => gmdate( 'Y-m-d', $before ), |
|
125 | + 'after' => gmdate( 'Y-m-d', $after ), |
|
126 | + ); |
|
127 | + |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Retrieves todays date range. |
|
132 | + * |
|
133 | + * @return array The appropriate date range. |
|
134 | + */ |
|
135 | + public function get_today_date_range() { |
|
136 | + |
|
137 | + // Set the previous date range. |
|
138 | + $this->previous_range = array( |
|
139 | + 'period' => 'yesterday', |
|
140 | + ); |
|
141 | + |
|
142 | + // Generate the report. |
|
143 | + return array( |
|
144 | + 'before' => gmdate( 'Y-m-d' ), |
|
145 | + 'after' => gmdate( 'Y-m-d' ), |
|
146 | + ); |
|
147 | + |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Retrieves yesterdays date range. |
|
152 | + * |
|
153 | + * @return array The appropriate date range. |
|
154 | + */ |
|
155 | + public function get_yesterday_date_range() { |
|
156 | + |
|
157 | + // Set the previous date range. |
|
158 | + $this->previous_range = array( |
|
159 | + 'period' => 'custom', |
|
160 | + 'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
161 | + 'after' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
162 | + ); |
|
163 | + |
|
164 | + // Generate the report. |
|
165 | + return array( |
|
166 | + 'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
167 | + 'after' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
168 | + ); |
|
169 | + |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Retrieves this week's date range. |
|
174 | + * |
|
175 | + * @return array The appropriate date range. |
|
176 | + */ |
|
177 | + public function get_week_date_range() { |
|
178 | + |
|
179 | + // Set the previous date range. |
|
180 | + $this->previous_range = array( |
|
181 | + 'period' => 'last_week', |
|
182 | + ); |
|
183 | + |
|
184 | + // Generate the report. |
|
185 | + $week_starts = absint( get_option( 'start_of_week' ) ); |
|
186 | + return array( |
|
187 | + 'before' => gmdate( 'Y-m-d' ), |
|
188 | + 'after' => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ), |
|
189 | + ); |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * Retrieves last week's date range. |
|
194 | + * |
|
195 | + * @return array The appropriate date range. |
|
196 | + */ |
|
197 | + public function get_last_week_date_range() { |
|
198 | + |
|
199 | + $week_starts = absint( get_option( 'start_of_week' ) ); |
|
200 | + $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' ); |
|
201 | + $date_range = array( |
|
202 | + 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
203 | + 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
204 | + ); |
|
205 | + |
|
206 | + // Set the previous date range. |
|
207 | + $week_starts = $week_starts - 7 * DAY_IN_SECONDS; |
|
208 | + $this->previous_range = array( |
|
209 | + 'period' => 'custom', |
|
210 | + 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
211 | + 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
212 | + ); |
|
213 | + |
|
214 | + // Generate the report. |
|
215 | + return $date_range; |
|
216 | + } |
|
217 | + |
|
218 | + /** |
|
219 | + * Retrieves last x days date range. |
|
220 | + * |
|
221 | + * @return array The appropriate date range. |
|
222 | + */ |
|
223 | + public function get_x_days_date_range( $days = 7 ) { |
|
224 | + |
|
225 | + $days--; |
|
226 | + |
|
227 | + $date_range = array( |
|
228 | + 'before' => gmdate( 'Y-m-d' ), |
|
229 | + 'after' => gmdate( 'Y-m-d', strtotime( "-$days days" ) ), |
|
230 | + ); |
|
231 | + |
|
232 | + $days++; |
|
233 | + |
|
234 | + // Set the previous date range. |
|
235 | + $this->previous_range = array( |
|
236 | + 'period' => 'custom', |
|
237 | + 'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ), |
|
238 | + 'after' => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ), |
|
239 | + ); |
|
240 | + |
|
241 | + // Generate the report. |
|
242 | + return $date_range; |
|
243 | + } |
|
244 | + |
|
245 | + /** |
|
246 | + * Retrieves this month date range. |
|
247 | + * |
|
248 | + * @return array The appropriate date range. |
|
249 | + */ |
|
250 | + public function get_month_date_range() { |
|
251 | + |
|
252 | + // Set the previous date range. |
|
253 | + $this->previous_range = array( |
|
254 | + 'period' => 'last_month', |
|
255 | + ); |
|
256 | + |
|
257 | + // Generate the report. |
|
258 | + return array( |
|
259 | + 'after' => gmdate( 'Y-m-01' ), |
|
260 | + 'before' => gmdate( 'Y-m-t' ), |
|
261 | + ); |
|
262 | + |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Retrieves last month's date range. |
|
267 | + * |
|
268 | + * @return array The appropriate date range. |
|
269 | + */ |
|
270 | + public function get_last_month_date_range() { |
|
271 | + |
|
272 | + // Set the previous date range. |
|
273 | + $this->previous_range = array( |
|
274 | + 'period' => 'custom', |
|
275 | + 'after' => gmdate( 'Y-m-01', strtotime( '-2 months' ) ), |
|
276 | + 'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ), |
|
277 | + ); |
|
278 | + |
|
279 | + // Generate the report. |
|
280 | + return array( |
|
281 | + 'after' => gmdate( 'Y-m-01', strtotime( 'last month' ) ), |
|
282 | + 'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ), |
|
283 | + ); |
|
284 | + |
|
285 | + } |
|
286 | + |
|
287 | + /** |
|
288 | + * Retrieves this quarter date range. |
|
289 | + * |
|
290 | + * @return array The available quarters. |
|
291 | + */ |
|
292 | + public function get_quarters() { |
|
293 | + |
|
294 | + $year = (int) gmdate( 'Y' ); |
|
295 | + $last_year = (int) $year - 1; |
|
296 | + return array( |
|
297 | + |
|
298 | + // Third quarter of previous year: July 1st to September 30th |
|
299 | + array( |
|
300 | + 'before' => "{$last_year}-09-30", |
|
301 | + 'after' => "{$last_year}-07-01", |
|
302 | + ), |
|
303 | + |
|
304 | + // Last quarter of previous year: October 1st to December 31st |
|
305 | + array( |
|
306 | + 'before' => "{$last_year}-12-31", |
|
307 | + 'after' => "{$last_year}-10-01", |
|
308 | + ), |
|
309 | + |
|
310 | + // First quarter: January 1st to March 31st |
|
311 | + array( |
|
312 | + 'before' => "{$year}-03-31", |
|
313 | + 'after' => "{$year}-01-01", |
|
314 | + ), |
|
315 | + |
|
316 | + // Second quarter: April 1st to June 30th |
|
317 | + array( |
|
318 | + 'before' => "{$year}-06-30", |
|
319 | + 'after' => "{$year}-04-01", |
|
320 | + ), |
|
321 | + |
|
322 | + // Third quarter: July 1st to September 30th |
|
323 | + array( |
|
324 | + 'before' => "{$year}-09-30", |
|
325 | + 'after' => "{$year}-07-01", |
|
326 | + ), |
|
327 | + |
|
328 | + // Fourth quarter: October 1st to December 31st |
|
329 | + array( |
|
330 | + 'before' => "{$year}-12-31", |
|
331 | + 'after' => "{$year}-10-01", |
|
332 | + ), |
|
333 | + ); |
|
334 | + } |
|
335 | + |
|
336 | + /** |
|
337 | + * Retrieves the current quater. |
|
338 | + * |
|
339 | + * @return int The current quarter. |
|
340 | + */ |
|
341 | + public function get_quarter() { |
|
342 | + |
|
343 | + $month = (int) gmdate( 'n' ); |
|
344 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
345 | + return $quarters[ $month - 1 ]; |
|
346 | + |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Retrieves this quarter date range. |
|
351 | + * |
|
352 | + * @return array The appropriate date range. |
|
353 | + */ |
|
354 | + public function get_quarter_date_range() { |
|
355 | + |
|
356 | + // Set the previous date range. |
|
357 | + $this->previous_range = array( |
|
358 | + 'period' => 'last_quarter', |
|
359 | + ); |
|
360 | + |
|
361 | + // Generate the report. |
|
362 | + $quarter = $this->get_quarter(); |
|
363 | + $quarters = $this->get_quarters(); |
|
364 | + return $quarters[ $quarter + 1 ]; |
|
365 | + |
|
366 | + } |
|
367 | + |
|
368 | + /** |
|
369 | + * Retrieves last quarter's date range. |
|
370 | + * |
|
371 | + * @return array The appropriate date range. |
|
372 | + */ |
|
373 | + public function get_last_quarter_date_range() { |
|
374 | + |
|
375 | + $quarters = $this->get_quarters(); |
|
376 | + $quarter = $this->get_quarter(); |
|
377 | + |
|
378 | + // Set the previous date range. |
|
379 | + $this->previous_range = array_merge( |
|
380 | + $quarters[ $quarter - 1 ], |
|
381 | + array( 'period' => 'custom' ) |
|
382 | + ); |
|
383 | + |
|
384 | + // Generate the report. |
|
385 | + return $quarters[ $quarter ]; |
|
386 | + |
|
387 | + } |
|
388 | + |
|
389 | + /** |
|
390 | + * Retrieves this year date range. |
|
391 | + * |
|
392 | + * @return array The appropriate date range. |
|
393 | + */ |
|
394 | + public function get_year_date_range() { |
|
395 | + |
|
396 | + // Set the previous date range. |
|
397 | + $this->previous_range = array( |
|
398 | + 'period' => 'last_year', |
|
399 | + ); |
|
400 | + |
|
401 | + // Generate the report. |
|
402 | + return array( |
|
403 | + 'after' => gmdate( 'Y-01-01' ), |
|
404 | + 'before' => gmdate( 'Y-12-31' ), |
|
405 | + ); |
|
406 | + |
|
407 | + } |
|
408 | + |
|
409 | + /** |
|
410 | + * Retrieves last year date range. |
|
411 | + * |
|
412 | + * @return array The appropriate date range. |
|
413 | + */ |
|
414 | + public function get_last_year_date_range() { |
|
415 | + |
|
416 | + // Set the previous date range. |
|
417 | + $this->previous_range = array( |
|
418 | + 'period' => 'custom', |
|
419 | + 'after' => gmdate( 'Y-01-01', strtotime( '-2 years' ) ), |
|
420 | + 'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ), |
|
421 | + ); |
|
422 | + |
|
423 | + // Generate the report. |
|
424 | + return array( |
|
425 | + 'after' => gmdate( 'Y-01-01', strtotime( 'last year' ) ), |
|
426 | + 'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ), |
|
427 | + ); |
|
428 | + |
|
429 | + } |
|
430 | + |
|
431 | + /** |
|
432 | + * Prepare a the request date for SQL usage. |
|
433 | + * |
|
434 | + * @param WP_REST_Request $request Request object. |
|
435 | + * @param string $date_field The date field. |
|
436 | + * @return string The appropriate SQL. |
|
437 | + */ |
|
438 | + public function get_date_range_sql( $request, $date_field ) { |
|
439 | + global $wpdb; |
|
440 | + |
|
441 | + $sql = '1=1'; |
|
442 | + $range = $this->get_date_range( $request ); |
|
443 | + |
|
444 | + if ( ! empty( $range['after'] ) ) { |
|
445 | + $sql .= ' AND ' . $wpdb->prepare( |
|
446 | + "$date_field >= %s", |
|
447 | + $range['after'] |
|
448 | + ); |
|
449 | + } |
|
450 | + |
|
451 | + if ( ! empty( $range['before'] ) ) { |
|
452 | + $sql .= ' AND ' . $wpdb->prepare( |
|
453 | + "$date_field <= %s", |
|
454 | + $range['before'] |
|
455 | + ); |
|
456 | + } |
|
457 | + |
|
458 | + return $sql; |
|
459 | + |
|
460 | + } |
|
461 | + |
|
462 | + /** |
|
463 | + * Prepares a group by query. |
|
464 | + * |
|
465 | + * @param string $date_field The date field. |
|
466 | + * @return string The appropriate SQL. |
|
467 | + */ |
|
468 | + public function get_group_by_sql( $date_field ) { |
|
469 | + |
|
470 | + if ( 'day' === $this->groupby ) { |
|
471 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
472 | + } |
|
473 | + |
|
474 | + return "YEAR($date_field), MONTH($date_field)"; |
|
475 | + } |
|
476 | + |
|
477 | + /** |
|
478 | + * Get the query params for collections. |
|
479 | + * |
|
480 | + * @return array |
|
481 | + */ |
|
482 | + public function get_collection_params() { |
|
483 | + return array( |
|
484 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
485 | + 'period' => array( |
|
486 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
487 | + 'type' => 'string', |
|
488 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
489 | + 'validate_callback' => 'rest_validate_request_arg', |
|
490 | + 'sanitize_callback' => 'sanitize_text_field', |
|
491 | + 'default' => '7_days', |
|
492 | + ), |
|
493 | + 'after' => array( |
|
494 | + /* translators: %s: date format */ |
|
495 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
496 | + 'type' => 'string', |
|
497 | + 'validate_callback' => 'rest_validate_request_arg', |
|
498 | + 'sanitize_callback' => 'sanitize_text_field', |
|
499 | + 'default' => gmdate( 'Y-m-d', strtotime( '-7 days' ) ), |
|
500 | + ), |
|
501 | + 'before' => array( |
|
502 | + /* translators: %s: date format */ |
|
503 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
504 | + 'type' => 'string', |
|
505 | + 'validate_callback' => 'rest_validate_request_arg', |
|
506 | + 'sanitize_callback' => 'sanitize_text_field', |
|
507 | + 'default' => gmdate( 'Y-m-d' ), |
|
508 | + ), |
|
509 | + ); |
|
510 | + } |
|
511 | 511 | } |
@@ -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,26 +43,26 @@ 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 | // Check if the period is x_days. |
49 | - if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) { |
|
50 | - $date_range = $this->get_x_days_date_range( absint( $matches[1] ) ); |
|
51 | - } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) { |
|
52 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
49 | + if (preg_match('/^(\d+)_days$/', $request['period'], $matches)) { |
|
50 | + $date_range = $this->get_x_days_date_range(absint($matches[1])); |
|
51 | + } elseif (is_callable(array($this, 'get_' . $request['period'] . '_date_range'))) { |
|
52 | + $date_range = call_user_func(array($this, 'get_' . $request['period'] . '_date_range'), $request); |
|
53 | 53 | } else { |
54 | 54 | $request['period'] = '7_days'; |
55 | 55 | $date_range = $this->get_x_days_date_range(); |
56 | 56 | } |
57 | 57 | |
58 | 58 | // 3 months max for day view. |
59 | - $before = strtotime( $date_range['before'] ); |
|
60 | - $after = strtotime( $date_range['after'] ); |
|
61 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) { |
|
59 | + $before = strtotime($date_range['before']); |
|
60 | + $after = strtotime($date_range['after']); |
|
61 | + if (floor(($before - $after) / MONTH_IN_SECONDS) > 2) { |
|
62 | 62 | $this->groupby = 'month'; |
63 | 63 | } |
64 | 64 | |
65 | - $this->prepare_interval( $date_range ); |
|
65 | + $this->prepare_interval($date_range); |
|
66 | 66 | |
67 | 67 | return $date_range; |
68 | 68 | |
@@ -74,25 +74,25 @@ discard block |
||
74 | 74 | * @param array $range Date range. |
75 | 75 | * @return array The appropriate date range. |
76 | 76 | */ |
77 | - public function prepare_interval( $range ) { |
|
77 | + public function prepare_interval($range) { |
|
78 | 78 | |
79 | - $before = strtotime( $range['before'] ); |
|
80 | - $after = strtotime( $range['after'] ); |
|
81 | - if ( 'day' === $this->groupby ) { |
|
82 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
83 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
79 | + $before = strtotime($range['before']); |
|
80 | + $after = strtotime($range['after']); |
|
81 | + if ('day' === $this->groupby) { |
|
82 | + $difference = max(DAY_IN_SECONDS, (DAY_IN_SECONDS + $before - $after)); // Prevent division by 0; |
|
83 | + $this->interval = absint(ceil(max(1, $difference / DAY_IN_SECONDS))); |
|
84 | 84 | return; |
85 | 85 | } |
86 | 86 | |
87 | 87 | $this->interval = 0; |
88 | - $min_date = strtotime( gmdate( 'Y-m-01', $after ) ); |
|
88 | + $min_date = strtotime(gmdate('Y-m-01', $after)); |
|
89 | 89 | |
90 | - while ( $min_date <= $before ) { |
|
91 | - $this->interval ++; |
|
92 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
90 | + while ($min_date <= $before) { |
|
91 | + $this->interval++; |
|
92 | + $min_date = strtotime('+1 MONTH', $min_date); |
|
93 | 93 | } |
94 | 94 | |
95 | - $this->interval = max( 1, $this->interval ); |
|
95 | + $this->interval = max(1, $this->interval); |
|
96 | 96 | |
97 | 97 | } |
98 | 98 | |
@@ -102,27 +102,27 @@ discard block |
||
102 | 102 | * @param WP_REST_Request $request Request object. |
103 | 103 | * @return array The appropriate date range. |
104 | 104 | */ |
105 | - public function get_custom_date_range( $request ) { |
|
105 | + public function get_custom_date_range($request) { |
|
106 | 106 | |
107 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
108 | - $before = gmdate( 'Y-m-d' ); |
|
107 | + $after = max(strtotime('-20 years'), strtotime(sanitize_text_field($request['after']))); |
|
108 | + $before = gmdate('Y-m-d'); |
|
109 | 109 | |
110 | - if ( ! empty( $request['before'] ) ) { |
|
111 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
110 | + if (!empty($request['before'])) { |
|
111 | + $before = min($before, strtotime(sanitize_text_field($request['before']))); |
|
112 | 112 | } |
113 | 113 | |
114 | 114 | // Set the previous date range. |
115 | 115 | $difference = $before - $after; |
116 | 116 | $this->previous_range = array( |
117 | 117 | 'period' => 'custom', |
118 | - 'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ), |
|
119 | - 'after' => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ), |
|
118 | + 'before' => gmdate('Y-m-d', $before - $difference - DAY_IN_SECONDS), |
|
119 | + 'after' => gmdate('Y-m-d', $after - $difference - DAY_IN_SECONDS), |
|
120 | 120 | ); |
121 | 121 | |
122 | 122 | // Generate the report. |
123 | 123 | return array( |
124 | - 'before' => gmdate( 'Y-m-d', $before ), |
|
125 | - 'after' => gmdate( 'Y-m-d', $after ), |
|
124 | + 'before' => gmdate('Y-m-d', $before), |
|
125 | + 'after' => gmdate('Y-m-d', $after), |
|
126 | 126 | ); |
127 | 127 | |
128 | 128 | } |
@@ -141,8 +141,8 @@ discard block |
||
141 | 141 | |
142 | 142 | // Generate the report. |
143 | 143 | return array( |
144 | - 'before' => gmdate( 'Y-m-d' ), |
|
145 | - 'after' => gmdate( 'Y-m-d' ), |
|
144 | + 'before' => gmdate('Y-m-d'), |
|
145 | + 'after' => gmdate('Y-m-d'), |
|
146 | 146 | ); |
147 | 147 | |
148 | 148 | } |
@@ -157,14 +157,14 @@ discard block |
||
157 | 157 | // Set the previous date range. |
158 | 158 | $this->previous_range = array( |
159 | 159 | 'period' => 'custom', |
160 | - 'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
161 | - 'after' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ), |
|
160 | + 'before' => gmdate('Y-m-d', strtotime('-2 days')), |
|
161 | + 'after' => gmdate('Y-m-d', strtotime('-2 days')), |
|
162 | 162 | ); |
163 | 163 | |
164 | 164 | // Generate the report. |
165 | 165 | return array( |
166 | - 'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
167 | - 'after' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ), |
|
166 | + 'before' => gmdate('Y-m-d', strtotime('-1 day')), |
|
167 | + 'after' => gmdate('Y-m-d', strtotime('-1 day')), |
|
168 | 168 | ); |
169 | 169 | |
170 | 170 | } |
@@ -182,10 +182,10 @@ discard block |
||
182 | 182 | ); |
183 | 183 | |
184 | 184 | // Generate the report. |
185 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
185 | + $week_starts = absint(get_option('start_of_week')); |
|
186 | 186 | return array( |
187 | - 'before' => gmdate( 'Y-m-d' ), |
|
188 | - 'after' => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ), |
|
187 | + 'before' => gmdate('Y-m-d'), |
|
188 | + 'after' => gmdate('Y-m-d', strtotime('next Sunday -' . (7 - $week_starts) . ' days')), |
|
189 | 189 | ); |
190 | 190 | } |
191 | 191 | |
@@ -196,19 +196,19 @@ discard block |
||
196 | 196 | */ |
197 | 197 | public function get_last_week_date_range() { |
198 | 198 | |
199 | - $week_starts = absint( get_option( 'start_of_week' ) ); |
|
200 | - $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' ); |
|
199 | + $week_starts = absint(get_option('start_of_week')); |
|
200 | + $week_starts = strtotime('last Sunday -' . (7 - $week_starts) . ' days'); |
|
201 | 201 | $date_range = array( |
202 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
203 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
202 | + 'before' => gmdate('Y-m-d', $week_starts + 6 * DAY_IN_SECONDS), |
|
203 | + 'after' => gmdate('Y-m-d', $week_starts), |
|
204 | 204 | ); |
205 | 205 | |
206 | 206 | // Set the previous date range. |
207 | 207 | $week_starts = $week_starts - 7 * DAY_IN_SECONDS; |
208 | 208 | $this->previous_range = array( |
209 | 209 | 'period' => 'custom', |
210 | - 'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ), |
|
211 | - 'after' => gmdate( 'Y-m-d', $week_starts ), |
|
210 | + 'before' => gmdate('Y-m-d', $week_starts + 6 * DAY_IN_SECONDS), |
|
211 | + 'after' => gmdate('Y-m-d', $week_starts), |
|
212 | 212 | ); |
213 | 213 | |
214 | 214 | // Generate the report. |
@@ -220,13 +220,13 @@ discard block |
||
220 | 220 | * |
221 | 221 | * @return array The appropriate date range. |
222 | 222 | */ |
223 | - public function get_x_days_date_range( $days = 7 ) { |
|
223 | + public function get_x_days_date_range($days = 7) { |
|
224 | 224 | |
225 | 225 | $days--; |
226 | 226 | |
227 | - $date_range = array( |
|
228 | - 'before' => gmdate( 'Y-m-d' ), |
|
229 | - 'after' => gmdate( 'Y-m-d', strtotime( "-$days days" ) ), |
|
227 | + $date_range = array( |
|
228 | + 'before' => gmdate('Y-m-d'), |
|
229 | + 'after' => gmdate('Y-m-d', strtotime("-$days days")), |
|
230 | 230 | ); |
231 | 231 | |
232 | 232 | $days++; |
@@ -234,8 +234,8 @@ discard block |
||
234 | 234 | // Set the previous date range. |
235 | 235 | $this->previous_range = array( |
236 | 236 | 'period' => 'custom', |
237 | - 'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ), |
|
238 | - 'after' => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ), |
|
237 | + 'before' => gmdate('Y-m-d', strtotime($date_range['before']) - $days * DAY_IN_SECONDS), |
|
238 | + 'after' => gmdate('Y-m-d', strtotime($date_range['after']) - $days * DAY_IN_SECONDS), |
|
239 | 239 | ); |
240 | 240 | |
241 | 241 | // Generate the report. |
@@ -256,8 +256,8 @@ discard block |
||
256 | 256 | |
257 | 257 | // Generate the report. |
258 | 258 | return array( |
259 | - 'after' => gmdate( 'Y-m-01' ), |
|
260 | - 'before' => gmdate( 'Y-m-t' ), |
|
259 | + 'after' => gmdate('Y-m-01'), |
|
260 | + 'before' => gmdate('Y-m-t'), |
|
261 | 261 | ); |
262 | 262 | |
263 | 263 | } |
@@ -272,14 +272,14 @@ discard block |
||
272 | 272 | // Set the previous date range. |
273 | 273 | $this->previous_range = array( |
274 | 274 | 'period' => 'custom', |
275 | - 'after' => gmdate( 'Y-m-01', strtotime( '-2 months' ) ), |
|
276 | - 'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ), |
|
275 | + 'after' => gmdate('Y-m-01', strtotime('-2 months')), |
|
276 | + 'before' => gmdate('Y-m-t', strtotime('-2 months')), |
|
277 | 277 | ); |
278 | 278 | |
279 | 279 | // Generate the report. |
280 | 280 | return array( |
281 | - 'after' => gmdate( 'Y-m-01', strtotime( 'last month' ) ), |
|
282 | - 'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ), |
|
281 | + 'after' => gmdate('Y-m-01', strtotime('last month')), |
|
282 | + 'before' => gmdate('Y-m-t', strtotime('last month')), |
|
283 | 283 | ); |
284 | 284 | |
285 | 285 | } |
@@ -291,7 +291,7 @@ discard block |
||
291 | 291 | */ |
292 | 292 | public function get_quarters() { |
293 | 293 | |
294 | - $year = (int) gmdate( 'Y' ); |
|
294 | + $year = (int) gmdate('Y'); |
|
295 | 295 | $last_year = (int) $year - 1; |
296 | 296 | return array( |
297 | 297 | |
@@ -340,9 +340,9 @@ discard block |
||
340 | 340 | */ |
341 | 341 | public function get_quarter() { |
342 | 342 | |
343 | - $month = (int) gmdate( 'n' ); |
|
344 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
345 | - return $quarters[ $month - 1 ]; |
|
343 | + $month = (int) gmdate('n'); |
|
344 | + $quarters = array(1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4); |
|
345 | + return $quarters[$month - 1]; |
|
346 | 346 | |
347 | 347 | } |
348 | 348 | |
@@ -361,7 +361,7 @@ discard block |
||
361 | 361 | // Generate the report. |
362 | 362 | $quarter = $this->get_quarter(); |
363 | 363 | $quarters = $this->get_quarters(); |
364 | - return $quarters[ $quarter + 1 ]; |
|
364 | + return $quarters[$quarter + 1]; |
|
365 | 365 | |
366 | 366 | } |
367 | 367 | |
@@ -377,12 +377,12 @@ discard block |
||
377 | 377 | |
378 | 378 | // Set the previous date range. |
379 | 379 | $this->previous_range = array_merge( |
380 | - $quarters[ $quarter - 1 ], |
|
381 | - array( 'period' => 'custom' ) |
|
380 | + $quarters[$quarter - 1], |
|
381 | + array('period' => 'custom') |
|
382 | 382 | ); |
383 | 383 | |
384 | 384 | // Generate the report. |
385 | - return $quarters[ $quarter ]; |
|
385 | + return $quarters[$quarter]; |
|
386 | 386 | |
387 | 387 | } |
388 | 388 | |
@@ -400,8 +400,8 @@ discard block |
||
400 | 400 | |
401 | 401 | // Generate the report. |
402 | 402 | return array( |
403 | - 'after' => gmdate( 'Y-01-01' ), |
|
404 | - 'before' => gmdate( 'Y-12-31' ), |
|
403 | + 'after' => gmdate('Y-01-01'), |
|
404 | + 'before' => gmdate('Y-12-31'), |
|
405 | 405 | ); |
406 | 406 | |
407 | 407 | } |
@@ -416,14 +416,14 @@ discard block |
||
416 | 416 | // Set the previous date range. |
417 | 417 | $this->previous_range = array( |
418 | 418 | 'period' => 'custom', |
419 | - 'after' => gmdate( 'Y-01-01', strtotime( '-2 years' ) ), |
|
420 | - 'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ), |
|
419 | + 'after' => gmdate('Y-01-01', strtotime('-2 years')), |
|
420 | + 'before' => gmdate('Y-12-31', strtotime('-2 years')), |
|
421 | 421 | ); |
422 | 422 | |
423 | 423 | // Generate the report. |
424 | 424 | return array( |
425 | - 'after' => gmdate( 'Y-01-01', strtotime( 'last year' ) ), |
|
426 | - 'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ), |
|
425 | + 'after' => gmdate('Y-01-01', strtotime('last year')), |
|
426 | + 'before' => gmdate('Y-12-31', strtotime('last year')), |
|
427 | 427 | ); |
428 | 428 | |
429 | 429 | } |
@@ -435,20 +435,20 @@ discard block |
||
435 | 435 | * @param string $date_field The date field. |
436 | 436 | * @return string The appropriate SQL. |
437 | 437 | */ |
438 | - public function get_date_range_sql( $request, $date_field ) { |
|
438 | + public function get_date_range_sql($request, $date_field) { |
|
439 | 439 | global $wpdb; |
440 | 440 | |
441 | 441 | $sql = '1=1'; |
442 | - $range = $this->get_date_range( $request ); |
|
442 | + $range = $this->get_date_range($request); |
|
443 | 443 | |
444 | - if ( ! empty( $range['after'] ) ) { |
|
444 | + if (!empty($range['after'])) { |
|
445 | 445 | $sql .= ' AND ' . $wpdb->prepare( |
446 | 446 | "$date_field >= %s", |
447 | 447 | $range['after'] |
448 | 448 | ); |
449 | 449 | } |
450 | 450 | |
451 | - if ( ! empty( $range['before'] ) ) { |
|
451 | + if (!empty($range['before'])) { |
|
452 | 452 | $sql .= ' AND ' . $wpdb->prepare( |
453 | 453 | "$date_field <= %s", |
454 | 454 | $range['before'] |
@@ -465,9 +465,9 @@ discard block |
||
465 | 465 | * @param string $date_field The date field. |
466 | 466 | * @return string The appropriate SQL. |
467 | 467 | */ |
468 | - public function get_group_by_sql( $date_field ) { |
|
468 | + public function get_group_by_sql($date_field) { |
|
469 | 469 | |
470 | - if ( 'day' === $this->groupby ) { |
|
470 | + if ('day' === $this->groupby) { |
|
471 | 471 | return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
472 | 472 | } |
473 | 473 | |
@@ -481,30 +481,30 @@ discard block |
||
481 | 481 | */ |
482 | 482 | public function get_collection_params() { |
483 | 483 | return array( |
484 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
484 | + 'context' => $this->get_context_param(array('default' => 'view')), |
|
485 | 485 | 'period' => array( |
486 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
486 | + 'description' => __('Limit to results of a specific period.', 'invoicing'), |
|
487 | 487 | 'type' => 'string', |
488 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
488 | + 'enum' => array('custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter'), |
|
489 | 489 | 'validate_callback' => 'rest_validate_request_arg', |
490 | 490 | 'sanitize_callback' => 'sanitize_text_field', |
491 | 491 | 'default' => '7_days', |
492 | 492 | ), |
493 | 493 | 'after' => array( |
494 | 494 | /* translators: %s: date format */ |
495 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
495 | + 'description' => sprintf(__('Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
496 | 496 | 'type' => 'string', |
497 | 497 | 'validate_callback' => 'rest_validate_request_arg', |
498 | 498 | 'sanitize_callback' => 'sanitize_text_field', |
499 | - 'default' => gmdate( 'Y-m-d', strtotime( '-7 days' ) ), |
|
499 | + 'default' => gmdate('Y-m-d', strtotime('-7 days')), |
|
500 | 500 | ), |
501 | 501 | 'before' => array( |
502 | 502 | /* translators: %s: date format */ |
503 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
503 | + 'description' => sprintf(__('Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'), |
|
504 | 504 | 'type' => 'string', |
505 | 505 | 'validate_callback' => 'rest_validate_request_arg', |
506 | 506 | 'sanitize_callback' => 'sanitize_text_field', |
507 | - 'default' => gmdate( 'Y-m-d' ), |
|
507 | + 'default' => gmdate('Y-m-d'), |
|
508 | 508 | ), |
509 | 509 | ); |
510 | 510 | } |
@@ -12,294 +12,294 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Reports_Helper { |
14 | 14 | |
15 | - /** |
|
16 | - * Get report totals such as invoice totals and discount amounts. |
|
17 | - * |
|
18 | - * Data example: |
|
19 | - * |
|
20 | - * 'subtotal' => array( |
|
21 | - * 'type' => 'invoice_data', |
|
22 | - * 'function' => 'SUM', |
|
23 | - * 'name' => 'subtotal' |
|
24 | - * ) |
|
25 | - * |
|
26 | - * @param array $args |
|
27 | - * @return mixed depending on query_type |
|
28 | - */ |
|
29 | - public static function get_invoice_report_data( $args = array() ) { |
|
30 | - global $wpdb; |
|
31 | - |
|
32 | - $default_args = array( |
|
33 | - 'data' => array(), // The data to retrieve. |
|
34 | - 'where' => array(), // An array of where queries. |
|
35 | - 'query_type' => 'get_row', // wpdb query to run. |
|
36 | - 'group_by' => '', // What to group results by. |
|
37 | - 'order_by' => '', // What to order by. |
|
38 | - 'limit' => '', // Results limit. |
|
39 | - 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
40 | - 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
41 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
42 | - 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
43 | - ); |
|
44 | - |
|
45 | - $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
46 | - $args = wp_parse_args( $args, $default_args ); |
|
47 | - |
|
48 | - extract( $args ); |
|
49 | - |
|
50 | - if ( empty( $data ) ) { |
|
51 | - return ''; |
|
52 | - } |
|
53 | - |
|
54 | - $query = array(); |
|
55 | - $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
56 | - $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
57 | - $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
58 | - |
|
59 | - $query['where'] = " |
|
15 | + /** |
|
16 | + * Get report totals such as invoice totals and discount amounts. |
|
17 | + * |
|
18 | + * Data example: |
|
19 | + * |
|
20 | + * 'subtotal' => array( |
|
21 | + * 'type' => 'invoice_data', |
|
22 | + * 'function' => 'SUM', |
|
23 | + * 'name' => 'subtotal' |
|
24 | + * ) |
|
25 | + * |
|
26 | + * @param array $args |
|
27 | + * @return mixed depending on query_type |
|
28 | + */ |
|
29 | + public static function get_invoice_report_data( $args = array() ) { |
|
30 | + global $wpdb; |
|
31 | + |
|
32 | + $default_args = array( |
|
33 | + 'data' => array(), // The data to retrieve. |
|
34 | + 'where' => array(), // An array of where queries. |
|
35 | + 'query_type' => 'get_row', // wpdb query to run. |
|
36 | + 'group_by' => '', // What to group results by. |
|
37 | + 'order_by' => '', // What to order by. |
|
38 | + 'limit' => '', // Results limit. |
|
39 | + 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
40 | + 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
41 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
42 | + 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
43 | + ); |
|
44 | + |
|
45 | + $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
46 | + $args = wp_parse_args( $args, $default_args ); |
|
47 | + |
|
48 | + extract( $args ); |
|
49 | + |
|
50 | + if ( empty( $data ) ) { |
|
51 | + return ''; |
|
52 | + } |
|
53 | + |
|
54 | + $query = array(); |
|
55 | + $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
56 | + $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
57 | + $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
58 | + |
|
59 | + $query['where'] = " |
|
60 | 60 | WHERE posts.post_type IN ( '" . implode( "','", $invoice_types ) . "' ) |
61 | 61 | "; |
62 | 62 | |
63 | - if ( ! empty( $invoice_status ) ) { |
|
64 | - $query['where'] .= " |
|
63 | + if ( ! empty( $invoice_status ) ) { |
|
64 | + $query['where'] .= " |
|
65 | 65 | AND posts.post_status IN ( '" . implode( "','", $invoice_status ) . "' ) |
66 | 66 | "; |
67 | - } |
|
68 | - |
|
69 | - if ( ! empty( $parent_invoice_status ) ) { |
|
70 | - if ( ! empty( $invoice_status ) ) { |
|
71 | - $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
72 | - } else { |
|
73 | - $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
74 | - } |
|
75 | - } |
|
76 | - |
|
77 | - if ( ! empty( $filter_range['before'] ) ) { |
|
78 | - $query['where'] .= " |
|
67 | + } |
|
68 | + |
|
69 | + if ( ! empty( $parent_invoice_status ) ) { |
|
70 | + if ( ! empty( $invoice_status ) ) { |
|
71 | + $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
72 | + } else { |
|
73 | + $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
74 | + } |
|
75 | + } |
|
76 | + |
|
77 | + if ( ! empty( $filter_range['before'] ) ) { |
|
78 | + $query['where'] .= " |
|
79 | 79 | AND posts.post_date <= '" . gmdate( 'Y-m-d 23:59:59', strtotime( $filter_range['before'] ) ) . "' |
80 | 80 | "; |
81 | - } |
|
81 | + } |
|
82 | 82 | |
83 | - if ( ! empty( $filter_range['after'] ) ) { |
|
84 | - $query['where'] .= " |
|
83 | + if ( ! empty( $filter_range['after'] ) ) { |
|
84 | + $query['where'] .= " |
|
85 | 85 | AND posts.post_date >= '" . gmdate( 'Y-m-d 00:00:00', strtotime( $filter_range['after'] ) ) . "' |
86 | 86 | "; |
87 | - } |
|
87 | + } |
|
88 | 88 | |
89 | - if ( ! empty( $where ) ) { |
|
89 | + if ( ! empty( $where ) ) { |
|
90 | 90 | |
91 | - foreach ( $where as $value ) { |
|
91 | + foreach ( $where as $value ) { |
|
92 | 92 | |
93 | - if ( strtolower( $value['operator'] ) === 'in' || strtolower( $value['operator'] ) === 'not in' ) { |
|
94 | - |
|
95 | - if ( is_array( $value['value'] ) ) { |
|
96 | - $value['value'] = implode( "','", $value['value'] ); |
|
97 | - } |
|
98 | - |
|
99 | - if ( ! empty( $value['value'] ) ) { |
|
100 | - $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
101 | - } |
|
102 | - } else { |
|
103 | - $where_value = "{$value['operator']} '{$value['value']}'"; |
|
104 | - } |
|
105 | - |
|
106 | - if ( ! empty( $where_value ) ) { |
|
107 | - $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - |
|
112 | - if ( $group_by ) { |
|
113 | - $query['group_by'] = "GROUP BY {$group_by}"; |
|
114 | - } |
|
115 | - |
|
116 | - if ( $order_by ) { |
|
117 | - $query['order_by'] = "ORDER BY {$order_by}"; |
|
118 | - } |
|
119 | - |
|
120 | - if ( $limit ) { |
|
121 | - $query['limit'] = "LIMIT {$limit}"; |
|
122 | - } |
|
123 | - |
|
124 | - $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
125 | - $query = implode( ' ', $query ); |
|
126 | - |
|
127 | - return self::execute( $query_type, $query ); |
|
128 | - |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * Prepares the data to select. |
|
133 | - * |
|
134 | - * |
|
135 | - * @param array $data |
|
136 | - * @return array |
|
137 | - */ |
|
138 | - public static function prepare_invoice_data( $data ) { |
|
139 | - |
|
140 | - $prepared = array(); |
|
141 | - |
|
142 | - foreach ( $data as $raw_key => $value ) { |
|
143 | - $key = sanitize_key( $raw_key ); |
|
144 | - $distinct = ''; |
|
145 | - |
|
146 | - if ( isset( $value['distinct'] ) ) { |
|
147 | - $distinct = 'DISTINCT'; |
|
148 | - } |
|
149 | - |
|
150 | - $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
151 | - |
|
152 | - if ( false === $get_key ) { |
|
153 | - // Skip to the next foreach iteration else the query will be invalid. |
|
154 | - continue; |
|
155 | - } |
|
156 | - |
|
157 | - if ( ! empty( $value['function'] ) ) { |
|
158 | - $get = "{$value['function']}({$distinct} {$get_key})"; |
|
159 | - } else { |
|
160 | - $get = "{$distinct} {$get_key}"; |
|
161 | - } |
|
162 | - |
|
163 | - $prepared[] = "{$get} as {$value['name']}"; |
|
164 | - } |
|
165 | - |
|
166 | - return $prepared; |
|
167 | - |
|
168 | - } |
|
169 | - |
|
170 | - /** |
|
171 | - * Prepares the joins to use. |
|
172 | - * |
|
173 | - * |
|
174 | - * @param array $data |
|
175 | - * @param bool $with_parent |
|
176 | - * @return array |
|
177 | - */ |
|
178 | - public static function prepare_invoice_joins( $data, $with_parent ) { |
|
179 | - global $wpdb; |
|
180 | - |
|
181 | - $prepared = array(); |
|
182 | - |
|
183 | - foreach ( $data as $raw_key => $value ) { |
|
184 | - $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
185 | - $type = isset( $value['type'] ) ? $value['type'] : false; |
|
186 | - $key = sanitize_key( $raw_key ); |
|
187 | - |
|
188 | - switch ( $type ) { |
|
189 | - case 'meta': |
|
190 | - $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
191 | - break; |
|
192 | - case 'parent_meta': |
|
193 | - $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
194 | - break; |
|
195 | - case 'invoice_data': |
|
196 | - $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
197 | - break; |
|
198 | - case 'invoice_item': |
|
199 | - $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
200 | - break; |
|
201 | - } |
|
202 | - } |
|
203 | - |
|
204 | - if ( $with_parent ) { |
|
205 | - $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
206 | - } |
|
207 | - |
|
208 | - return $prepared; |
|
209 | - |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Retrieves the appropriate table key to use. |
|
214 | - * |
|
215 | - * |
|
216 | - * @param string $key |
|
217 | - * @param string $table |
|
218 | - * @return string|false |
|
219 | - */ |
|
220 | - public static function get_invoice_table_key( $key, $table ) { |
|
221 | - |
|
222 | - $keys = array( |
|
223 | - 'meta' => "meta_{$key}.meta_value", |
|
224 | - 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
225 | - 'post_data' => "posts.{$key}", |
|
226 | - 'invoice_data' => "invoices.{$key}", |
|
227 | - 'invoice_item' => "invoice_items.{$key}", |
|
228 | - ); |
|
229 | - |
|
230 | - return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
231 | - |
|
232 | - } |
|
233 | - |
|
234 | - /** |
|
235 | - * Executes a query and caches the result for a minute. |
|
236 | - * |
|
237 | - * |
|
238 | - * @param string $query_type |
|
239 | - * @param string $query |
|
240 | - * @return mixed depending on query_type |
|
241 | - */ |
|
242 | - public static function execute( $query_type, $query ) { |
|
243 | - global $wpdb; |
|
244 | - |
|
245 | - $query_hash = md5( $query_type . $query ); |
|
246 | - $result = self::get_cached_query( $query_hash ); |
|
247 | - if ( $result === false ) { |
|
248 | - self::enable_big_selects(); |
|
249 | - |
|
250 | - $result = $wpdb->$query_type( $query ); |
|
251 | - self::set_cached_query( $query_hash, $result ); |
|
252 | - } |
|
253 | - |
|
254 | - return $result; |
|
255 | - |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Enables big mysql selects for reports, just once for this session. |
|
260 | - */ |
|
261 | - protected static function enable_big_selects() { |
|
262 | - static $big_selects = false; |
|
263 | - |
|
264 | - global $wpdb; |
|
265 | - |
|
266 | - if ( ! $big_selects ) { |
|
267 | - $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
268 | - $big_selects = true; |
|
269 | - } |
|
270 | - } |
|
271 | - |
|
272 | - /** |
|
273 | - * Get the cached query result or null if it's not in the cache. |
|
274 | - * |
|
275 | - * @param string $query_hash The query hash. |
|
276 | - * |
|
277 | - * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
278 | - */ |
|
279 | - protected static function get_cached_query( $query_hash ) { |
|
280 | - |
|
281 | - return wp_cache_get( |
|
282 | - $query_hash, |
|
283 | - strtolower( __CLASS__ ) |
|
284 | - ); |
|
285 | - |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Set the cached query result. |
|
290 | - * |
|
291 | - * @param string $query_hash The query hash. |
|
292 | - * @param mixed $data The data to cache. |
|
293 | - */ |
|
294 | - protected static function set_cached_query( $query_hash, $data ) { |
|
295 | - |
|
296 | - wp_cache_set( |
|
297 | - $query_hash, |
|
298 | - $data, |
|
299 | - strtolower( __CLASS__ ), |
|
300 | - MINUTE_IN_SECONDS |
|
301 | - ); |
|
302 | - |
|
303 | - } |
|
93 | + if ( strtolower( $value['operator'] ) === 'in' || strtolower( $value['operator'] ) === 'not in' ) { |
|
94 | + |
|
95 | + if ( is_array( $value['value'] ) ) { |
|
96 | + $value['value'] = implode( "','", $value['value'] ); |
|
97 | + } |
|
98 | + |
|
99 | + if ( ! empty( $value['value'] ) ) { |
|
100 | + $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
101 | + } |
|
102 | + } else { |
|
103 | + $where_value = "{$value['operator']} '{$value['value']}'"; |
|
104 | + } |
|
105 | + |
|
106 | + if ( ! empty( $where_value ) ) { |
|
107 | + $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + |
|
112 | + if ( $group_by ) { |
|
113 | + $query['group_by'] = "GROUP BY {$group_by}"; |
|
114 | + } |
|
115 | + |
|
116 | + if ( $order_by ) { |
|
117 | + $query['order_by'] = "ORDER BY {$order_by}"; |
|
118 | + } |
|
119 | + |
|
120 | + if ( $limit ) { |
|
121 | + $query['limit'] = "LIMIT {$limit}"; |
|
122 | + } |
|
123 | + |
|
124 | + $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
125 | + $query = implode( ' ', $query ); |
|
126 | + |
|
127 | + return self::execute( $query_type, $query ); |
|
128 | + |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * Prepares the data to select. |
|
133 | + * |
|
134 | + * |
|
135 | + * @param array $data |
|
136 | + * @return array |
|
137 | + */ |
|
138 | + public static function prepare_invoice_data( $data ) { |
|
139 | + |
|
140 | + $prepared = array(); |
|
141 | + |
|
142 | + foreach ( $data as $raw_key => $value ) { |
|
143 | + $key = sanitize_key( $raw_key ); |
|
144 | + $distinct = ''; |
|
145 | + |
|
146 | + if ( isset( $value['distinct'] ) ) { |
|
147 | + $distinct = 'DISTINCT'; |
|
148 | + } |
|
149 | + |
|
150 | + $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
151 | + |
|
152 | + if ( false === $get_key ) { |
|
153 | + // Skip to the next foreach iteration else the query will be invalid. |
|
154 | + continue; |
|
155 | + } |
|
156 | + |
|
157 | + if ( ! empty( $value['function'] ) ) { |
|
158 | + $get = "{$value['function']}({$distinct} {$get_key})"; |
|
159 | + } else { |
|
160 | + $get = "{$distinct} {$get_key}"; |
|
161 | + } |
|
162 | + |
|
163 | + $prepared[] = "{$get} as {$value['name']}"; |
|
164 | + } |
|
165 | + |
|
166 | + return $prepared; |
|
167 | + |
|
168 | + } |
|
169 | + |
|
170 | + /** |
|
171 | + * Prepares the joins to use. |
|
172 | + * |
|
173 | + * |
|
174 | + * @param array $data |
|
175 | + * @param bool $with_parent |
|
176 | + * @return array |
|
177 | + */ |
|
178 | + public static function prepare_invoice_joins( $data, $with_parent ) { |
|
179 | + global $wpdb; |
|
180 | + |
|
181 | + $prepared = array(); |
|
182 | + |
|
183 | + foreach ( $data as $raw_key => $value ) { |
|
184 | + $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
185 | + $type = isset( $value['type'] ) ? $value['type'] : false; |
|
186 | + $key = sanitize_key( $raw_key ); |
|
187 | + |
|
188 | + switch ( $type ) { |
|
189 | + case 'meta': |
|
190 | + $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
191 | + break; |
|
192 | + case 'parent_meta': |
|
193 | + $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
194 | + break; |
|
195 | + case 'invoice_data': |
|
196 | + $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
197 | + break; |
|
198 | + case 'invoice_item': |
|
199 | + $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
200 | + break; |
|
201 | + } |
|
202 | + } |
|
203 | + |
|
204 | + if ( $with_parent ) { |
|
205 | + $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
206 | + } |
|
207 | + |
|
208 | + return $prepared; |
|
209 | + |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Retrieves the appropriate table key to use. |
|
214 | + * |
|
215 | + * |
|
216 | + * @param string $key |
|
217 | + * @param string $table |
|
218 | + * @return string|false |
|
219 | + */ |
|
220 | + public static function get_invoice_table_key( $key, $table ) { |
|
221 | + |
|
222 | + $keys = array( |
|
223 | + 'meta' => "meta_{$key}.meta_value", |
|
224 | + 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
225 | + 'post_data' => "posts.{$key}", |
|
226 | + 'invoice_data' => "invoices.{$key}", |
|
227 | + 'invoice_item' => "invoice_items.{$key}", |
|
228 | + ); |
|
229 | + |
|
230 | + return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
231 | + |
|
232 | + } |
|
233 | + |
|
234 | + /** |
|
235 | + * Executes a query and caches the result for a minute. |
|
236 | + * |
|
237 | + * |
|
238 | + * @param string $query_type |
|
239 | + * @param string $query |
|
240 | + * @return mixed depending on query_type |
|
241 | + */ |
|
242 | + public static function execute( $query_type, $query ) { |
|
243 | + global $wpdb; |
|
244 | + |
|
245 | + $query_hash = md5( $query_type . $query ); |
|
246 | + $result = self::get_cached_query( $query_hash ); |
|
247 | + if ( $result === false ) { |
|
248 | + self::enable_big_selects(); |
|
249 | + |
|
250 | + $result = $wpdb->$query_type( $query ); |
|
251 | + self::set_cached_query( $query_hash, $result ); |
|
252 | + } |
|
253 | + |
|
254 | + return $result; |
|
255 | + |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Enables big mysql selects for reports, just once for this session. |
|
260 | + */ |
|
261 | + protected static function enable_big_selects() { |
|
262 | + static $big_selects = false; |
|
263 | + |
|
264 | + global $wpdb; |
|
265 | + |
|
266 | + if ( ! $big_selects ) { |
|
267 | + $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
268 | + $big_selects = true; |
|
269 | + } |
|
270 | + } |
|
271 | + |
|
272 | + /** |
|
273 | + * Get the cached query result or null if it's not in the cache. |
|
274 | + * |
|
275 | + * @param string $query_hash The query hash. |
|
276 | + * |
|
277 | + * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
278 | + */ |
|
279 | + protected static function get_cached_query( $query_hash ) { |
|
280 | + |
|
281 | + return wp_cache_get( |
|
282 | + $query_hash, |
|
283 | + strtolower( __CLASS__ ) |
|
284 | + ); |
|
285 | + |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Set the cached query result. |
|
290 | + * |
|
291 | + * @param string $query_hash The query hash. |
|
292 | + * @param mixed $data The data to cache. |
|
293 | + */ |
|
294 | + protected static function set_cached_query( $query_hash, $data ) { |
|
295 | + |
|
296 | + wp_cache_set( |
|
297 | + $query_hash, |
|
298 | + $data, |
|
299 | + strtolower( __CLASS__ ), |
|
300 | + MINUTE_IN_SECONDS |
|
301 | + ); |
|
302 | + |
|
303 | + } |
|
304 | 304 | |
305 | 305 | } |
@@ -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_Helper Class. |
@@ -26,7 +26,7 @@ discard block |
||
26 | 26 | * @param array $args |
27 | 27 | * @return mixed depending on query_type |
28 | 28 | */ |
29 | - public static function get_invoice_report_data( $args = array() ) { |
|
29 | + public static function get_invoice_report_data($args = array()) { |
|
30 | 30 | global $wpdb; |
31 | 31 | |
32 | 32 | $default_args = array( |
@@ -37,94 +37,94 @@ discard block |
||
37 | 37 | 'order_by' => '', // What to order by. |
38 | 38 | 'limit' => '', // Results limit. |
39 | 39 | 'filter_range' => array(), // An array of before and after dates to limit results by. |
40 | - 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
41 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
40 | + 'invoice_types' => array('wpi_invoice'), // An array of post types to retrieve. |
|
41 | + 'invoice_status' => array('publish', 'wpi-processing', 'wpi-onhold'), |
|
42 | 42 | 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
43 | 43 | ); |
44 | 44 | |
45 | - $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
46 | - $args = wp_parse_args( $args, $default_args ); |
|
45 | + $args = apply_filters('getpaid_reports_get_invoice_report_data_args', $args); |
|
46 | + $args = wp_parse_args($args, $default_args); |
|
47 | 47 | |
48 | - extract( $args ); |
|
48 | + extract($args); |
|
49 | 49 | |
50 | - if ( empty( $data ) ) { |
|
50 | + if (empty($data)) { |
|
51 | 51 | return ''; |
52 | 52 | } |
53 | 53 | |
54 | 54 | $query = array(); |
55 | - $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
55 | + $query['select'] = 'SELECT ' . implode(',', self::prepare_invoice_data($data)); |
|
56 | 56 | $query['from'] = "FROM {$wpdb->posts} AS posts"; |
57 | - $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
57 | + $query['join'] = implode(' ', self::prepare_invoice_joins($data + $where, !empty($parent_invoice_status))); |
|
58 | 58 | |
59 | 59 | $query['where'] = " |
60 | - WHERE posts.post_type IN ( '" . implode( "','", $invoice_types ) . "' ) |
|
60 | + WHERE posts.post_type IN ( '" . implode("','", $invoice_types) . "' ) |
|
61 | 61 | "; |
62 | 62 | |
63 | - if ( ! empty( $invoice_status ) ) { |
|
63 | + if (!empty($invoice_status)) { |
|
64 | 64 | $query['where'] .= " |
65 | - AND posts.post_status IN ( '" . implode( "','", $invoice_status ) . "' ) |
|
65 | + AND posts.post_status IN ( '" . implode("','", $invoice_status) . "' ) |
|
66 | 66 | "; |
67 | 67 | } |
68 | 68 | |
69 | - if ( ! empty( $parent_invoice_status ) ) { |
|
70 | - if ( ! empty( $invoice_status ) ) { |
|
71 | - $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
69 | + if (!empty($parent_invoice_status)) { |
|
70 | + if (!empty($invoice_status)) { |
|
71 | + $query['where'] .= " AND ( parent.post_status IN ( '" . implode("','", $parent_invoice_status) . "' ) OR parent.ID IS NULL ) "; |
|
72 | 72 | } else { |
73 | - $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
73 | + $query['where'] .= " AND parent.post_status IN ( '" . implode("','", $parent_invoice_status) . "' ) "; |
|
74 | 74 | } |
75 | 75 | } |
76 | 76 | |
77 | - if ( ! empty( $filter_range['before'] ) ) { |
|
77 | + if (!empty($filter_range['before'])) { |
|
78 | 78 | $query['where'] .= " |
79 | - AND posts.post_date <= '" . gmdate( 'Y-m-d 23:59:59', strtotime( $filter_range['before'] ) ) . "' |
|
79 | + AND posts.post_date <= '" . gmdate('Y-m-d 23:59:59', strtotime($filter_range['before'])) . "' |
|
80 | 80 | "; |
81 | 81 | } |
82 | 82 | |
83 | - if ( ! empty( $filter_range['after'] ) ) { |
|
83 | + if (!empty($filter_range['after'])) { |
|
84 | 84 | $query['where'] .= " |
85 | - AND posts.post_date >= '" . gmdate( 'Y-m-d 00:00:00', strtotime( $filter_range['after'] ) ) . "' |
|
85 | + AND posts.post_date >= '" . gmdate('Y-m-d 00:00:00', strtotime($filter_range['after'])) . "' |
|
86 | 86 | "; |
87 | 87 | } |
88 | 88 | |
89 | - if ( ! empty( $where ) ) { |
|
89 | + if (!empty($where)) { |
|
90 | 90 | |
91 | - foreach ( $where as $value ) { |
|
91 | + foreach ($where as $value) { |
|
92 | 92 | |
93 | - if ( strtolower( $value['operator'] ) === 'in' || strtolower( $value['operator'] ) === 'not in' ) { |
|
93 | + if (strtolower($value['operator']) === 'in' || strtolower($value['operator']) === 'not in') { |
|
94 | 94 | |
95 | - if ( is_array( $value['value'] ) ) { |
|
96 | - $value['value'] = implode( "','", $value['value'] ); |
|
95 | + if (is_array($value['value'])) { |
|
96 | + $value['value'] = implode("','", $value['value']); |
|
97 | 97 | } |
98 | 98 | |
99 | - if ( ! empty( $value['value'] ) ) { |
|
99 | + if (!empty($value['value'])) { |
|
100 | 100 | $where_value = "{$value['operator']} ('{$value['value']}')"; |
101 | 101 | } |
102 | 102 | } else { |
103 | 103 | $where_value = "{$value['operator']} '{$value['value']}'"; |
104 | 104 | } |
105 | 105 | |
106 | - if ( ! empty( $where_value ) ) { |
|
106 | + if (!empty($where_value)) { |
|
107 | 107 | $query['where'] .= " AND {$value['key']} {$where_value}"; |
108 | 108 | } |
109 | 109 | } |
110 | 110 | } |
111 | 111 | |
112 | - if ( $group_by ) { |
|
112 | + if ($group_by) { |
|
113 | 113 | $query['group_by'] = "GROUP BY {$group_by}"; |
114 | 114 | } |
115 | 115 | |
116 | - if ( $order_by ) { |
|
116 | + if ($order_by) { |
|
117 | 117 | $query['order_by'] = "ORDER BY {$order_by}"; |
118 | 118 | } |
119 | 119 | |
120 | - if ( $limit ) { |
|
120 | + if ($limit) { |
|
121 | 121 | $query['limit'] = "LIMIT {$limit}"; |
122 | 122 | } |
123 | 123 | |
124 | - $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
125 | - $query = implode( ' ', $query ); |
|
124 | + $query = apply_filters('getpaid_reports_get_invoice_report_query', $query, $data); |
|
125 | + $query = implode(' ', $query); |
|
126 | 126 | |
127 | - return self::execute( $query_type, $query ); |
|
127 | + return self::execute($query_type, $query); |
|
128 | 128 | |
129 | 129 | } |
130 | 130 | |
@@ -135,26 +135,26 @@ discard block |
||
135 | 135 | * @param array $data |
136 | 136 | * @return array |
137 | 137 | */ |
138 | - public static function prepare_invoice_data( $data ) { |
|
138 | + public static function prepare_invoice_data($data) { |
|
139 | 139 | |
140 | 140 | $prepared = array(); |
141 | 141 | |
142 | - foreach ( $data as $raw_key => $value ) { |
|
143 | - $key = sanitize_key( $raw_key ); |
|
142 | + foreach ($data as $raw_key => $value) { |
|
143 | + $key = sanitize_key($raw_key); |
|
144 | 144 | $distinct = ''; |
145 | 145 | |
146 | - if ( isset( $value['distinct'] ) ) { |
|
146 | + if (isset($value['distinct'])) { |
|
147 | 147 | $distinct = 'DISTINCT'; |
148 | 148 | } |
149 | 149 | |
150 | - $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
150 | + $get_key = self::get_invoice_table_key($key, $value['type']); |
|
151 | 151 | |
152 | - if ( false === $get_key ) { |
|
152 | + if (false === $get_key) { |
|
153 | 153 | // Skip to the next foreach iteration else the query will be invalid. |
154 | 154 | continue; |
155 | 155 | } |
156 | 156 | |
157 | - if ( ! empty( $value['function'] ) ) { |
|
157 | + if (!empty($value['function'])) { |
|
158 | 158 | $get = "{$value['function']}({$distinct} {$get_key})"; |
159 | 159 | } else { |
160 | 160 | $get = "{$distinct} {$get_key}"; |
@@ -175,22 +175,22 @@ discard block |
||
175 | 175 | * @param bool $with_parent |
176 | 176 | * @return array |
177 | 177 | */ |
178 | - public static function prepare_invoice_joins( $data, $with_parent ) { |
|
178 | + public static function prepare_invoice_joins($data, $with_parent) { |
|
179 | 179 | global $wpdb; |
180 | 180 | |
181 | 181 | $prepared = array(); |
182 | 182 | |
183 | - foreach ( $data as $raw_key => $value ) { |
|
184 | - $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
185 | - $type = isset( $value['type'] ) ? $value['type'] : false; |
|
186 | - $key = sanitize_key( $raw_key ); |
|
183 | + foreach ($data as $raw_key => $value) { |
|
184 | + $join_type = isset($value['join_type']) ? $value['join_type'] : 'INNER'; |
|
185 | + $type = isset($value['type']) ? $value['type'] : false; |
|
186 | + $key = sanitize_key($raw_key); |
|
187 | 187 | |
188 | - switch ( $type ) { |
|
188 | + switch ($type) { |
|
189 | 189 | case 'meta': |
190 | - $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
190 | + $prepared["meta_{$key}"] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
191 | 191 | break; |
192 | 192 | case 'parent_meta': |
193 | - $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
193 | + $prepared["parent_meta_{$key}"] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
194 | 194 | break; |
195 | 195 | case 'invoice_data': |
196 | 196 | $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | } |
202 | 202 | } |
203 | 203 | |
204 | - if ( $with_parent ) { |
|
204 | + if ($with_parent) { |
|
205 | 205 | $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
206 | 206 | } |
207 | 207 | |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | * @param string $table |
218 | 218 | * @return string|false |
219 | 219 | */ |
220 | - public static function get_invoice_table_key( $key, $table ) { |
|
220 | + public static function get_invoice_table_key($key, $table) { |
|
221 | 221 | |
222 | 222 | $keys = array( |
223 | 223 | 'meta' => "meta_{$key}.meta_value", |
@@ -227,7 +227,7 @@ discard block |
||
227 | 227 | 'invoice_item' => "invoice_items.{$key}", |
228 | 228 | ); |
229 | 229 | |
230 | - return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
230 | + return isset($keys[$table]) ? $keys[$table] : false; |
|
231 | 231 | |
232 | 232 | } |
233 | 233 | |
@@ -239,16 +239,16 @@ discard block |
||
239 | 239 | * @param string $query |
240 | 240 | * @return mixed depending on query_type |
241 | 241 | */ |
242 | - public static function execute( $query_type, $query ) { |
|
242 | + public static function execute($query_type, $query) { |
|
243 | 243 | global $wpdb; |
244 | 244 | |
245 | - $query_hash = md5( $query_type . $query ); |
|
246 | - $result = self::get_cached_query( $query_hash ); |
|
247 | - if ( $result === false ) { |
|
245 | + $query_hash = md5($query_type . $query); |
|
246 | + $result = self::get_cached_query($query_hash); |
|
247 | + if ($result === false) { |
|
248 | 248 | self::enable_big_selects(); |
249 | 249 | |
250 | - $result = $wpdb->$query_type( $query ); |
|
251 | - self::set_cached_query( $query_hash, $result ); |
|
250 | + $result = $wpdb->$query_type($query); |
|
251 | + self::set_cached_query($query_hash, $result); |
|
252 | 252 | } |
253 | 253 | |
254 | 254 | return $result; |
@@ -263,8 +263,8 @@ discard block |
||
263 | 263 | |
264 | 264 | global $wpdb; |
265 | 265 | |
266 | - if ( ! $big_selects ) { |
|
267 | - $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
266 | + if (!$big_selects) { |
|
267 | + $wpdb->query('SET SESSION SQL_BIG_SELECTS=1'); |
|
268 | 268 | $big_selects = true; |
269 | 269 | } |
270 | 270 | } |
@@ -276,11 +276,11 @@ discard block |
||
276 | 276 | * |
277 | 277 | * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
278 | 278 | */ |
279 | - protected static function get_cached_query( $query_hash ) { |
|
279 | + protected static function get_cached_query($query_hash) { |
|
280 | 280 | |
281 | 281 | return wp_cache_get( |
282 | 282 | $query_hash, |
283 | - strtolower( __CLASS__ ) |
|
283 | + strtolower(__CLASS__) |
|
284 | 284 | ); |
285 | 285 | |
286 | 286 | } |
@@ -291,12 +291,12 @@ discard block |
||
291 | 291 | * @param string $query_hash The query hash. |
292 | 292 | * @param mixed $data The data to cache. |
293 | 293 | */ |
294 | - protected static function set_cached_query( $query_hash, $data ) { |
|
294 | + protected static function set_cached_query($query_hash, $data) { |
|
295 | 295 | |
296 | 296 | wp_cache_set( |
297 | 297 | $query_hash, |
298 | 298 | $data, |
299 | - strtolower( __CLASS__ ), |
|
299 | + strtolower(__CLASS__), |
|
300 | 300 | MINUTE_IN_SECONDS |
301 | 301 | ); |
302 | 302 |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | * Checks if the current user cna view an invoice receipt. |
68 | 68 | */ |
69 | 69 | function wpinv_can_view_receipt( $invoice ) { |
70 | - return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
70 | + return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | /** |
@@ -556,37 +556,37 @@ discard block |
||
556 | 556 | $label = empty( $label ) ? __( 'Invoice', 'invoicing' ) : sanitize_text_field( $label ); |
557 | 557 | $columns = array( |
558 | 558 | |
559 | - 'invoice-number' => array( |
|
560 | - 'title' => $label, |
|
561 | - 'class' => 'text-left', |
|
562 | - ), |
|
559 | + 'invoice-number' => array( |
|
560 | + 'title' => $label, |
|
561 | + 'class' => 'text-left', |
|
562 | + ), |
|
563 | 563 | |
564 | - 'created-date' => array( |
|
565 | - 'title' => __( 'Created Date', 'invoicing' ), |
|
566 | - 'class' => 'text-left', |
|
567 | - ), |
|
564 | + 'created-date' => array( |
|
565 | + 'title' => __( 'Created Date', 'invoicing' ), |
|
566 | + 'class' => 'text-left', |
|
567 | + ), |
|
568 | 568 | |
569 | - 'payment-date' => array( |
|
570 | - 'title' => __( 'Payment Date', 'invoicing' ), |
|
571 | - 'class' => 'text-left', |
|
572 | - ), |
|
569 | + 'payment-date' => array( |
|
570 | + 'title' => __( 'Payment Date', 'invoicing' ), |
|
571 | + 'class' => 'text-left', |
|
572 | + ), |
|
573 | 573 | |
574 | - 'invoice-status' => array( |
|
575 | - 'title' => __( 'Status', 'invoicing' ), |
|
576 | - 'class' => 'text-center', |
|
577 | - ), |
|
574 | + 'invoice-status' => array( |
|
575 | + 'title' => __( 'Status', 'invoicing' ), |
|
576 | + 'class' => 'text-center', |
|
577 | + ), |
|
578 | 578 | |
579 | - 'invoice-total' => array( |
|
580 | - 'title' => __( 'Total', 'invoicing' ), |
|
581 | - 'class' => 'text-right', |
|
582 | - ), |
|
579 | + 'invoice-total' => array( |
|
580 | + 'title' => __( 'Total', 'invoicing' ), |
|
581 | + 'class' => 'text-right', |
|
582 | + ), |
|
583 | 583 | |
584 | - 'invoice-actions' => array( |
|
585 | - 'title' => ' ', |
|
586 | - 'class' => 'text-center', |
|
587 | - ), |
|
584 | + 'invoice-actions' => array( |
|
585 | + 'title' => ' ', |
|
586 | + 'class' => 'text-center', |
|
587 | + ), |
|
588 | 588 | |
589 | - ); |
|
589 | + ); |
|
590 | 590 | |
591 | 591 | return apply_filters( 'wpinv_user_invoices_columns', $columns, $post_type ); |
592 | 592 | } |
@@ -1274,22 +1274,22 @@ discard block |
||
1274 | 1274 | */ |
1275 | 1275 | function getpaid_get_invoice_status_classes() { |
1276 | 1276 | |
1277 | - return apply_filters( |
|
1278 | - 'getpaid_get_invoice_status_classes', |
|
1279 | - array( |
|
1277 | + return apply_filters( |
|
1278 | + 'getpaid_get_invoice_status_classes', |
|
1279 | + array( |
|
1280 | 1280 | 'wpi-quote-declined' => 'bg-danger', |
1281 | 1281 | 'wpi-failed' => 'bg-danger', |
1282 | - 'wpi-processing' => 'bg-info', |
|
1283 | - 'wpi-onhold' => 'bg-warning text-dark', |
|
1284 | - 'wpi-quote-accepted' => 'bg-success', |
|
1285 | - 'publish' => 'bg-success', |
|
1286 | - 'wpi-renewal' => 'bg-primary', |
|
1282 | + 'wpi-processing' => 'bg-info', |
|
1283 | + 'wpi-onhold' => 'bg-warning text-dark', |
|
1284 | + 'wpi-quote-accepted' => 'bg-success', |
|
1285 | + 'publish' => 'bg-success', |
|
1286 | + 'wpi-renewal' => 'bg-primary', |
|
1287 | 1287 | 'wpi-cancelled' => 'bg-secondary', |
1288 | 1288 | 'wpi-pending' => 'bg-dark', |
1289 | 1289 | 'wpi-quote-pending' => 'bg-dark', |
1290 | 1290 | 'wpi-refunded' => 'bg-secondary', |
1291 | - ) |
|
1292 | - ); |
|
1291 | + ) |
|
1292 | + ); |
|
1293 | 1293 | |
1294 | 1294 | } |
1295 | 1295 | |
@@ -1303,7 +1303,7 @@ discard block |
||
1303 | 1303 | function getpaid_get_invoice_tax_rate( $invoice, $item ) { |
1304 | 1304 | |
1305 | 1305 | $rates = getpaid_get_item_tax_rates( $item, $invoice->get_country(), $invoice->get_state() ); |
1306 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
1306 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
1307 | 1307 | $rates = wp_list_pluck( $rates, 'rate' ); |
1308 | 1308 | |
1309 | 1309 | return array_sum( $rates ); |
@@ -6,7 +6,7 @@ discard block |
||
6 | 6 | * @package Invoicing |
7 | 7 | */ |
8 | 8 | |
9 | -defined( 'ABSPATH' ) || exit; |
|
9 | +defined('ABSPATH') || exit; |
|
10 | 10 | |
11 | 11 | /** |
12 | 12 | * Retrieves the current invoice. |
@@ -14,15 +14,15 @@ discard block |
||
14 | 14 | function getpaid_get_current_invoice_id() { |
15 | 15 | |
16 | 16 | // Ensure that we have an invoice key. |
17 | - if ( empty( $_GET['invoice_key'] ) ) { |
|
17 | + if (empty($_GET['invoice_key'])) { |
|
18 | 18 | return 0; |
19 | 19 | } |
20 | 20 | |
21 | 21 | // Retrieve an invoice using the key. |
22 | - $invoice = new WPInv_Invoice( sanitize_text_field( $_GET['invoice_key'] ) ); |
|
22 | + $invoice = new WPInv_Invoice(sanitize_text_field($_GET['invoice_key'])); |
|
23 | 23 | |
24 | 24 | // Compare the invoice key and the parsed key. |
25 | - if ( $invoice->get_id() != 0 && $invoice->get_key() == sanitize_text_field( $_GET['invoice_key'] ) ) { |
|
25 | + if ($invoice->get_id() != 0 && $invoice->get_key() == sanitize_text_field($_GET['invoice_key'])) { |
|
26 | 26 | return $invoice->get_id(); |
27 | 27 | } |
28 | 28 | |
@@ -32,42 +32,42 @@ discard block |
||
32 | 32 | /** |
33 | 33 | * Checks if the current user cna view an invoice. |
34 | 34 | */ |
35 | -function wpinv_user_can_view_invoice( $invoice ) { |
|
36 | - $invoice = new WPInv_Invoice( $invoice ); |
|
35 | +function wpinv_user_can_view_invoice($invoice) { |
|
36 | + $invoice = new WPInv_Invoice($invoice); |
|
37 | 37 | |
38 | 38 | // Abort if the invoice does not exist. |
39 | - if ( 0 == $invoice->get_id() ) { |
|
39 | + if (0 == $invoice->get_id()) { |
|
40 | 40 | return false; |
41 | 41 | } |
42 | 42 | |
43 | 43 | // Don't allow trash, draft status |
44 | - if ( $invoice->is_draft() ) { |
|
44 | + if ($invoice->is_draft()) { |
|
45 | 45 | return false; |
46 | 46 | } |
47 | 47 | |
48 | 48 | // If users are not required to login to check out, compare the invoice keys. |
49 | - if ( ! wpinv_require_login_to_checkout() && isset( $_GET['invoice_key'] ) && sanitize_text_field( $_GET['invoice_key'] ) == $invoice->get_key() ) { |
|
49 | + if (!wpinv_require_login_to_checkout() && isset($_GET['invoice_key']) && sanitize_text_field($_GET['invoice_key']) == $invoice->get_key()) { |
|
50 | 50 | return true; |
51 | 51 | } |
52 | 52 | |
53 | 53 | // Always enable for admins.. |
54 | - if ( wpinv_current_user_can( 'view_invoice', array( 'invoice' => $invoice ) ) || current_user_can( 'view_invoices', $invoice->get_id() ) ) { // Admin user |
|
54 | + if (wpinv_current_user_can('view_invoice', array('invoice' => $invoice)) || current_user_can('view_invoices', $invoice->get_id())) { // Admin user |
|
55 | 55 | return true; |
56 | 56 | } |
57 | 57 | |
58 | 58 | // Else, ensure that this is their invoice. |
59 | - if ( is_user_logged_in() && $invoice->get_user_id() == get_current_user_id() ) { |
|
59 | + if (is_user_logged_in() && $invoice->get_user_id() == get_current_user_id()) { |
|
60 | 60 | return true; |
61 | 61 | } |
62 | 62 | |
63 | - return apply_filters( 'wpinv_current_user_can_view_invoice', false, $invoice ); |
|
63 | + return apply_filters('wpinv_current_user_can_view_invoice', false, $invoice); |
|
64 | 64 | } |
65 | 65 | |
66 | 66 | /** |
67 | 67 | * Checks if the current user cna view an invoice receipt. |
68 | 68 | */ |
69 | -function wpinv_can_view_receipt( $invoice ) { |
|
70 | - return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
69 | +function wpinv_can_view_receipt($invoice) { |
|
70 | + return (bool) apply_filters('wpinv_can_view_receipt', wpinv_user_can_view_invoice($invoice), $invoice); |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | /** |
@@ -77,16 +77,16 @@ discard block |
||
77 | 77 | */ |
78 | 78 | function getpaid_get_invoice_post_types() { |
79 | 79 | $post_types = array( |
80 | - 'wpi_quote' => __( 'Quote', 'invoicing' ), |
|
81 | - 'wpi_invoice' => __( 'Invoice', 'invoicing' ), |
|
80 | + 'wpi_quote' => __('Quote', 'invoicing'), |
|
81 | + 'wpi_invoice' => __('Invoice', 'invoicing'), |
|
82 | 82 | ); |
83 | 83 | |
84 | 84 | // Ensure the quotes addon is installed. |
85 | - if ( ! defined( 'WPINV_QUOTES_VERSION' ) ) { |
|
86 | - unset( $post_types['wpi_quote'] ); |
|
85 | + if (!defined('WPINV_QUOTES_VERSION')) { |
|
86 | + unset($post_types['wpi_quote']); |
|
87 | 87 | } |
88 | 88 | |
89 | - return apply_filters( 'getpaid_invoice_post_types', $post_types ); |
|
89 | + return apply_filters('getpaid_invoice_post_types', $post_types); |
|
90 | 90 | } |
91 | 91 | |
92 | 92 | /** |
@@ -95,8 +95,8 @@ discard block |
||
95 | 95 | * |
96 | 96 | * @param string $post_type The post type to check for. |
97 | 97 | */ |
98 | -function getpaid_is_invoice_post_type( $post_type ) { |
|
99 | - return is_scalar( $post_type ) && ! empty( $post_type ) && array_key_exists( $post_type, getpaid_get_invoice_post_types() ); |
|
98 | +function getpaid_is_invoice_post_type($post_type) { |
|
99 | + return is_scalar($post_type) && !empty($post_type) && array_key_exists($post_type, getpaid_get_invoice_post_types()); |
|
100 | 100 | } |
101 | 101 | |
102 | 102 | /** |
@@ -106,9 +106,9 @@ discard block |
||
106 | 106 | * @param bool $wp_error Whether to return false or WP_Error on failure. |
107 | 107 | * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
108 | 108 | */ |
109 | -function wpinv_create_invoice( $data = array(), $deprecated = null, $wp_error = false ) { |
|
109 | +function wpinv_create_invoice($data = array(), $deprecated = null, $wp_error = false) { |
|
110 | 110 | $data['invoice_id'] = 0; |
111 | - return wpinv_insert_invoice( $data, $wp_error ); |
|
111 | + return wpinv_insert_invoice($data, $wp_error); |
|
112 | 112 | } |
113 | 113 | |
114 | 114 | /** |
@@ -118,35 +118,35 @@ discard block |
||
118 | 118 | * @param bool $wp_error Whether to return false or WP_Error on failure. |
119 | 119 | * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
120 | 120 | */ |
121 | -function wpinv_update_invoice( $data = array(), $wp_error = false ) { |
|
121 | +function wpinv_update_invoice($data = array(), $wp_error = false) { |
|
122 | 122 | |
123 | 123 | // Backwards compatibility. |
124 | - if ( ! empty( $data['ID'] ) ) { |
|
124 | + if (!empty($data['ID'])) { |
|
125 | 125 | $data['invoice_id'] = $data['ID']; |
126 | 126 | } |
127 | 127 | |
128 | 128 | // Do we have an invoice id? |
129 | - if ( empty( $data['invoice_id'] ) ) { |
|
130 | - return $wp_error ? new WP_Error( 'invalid_invoice_id', __( 'Invalid invoice ID.', 'invoicing' ) ) : 0; |
|
129 | + if (empty($data['invoice_id'])) { |
|
130 | + return $wp_error ? new WP_Error('invalid_invoice_id', __('Invalid invoice ID.', 'invoicing')) : 0; |
|
131 | 131 | } |
132 | 132 | |
133 | 133 | // Retrieve the invoice. |
134 | - $invoice = wpinv_get_invoice( $data['invoice_id'] ); |
|
134 | + $invoice = wpinv_get_invoice($data['invoice_id']); |
|
135 | 135 | |
136 | 136 | // And abort if it does not exist. |
137 | - if ( empty( $invoice ) ) { |
|
138 | - return $wp_error ? new WP_Error( 'missing_invoice', __( 'Invoice not found.', 'invoicing' ) ) : 0; |
|
137 | + if (empty($invoice)) { |
|
138 | + return $wp_error ? new WP_Error('missing_invoice', __('Invoice not found.', 'invoicing')) : 0; |
|
139 | 139 | } |
140 | 140 | |
141 | 141 | // Do not update totals for paid / refunded invoices. |
142 | - if ( $invoice->is_paid() || $invoice->is_refunded() ) { |
|
142 | + if ($invoice->is_paid() || $invoice->is_refunded()) { |
|
143 | 143 | |
144 | - if ( ! empty( $data['items'] ) || ! empty( $data['cart_details'] ) ) { |
|
145 | - return $wp_error ? new WP_Error( 'paid_invoice', __( 'You can not update cart items for invoices that have already been paid for.', 'invoicing' ) ) : 0; |
|
144 | + if (!empty($data['items']) || !empty($data['cart_details'])) { |
|
145 | + return $wp_error ? new WP_Error('paid_invoice', __('You can not update cart items for invoices that have already been paid for.', 'invoicing')) : 0; |
|
146 | 146 | } |
147 | 147 | } |
148 | 148 | |
149 | - return wpinv_insert_invoice( $data, $wp_error ); |
|
149 | + return wpinv_insert_invoice($data, $wp_error); |
|
150 | 150 | |
151 | 151 | } |
152 | 152 | |
@@ -157,62 +157,62 @@ discard block |
||
157 | 157 | * @param bool $wp_error Whether to return false or WP_Error on failure. |
158 | 158 | * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
159 | 159 | */ |
160 | -function wpinv_insert_invoice( $data = array(), $wp_error = false ) { |
|
160 | +function wpinv_insert_invoice($data = array(), $wp_error = false) { |
|
161 | 161 | |
162 | 162 | // Ensure that we have invoice data. |
163 | - if ( empty( $data ) ) { |
|
163 | + if (empty($data)) { |
|
164 | 164 | return false; |
165 | 165 | } |
166 | 166 | |
167 | 167 | // The invoice id will be provided when updating an invoice. |
168 | - $data['invoice_id'] = ! empty( $data['invoice_id'] ) ? (int) $data['invoice_id'] : false; |
|
168 | + $data['invoice_id'] = !empty($data['invoice_id']) ? (int) $data['invoice_id'] : false; |
|
169 | 169 | |
170 | 170 | // Retrieve the invoice. |
171 | - $invoice = new WPInv_Invoice( $data['invoice_id'] ); |
|
171 | + $invoice = new WPInv_Invoice($data['invoice_id']); |
|
172 | 172 | |
173 | 173 | // Do we have an error? |
174 | - if ( ! empty( $invoice->last_error ) ) { |
|
175 | - return $wp_error ? new WP_Error( 'invalid_invoice_id', $invoice->last_error ) : 0; |
|
174 | + if (!empty($invoice->last_error)) { |
|
175 | + return $wp_error ? new WP_Error('invalid_invoice_id', $invoice->last_error) : 0; |
|
176 | 176 | } |
177 | 177 | |
178 | 178 | // Backwards compatibility (billing address). |
179 | - if ( ! empty( $data['user_info'] ) ) { |
|
179 | + if (!empty($data['user_info'])) { |
|
180 | 180 | |
181 | - foreach ( $data['user_info'] as $key => $value ) { |
|
181 | + foreach ($data['user_info'] as $key => $value) { |
|
182 | 182 | |
183 | - if ( $key == 'discounts' ) { |
|
183 | + if ($key == 'discounts') { |
|
184 | 184 | $value = (array) $value; |
185 | - $data['discount_code'] = empty( $value ) ? null : $value[0]; |
|
185 | + $data['discount_code'] = empty($value) ? null : $value[0]; |
|
186 | 186 | } else { |
187 | - $data[ $key ] = $value; |
|
187 | + $data[$key] = $value; |
|
188 | 188 | } |
189 | 189 | } |
190 | 190 | } |
191 | 191 | |
192 | 192 | // Backwards compatibility. |
193 | - if ( ! empty( $data['payment_details'] ) ) { |
|
193 | + if (!empty($data['payment_details'])) { |
|
194 | 194 | |
195 | - foreach ( $data['payment_details'] as $key => $value ) { |
|
196 | - $data[ $key ] = $value; |
|
195 | + foreach ($data['payment_details'] as $key => $value) { |
|
196 | + $data[$key] = $value; |
|
197 | 197 | } |
198 | 198 | } |
199 | 199 | |
200 | 200 | // Set up the owner of the invoice. |
201 | - $user_id = ! empty( $data['user_id'] ) ? wpinv_clean( $data['user_id'] ) : get_current_user_id(); |
|
201 | + $user_id = !empty($data['user_id']) ? wpinv_clean($data['user_id']) : get_current_user_id(); |
|
202 | 202 | |
203 | 203 | // Make sure the user exists. |
204 | - if ( ! get_userdata( $user_id ) ) { |
|
205 | - return $wp_error ? new WP_Error( 'wpinv_invalid_user', __( 'There is no user with that ID.', 'invoicing' ) ) : 0; |
|
204 | + if (!get_userdata($user_id)) { |
|
205 | + return $wp_error ? new WP_Error('wpinv_invalid_user', __('There is no user with that ID.', 'invoicing')) : 0; |
|
206 | 206 | } |
207 | 207 | |
208 | - $address = wpinv_get_user_address( $user_id ); |
|
208 | + $address = wpinv_get_user_address($user_id); |
|
209 | 209 | |
210 | - foreach ( $address as $key => $value ) { |
|
210 | + foreach ($address as $key => $value) { |
|
211 | 211 | |
212 | - if ( $value == '' ) { |
|
213 | - $address[ $key ] = null; |
|
212 | + if ($value == '') { |
|
213 | + $address[$key] = null; |
|
214 | 214 | } else { |
215 | - $address[ $key ] = wpinv_clean( $value ); |
|
215 | + $address[$key] = wpinv_clean($value); |
|
216 | 216 | } |
217 | 217 | } |
218 | 218 | |
@@ -221,101 +221,101 @@ discard block |
||
221 | 221 | array( |
222 | 222 | |
223 | 223 | // Basic info. |
224 | - 'template' => isset( $data['template'] ) ? wpinv_clean( $data['template'] ) : null, |
|
225 | - 'email_cc' => isset( $data['email_cc'] ) ? wpinv_clean( $data['email_cc'] ) : null, |
|
226 | - 'date_created' => isset( $data['created_date'] ) ? wpinv_clean( $data['created_date'] ) : null, |
|
227 | - 'due_date' => isset( $data['due_date'] ) ? wpinv_clean( $data['due_date'] ) : null, |
|
228 | - 'date_completed' => isset( $data['date_completed'] ) ? wpinv_clean( $data['date_completed'] ) : null, |
|
229 | - 'number' => isset( $data['number'] ) ? wpinv_clean( $data['number'] ) : null, |
|
230 | - 'key' => isset( $data['key'] ) ? wpinv_clean( $data['key'] ) : null, |
|
231 | - 'status' => isset( $data['status'] ) ? wpinv_clean( $data['status'] ) : null, |
|
232 | - 'post_type' => isset( $data['post_type'] ) ? wpinv_clean( $data['post_type'] ) : null, |
|
233 | - 'user_ip' => isset( $data['ip'] ) ? wpinv_clean( $data['ip'] ) : wpinv_get_ip(), |
|
234 | - 'parent_id' => isset( $data['parent'] ) ? intval( $data['parent'] ) : null, |
|
235 | - 'mode' => isset( $data['mode'] ) ? wpinv_clean( $data['mode'] ) : null, |
|
236 | - 'description' => isset( $data['description'] ) ? wp_kses_post( $data['description'] ) : null, |
|
224 | + 'template' => isset($data['template']) ? wpinv_clean($data['template']) : null, |
|
225 | + 'email_cc' => isset($data['email_cc']) ? wpinv_clean($data['email_cc']) : null, |
|
226 | + 'date_created' => isset($data['created_date']) ? wpinv_clean($data['created_date']) : null, |
|
227 | + 'due_date' => isset($data['due_date']) ? wpinv_clean($data['due_date']) : null, |
|
228 | + 'date_completed' => isset($data['date_completed']) ? wpinv_clean($data['date_completed']) : null, |
|
229 | + 'number' => isset($data['number']) ? wpinv_clean($data['number']) : null, |
|
230 | + 'key' => isset($data['key']) ? wpinv_clean($data['key']) : null, |
|
231 | + 'status' => isset($data['status']) ? wpinv_clean($data['status']) : null, |
|
232 | + 'post_type' => isset($data['post_type']) ? wpinv_clean($data['post_type']) : null, |
|
233 | + 'user_ip' => isset($data['ip']) ? wpinv_clean($data['ip']) : wpinv_get_ip(), |
|
234 | + 'parent_id' => isset($data['parent']) ? intval($data['parent']) : null, |
|
235 | + 'mode' => isset($data['mode']) ? wpinv_clean($data['mode']) : null, |
|
236 | + 'description' => isset($data['description']) ? wp_kses_post($data['description']) : null, |
|
237 | 237 | |
238 | 238 | // Payment info. |
239 | - 'disable_taxes' => ! empty( $data['disable_taxes'] ), |
|
240 | - 'currency' => isset( $data['currency'] ) ? wpinv_clean( $data['currency'] ) : wpinv_get_currency(), |
|
241 | - 'gateway' => isset( $data['gateway'] ) ? wpinv_clean( $data['gateway'] ) : null, |
|
242 | - 'transaction_id' => isset( $data['transaction_id'] ) ? wpinv_clean( $data['transaction_id'] ) : null, |
|
243 | - 'discount_code' => isset( $data['discount_code'] ) ? wpinv_clean( $data['discount_code'] ) : null, |
|
244 | - 'payment_form' => isset( $data['payment_form'] ) ? intval( $data['payment_form'] ) : null, |
|
245 | - 'submission_id' => isset( $data['submission_id'] ) ? wpinv_clean( $data['submission_id'] ) : null, |
|
246 | - 'subscription_id' => isset( $data['subscription_id'] ) ? wpinv_clean( $data['subscription_id'] ) : null, |
|
247 | - 'is_viewed' => isset( $data['is_viewed'] ) ? wpinv_clean( $data['is_viewed'] ) : null, |
|
248 | - 'fees' => isset( $data['fees'] ) ? wpinv_clean( $data['fees'] ) : null, |
|
249 | - 'discounts' => isset( $data['discounts'] ) ? wpinv_clean( $data['discounts'] ) : null, |
|
250 | - 'taxes' => isset( $data['taxes'] ) ? wpinv_clean( $data['taxes'] ) : null, |
|
239 | + 'disable_taxes' => !empty($data['disable_taxes']), |
|
240 | + 'currency' => isset($data['currency']) ? wpinv_clean($data['currency']) : wpinv_get_currency(), |
|
241 | + 'gateway' => isset($data['gateway']) ? wpinv_clean($data['gateway']) : null, |
|
242 | + 'transaction_id' => isset($data['transaction_id']) ? wpinv_clean($data['transaction_id']) : null, |
|
243 | + 'discount_code' => isset($data['discount_code']) ? wpinv_clean($data['discount_code']) : null, |
|
244 | + 'payment_form' => isset($data['payment_form']) ? intval($data['payment_form']) : null, |
|
245 | + 'submission_id' => isset($data['submission_id']) ? wpinv_clean($data['submission_id']) : null, |
|
246 | + 'subscription_id' => isset($data['subscription_id']) ? wpinv_clean($data['subscription_id']) : null, |
|
247 | + 'is_viewed' => isset($data['is_viewed']) ? wpinv_clean($data['is_viewed']) : null, |
|
248 | + 'fees' => isset($data['fees']) ? wpinv_clean($data['fees']) : null, |
|
249 | + 'discounts' => isset($data['discounts']) ? wpinv_clean($data['discounts']) : null, |
|
250 | + 'taxes' => isset($data['taxes']) ? wpinv_clean($data['taxes']) : null, |
|
251 | 251 | |
252 | 252 | // Billing details. |
253 | 253 | 'user_id' => $data['user_id'], |
254 | - 'first_name' => isset( $data['first_name'] ) ? wpinv_clean( $data['first_name'] ) : $address['first_name'], |
|
255 | - 'last_name' => isset( $data['last_name'] ) ? wpinv_clean( $data['last_name'] ) : $address['last_name'], |
|
256 | - 'address' => isset( $data['address'] ) ? wpinv_clean( $data['address'] ) : $address['address'], |
|
257 | - 'vat_number' => isset( $data['vat_number'] ) ? wpinv_clean( $data['vat_number'] ) : $address['vat_number'], |
|
258 | - 'company' => isset( $data['company'] ) ? wpinv_clean( $data['company'] ) : $address['company'], |
|
259 | - 'zip' => isset( $data['zip'] ) ? wpinv_clean( $data['zip'] ) : $address['zip'], |
|
260 | - 'state' => isset( $data['state'] ) ? wpinv_clean( $data['state'] ) : $address['state'], |
|
261 | - 'city' => isset( $data['city'] ) ? wpinv_clean( $data['city'] ) : $address['city'], |
|
262 | - 'country' => isset( $data['country'] ) ? wpinv_clean( $data['country'] ) : $address['country'], |
|
263 | - 'phone' => isset( $data['phone'] ) ? wpinv_clean( $data['phone'] ) : $address['phone'], |
|
264 | - 'address_confirmed' => ! empty( $data['address_confirmed'] ), |
|
254 | + 'first_name' => isset($data['first_name']) ? wpinv_clean($data['first_name']) : $address['first_name'], |
|
255 | + 'last_name' => isset($data['last_name']) ? wpinv_clean($data['last_name']) : $address['last_name'], |
|
256 | + 'address' => isset($data['address']) ? wpinv_clean($data['address']) : $address['address'], |
|
257 | + 'vat_number' => isset($data['vat_number']) ? wpinv_clean($data['vat_number']) : $address['vat_number'], |
|
258 | + 'company' => isset($data['company']) ? wpinv_clean($data['company']) : $address['company'], |
|
259 | + 'zip' => isset($data['zip']) ? wpinv_clean($data['zip']) : $address['zip'], |
|
260 | + 'state' => isset($data['state']) ? wpinv_clean($data['state']) : $address['state'], |
|
261 | + 'city' => isset($data['city']) ? wpinv_clean($data['city']) : $address['city'], |
|
262 | + 'country' => isset($data['country']) ? wpinv_clean($data['country']) : $address['country'], |
|
263 | + 'phone' => isset($data['phone']) ? wpinv_clean($data['phone']) : $address['phone'], |
|
264 | + 'address_confirmed' => !empty($data['address_confirmed']), |
|
265 | 265 | |
266 | 266 | ) |
267 | 267 | ); |
268 | 268 | |
269 | 269 | // Backwards compatibililty. |
270 | - if ( ! empty( $data['cart_details'] ) && is_array( $data['cart_details'] ) ) { |
|
270 | + if (!empty($data['cart_details']) && is_array($data['cart_details'])) { |
|
271 | 271 | $data['items'] = array(); |
272 | 272 | |
273 | - foreach ( $data['cart_details'] as $_item ) { |
|
273 | + foreach ($data['cart_details'] as $_item) { |
|
274 | 274 | |
275 | 275 | // Ensure that we have an item id. |
276 | - if ( empty( $_item['id'] ) ) { |
|
276 | + if (empty($_item['id'])) { |
|
277 | 277 | continue; |
278 | 278 | } |
279 | 279 | |
280 | 280 | // Retrieve the item. |
281 | - $item = new GetPaid_Form_Item( $_item['id'] ); |
|
281 | + $item = new GetPaid_Form_Item($_item['id']); |
|
282 | 282 | |
283 | 283 | // Ensure that it is purchasable. |
284 | - if ( ! $item->can_purchase() ) { |
|
284 | + if (!$item->can_purchase()) { |
|
285 | 285 | continue; |
286 | 286 | } |
287 | 287 | |
288 | 288 | // Set quantity. |
289 | - if ( ! empty( $_item['quantity'] ) && is_numeric( $_item['quantity'] ) ) { |
|
290 | - $item->set_quantity( $_item['quantity'] ); |
|
289 | + if (!empty($_item['quantity']) && is_numeric($_item['quantity'])) { |
|
290 | + $item->set_quantity($_item['quantity']); |
|
291 | 291 | } |
292 | 292 | |
293 | 293 | // Set price. |
294 | - if ( isset( $_item['item_price'] ) ) { |
|
295 | - $item->set_price( $_item['item_price'] ); |
|
294 | + if (isset($_item['item_price'])) { |
|
295 | + $item->set_price($_item['item_price']); |
|
296 | 296 | } |
297 | 297 | |
298 | - if ( isset( $_item['custom_price'] ) ) { |
|
299 | - $item->set_price( $_item['custom_price'] ); |
|
298 | + if (isset($_item['custom_price'])) { |
|
299 | + $item->set_price($_item['custom_price']); |
|
300 | 300 | } |
301 | 301 | |
302 | 302 | // Set name. |
303 | - if ( ! empty( $_item['name'] ) ) { |
|
304 | - $item->set_name( $_item['name'] ); |
|
303 | + if (!empty($_item['name'])) { |
|
304 | + $item->set_name($_item['name']); |
|
305 | 305 | } |
306 | 306 | |
307 | 307 | // Set description. |
308 | - if ( isset( $_item['description'] ) ) { |
|
309 | - $item->set_custom_description( $_item['description'] ); |
|
308 | + if (isset($_item['description'])) { |
|
309 | + $item->set_custom_description($_item['description']); |
|
310 | 310 | } |
311 | 311 | |
312 | 312 | // Set meta. |
313 | - if ( isset( $_item['meta'] ) && is_array( $_item['meta'] ) ) { |
|
313 | + if (isset($_item['meta']) && is_array($_item['meta'])) { |
|
314 | 314 | |
315 | - $item->set_item_meta( $_item['meta'] ); |
|
315 | + $item->set_item_meta($_item['meta']); |
|
316 | 316 | |
317 | - if ( isset( $_item['meta']['description'] ) ) { |
|
318 | - $item->set_custom_description( $_item['meta']['description'] ); |
|
317 | + if (isset($_item['meta']['description'])) { |
|
318 | + $item->set_custom_description($_item['meta']['description']); |
|
319 | 319 | } |
320 | 320 | } |
321 | 321 | |
@@ -325,14 +325,14 @@ discard block |
||
325 | 325 | } |
326 | 326 | |
327 | 327 | // Add invoice items. |
328 | - if ( ! empty( $data['items'] ) && is_array( $data['items'] ) ) { |
|
328 | + if (!empty($data['items']) && is_array($data['items'])) { |
|
329 | 329 | |
330 | - $invoice->set_items( array() ); |
|
330 | + $invoice->set_items(array()); |
|
331 | 331 | |
332 | - foreach ( $data['items'] as $item ) { |
|
332 | + foreach ($data['items'] as $item) { |
|
333 | 333 | |
334 | - if ( is_object( $item ) && is_a( $item, 'GetPaid_Form_Item' ) && $item->can_purchase() ) { |
|
335 | - $invoice->add_item( $item ); |
|
334 | + if (is_object($item) && is_a($item, 'GetPaid_Form_Item') && $item->can_purchase()) { |
|
335 | + $invoice->add_item($item); |
|
336 | 336 | } |
337 | 337 | } |
338 | 338 | } |
@@ -341,30 +341,30 @@ discard block |
||
341 | 341 | $invoice->recalculate_total(); |
342 | 342 | $invoice->save(); |
343 | 343 | |
344 | - if ( ! $invoice->get_id() ) { |
|
345 | - return $wp_error ? new WP_Error( 'wpinv_insert_invoice_error', __( 'An error occured when saving your invoice.', 'invoicing' ) ) : 0; |
|
344 | + if (!$invoice->get_id()) { |
|
345 | + return $wp_error ? new WP_Error('wpinv_insert_invoice_error', __('An error occured when saving your invoice.', 'invoicing')) : 0; |
|
346 | 346 | } |
347 | 347 | |
348 | 348 | // Add private note. |
349 | - if ( ! empty( $data['private_note'] ) ) { |
|
350 | - $invoice->add_note( $data['private_note'] ); |
|
349 | + if (!empty($data['private_note'])) { |
|
350 | + $invoice->add_note($data['private_note']); |
|
351 | 351 | } |
352 | 352 | |
353 | 353 | // User notes. |
354 | - if ( ! empty( $data['user_note'] ) ) { |
|
355 | - $invoice->add_note( $data['user_note'], true ); |
|
354 | + if (!empty($data['user_note'])) { |
|
355 | + $invoice->add_note($data['user_note'], true); |
|
356 | 356 | } |
357 | 357 | |
358 | 358 | // Created via. |
359 | - if ( isset( $data['created_via'] ) ) { |
|
360 | - update_post_meta( $invoice->get_id(), 'wpinv_created_via', $data['created_via'] ); |
|
359 | + if (isset($data['created_via'])) { |
|
360 | + update_post_meta($invoice->get_id(), 'wpinv_created_via', $data['created_via']); |
|
361 | 361 | } |
362 | 362 | |
363 | 363 | // Backwards compatiblity. |
364 | - if ( $invoice->is_quote() ) { |
|
364 | + if ($invoice->is_quote()) { |
|
365 | 365 | |
366 | - if ( isset( $data['valid_until'] ) ) { |
|
367 | - update_post_meta( $invoice->get_id(), 'wpinv_quote_valid_until', $data['valid_until'] ); |
|
366 | + if (isset($data['valid_until'])) { |
|
367 | + update_post_meta($invoice->get_id(), 'wpinv_quote_valid_until', $data['valid_until']); |
|
368 | 368 | } |
369 | 369 | } |
370 | 370 | |
@@ -378,20 +378,20 @@ discard block |
||
378 | 378 | * @param $bool $deprecated |
379 | 379 | * @return WPInv_Invoice|null |
380 | 380 | */ |
381 | -function wpinv_get_invoice( $invoice = 0, $deprecated = false ) { |
|
381 | +function wpinv_get_invoice($invoice = 0, $deprecated = false) { |
|
382 | 382 | |
383 | 383 | // If we are retrieving the invoice from the cart... |
384 | - if ( $deprecated && empty( $invoice ) ) { |
|
384 | + if ($deprecated && empty($invoice)) { |
|
385 | 385 | $invoice = (int) getpaid_get_current_invoice_id(); |
386 | 386 | } |
387 | 387 | |
388 | 388 | // Retrieve the invoice. |
389 | - if ( ! is_a( $invoice, 'WPInv_Invoice' ) ) { |
|
390 | - $invoice = new WPInv_Invoice( $invoice ); |
|
389 | + if (!is_a($invoice, 'WPInv_Invoice')) { |
|
390 | + $invoice = new WPInv_Invoice($invoice); |
|
391 | 391 | } |
392 | 392 | |
393 | 393 | // Check if it exists. |
394 | - if ( $invoice->exists() ) { |
|
394 | + if ($invoice->exists()) { |
|
395 | 395 | return $invoice; |
396 | 396 | } |
397 | 397 | |
@@ -404,15 +404,15 @@ discard block |
||
404 | 404 | * @param array $args Args to search for. |
405 | 405 | * @return WPInv_Invoice[]|int[]|object |
406 | 406 | */ |
407 | -function wpinv_get_invoices( $args ) { |
|
407 | +function wpinv_get_invoices($args) { |
|
408 | 408 | |
409 | 409 | // Prepare args. |
410 | 410 | $args = wp_parse_args( |
411 | 411 | $args, |
412 | 412 | array( |
413 | - 'status' => array_keys( wpinv_get_invoice_statuses() ), |
|
413 | + 'status' => array_keys(wpinv_get_invoice_statuses()), |
|
414 | 414 | 'type' => 'wpi_invoice', |
415 | - 'limit' => get_option( 'posts_per_page' ), |
|
415 | + 'limit' => get_option('posts_per_page'), |
|
416 | 416 | 'return' => 'objects', |
417 | 417 | ) |
418 | 418 | ); |
@@ -430,24 +430,24 @@ discard block |
||
430 | 430 | 'post__in' => 'include', |
431 | 431 | ); |
432 | 432 | |
433 | - foreach ( $map_legacy as $to => $from ) { |
|
434 | - if ( isset( $args[ $from ] ) ) { |
|
435 | - $args[ $to ] = $args[ $from ]; |
|
436 | - unset( $args[ $from ] ); |
|
433 | + foreach ($map_legacy as $to => $from) { |
|
434 | + if (isset($args[$from])) { |
|
435 | + $args[$to] = $args[$from]; |
|
436 | + unset($args[$from]); |
|
437 | 437 | } |
438 | 438 | } |
439 | 439 | |
440 | 440 | // Backwards compatibility. |
441 | - if ( ! empty( $args['email'] ) && empty( $args['user'] ) ) { |
|
441 | + if (!empty($args['email']) && empty($args['user'])) { |
|
442 | 442 | $args['user'] = $args['email']; |
443 | - unset( $args['email'] ); |
|
443 | + unset($args['email']); |
|
444 | 444 | } |
445 | 445 | |
446 | 446 | // Handle cases where the user is set as an email. |
447 | - if ( ! empty( $args['author'] ) && is_email( $args['author'] ) ) { |
|
448 | - $user = get_user_by( 'email', $args['user'] ); |
|
447 | + if (!empty($args['author']) && is_email($args['author'])) { |
|
448 | + $user = get_user_by('email', $args['user']); |
|
449 | 449 | |
450 | - if ( $user ) { |
|
450 | + if ($user) { |
|
451 | 451 | $args['author'] = $user->user_email; |
452 | 452 | } |
453 | 453 | } |
@@ -457,31 +457,31 @@ discard block |
||
457 | 457 | |
458 | 458 | // Show all posts. |
459 | 459 | $paginate = true; |
460 | - if ( isset( $args['paginate'] ) ) { |
|
460 | + if (isset($args['paginate'])) { |
|
461 | 461 | |
462 | 462 | $paginate = $args['paginate']; |
463 | - $args['no_found_rows'] = empty( $args['paginate'] ); |
|
464 | - unset( $args['paginate'] ); |
|
463 | + $args['no_found_rows'] = empty($args['paginate']); |
|
464 | + unset($args['paginate']); |
|
465 | 465 | |
466 | 466 | } |
467 | 467 | |
468 | 468 | // Whether to return objects or fields. |
469 | 469 | $return = $args['return']; |
470 | - unset( $args['return'] ); |
|
470 | + unset($args['return']); |
|
471 | 471 | |
472 | 472 | // Get invoices. |
473 | - $invoices = new WP_Query( apply_filters( 'wpinv_get_invoices_args', $args ) ); |
|
473 | + $invoices = new WP_Query(apply_filters('wpinv_get_invoices_args', $args)); |
|
474 | 474 | |
475 | 475 | // Prepare the results. |
476 | - if ( 'objects' === $return ) { |
|
477 | - $results = array_map( 'wpinv_get_invoice', $invoices->posts ); |
|
478 | - } elseif ( 'self' === $return ) { |
|
476 | + if ('objects' === $return) { |
|
477 | + $results = array_map('wpinv_get_invoice', $invoices->posts); |
|
478 | + } elseif ('self' === $return) { |
|
479 | 479 | return $invoices; |
480 | 480 | } else { |
481 | 481 | $results = $invoices->posts; |
482 | 482 | } |
483 | 483 | |
484 | - if ( $paginate ) { |
|
484 | + if ($paginate) { |
|
485 | 485 | return (object) array( |
486 | 486 | 'invoices' => $results, |
487 | 487 | 'total' => $invoices->found_posts, |
@@ -499,8 +499,8 @@ discard block |
||
499 | 499 | * @param string $transaction_id The transaction id to check. |
500 | 500 | * @return int Invoice id on success or 0 on failure |
501 | 501 | */ |
502 | -function wpinv_get_id_by_transaction_id( $transaction_id ) { |
|
503 | - return WPInv_Invoice::get_invoice_id_by_field( $transaction_id, 'transaction_id' ); |
|
502 | +function wpinv_get_id_by_transaction_id($transaction_id) { |
|
503 | + return WPInv_Invoice::get_invoice_id_by_field($transaction_id, 'transaction_id'); |
|
504 | 504 | } |
505 | 505 | |
506 | 506 | /** |
@@ -509,8 +509,8 @@ discard block |
||
509 | 509 | * @param string $invoice_number The invoice number to check. |
510 | 510 | * @return int Invoice id on success or 0 on failure |
511 | 511 | */ |
512 | -function wpinv_get_id_by_invoice_number( $invoice_number ) { |
|
513 | - return WPInv_Invoice::get_invoice_id_by_field( $invoice_number, 'number' ); |
|
512 | +function wpinv_get_id_by_invoice_number($invoice_number) { |
|
513 | + return WPInv_Invoice::get_invoice_id_by_field($invoice_number, 'number'); |
|
514 | 514 | } |
515 | 515 | |
516 | 516 | /** |
@@ -519,8 +519,8 @@ discard block |
||
519 | 519 | * @param string $invoice_key The invoice key to check. |
520 | 520 | * @return int Invoice id on success or 0 on failure |
521 | 521 | */ |
522 | -function wpinv_get_invoice_id_by_key( $invoice_key ) { |
|
523 | - return WPInv_Invoice::get_invoice_id_by_field( $invoice_key, 'key' ); |
|
522 | +function wpinv_get_invoice_id_by_key($invoice_key) { |
|
523 | + return WPInv_Invoice::get_invoice_id_by_field($invoice_key, 'key'); |
|
524 | 524 | } |
525 | 525 | |
526 | 526 | /** |
@@ -530,19 +530,19 @@ discard block |
||
530 | 530 | * @param string $type Optionally filter by type i.e customer|system |
531 | 531 | * @return array|null |
532 | 532 | */ |
533 | -function wpinv_get_invoice_notes( $invoice = 0, $type = '' ) { |
|
533 | +function wpinv_get_invoice_notes($invoice = 0, $type = '') { |
|
534 | 534 | |
535 | 535 | // Prepare the invoice. |
536 | - $invoice = wpinv_get_invoice( $invoice ); |
|
537 | - if ( empty( $invoice ) ) { |
|
536 | + $invoice = wpinv_get_invoice($invoice); |
|
537 | + if (empty($invoice)) { |
|
538 | 538 | return null; |
539 | 539 | } |
540 | 540 | |
541 | 541 | // Fetch notes. |
542 | - $notes = getpaid_notes()->get_invoice_notes( $invoice->get_id(), $type ); |
|
542 | + $notes = getpaid_notes()->get_invoice_notes($invoice->get_id(), $type); |
|
543 | 543 | |
544 | 544 | // Filter the notes. |
545 | - return apply_filters( 'wpinv_invoice_notes', $notes, $invoice->get_id(), $type ); |
|
545 | + return apply_filters('wpinv_invoice_notes', $notes, $invoice->get_id(), $type); |
|
546 | 546 | } |
547 | 547 | |
548 | 548 | /** |
@@ -550,10 +550,10 @@ discard block |
||
550 | 550 | * |
551 | 551 | * @param string $post_type |
552 | 552 | */ |
553 | -function wpinv_get_user_invoices_columns( $post_type = 'wpi_invoice' ) { |
|
553 | +function wpinv_get_user_invoices_columns($post_type = 'wpi_invoice') { |
|
554 | 554 | |
555 | - $label = getpaid_get_post_type_label( $post_type, false ); |
|
556 | - $label = empty( $label ) ? __( 'Invoice', 'invoicing' ) : sanitize_text_field( $label ); |
|
555 | + $label = getpaid_get_post_type_label($post_type, false); |
|
556 | + $label = empty($label) ? __('Invoice', 'invoicing') : sanitize_text_field($label); |
|
557 | 557 | $columns = array( |
558 | 558 | |
559 | 559 | 'invoice-number' => array( |
@@ -562,22 +562,22 @@ discard block |
||
562 | 562 | ), |
563 | 563 | |
564 | 564 | 'created-date' => array( |
565 | - 'title' => __( 'Created Date', 'invoicing' ), |
|
565 | + 'title' => __('Created Date', 'invoicing'), |
|
566 | 566 | 'class' => 'text-left', |
567 | 567 | ), |
568 | 568 | |
569 | 569 | 'payment-date' => array( |
570 | - 'title' => __( 'Payment Date', 'invoicing' ), |
|
570 | + 'title' => __('Payment Date', 'invoicing'), |
|
571 | 571 | 'class' => 'text-left', |
572 | 572 | ), |
573 | 573 | |
574 | 574 | 'invoice-status' => array( |
575 | - 'title' => __( 'Status', 'invoicing' ), |
|
575 | + 'title' => __('Status', 'invoicing'), |
|
576 | 576 | 'class' => 'text-center', |
577 | 577 | ), |
578 | 578 | |
579 | 579 | 'invoice-total' => array( |
580 | - 'title' => __( 'Total', 'invoicing' ), |
|
580 | + 'title' => __('Total', 'invoicing'), |
|
581 | 581 | 'class' => 'text-right', |
582 | 582 | ), |
583 | 583 | |
@@ -588,7 +588,7 @@ discard block |
||
588 | 588 | |
589 | 589 | ); |
590 | 590 | |
591 | - return apply_filters( 'wpinv_user_invoices_columns', $columns, $post_type ); |
|
591 | + return apply_filters('wpinv_user_invoices_columns', $columns, $post_type); |
|
592 | 592 | } |
593 | 593 | |
594 | 594 | /** |
@@ -598,59 +598,59 @@ discard block |
||
598 | 598 | |
599 | 599 | // Find the invoice. |
600 | 600 | $invoice_id = getpaid_get_current_invoice_id(); |
601 | - $invoice = new WPInv_Invoice( $invoice_id ); |
|
601 | + $invoice = new WPInv_Invoice($invoice_id); |
|
602 | 602 | |
603 | 603 | // Abort if non was found. |
604 | - if ( empty( $invoice_id ) || $invoice->is_draft() ) { |
|
604 | + if (empty($invoice_id) || $invoice->is_draft()) { |
|
605 | 605 | |
606 | 606 | return aui()->alert( |
607 | 607 | array( |
608 | 608 | 'type' => 'warning', |
609 | - 'content' => __( 'We could not find your invoice', 'invoicing' ), |
|
609 | + 'content' => __('We could not find your invoice', 'invoicing'), |
|
610 | 610 | ) |
611 | 611 | ); |
612 | 612 | |
613 | 613 | } |
614 | 614 | |
615 | 615 | // Can the user view this invoice? |
616 | - if ( ! wpinv_can_view_receipt( $invoice_id ) ) { |
|
616 | + if (!wpinv_can_view_receipt($invoice_id)) { |
|
617 | 617 | |
618 | 618 | return aui()->alert( |
619 | 619 | array( |
620 | 620 | 'type' => 'warning', |
621 | - 'content' => __( 'You are not allowed to view this receipt', 'invoicing' ), |
|
621 | + 'content' => __('You are not allowed to view this receipt', 'invoicing'), |
|
622 | 622 | ) |
623 | 623 | ); |
624 | 624 | |
625 | 625 | } |
626 | 626 | |
627 | 627 | // Load the template. |
628 | - return wpinv_get_template_html( 'invoice-receipt.php', compact( 'invoice' ) ); |
|
628 | + return wpinv_get_template_html('invoice-receipt.php', compact('invoice')); |
|
629 | 629 | |
630 | 630 | } |
631 | 631 | |
632 | 632 | /** |
633 | 633 | * Displays the invoice history. |
634 | 634 | */ |
635 | -function getpaid_invoice_history( $user_id = 0, $post_type = 'wpi_invoice' ) { |
|
635 | +function getpaid_invoice_history($user_id = 0, $post_type = 'wpi_invoice') { |
|
636 | 636 | |
637 | 637 | // Ensure that we have a user id. |
638 | - if ( empty( $user_id ) || ! is_numeric( $user_id ) ) { |
|
638 | + if (empty($user_id) || !is_numeric($user_id)) { |
|
639 | 639 | $user_id = get_current_user_id(); |
640 | 640 | } |
641 | 641 | |
642 | - $label = getpaid_get_post_type_label( $post_type ); |
|
643 | - $label = empty( $label ) ? __( 'Invoices', 'invoicing' ) : sanitize_text_field( $label ); |
|
642 | + $label = getpaid_get_post_type_label($post_type); |
|
643 | + $label = empty($label) ? __('Invoices', 'invoicing') : sanitize_text_field($label); |
|
644 | 644 | |
645 | 645 | // View user id. |
646 | - if ( empty( $user_id ) ) { |
|
646 | + if (empty($user_id)) { |
|
647 | 647 | |
648 | 648 | return aui()->alert( |
649 | 649 | array( |
650 | 650 | 'type' => 'warning', |
651 | 651 | 'content' => sprintf( |
652 | - __( 'You must be logged in to view your %s.', 'invoicing' ), |
|
653 | - strtolower( $label ) |
|
652 | + __('You must be logged in to view your %s.', 'invoicing'), |
|
653 | + strtolower($label) |
|
654 | 654 | ), |
655 | 655 | ) |
656 | 656 | ); |
@@ -660,22 +660,22 @@ discard block |
||
660 | 660 | // Fetch invoices. |
661 | 661 | $invoices = wpinv_get_invoices( |
662 | 662 | array( |
663 | - 'page' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
663 | + 'page' => (get_query_var('paged')) ? absint(get_query_var('paged')) : 1, |
|
664 | 664 | 'user' => $user_id, |
665 | 665 | 'paginate' => true, |
666 | 666 | 'type' => $post_type, |
667 | - 'status' => array_keys( wpinv_get_invoice_statuses( false, false, $post_type ) ), |
|
667 | + 'status' => array_keys(wpinv_get_invoice_statuses(false, false, $post_type)), |
|
668 | 668 | ) |
669 | 669 | ); |
670 | 670 | |
671 | - if ( empty( $invoices->total ) ) { |
|
671 | + if (empty($invoices->total)) { |
|
672 | 672 | |
673 | 673 | return aui()->alert( |
674 | 674 | array( |
675 | 675 | 'type' => 'info', |
676 | 676 | 'content' => sprintf( |
677 | - __( 'No %s found.', 'invoicing' ), |
|
678 | - strtolower( $label ) |
|
677 | + __('No %s found.', 'invoicing'), |
|
678 | + strtolower($label) |
|
679 | 679 | ), |
680 | 680 | ) |
681 | 681 | ); |
@@ -683,38 +683,38 @@ discard block |
||
683 | 683 | } |
684 | 684 | |
685 | 685 | // Load the template. |
686 | - return wpinv_get_template_html( 'invoice-history.php', compact( 'invoices', 'post_type' ) ); |
|
686 | + return wpinv_get_template_html('invoice-history.php', compact('invoices', 'post_type')); |
|
687 | 687 | |
688 | 688 | } |
689 | 689 | |
690 | 690 | /** |
691 | 691 | * Formats an invoice number given an invoice type. |
692 | 692 | */ |
693 | -function wpinv_format_invoice_number( $number, $type = '' ) { |
|
693 | +function wpinv_format_invoice_number($number, $type = '') { |
|
694 | 694 | |
695 | 695 | // Allow other plugins to overide this. |
696 | - $check = apply_filters( 'wpinv_pre_format_invoice_number', null, $number, $type ); |
|
697 | - if ( null !== $check ) { |
|
696 | + $check = apply_filters('wpinv_pre_format_invoice_number', null, $number, $type); |
|
697 | + if (null !== $check) { |
|
698 | 698 | return $check; |
699 | 699 | } |
700 | 700 | |
701 | 701 | // Ensure that we have a numeric number. |
702 | - if ( ! is_numeric( $number ) ) { |
|
702 | + if (!is_numeric($number)) { |
|
703 | 703 | return $number; |
704 | 704 | } |
705 | 705 | |
706 | 706 | // Format the number. |
707 | - $padd = absint( (int) wpinv_get_option( 'invoice_number_padd', 5 ) ); |
|
708 | - $prefix = sanitize_text_field( (string) wpinv_get_option( 'invoice_number_prefix', 'INV-' ) ); |
|
709 | - $prefix = sanitize_text_field( apply_filters( 'getpaid_invoice_type_prefix', $prefix, $type ) ); |
|
710 | - $postfix = sanitize_text_field( (string) wpinv_get_option( 'invoice_number_postfix' ) ); |
|
711 | - $postfix = sanitize_text_field( apply_filters( 'getpaid_invoice_type_postfix', $postfix, $type ) ); |
|
712 | - $formatted_number = zeroise( absint( $number ), $padd ); |
|
707 | + $padd = absint((int) wpinv_get_option('invoice_number_padd', 5)); |
|
708 | + $prefix = sanitize_text_field((string) wpinv_get_option('invoice_number_prefix', 'INV-')); |
|
709 | + $prefix = sanitize_text_field(apply_filters('getpaid_invoice_type_prefix', $prefix, $type)); |
|
710 | + $postfix = sanitize_text_field((string) wpinv_get_option('invoice_number_postfix')); |
|
711 | + $postfix = sanitize_text_field(apply_filters('getpaid_invoice_type_postfix', $postfix, $type)); |
|
712 | + $formatted_number = zeroise(absint($number), $padd); |
|
713 | 713 | |
714 | 714 | // Add the prefix and post fix. |
715 | 715 | $formatted_number = $prefix . $formatted_number . $postfix; |
716 | 716 | |
717 | - return apply_filters( 'wpinv_format_invoice_number', $formatted_number, $number, $prefix, $postfix, $padd ); |
|
717 | + return apply_filters('wpinv_format_invoice_number', $formatted_number, $number, $prefix, $postfix, $padd); |
|
718 | 718 | } |
719 | 719 | |
720 | 720 | /** |
@@ -723,58 +723,58 @@ discard block |
||
723 | 723 | * @param string $type. |
724 | 724 | * @return int|null|bool |
725 | 725 | */ |
726 | -function wpinv_get_next_invoice_number( $type = '' ) { |
|
726 | +function wpinv_get_next_invoice_number($type = '') { |
|
727 | 727 | |
728 | 728 | // Allow plugins to overide this. |
729 | - $check = apply_filters( 'wpinv_get_pre_next_invoice_number', null, $type ); |
|
730 | - if ( null !== $check ) { |
|
729 | + $check = apply_filters('wpinv_get_pre_next_invoice_number', null, $type); |
|
730 | + if (null !== $check) { |
|
731 | 731 | return $check; |
732 | 732 | } |
733 | 733 | |
734 | 734 | // Ensure sequential invoice numbers is active. |
735 | - if ( ! wpinv_sequential_number_active() ) { |
|
735 | + if (!wpinv_sequential_number_active()) { |
|
736 | 736 | return false; |
737 | 737 | } |
738 | 738 | |
739 | 739 | // Retrieve the current number and the start number. |
740 | - $number = (int) get_option( 'wpinv_last_invoice_number', 0 ); |
|
741 | - $start = absint( (int) wpinv_get_option( 'invoice_sequence_start', 1 ) ); |
|
740 | + $number = (int) get_option('wpinv_last_invoice_number', 0); |
|
741 | + $start = absint((int) wpinv_get_option('invoice_sequence_start', 1)); |
|
742 | 742 | |
743 | 743 | // Ensure that we are starting at a positive integer. |
744 | - $start = max( $start, 1 ); |
|
744 | + $start = max($start, 1); |
|
745 | 745 | |
746 | 746 | // If this is the first invoice, use the start number. |
747 | - $number = max( $start, $number ); |
|
747 | + $number = max($start, $number); |
|
748 | 748 | |
749 | 749 | // Format the invoice number. |
750 | - $formatted_number = wpinv_format_invoice_number( $number, $type ); |
|
750 | + $formatted_number = wpinv_format_invoice_number($number, $type); |
|
751 | 751 | |
752 | 752 | // Ensure that this number is unique. |
753 | - $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $formatted_number, 'number' ); |
|
753 | + $invoice_id = WPInv_Invoice::get_invoice_id_by_field($formatted_number, 'number'); |
|
754 | 754 | |
755 | 755 | // We found a match. Nice. |
756 | - if ( empty( $invoice_id ) ) { |
|
757 | - update_option( 'wpinv_last_invoice_number', $number ); |
|
758 | - return apply_filters( 'wpinv_get_next_invoice_number', $number ); |
|
756 | + if (empty($invoice_id)) { |
|
757 | + update_option('wpinv_last_invoice_number', $number); |
|
758 | + return apply_filters('wpinv_get_next_invoice_number', $number); |
|
759 | 759 | } |
760 | 760 | |
761 | - update_option( 'wpinv_last_invoice_number', $number + 1 ); |
|
762 | - return wpinv_get_next_invoice_number( $type ); |
|
761 | + update_option('wpinv_last_invoice_number', $number + 1); |
|
762 | + return wpinv_get_next_invoice_number($type); |
|
763 | 763 | |
764 | 764 | } |
765 | 765 | |
766 | 766 | /** |
767 | 767 | * The prefix used for invoice paths. |
768 | 768 | */ |
769 | -function wpinv_post_name_prefix( $post_type = 'wpi_invoice' ) { |
|
770 | - return apply_filters( 'wpinv_post_name_prefix', 'inv-', $post_type ); |
|
769 | +function wpinv_post_name_prefix($post_type = 'wpi_invoice') { |
|
770 | + return apply_filters('wpinv_post_name_prefix', 'inv-', $post_type); |
|
771 | 771 | } |
772 | 772 | |
773 | -function wpinv_generate_post_name( $post_ID ) { |
|
774 | - $prefix = wpinv_post_name_prefix( get_post_type( $post_ID ) ); |
|
775 | - $post_name = sanitize_title( $prefix . $post_ID ); |
|
773 | +function wpinv_generate_post_name($post_ID) { |
|
774 | + $prefix = wpinv_post_name_prefix(get_post_type($post_ID)); |
|
775 | + $post_name = sanitize_title($prefix . $post_ID); |
|
776 | 776 | |
777 | - return apply_filters( 'wpinv_generate_post_name', $post_name, $post_ID, $prefix ); |
|
777 | + return apply_filters('wpinv_generate_post_name', $post_name, $post_ID, $prefix); |
|
778 | 778 | } |
779 | 779 | |
780 | 780 | /** |
@@ -782,8 +782,8 @@ discard block |
||
782 | 782 | * |
783 | 783 | * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
784 | 784 | */ |
785 | -function wpinv_is_invoice_viewed( $invoice ) { |
|
786 | - $invoice = new WPInv_Invoice( $invoice ); |
|
785 | +function wpinv_is_invoice_viewed($invoice) { |
|
786 | + $invoice = new WPInv_Invoice($invoice); |
|
787 | 787 | return (bool) $invoice->get_is_viewed(); |
788 | 788 | } |
789 | 789 | |
@@ -792,17 +792,17 @@ discard block |
||
792 | 792 | * |
793 | 793 | * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
794 | 794 | */ |
795 | -function getpaid_maybe_mark_invoice_as_viewed( $invoice ) { |
|
796 | - $invoice = new WPInv_Invoice( $invoice ); |
|
795 | +function getpaid_maybe_mark_invoice_as_viewed($invoice) { |
|
796 | + $invoice = new WPInv_Invoice($invoice); |
|
797 | 797 | |
798 | - if ( get_current_user_id() == $invoice->get_user_id() && ! $invoice->get_is_viewed() ) { |
|
799 | - $invoice->set_is_viewed( true ); |
|
798 | + if (get_current_user_id() == $invoice->get_user_id() && !$invoice->get_is_viewed()) { |
|
799 | + $invoice->set_is_viewed(true); |
|
800 | 800 | $invoice->save(); |
801 | 801 | } |
802 | 802 | |
803 | 803 | } |
804 | -add_action( 'wpinv_invoice_print_before_display', 'getpaid_maybe_mark_invoice_as_viewed' ); |
|
805 | -add_action( 'wpinv_before_receipt', 'getpaid_maybe_mark_invoice_as_viewed' ); |
|
804 | +add_action('wpinv_invoice_print_before_display', 'getpaid_maybe_mark_invoice_as_viewed'); |
|
805 | +add_action('wpinv_before_receipt', 'getpaid_maybe_mark_invoice_as_viewed'); |
|
806 | 806 | |
807 | 807 | /** |
808 | 808 | * Processes an invoice refund. |
@@ -811,26 +811,26 @@ discard block |
||
811 | 811 | * @param array $status_transition |
812 | 812 | * @todo: descrease customer/store earnings |
813 | 813 | */ |
814 | -function getpaid_maybe_process_refund( $invoice, $status_transition ) { |
|
814 | +function getpaid_maybe_process_refund($invoice, $status_transition) { |
|
815 | 815 | |
816 | - if ( empty( $status_transition['from'] ) || ! in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ) ) ) { |
|
816 | + if (empty($status_transition['from']) || !in_array($status_transition['from'], array('publish', 'wpi-processing', 'wpi-renewal'))) { |
|
817 | 817 | return; |
818 | 818 | } |
819 | 819 | |
820 | 820 | $discount_code = $invoice->get_discount_code(); |
821 | - if ( ! empty( $discount_code ) ) { |
|
822 | - $discount = wpinv_get_discount_obj( $discount_code ); |
|
821 | + if (!empty($discount_code)) { |
|
822 | + $discount = wpinv_get_discount_obj($discount_code); |
|
823 | 823 | |
824 | - if ( $discount->exists() ) { |
|
824 | + if ($discount->exists()) { |
|
825 | 825 | $discount->increase_usage( -1 ); |
826 | 826 | } |
827 | 827 | } |
828 | 828 | |
829 | - do_action( 'wpinv_pre_refund_invoice', $invoice, $invoice->get_id() ); |
|
830 | - do_action( 'wpinv_refund_invoice', $invoice, $invoice->get_id() ); |
|
831 | - do_action( 'wpinv_post_refund_invoice', $invoice, $invoice->get_id() ); |
|
829 | + do_action('wpinv_pre_refund_invoice', $invoice, $invoice->get_id()); |
|
830 | + do_action('wpinv_refund_invoice', $invoice, $invoice->get_id()); |
|
831 | + do_action('wpinv_post_refund_invoice', $invoice, $invoice->get_id()); |
|
832 | 832 | } |
833 | -add_action( 'getpaid_invoice_status_wpi-refunded', 'getpaid_maybe_process_refund', 10, 2 ); |
|
833 | +add_action('getpaid_invoice_status_wpi-refunded', 'getpaid_maybe_process_refund', 10, 2); |
|
834 | 834 | |
835 | 835 | |
836 | 836 | /** |
@@ -838,47 +838,47 @@ discard block |
||
838 | 838 | * |
839 | 839 | * @param int $invoice_id |
840 | 840 | */ |
841 | -function getpaid_process_invoice_payment( $invoice_id ) { |
|
841 | +function getpaid_process_invoice_payment($invoice_id) { |
|
842 | 842 | |
843 | 843 | // Fetch the invoice. |
844 | - $invoice = new WPInv_Invoice( $invoice_id ); |
|
844 | + $invoice = new WPInv_Invoice($invoice_id); |
|
845 | 845 | |
846 | 846 | // We only want to do this once. |
847 | - if ( 1 == get_post_meta( $invoice->get_id(), 'wpinv_processed_payment', true ) ) { |
|
847 | + if (1 == get_post_meta($invoice->get_id(), 'wpinv_processed_payment', true)) { |
|
848 | 848 | return; |
849 | 849 | } |
850 | 850 | |
851 | - update_post_meta( $invoice->get_id(), 'wpinv_processed_payment', 1 ); |
|
851 | + update_post_meta($invoice->get_id(), 'wpinv_processed_payment', 1); |
|
852 | 852 | |
853 | 853 | // Fires when processing a payment. |
854 | - do_action( 'getpaid_process_payment', $invoice ); |
|
854 | + do_action('getpaid_process_payment', $invoice); |
|
855 | 855 | |
856 | 856 | // Fire an action for each invoice item. |
857 | - foreach ( $invoice->get_items() as $item ) { |
|
858 | - do_action( 'getpaid_process_item_payment', $item, $invoice ); |
|
857 | + foreach ($invoice->get_items() as $item) { |
|
858 | + do_action('getpaid_process_item_payment', $item, $invoice); |
|
859 | 859 | } |
860 | 860 | |
861 | 861 | // Increase discount usage. |
862 | 862 | $discount_code = $invoice->get_discount_code(); |
863 | - if ( ! empty( $discount_code ) && ! $invoice->is_renewal() ) { |
|
864 | - $discount = wpinv_get_discount_obj( $discount_code ); |
|
863 | + if (!empty($discount_code) && !$invoice->is_renewal()) { |
|
864 | + $discount = wpinv_get_discount_obj($discount_code); |
|
865 | 865 | |
866 | - if ( $discount->exists() ) { |
|
866 | + if ($discount->exists()) { |
|
867 | 867 | $discount->increase_usage(); |
868 | 868 | } |
869 | 869 | } |
870 | 870 | |
871 | 871 | // Record reverse vat. |
872 | - if ( 'invoice' === $invoice->get_type() && wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) { |
|
872 | + if ('invoice' === $invoice->get_type() && wpinv_use_taxes() && !$invoice->get_disable_taxes()) { |
|
873 | 873 | |
874 | 874 | $taxes = $invoice->get_total_tax(); |
875 | - if ( empty( $taxes ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) { |
|
876 | - $invoice->add_note( __( 'VAT was reverse charged', 'invoicing' ), false, false, true ); |
|
875 | + if (empty($taxes) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction($invoice->get_country())) { |
|
876 | + $invoice->add_note(__('VAT was reverse charged', 'invoicing'), false, false, true); |
|
877 | 877 | } |
878 | 878 | } |
879 | 879 | |
880 | 880 | } |
881 | -add_action( 'getpaid_invoice_payment_status_changed', 'getpaid_process_invoice_payment' ); |
|
881 | +add_action('getpaid_invoice_payment_status_changed', 'getpaid_process_invoice_payment'); |
|
882 | 882 | |
883 | 883 | /** |
884 | 884 | * Returns an array of invoice item columns |
@@ -886,13 +886,13 @@ discard block |
||
886 | 886 | * @param int|WPInv_Invoice $invoice |
887 | 887 | * @return array |
888 | 888 | */ |
889 | -function getpaid_invoice_item_columns( $invoice ) { |
|
889 | +function getpaid_invoice_item_columns($invoice) { |
|
890 | 890 | |
891 | 891 | // Prepare the invoice. |
892 | - $invoice = new WPInv_Invoice( $invoice ); |
|
892 | + $invoice = new WPInv_Invoice($invoice); |
|
893 | 893 | |
894 | 894 | // Abort if there is no invoice. |
895 | - if ( 0 == $invoice->get_id() ) { |
|
895 | + if (0 == $invoice->get_id()) { |
|
896 | 896 | return array(); |
897 | 897 | } |
898 | 898 | |
@@ -900,52 +900,52 @@ discard block |
||
900 | 900 | $columns = apply_filters( |
901 | 901 | 'getpaid_invoice_item_columns', |
902 | 902 | array( |
903 | - 'name' => __( 'Item', 'invoicing' ), |
|
904 | - 'price' => __( 'Price', 'invoicing' ), |
|
905 | - 'tax_rate' => __( 'Tax Rate', 'invoicing' ), |
|
906 | - 'quantity' => __( 'Quantity', 'invoicing' ), |
|
907 | - 'subtotal' => __( 'Item Subtotal', 'invoicing' ), |
|
903 | + 'name' => __('Item', 'invoicing'), |
|
904 | + 'price' => __('Price', 'invoicing'), |
|
905 | + 'tax_rate' => __('Tax Rate', 'invoicing'), |
|
906 | + 'quantity' => __('Quantity', 'invoicing'), |
|
907 | + 'subtotal' => __('Item Subtotal', 'invoicing'), |
|
908 | 908 | ), |
909 | 909 | $invoice |
910 | 910 | ); |
911 | 911 | |
912 | 912 | // Quantities. |
913 | - if ( isset( $columns['quantity'] ) ) { |
|
913 | + if (isset($columns['quantity'])) { |
|
914 | 914 | |
915 | - if ( 'hours' == $invoice->get_template() ) { |
|
916 | - $columns['quantity'] = __( 'Hours', 'invoicing' ); |
|
915 | + if ('hours' == $invoice->get_template()) { |
|
916 | + $columns['quantity'] = __('Hours', 'invoicing'); |
|
917 | 917 | } |
918 | 918 | |
919 | - if ( ! wpinv_item_quantities_enabled() || 'amount' == $invoice->get_template() ) { |
|
920 | - unset( $columns['quantity'] ); |
|
919 | + if (!wpinv_item_quantities_enabled() || 'amount' == $invoice->get_template()) { |
|
920 | + unset($columns['quantity']); |
|
921 | 921 | } |
922 | 922 | } |
923 | 923 | |
924 | 924 | // Price. |
925 | - if ( isset( $columns['price'] ) ) { |
|
925 | + if (isset($columns['price'])) { |
|
926 | 926 | |
927 | - if ( 'amount' == $invoice->get_template() ) { |
|
928 | - $columns['price'] = __( 'Amount', 'invoicing' ); |
|
927 | + if ('amount' == $invoice->get_template()) { |
|
928 | + $columns['price'] = __('Amount', 'invoicing'); |
|
929 | 929 | } |
930 | 930 | |
931 | - if ( 'hours' == $invoice->get_template() ) { |
|
932 | - $columns['price'] = __( 'Rate', 'invoicing' ); |
|
931 | + if ('hours' == $invoice->get_template()) { |
|
932 | + $columns['price'] = __('Rate', 'invoicing'); |
|
933 | 933 | } |
934 | 934 | } |
935 | 935 | |
936 | 936 | // Sub total. |
937 | - if ( isset( $columns['subtotal'] ) ) { |
|
937 | + if (isset($columns['subtotal'])) { |
|
938 | 938 | |
939 | - if ( 'amount' == $invoice->get_template() ) { |
|
940 | - unset( $columns['subtotal'] ); |
|
939 | + if ('amount' == $invoice->get_template()) { |
|
940 | + unset($columns['subtotal']); |
|
941 | 941 | } |
942 | 942 | } |
943 | 943 | |
944 | 944 | // Tax rates. |
945 | - if ( isset( $columns['tax_rate'] ) ) { |
|
945 | + if (isset($columns['tax_rate'])) { |
|
946 | 946 | |
947 | - if ( 0 == $invoice->get_total_tax() ) { |
|
948 | - unset( $columns['tax_rate'] ); |
|
947 | + if (0 == $invoice->get_total_tax()) { |
|
948 | + unset($columns['tax_rate']); |
|
949 | 949 | } |
950 | 950 | } |
951 | 951 | |
@@ -958,53 +958,53 @@ discard block |
||
958 | 958 | * @param int|WPInv_Invoice $invoice |
959 | 959 | * @return array |
960 | 960 | */ |
961 | -function getpaid_invoice_totals_rows( $invoice ) { |
|
961 | +function getpaid_invoice_totals_rows($invoice) { |
|
962 | 962 | |
963 | 963 | // Prepare the invoice. |
964 | - $invoice = new WPInv_Invoice( $invoice ); |
|
964 | + $invoice = new WPInv_Invoice($invoice); |
|
965 | 965 | |
966 | 966 | // Abort if there is no invoice. |
967 | - if ( 0 == $invoice->get_id() ) { |
|
967 | + if (0 == $invoice->get_id()) { |
|
968 | 968 | return array(); |
969 | 969 | } |
970 | 970 | |
971 | 971 | $totals = apply_filters( |
972 | 972 | 'getpaid_invoice_totals_rows', |
973 | 973 | array( |
974 | - 'subtotal' => __( 'Subtotal', 'invoicing' ), |
|
975 | - 'shipping' => __( 'Shipping', 'invoicing' ), |
|
976 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
977 | - 'fee' => __( 'Fee', 'invoicing' ), |
|
978 | - 'discount' => __( 'Discount', 'invoicing' ), |
|
979 | - 'total' => __( 'Total', 'invoicing' ), |
|
974 | + 'subtotal' => __('Subtotal', 'invoicing'), |
|
975 | + 'shipping' => __('Shipping', 'invoicing'), |
|
976 | + 'tax' => __('Tax', 'invoicing'), |
|
977 | + 'fee' => __('Fee', 'invoicing'), |
|
978 | + 'discount' => __('Discount', 'invoicing'), |
|
979 | + 'total' => __('Total', 'invoicing'), |
|
980 | 980 | ), |
981 | 981 | $invoice |
982 | 982 | ); |
983 | 983 | |
984 | - if ( ! $invoice->has_shipping() ) { |
|
985 | - unset( $totals['shipping'] ); |
|
984 | + if (!$invoice->has_shipping()) { |
|
985 | + unset($totals['shipping']); |
|
986 | 986 | } |
987 | 987 | |
988 | - if ( ( $invoice->get_disable_taxes() || ! wpinv_use_taxes() ) && isset( $totals['tax'] ) ) { |
|
989 | - unset( $totals['tax'] ); |
|
988 | + if (($invoice->get_disable_taxes() || !wpinv_use_taxes()) && isset($totals['tax'])) { |
|
989 | + unset($totals['tax']); |
|
990 | 990 | } |
991 | 991 | |
992 | 992 | // If we have taxes, display individual taxes. |
993 | - if ( isset( $totals['tax'] ) && wpinv_display_individual_tax_rates() ) { |
|
993 | + if (isset($totals['tax']) && wpinv_display_individual_tax_rates()) { |
|
994 | 994 | |
995 | 995 | $new_totals = array(); |
996 | - foreach ( $totals as $key => $label ) { |
|
996 | + foreach ($totals as $key => $label) { |
|
997 | 997 | |
998 | - if ( 'tax' !== $key ) { |
|
999 | - $new_totals[ $key ] = $label; |
|
998 | + if ('tax' !== $key) { |
|
999 | + $new_totals[$key] = $label; |
|
1000 | 1000 | continue; |
1001 | 1001 | } |
1002 | 1002 | |
1003 | - $taxes = array_keys( $invoice->get_taxes() ); |
|
1004 | - if ( ! empty( $taxes ) ) { |
|
1003 | + $taxes = array_keys($invoice->get_taxes()); |
|
1004 | + if (!empty($taxes)) { |
|
1005 | 1005 | |
1006 | - foreach ( $taxes as $tax ) { |
|
1007 | - $new_totals[ 'tax__' . $tax ] = $tax; |
|
1006 | + foreach ($taxes as $tax) { |
|
1007 | + $new_totals['tax__' . $tax] = $tax; |
|
1008 | 1008 | } |
1009 | 1009 | } |
1010 | 1010 | } |
@@ -1012,12 +1012,12 @@ discard block |
||
1012 | 1012 | $totals = $new_totals; |
1013 | 1013 | } |
1014 | 1014 | |
1015 | - if ( 0 == $invoice->get_total_fees() && isset( $totals['fee'] ) ) { |
|
1016 | - unset( $totals['fee'] ); |
|
1015 | + if (0 == $invoice->get_total_fees() && isset($totals['fee'])) { |
|
1016 | + unset($totals['fee']); |
|
1017 | 1017 | } |
1018 | 1018 | |
1019 | - if ( 0 == $invoice->get_total_discount() && isset( $totals['discount'] ) ) { |
|
1020 | - unset( $totals['discount'] ); |
|
1019 | + if (0 == $invoice->get_total_discount() && isset($totals['discount'])) { |
|
1020 | + unset($totals['discount']); |
|
1021 | 1021 | } |
1022 | 1022 | |
1023 | 1023 | return $totals; |
@@ -1028,47 +1028,47 @@ discard block |
||
1028 | 1028 | * |
1029 | 1029 | * @param WPInv_Invoice $invoice |
1030 | 1030 | */ |
1031 | -function getpaid_new_invoice( $invoice ) { |
|
1031 | +function getpaid_new_invoice($invoice) { |
|
1032 | 1032 | |
1033 | - if ( ! $invoice->get_status() ) { |
|
1033 | + if (!$invoice->get_status()) { |
|
1034 | 1034 | return; |
1035 | 1035 | } |
1036 | 1036 | |
1037 | 1037 | // Add an invoice created note. |
1038 | 1038 | $invoice->add_note( |
1039 | 1039 | sprintf( |
1040 | - __( '%1$s created with the status "%2$s".', 'invoicing' ), |
|
1041 | - ucfirst( $invoice->get_invoice_quote_type() ), |
|
1042 | - wpinv_status_nicename( $invoice->get_status(), $invoice ) |
|
1040 | + __('%1$s created with the status "%2$s".', 'invoicing'), |
|
1041 | + ucfirst($invoice->get_invoice_quote_type()), |
|
1042 | + wpinv_status_nicename($invoice->get_status(), $invoice) |
|
1043 | 1043 | ) |
1044 | 1044 | ); |
1045 | 1045 | |
1046 | 1046 | } |
1047 | -add_action( 'getpaid_new_invoice', 'getpaid_new_invoice' ); |
|
1047 | +add_action('getpaid_new_invoice', 'getpaid_new_invoice'); |
|
1048 | 1048 | |
1049 | 1049 | /** |
1050 | 1050 | * This function updates invoice caches. |
1051 | 1051 | * |
1052 | 1052 | * @param WPInv_Invoice $invoice |
1053 | 1053 | */ |
1054 | -function getpaid_update_invoice_caches( $invoice ) { |
|
1054 | +function getpaid_update_invoice_caches($invoice) { |
|
1055 | 1055 | |
1056 | 1056 | // Cache invoice number. |
1057 | - wp_cache_set( $invoice->get_number(), $invoice->get_id(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
1057 | + wp_cache_set($invoice->get_number(), $invoice->get_id(), 'getpaid_invoice_numbers_to_invoice_ids'); |
|
1058 | 1058 | |
1059 | 1059 | // Cache invoice key. |
1060 | - wp_cache_set( $invoice->get_key(), $invoice->get_id(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
1060 | + wp_cache_set($invoice->get_key(), $invoice->get_id(), 'getpaid_invoice_keys_to_invoice_ids'); |
|
1061 | 1061 | |
1062 | 1062 | // (Maybe) cache transaction id. |
1063 | 1063 | $transaction_id = $invoice->get_transaction_id(); |
1064 | 1064 | |
1065 | - if ( ! empty( $transaction_id ) ) { |
|
1066 | - wp_cache_set( $transaction_id, $invoice->get_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
1065 | + if (!empty($transaction_id)) { |
|
1066 | + wp_cache_set($transaction_id, $invoice->get_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids'); |
|
1067 | 1067 | } |
1068 | 1068 | |
1069 | 1069 | } |
1070 | -add_action( 'getpaid_new_invoice', 'getpaid_update_invoice_caches', 5 ); |
|
1071 | -add_action( 'getpaid_update_invoice', 'getpaid_update_invoice_caches', 5 ); |
|
1070 | +add_action('getpaid_new_invoice', 'getpaid_update_invoice_caches', 5); |
|
1071 | +add_action('getpaid_update_invoice', 'getpaid_update_invoice_caches', 5); |
|
1072 | 1072 | |
1073 | 1073 | /** |
1074 | 1074 | * Duplicates an invoice. |
@@ -1078,7 +1078,7 @@ discard block |
||
1078 | 1078 | * @param WPInv_Invoice $old_invoice The invoice to duplicate |
1079 | 1079 | * @return WPInv_Invoice The new invoice. |
1080 | 1080 | */ |
1081 | -function getpaid_duplicate_invoice( $old_invoice ) { |
|
1081 | +function getpaid_duplicate_invoice($old_invoice) { |
|
1082 | 1082 | |
1083 | 1083 | // Create the new invoice. |
1084 | 1084 | $invoice = new WPInv_Invoice(); |
@@ -1138,136 +1138,136 @@ discard block |
||
1138 | 1138 | * @param WPInv_Invoice $invoice |
1139 | 1139 | * @return array |
1140 | 1140 | */ |
1141 | -function getpaid_get_invoice_meta( $invoice ) { |
|
1141 | +function getpaid_get_invoice_meta($invoice) { |
|
1142 | 1142 | |
1143 | 1143 | // Load the invoice meta. |
1144 | 1144 | $meta = array( |
1145 | 1145 | |
1146 | 1146 | 'number' => array( |
1147 | 1147 | 'label' => sprintf( |
1148 | - __( '%s Number', 'invoicing' ), |
|
1149 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
1148 | + __('%s Number', 'invoicing'), |
|
1149 | + ucfirst($invoice->get_invoice_quote_type()) |
|
1150 | 1150 | ), |
1151 | - 'value' => sanitize_text_field( $invoice->get_number() ), |
|
1151 | + 'value' => sanitize_text_field($invoice->get_number()), |
|
1152 | 1152 | ), |
1153 | 1153 | |
1154 | 1154 | 'status' => array( |
1155 | 1155 | 'label' => sprintf( |
1156 | - __( '%s Status', 'invoicing' ), |
|
1157 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
1156 | + __('%s Status', 'invoicing'), |
|
1157 | + ucfirst($invoice->get_invoice_quote_type()) |
|
1158 | 1158 | ), |
1159 | 1159 | 'value' => $invoice->get_status_label_html(), |
1160 | 1160 | ), |
1161 | 1161 | |
1162 | 1162 | 'date' => array( |
1163 | 1163 | 'label' => sprintf( |
1164 | - __( '%s Date', 'invoicing' ), |
|
1165 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
1164 | + __('%s Date', 'invoicing'), |
|
1165 | + ucfirst($invoice->get_invoice_quote_type()) |
|
1166 | 1166 | ), |
1167 | - 'value' => getpaid_format_date( $invoice->get_created_date() ), |
|
1167 | + 'value' => getpaid_format_date($invoice->get_created_date()), |
|
1168 | 1168 | ), |
1169 | 1169 | |
1170 | 1170 | 'date_paid' => array( |
1171 | - 'label' => __( 'Paid On', 'invoicing' ), |
|
1172 | - 'value' => getpaid_format_date( $invoice->get_completed_date() ), |
|
1171 | + 'label' => __('Paid On', 'invoicing'), |
|
1172 | + 'value' => getpaid_format_date($invoice->get_completed_date()), |
|
1173 | 1173 | ), |
1174 | 1174 | |
1175 | 1175 | 'gateway' => array( |
1176 | - 'label' => __( 'Payment Method', 'invoicing' ), |
|
1177 | - 'value' => sanitize_text_field( $invoice->get_gateway_title() ), |
|
1176 | + 'label' => __('Payment Method', 'invoicing'), |
|
1177 | + 'value' => sanitize_text_field($invoice->get_gateway_title()), |
|
1178 | 1178 | ), |
1179 | 1179 | |
1180 | 1180 | 'transaction_id' => array( |
1181 | - 'label' => __( 'Transaction ID', 'invoicing' ), |
|
1182 | - 'value' => sanitize_text_field( $invoice->get_transaction_id() ), |
|
1181 | + 'label' => __('Transaction ID', 'invoicing'), |
|
1182 | + 'value' => sanitize_text_field($invoice->get_transaction_id()), |
|
1183 | 1183 | ), |
1184 | 1184 | |
1185 | 1185 | 'due_date' => array( |
1186 | - 'label' => __( 'Due Date', 'invoicing' ), |
|
1187 | - 'value' => getpaid_format_date( $invoice->get_due_date() ), |
|
1186 | + 'label' => __('Due Date', 'invoicing'), |
|
1187 | + 'value' => getpaid_format_date($invoice->get_due_date()), |
|
1188 | 1188 | ), |
1189 | 1189 | |
1190 | 1190 | 'vat_number' => array( |
1191 | - 'label' => __( 'VAT Number', 'invoicing' ), |
|
1192 | - 'value' => sanitize_text_field( $invoice->get_vat_number() ), |
|
1191 | + 'label' => __('VAT Number', 'invoicing'), |
|
1192 | + 'value' => sanitize_text_field($invoice->get_vat_number()), |
|
1193 | 1193 | ), |
1194 | 1194 | |
1195 | 1195 | ); |
1196 | 1196 | |
1197 | - $additional_meta = get_post_meta( $invoice->get_id(), 'additional_meta_data', true ); |
|
1197 | + $additional_meta = get_post_meta($invoice->get_id(), 'additional_meta_data', true); |
|
1198 | 1198 | |
1199 | - if ( ! empty( $additional_meta ) ) { |
|
1199 | + if (!empty($additional_meta)) { |
|
1200 | 1200 | |
1201 | - foreach ( $additional_meta as $label => $value ) { |
|
1202 | - $meta[ sanitize_key( $label ) ] = array( |
|
1203 | - 'label' => esc_html( $label ), |
|
1204 | - 'value' => esc_html( $value ), |
|
1201 | + foreach ($additional_meta as $label => $value) { |
|
1202 | + $meta[sanitize_key($label)] = array( |
|
1203 | + 'label' => esc_html($label), |
|
1204 | + 'value' => esc_html($value), |
|
1205 | 1205 | ); |
1206 | 1206 | } |
1207 | 1207 | } |
1208 | 1208 | // If it is not paid, remove the date of payment. |
1209 | - if ( ! $invoice->is_paid() && ! $invoice->is_refunded() ) { |
|
1210 | - unset( $meta['date_paid'] ); |
|
1211 | - unset( $meta['transaction_id'] ); |
|
1209 | + if (!$invoice->is_paid() && !$invoice->is_refunded()) { |
|
1210 | + unset($meta['date_paid']); |
|
1211 | + unset($meta['transaction_id']); |
|
1212 | 1212 | } |
1213 | 1213 | |
1214 | - if ( ! $invoice->is_paid() || 'none' == $invoice->get_gateway() ) { |
|
1215 | - unset( $meta['gateway'] ); |
|
1214 | + if (!$invoice->is_paid() || 'none' == $invoice->get_gateway()) { |
|
1215 | + unset($meta['gateway']); |
|
1216 | 1216 | } |
1217 | 1217 | |
1218 | 1218 | // Only display the due date if due dates are enabled. |
1219 | - if ( ! $invoice->needs_payment() || ! wpinv_get_option( 'overdue_active' ) ) { |
|
1220 | - unset( $meta['due_date'] ); |
|
1219 | + if (!$invoice->needs_payment() || !wpinv_get_option('overdue_active')) { |
|
1220 | + unset($meta['due_date']); |
|
1221 | 1221 | } |
1222 | 1222 | |
1223 | 1223 | // Only display the vat number if taxes are enabled. |
1224 | - if ( ! wpinv_use_taxes() ) { |
|
1225 | - unset( $meta['vat_number'] ); |
|
1224 | + if (!wpinv_use_taxes()) { |
|
1225 | + unset($meta['vat_number']); |
|
1226 | 1226 | } |
1227 | 1227 | |
1228 | 1228 | // Link to the parent invoice. |
1229 | - if ( $invoice->get_parent_id() > 0 ) { |
|
1229 | + if ($invoice->get_parent_id() > 0) { |
|
1230 | 1230 | |
1231 | 1231 | $meta['parent'] = array( |
1232 | 1232 | |
1233 | 1233 | 'label' => sprintf( |
1234 | - __( 'Parent %s', 'invoicing' ), |
|
1235 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
1234 | + __('Parent %s', 'invoicing'), |
|
1235 | + ucfirst($invoice->get_invoice_quote_type()) |
|
1236 | 1236 | ), |
1237 | 1237 | |
1238 | - 'value' => wpinv_invoice_link( $invoice->get_parent_id() ), |
|
1238 | + 'value' => wpinv_invoice_link($invoice->get_parent_id()), |
|
1239 | 1239 | |
1240 | 1240 | ); |
1241 | 1241 | |
1242 | 1242 | } |
1243 | 1243 | |
1244 | - if ( $invoice->is_recurring() ) { |
|
1244 | + if ($invoice->is_recurring()) { |
|
1245 | 1245 | |
1246 | - $subscription = getpaid_get_invoice_subscriptions( $invoice ); |
|
1247 | - if ( ! empty( $subscription ) && ! is_array( $subscription ) && $subscription->exists() ) { |
|
1246 | + $subscription = getpaid_get_invoice_subscriptions($invoice); |
|
1247 | + if (!empty($subscription) && !is_array($subscription) && $subscription->exists()) { |
|
1248 | 1248 | |
1249 | 1249 | // Display the renewal date. |
1250 | - if ( $subscription->is_active() && 'cancelled' != $subscription->get_status() ) { |
|
1250 | + if ($subscription->is_active() && 'cancelled' != $subscription->get_status()) { |
|
1251 | 1251 | |
1252 | 1252 | $meta['renewal_date'] = array( |
1253 | - 'label' => __( 'Renews On', 'invoicing' ), |
|
1254 | - 'value' => getpaid_format_date( $subscription->get_expiration() ) . |
|
1253 | + 'label' => __('Renews On', 'invoicing'), |
|
1254 | + 'value' => getpaid_format_date($subscription->get_expiration()) . |
|
1255 | 1255 | sprintf( |
1256 | 1256 | ' <a class="small" href="%s">%s<a>', |
1257 | 1257 | $subscription->get_view_url(), |
1258 | - __( '(View Subscription)', 'invoicing' ) |
|
1258 | + __('(View Subscription)', 'invoicing') |
|
1259 | 1259 | ), |
1260 | 1260 | ); |
1261 | 1261 | |
1262 | 1262 | } |
1263 | 1263 | |
1264 | - if ( $invoice->is_parent() ) { |
|
1264 | + if ($invoice->is_parent()) { |
|
1265 | 1265 | |
1266 | 1266 | // Display the recurring amount. |
1267 | 1267 | $meta['recurring_total'] = array( |
1268 | 1268 | |
1269 | - 'label' => __( 'Recurring Amount', 'invoicing' ), |
|
1270 | - 'value' => wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ), |
|
1269 | + 'label' => __('Recurring Amount', 'invoicing'), |
|
1270 | + 'value' => wpinv_price($subscription->get_recurring_amount(), $invoice->get_currency()), |
|
1271 | 1271 | |
1272 | 1272 | ); |
1273 | 1273 | |
@@ -1278,13 +1278,13 @@ discard block |
||
1278 | 1278 | // Add the invoice total to the meta. |
1279 | 1279 | $meta['invoice_total'] = array( |
1280 | 1280 | |
1281 | - 'label' => __( 'Total Amount', 'invoicing' ), |
|
1282 | - 'value' => wpinv_price( $invoice->get_total(), $invoice->get_currency() ), |
|
1281 | + 'label' => __('Total Amount', 'invoicing'), |
|
1282 | + 'value' => wpinv_price($invoice->get_total(), $invoice->get_currency()), |
|
1283 | 1283 | |
1284 | 1284 | ); |
1285 | 1285 | |
1286 | 1286 | // Provide a way for third party plugins to filter the meta. |
1287 | - $meta = apply_filters( 'getpaid_invoice_meta_data', $meta, $invoice ); |
|
1287 | + $meta = apply_filters('getpaid_invoice_meta_data', $meta, $invoice); |
|
1288 | 1288 | |
1289 | 1289 | return $meta; |
1290 | 1290 | |
@@ -1323,12 +1323,12 @@ discard block |
||
1323 | 1323 | * @param GetPaid_Form_Item $item |
1324 | 1324 | * @return float |
1325 | 1325 | */ |
1326 | -function getpaid_get_invoice_tax_rate( $invoice, $item ) { |
|
1326 | +function getpaid_get_invoice_tax_rate($invoice, $item) { |
|
1327 | 1327 | |
1328 | - $rates = getpaid_get_item_tax_rates( $item, $invoice->get_country(), $invoice->get_state() ); |
|
1329 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
1330 | - $rates = wp_list_pluck( $rates, 'rate' ); |
|
1328 | + $rates = getpaid_get_item_tax_rates($item, $invoice->get_country(), $invoice->get_state()); |
|
1329 | + $rates = getpaid_filter_item_tax_rates($item, $rates); |
|
1330 | + $rates = wp_list_pluck($rates, 'rate'); |
|
1331 | 1331 | |
1332 | - return array_sum( $rates ); |
|
1332 | + return array_sum($rates); |
|
1333 | 1333 | |
1334 | 1334 | } |
@@ -12,144 +12,144 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Daily_Maintenance { |
14 | 14 | |
15 | - /** |
|
16 | - * Class constructor. |
|
17 | - */ |
|
18 | - public function __construct() { |
|
19 | - |
|
20 | - // Clear deprecated events. |
|
21 | - add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) ); |
|
22 | - |
|
23 | - // (Maybe) schedule a cron that runs daily. |
|
24 | - add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) ); |
|
25 | - |
|
26 | - // Fired everyday at 7 a.m (this might vary for sites with few visitors) |
|
27 | - add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) ); |
|
28 | - add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) ); |
|
29 | - add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) ); |
|
30 | - add_action( 'getpaid_daily_maintenance', array( $this, 'check_renewing_subscriptions' ) ); |
|
31 | - add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) ); |
|
32 | - |
|
33 | - } |
|
34 | - |
|
35 | - /** |
|
36 | - * Schedules a cron to run every day at 7 a.m |
|
37 | - * |
|
38 | - */ |
|
39 | - public function maybe_create_scheduled_event() { |
|
40 | - |
|
41 | - if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) { |
|
42 | - $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) ); |
|
43 | - wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' ); |
|
44 | - } |
|
45 | - |
|
46 | - } |
|
47 | - |
|
48 | - /** |
|
49 | - * Clears deprecated events. |
|
50 | - * |
|
51 | - */ |
|
52 | - public function maybe_clear_deprecated_events() { |
|
53 | - |
|
54 | - if ( ! get_option( 'wpinv_cleared_old_events' ) ) { |
|
55 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' ); |
|
56 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' ); |
|
57 | - update_option( 'wpinv_cleared_old_events', 1 ); |
|
58 | - } |
|
59 | - |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Fires the old hook for backwards compatibility. |
|
64 | - * |
|
65 | - */ |
|
66 | - public function backwards_compat() { |
|
67 | - do_action( 'wpinv_register_schedule_event_daily' ); |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Checks for subscriptions that are scheduled to renew. |
|
72 | - * |
|
73 | - */ |
|
74 | - public function check_renewing_subscriptions() { |
|
75 | - |
|
76 | - // Fetch subscriptions that expire today. |
|
77 | - $args = array( |
|
78 | - 'number' => -1, |
|
79 | - 'count_total' => false, |
|
80 | - 'status' => 'trialling active', |
|
81 | - 'date_expires_query' => array( |
|
82 | - array( |
|
83 | - 'year' => gmdate( 'Y' ), |
|
84 | - 'month' => gmdate( 'n' ), |
|
85 | - 'day' => gmdate( 'j' ), |
|
86 | - 'compare' => '=', |
|
87 | - ), |
|
88 | - ), |
|
89 | - ); |
|
90 | - |
|
91 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
92 | - |
|
93 | - foreach ( $subscriptions->get_results() as $subscription ) { |
|
94 | - |
|
95 | - /** @var WPInv_Subscription $subscription */ |
|
96 | - if ( $subscription->is_last_renewal() ) { |
|
97 | - $subscription->complete(); |
|
98 | - } else { |
|
99 | - do_action( 'getpaid_should_renew_subscription', $subscription ); |
|
100 | - } |
|
101 | - } |
|
102 | - |
|
103 | - } |
|
104 | - |
|
105 | - /** |
|
106 | - * Expires expired subscriptions. |
|
107 | - * |
|
108 | - */ |
|
109 | - public function maybe_expire_subscriptions() { |
|
110 | - |
|
111 | - // Fetch expired subscriptions (skips those that expire today). |
|
112 | - $args = array( |
|
113 | - 'number' => -1, |
|
114 | - 'count_total' => false, |
|
115 | - 'status' => 'trialling active failing cancelled', |
|
116 | - 'date_expires_query' => array( |
|
117 | - 'before' => 'yesterday', |
|
118 | - 'inclusive' => false, |
|
119 | - ), |
|
120 | - ); |
|
121 | - |
|
122 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
123 | - |
|
124 | - foreach ( $subscriptions->get_results() as $subscription ) { |
|
125 | - if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', false, $subscription ) ) { |
|
126 | - $subscription->set_status( 'expired' ); |
|
127 | - $subscription->save(); |
|
128 | - } |
|
129 | - } |
|
130 | - |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * Logs cron runs. |
|
135 | - * |
|
136 | - */ |
|
137 | - public function log_cron_run() { |
|
138 | - wpinv_error_log( 'GetPaid Daily Cron', false ); |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * Updates GeoIP databases. |
|
143 | - * |
|
144 | - */ |
|
145 | - public function maybe_update_geoip_databases() { |
|
146 | - $updated = get_transient( 'getpaid_updated_geoip_databases' ); |
|
147 | - |
|
148 | - if ( false === $updated ) { |
|
149 | - set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS ); |
|
150 | - do_action( 'getpaid_update_geoip_databases' ); |
|
151 | - } |
|
152 | - |
|
153 | - } |
|
15 | + /** |
|
16 | + * Class constructor. |
|
17 | + */ |
|
18 | + public function __construct() { |
|
19 | + |
|
20 | + // Clear deprecated events. |
|
21 | + add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) ); |
|
22 | + |
|
23 | + // (Maybe) schedule a cron that runs daily. |
|
24 | + add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) ); |
|
25 | + |
|
26 | + // Fired everyday at 7 a.m (this might vary for sites with few visitors) |
|
27 | + add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) ); |
|
28 | + add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) ); |
|
29 | + add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) ); |
|
30 | + add_action( 'getpaid_daily_maintenance', array( $this, 'check_renewing_subscriptions' ) ); |
|
31 | + add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) ); |
|
32 | + |
|
33 | + } |
|
34 | + |
|
35 | + /** |
|
36 | + * Schedules a cron to run every day at 7 a.m |
|
37 | + * |
|
38 | + */ |
|
39 | + public function maybe_create_scheduled_event() { |
|
40 | + |
|
41 | + if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) { |
|
42 | + $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) ); |
|
43 | + wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' ); |
|
44 | + } |
|
45 | + |
|
46 | + } |
|
47 | + |
|
48 | + /** |
|
49 | + * Clears deprecated events. |
|
50 | + * |
|
51 | + */ |
|
52 | + public function maybe_clear_deprecated_events() { |
|
53 | + |
|
54 | + if ( ! get_option( 'wpinv_cleared_old_events' ) ) { |
|
55 | + wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' ); |
|
56 | + wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' ); |
|
57 | + update_option( 'wpinv_cleared_old_events', 1 ); |
|
58 | + } |
|
59 | + |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Fires the old hook for backwards compatibility. |
|
64 | + * |
|
65 | + */ |
|
66 | + public function backwards_compat() { |
|
67 | + do_action( 'wpinv_register_schedule_event_daily' ); |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Checks for subscriptions that are scheduled to renew. |
|
72 | + * |
|
73 | + */ |
|
74 | + public function check_renewing_subscriptions() { |
|
75 | + |
|
76 | + // Fetch subscriptions that expire today. |
|
77 | + $args = array( |
|
78 | + 'number' => -1, |
|
79 | + 'count_total' => false, |
|
80 | + 'status' => 'trialling active', |
|
81 | + 'date_expires_query' => array( |
|
82 | + array( |
|
83 | + 'year' => gmdate( 'Y' ), |
|
84 | + 'month' => gmdate( 'n' ), |
|
85 | + 'day' => gmdate( 'j' ), |
|
86 | + 'compare' => '=', |
|
87 | + ), |
|
88 | + ), |
|
89 | + ); |
|
90 | + |
|
91 | + $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
92 | + |
|
93 | + foreach ( $subscriptions->get_results() as $subscription ) { |
|
94 | + |
|
95 | + /** @var WPInv_Subscription $subscription */ |
|
96 | + if ( $subscription->is_last_renewal() ) { |
|
97 | + $subscription->complete(); |
|
98 | + } else { |
|
99 | + do_action( 'getpaid_should_renew_subscription', $subscription ); |
|
100 | + } |
|
101 | + } |
|
102 | + |
|
103 | + } |
|
104 | + |
|
105 | + /** |
|
106 | + * Expires expired subscriptions. |
|
107 | + * |
|
108 | + */ |
|
109 | + public function maybe_expire_subscriptions() { |
|
110 | + |
|
111 | + // Fetch expired subscriptions (skips those that expire today). |
|
112 | + $args = array( |
|
113 | + 'number' => -1, |
|
114 | + 'count_total' => false, |
|
115 | + 'status' => 'trialling active failing cancelled', |
|
116 | + 'date_expires_query' => array( |
|
117 | + 'before' => 'yesterday', |
|
118 | + 'inclusive' => false, |
|
119 | + ), |
|
120 | + ); |
|
121 | + |
|
122 | + $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
123 | + |
|
124 | + foreach ( $subscriptions->get_results() as $subscription ) { |
|
125 | + if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', false, $subscription ) ) { |
|
126 | + $subscription->set_status( 'expired' ); |
|
127 | + $subscription->save(); |
|
128 | + } |
|
129 | + } |
|
130 | + |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * Logs cron runs. |
|
135 | + * |
|
136 | + */ |
|
137 | + public function log_cron_run() { |
|
138 | + wpinv_error_log( 'GetPaid Daily Cron', false ); |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * Updates GeoIP databases. |
|
143 | + * |
|
144 | + */ |
|
145 | + public function maybe_update_geoip_databases() { |
|
146 | + $updated = get_transient( 'getpaid_updated_geoip_databases' ); |
|
147 | + |
|
148 | + if ( false === $updated ) { |
|
149 | + set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS ); |
|
150 | + do_action( 'getpaid_update_geoip_databases' ); |
|
151 | + } |
|
152 | + |
|
153 | + } |
|
154 | 154 | |
155 | 155 | } |
@@ -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 | * Daily maintenance class. |
@@ -18,17 +18,17 @@ discard block |
||
18 | 18 | public function __construct() { |
19 | 19 | |
20 | 20 | // Clear deprecated events. |
21 | - add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) ); |
|
21 | + add_action('wp', array($this, 'maybe_clear_deprecated_events')); |
|
22 | 22 | |
23 | 23 | // (Maybe) schedule a cron that runs daily. |
24 | - add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) ); |
|
24 | + add_action('wp', array($this, 'maybe_create_scheduled_event')); |
|
25 | 25 | |
26 | 26 | // Fired everyday at 7 a.m (this might vary for sites with few visitors) |
27 | - add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) ); |
|
28 | - add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) ); |
|
29 | - add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) ); |
|
30 | - add_action( 'getpaid_daily_maintenance', array( $this, 'check_renewing_subscriptions' ) ); |
|
31 | - add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) ); |
|
27 | + add_action('getpaid_daily_maintenance', array($this, 'log_cron_run')); |
|
28 | + add_action('getpaid_daily_maintenance', array($this, 'backwards_compat')); |
|
29 | + add_action('getpaid_daily_maintenance', array($this, 'maybe_expire_subscriptions')); |
|
30 | + add_action('getpaid_daily_maintenance', array($this, 'check_renewing_subscriptions')); |
|
31 | + add_action('getpaid_daily_maintenance', array($this, 'maybe_update_geoip_databases')); |
|
32 | 32 | |
33 | 33 | } |
34 | 34 | |
@@ -38,9 +38,9 @@ discard block |
||
38 | 38 | */ |
39 | 39 | public function maybe_create_scheduled_event() { |
40 | 40 | |
41 | - if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) { |
|
42 | - $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) ); |
|
43 | - wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' ); |
|
41 | + if (!wp_next_scheduled('getpaid_daily_maintenance')) { |
|
42 | + $timestamp = strtotime('tomorrow 07:00:00', current_time('timestamp')); |
|
43 | + wp_schedule_event($timestamp, 'daily', 'getpaid_daily_maintenance'); |
|
44 | 44 | } |
45 | 45 | |
46 | 46 | } |
@@ -51,10 +51,10 @@ discard block |
||
51 | 51 | */ |
52 | 52 | public function maybe_clear_deprecated_events() { |
53 | 53 | |
54 | - if ( ! get_option( 'wpinv_cleared_old_events' ) ) { |
|
55 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' ); |
|
56 | - wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' ); |
|
57 | - update_option( 'wpinv_cleared_old_events', 1 ); |
|
54 | + if (!get_option('wpinv_cleared_old_events')) { |
|
55 | + wp_clear_scheduled_hook('wpinv_register_schedule_event_twicedaily'); |
|
56 | + wp_clear_scheduled_hook('wpinv_register_schedule_event_daily'); |
|
57 | + update_option('wpinv_cleared_old_events', 1); |
|
58 | 58 | } |
59 | 59 | |
60 | 60 | } |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | * |
65 | 65 | */ |
66 | 66 | public function backwards_compat() { |
67 | - do_action( 'wpinv_register_schedule_event_daily' ); |
|
67 | + do_action('wpinv_register_schedule_event_daily'); |
|
68 | 68 | } |
69 | 69 | |
70 | 70 | /** |
@@ -74,29 +74,29 @@ discard block |
||
74 | 74 | public function check_renewing_subscriptions() { |
75 | 75 | |
76 | 76 | // Fetch subscriptions that expire today. |
77 | - $args = array( |
|
77 | + $args = array( |
|
78 | 78 | 'number' => -1, |
79 | 79 | 'count_total' => false, |
80 | 80 | 'status' => 'trialling active', |
81 | 81 | 'date_expires_query' => array( |
82 | 82 | array( |
83 | - 'year' => gmdate( 'Y' ), |
|
84 | - 'month' => gmdate( 'n' ), |
|
85 | - 'day' => gmdate( 'j' ), |
|
83 | + 'year' => gmdate('Y'), |
|
84 | + 'month' => gmdate('n'), |
|
85 | + 'day' => gmdate('j'), |
|
86 | 86 | 'compare' => '=', |
87 | 87 | ), |
88 | 88 | ), |
89 | 89 | ); |
90 | 90 | |
91 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
91 | + $subscriptions = new GetPaid_Subscriptions_Query($args); |
|
92 | 92 | |
93 | - foreach ( $subscriptions->get_results() as $subscription ) { |
|
93 | + foreach ($subscriptions->get_results() as $subscription) { |
|
94 | 94 | |
95 | 95 | /** @var WPInv_Subscription $subscription */ |
96 | - if ( $subscription->is_last_renewal() ) { |
|
96 | + if ($subscription->is_last_renewal()) { |
|
97 | 97 | $subscription->complete(); |
98 | 98 | } else { |
99 | - do_action( 'getpaid_should_renew_subscription', $subscription ); |
|
99 | + do_action('getpaid_should_renew_subscription', $subscription); |
|
100 | 100 | } |
101 | 101 | } |
102 | 102 | |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | public function maybe_expire_subscriptions() { |
110 | 110 | |
111 | 111 | // Fetch expired subscriptions (skips those that expire today). |
112 | - $args = array( |
|
112 | + $args = array( |
|
113 | 113 | 'number' => -1, |
114 | 114 | 'count_total' => false, |
115 | 115 | 'status' => 'trialling active failing cancelled', |
@@ -119,11 +119,11 @@ discard block |
||
119 | 119 | ), |
120 | 120 | ); |
121 | 121 | |
122 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
122 | + $subscriptions = new GetPaid_Subscriptions_Query($args); |
|
123 | 123 | |
124 | - foreach ( $subscriptions->get_results() as $subscription ) { |
|
125 | - if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', false, $subscription ) ) { |
|
126 | - $subscription->set_status( 'expired' ); |
|
124 | + foreach ($subscriptions->get_results() as $subscription) { |
|
125 | + if (apply_filters('getpaid_daily_maintenance_should_expire_subscription', false, $subscription)) { |
|
126 | + $subscription->set_status('expired'); |
|
127 | 127 | $subscription->save(); |
128 | 128 | } |
129 | 129 | } |
@@ -135,7 +135,7 @@ discard block |
||
135 | 135 | * |
136 | 136 | */ |
137 | 137 | public function log_cron_run() { |
138 | - wpinv_error_log( 'GetPaid Daily Cron', false ); |
|
138 | + wpinv_error_log('GetPaid Daily Cron', false); |
|
139 | 139 | } |
140 | 140 | |
141 | 141 | /** |
@@ -143,11 +143,11 @@ discard block |
||
143 | 143 | * |
144 | 144 | */ |
145 | 145 | public function maybe_update_geoip_databases() { |
146 | - $updated = get_transient( 'getpaid_updated_geoip_databases' ); |
|
146 | + $updated = get_transient('getpaid_updated_geoip_databases'); |
|
147 | 147 | |
148 | - if ( false === $updated ) { |
|
149 | - set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS ); |
|
150 | - do_action( 'getpaid_update_geoip_databases' ); |
|
148 | + if (false === $updated) { |
|
149 | + set_transient('getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS); |
|
150 | + do_action('getpaid_update_geoip_databases'); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | } |