Passed
Push — master ( 853cd9...e82094 )
by Brian
11:45
created

getpaid_get_invoice_tax_rate()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 4
c 1
b 0
f 0
nc 1
nop 2
dl 0
loc 7
rs 10
1
<?php
2
/**
3
 * Contains invoice functions.
4
 *
5
 * @since 1.0.0
6
 * @package Invoicing
7
 */
8
 
9
defined( 'ABSPATH' ) || exit;
10
11
/**
12
 * Retrieves the current invoice.
13
 */
14
function getpaid_get_current_invoice_id() {
15
16
    // Ensure that we have an invoice key.
17
    if ( empty( $_GET['invoice_key'] ) ) {
18
        return 0;
19
    }
20
21
    // Retrieve an invoice using the key.
22
    $invoice = new WPInv_Invoice( $_GET['invoice_key'] );
23
24
    // Compare the invoice key and the parsed key.
25
    if ( $invoice->get_id() != 0 && $invoice->get_key() == $_GET['invoice_key'] ) {
26
        return $invoice->get_id();
27
    }
28
29
    return 0;
30
}
31
32
/**
33
 * Checks if the current user cna view an invoice.
34
 */
35
function wpinv_user_can_view_invoice( $invoice ) {
36
    $invoice = new WPInv_Invoice( $invoice );
37
38
    // Abort if the invoice does not exist.
39
    if ( 0 == $invoice->get_id() ) {
40
        return false;
41
    }
42
43
    // Don't allow trash, draft status
44
    if ( $invoice->is_draft() ) {
45
        return false;
46
    }
47
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'] ) && trim( $_GET['invoice_key'] ) == $invoice->get_key() ) {
50
        return true;
51
    }
52
53
    // Always enable for admins..
54
    if ( wpinv_current_user_can_manage_invoicing() || current_user_can( 'view_invoices', $invoice->get_id() ) ) { // Admin user
55
        return true;
56
    }
57
58
    // Else, ensure that this is their invoice.
59
    if ( is_user_logged_in() && $invoice->get_user_id() == get_current_user_id() ) {
60
        return true;
61
    }
62
63
    return apply_filters( 'wpinv_current_user_can_view_invoice', false, $invoice );
64
}
65
66
/**
67
 * Checks if the current user cna view an invoice receipt.
68
 */
69
function wpinv_can_view_receipt( $invoice ) {
70
	return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice );
71
}
72
73
/**
74
 * Returns an array of all invoice post types.
75
 * 
76
 * @return array
77
 */
78
function getpaid_get_invoice_post_types() {
79
    $post_types = array(
80
        'wpi_quote'   => __( 'Quote', 'invoicing' ),
81
        'wpi_invoice' => __( 'Invoice', 'invoicing' ),
82
    );
83
84
    // Ensure the quotes addon is installed.
85
    if ( ! defined( 'WPINV_QUOTES_VERSION' ) ) {
86
        unset( $post_types['wpi_quote'] );
87
    }
88
89
    return apply_filters( 'getpaid_invoice_post_types', $post_types );
90
}
91
92
/**
93
 * Checks if this is an invocing post type.
94
 * 
95
 * 
96
 * @param string $post_type The post type to check for.
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() );
100
}
101
102
/**
103
 * Creates a new invoice.
104
 * 
105
 * @param  array $data   An array of invoice properties.
106
 * @param  bool  $wp_error       Whether to return false or WP_Error on failure.
107
 * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success.
108
 */
109
function wpinv_create_invoice( $data = array(), $deprecated = null, $wp_error = false ) {
0 ignored issues
show
Unused Code introduced by
The parameter $deprecated is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

109
function wpinv_create_invoice( $data = array(), /** @scrutinizer ignore-unused */ $deprecated = null, $wp_error = false ) {

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
110
    $data[ 'invoice_id' ] = 0;
111
    return wpinv_insert_invoice( $data, $wp_error );
112
}
113
114
/**
115
 * Updates an existing invoice.
116
 * 
117
 * @param  array $data   An array of invoice properties.
118
 * @param  bool  $wp_error       Whether to return false or WP_Error on failure.
119
 * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success.
120
 */
121
function wpinv_update_invoice( $data = array(), $wp_error = false ) {
122
123
    // Backwards compatibility.
124
    if ( ! empty( $data['ID'] ) ) {
125
        $data['invoice_id'] = $data['ID'];
126
    }
127
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;
131
    }
132
133
    // Retrieve the invoice.
134
    $invoice = wpinv_get_invoice( $data['invoice_id'] );
135
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;
139
    }
140
141
    // Do not update totals for paid / refunded invoices.
142
    if ( $invoice->is_paid() || $invoice->is_refunded() ) {
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;
146
        }
147
148
    }
149
150
    return wpinv_insert_invoice( $data, $wp_error );
151
152
}
153
154
/**
155
 * Create/Update an invoice
156
 * 
157
 * @param  array $data   An array of invoice properties.
158
 * @param  bool  $wp_error       Whether to return false or WP_Error on failure.
159
 * @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success.
160
 */
161
function wpinv_insert_invoice( $data = array(), $wp_error = false ) {
162
163
    // Ensure that we have invoice data.
164
    if ( empty( $data ) ) {
165
        return false;
0 ignored issues
show
Bug Best Practice introduced by
The expression return false returns the type false which is incompatible with the documented return type WPInv_Invoice|WP_Error|integer.
Loading history...
166
    }
167
168
    // The invoice id will be provided when updating an invoice.
169
    $data['invoice_id'] = ! empty( $data['invoice_id'] ) ? (int) $data['invoice_id'] : false;
170
171
    // Retrieve the invoice.
172
    $invoice = new WPInv_Invoice( $data['invoice_id'] );
173
174
    // Do we have an error?
175
    if ( ! empty( $invoice->last_error ) ) {
176
        return $wp_error ? new WP_Error( 'invalid_invoice_id', $invoice->last_error ) : 0;
177
    }
178
179
    // Backwards compatibility (billing address).
180
    if ( ! empty( $data['user_info'] ) ) {
181
182
        foreach ( $data['user_info'] as $key => $value ) {
183
184
            if ( $key == 'discounts' ) {
185
                $value = (array) $value;
186
                $data[ 'discount_code' ] = empty( $value ) ? null : $value[0];
187
            } else {
188
                $data[ $key ] = $value;
189
            }
190
191
        }
192
193
    }
194
195
    // Backwards compatibility.
196
    if ( ! empty( $data['payment_details'] ) ) {
197
198
        foreach ( $data['payment_details'] as $key => $value ) {
199
            $data[ $key ] = $value;
200
        }
201
202
    }
203
204
    // Set up the owner of the invoice.
205
    $user_id = ! empty( $data['user_id'] ) ? wpinv_clean( $data['user_id'] ) : get_current_user_id();
206
207
    // Make sure the user exists.
208
    if ( ! get_userdata( $user_id ) ) {
209
        return $wp_error ? new WP_Error( 'wpinv_invalid_user', __( 'There is no user with that ID.', 'invoicing' ) ) : 0;
210
    }
211
212
    $address = wpinv_get_user_address( $user_id );
213
214
    foreach ( $address as $key => $value ) {
215
216
        if ( $value == '' ) {
217
            $address[ $key ] = null;
218
        } else {
219
            $address[ $key ] = wpinv_clean( $value );
220
        }
221
222
    }
223
224
    // Load new data.
225
    $invoice->set_props(
226
227
        array(
228
229
            // Basic info.
230
            'template'             => isset( $data['template'] ) ? wpinv_clean( $data['template'] ) : null,
231
            'email_cc'             => isset( $data['email_cc'] ) ? wpinv_clean( $data['email_cc'] ) : null,
232
            'date_created'         => isset( $data['created_date'] ) ? wpinv_clean( $data['created_date'] ) : null,
233
            'due_date'             => isset( $data['due_date'] ) ? wpinv_clean( $data['due_date'] ) : null,
234
            'date_completed'       => isset( $data['date_completed'] ) ? wpinv_clean( $data['date_completed'] ) : null,
235
            'number'               => isset( $data['number'] ) ? wpinv_clean( $data['number'] ) : null,
236
            'key'                  => isset( $data['key'] ) ? wpinv_clean( $data['key'] ) : null,
237
            'status'               => isset( $data['status'] ) ? wpinv_clean( $data['status'] ) : null,
238
            'post_type'            => isset( $data['post_type'] ) ? wpinv_clean( $data['post_type'] ) : null,
239
            'user_ip'              => isset( $data['ip'] ) ? wpinv_clean( $data['ip'] ) : wpinv_get_ip(),
240
            'parent_id'            => isset( $data['parent'] ) ? intval( $data['parent'] ) : null,
241
            'mode'                 => isset( $data['mode'] ) ? wpinv_clean( $data['mode'] ) : null,
242
            'description'          => isset( $data['description'] ) ? wp_kses_post( $data['description'] ) : null,
243
244
            // Payment info.
245
            'disable_taxes'        => ! empty( $data['disable_taxes'] ),
246
            'currency'             => isset( $data['currency'] ) ? wpinv_clean( $data['currency'] ) : wpinv_get_currency(),
247
            'gateway'              => isset( $data['gateway'] ) ? wpinv_clean( $data['gateway'] ) : null,
248
            'transaction_id'       => isset( $data['transaction_id'] ) ? wpinv_clean( $data['transaction_id'] ) : null,
249
            'discount_code'        => isset( $data['discount_code'] ) ? wpinv_clean( $data['discount_code'] ) : null,
250
            'payment_form'         => isset( $data['payment_form'] ) ? intval( $data['payment_form'] ) : null,
251
            'submission_id'        => isset( $data['submission_id'] ) ? wpinv_clean( $data['submission_id'] ) : null,
252
            'subscription_id'      => isset( $data['subscription_id'] ) ? wpinv_clean( $data['subscription_id'] ) : null,
253
            'is_viewed'            => isset( $data['is_viewed'] ) ? wpinv_clean( $data['is_viewed'] ) : null,
254
            'fees'                 => isset( $data['fees'] ) ? wpinv_clean( $data['fees'] ) : null,
255
            'discounts'            => isset( $data['discounts'] ) ? wpinv_clean( $data['discounts'] ) : null,
256
            'taxes'                => isset( $data['taxes'] ) ? wpinv_clean( $data['taxes'] ) : null,
257
            
258
259
            // Billing details.
260
            'user_id'              => $data['user_id'],
261
            'first_name'           => isset( $data['first_name'] ) ? wpinv_clean( $data['first_name'] ) : $address['first_name'],
262
            'last_name'            => isset( $data['last_name'] ) ? wpinv_clean( $data['last_name'] ) : $address['last_name'],
263
            'address'              => isset( $data['address'] ) ? wpinv_clean( $data['address'] ) : $address['address'] ,
264
            'vat_number'           => isset( $data['vat_number'] ) ? wpinv_clean( $data['vat_number'] ) : $address['vat_number'],
265
            'company'              => isset( $data['company'] ) ? wpinv_clean( $data['company'] ) : $address['company'],
266
            'zip'                  => isset( $data['zip'] ) ? wpinv_clean( $data['zip'] ) : $address['zip'],
267
            'state'                => isset( $data['state'] ) ? wpinv_clean( $data['state'] ) : $address['state'],
268
            'city'                 => isset( $data['city'] ) ? wpinv_clean( $data['city'] ) : $address['city'],
269
            'country'              => isset( $data['country'] ) ? wpinv_clean( $data['country'] ) : $address['country'],
270
            'phone'                => isset( $data['phone'] ) ? wpinv_clean( $data['phone'] ) : $address['phone'],
271
            'address_confirmed'    => ! empty( $data['address_confirmed'] ),
272
273
        )
274
275
    );
276
277
    // Backwards compatibililty.
278
    if ( ! empty( $data['cart_details'] ) && is_array( $data['cart_details'] ) ) {
279
        $data['items'] = array();
280
281
        foreach( $data['cart_details'] as $_item ) {
282
283
            // Ensure that we have an item id.
284
            if ( empty(  $_item['id']  ) ) {
285
                continue;
286
            }
287
288
            // Retrieve the item.
289
            $item = new GetPaid_Form_Item(  $_item['id']  );
290
291
            // Ensure that it is purchasable.
292
            if ( ! $item->can_purchase() ) {
293
                continue;
294
            }
295
296
            // Set quantity.
297
            if ( ! empty( $_item['quantity'] ) && is_numeric( $_item['quantity'] ) ) {
298
                $item->set_quantity( $_item['quantity'] );
299
            }
300
301
            // Set price.
302
            if ( isset( $_item['item_price'] ) ) {
303
                $item->set_price( $_item['item_price'] );
304
            }
305
306
            if ( isset( $_item['custom_price'] ) ) {
307
                $item->set_price( $_item['custom_price'] );
308
            }
309
310
            // Set name.
311
            if ( ! empty( $_item['name'] ) ) {
312
                $item->set_name( $_item['name'] );
313
            }
314
315
            // Set description.
316
            if ( isset( $_item['description'] ) ) {
317
                $item->set_custom_description( $_item['description'] );
318
            }
319
320
            // Set meta.
321
            if ( isset( $_item['meta'] ) && is_array( $_item['meta'] ) ) {
322
323
                $item->set_item_meta( $_item['meta'] );
324
325
                if ( isset( $_item['meta']['description'] ) ) {
326
                    $item->set_custom_description( $_item['meta']['description'] );
327
                }
328
329
            }
330
331
            $data['items'][] = $item;
332
333
        }
334
    }
335
336
    // Add invoice items.
337
    if ( ! empty( $data['items'] ) && is_array( $data['items'] ) ) {
338
339
        $invoice->set_items( array() );
340
341
        foreach ( $data['items'] as $item ) {
342
343
            if ( is_object( $item ) && is_a( $item, 'GetPaid_Form_Item' ) && $item->can_purchase() ) {
344
                $invoice->add_item( $item );
345
            }
346
347
        }
348
349
    }
350
351
    // Save the invoice.
352
    $invoice->recalculate_total();
353
    $invoice->save();
354
355
    if ( ! $invoice->get_id() ) {
356
        return $wp_error ? new WP_Error( 'wpinv_insert_invoice_error', __( 'An error occured when saving your invoice.', 'invoicing' ) ) : 0;
357
    }
358
359
    // Add private note.
360
    if ( ! empty( $data['private_note'] ) ) {
361
        $invoice->add_note( $data['private_note'] );
362
    }
363
364
    // User notes.
365
    if ( !empty( $data['user_note'] ) ) {
366
        $invoice->add_note( $data['user_note'], true );
367
    }
368
369
    // Created via.
370
    if ( isset( $data['created_via'] ) ) {
371
        update_post_meta( $invoice->get_id(), 'wpinv_created_via', $data['created_via'] );
372
    }
373
374
    // Backwards compatiblity.
375
    if ( $invoice->is_quote() ) {
376
377
        if ( isset( $data['valid_until'] ) ) {
378
            update_post_meta( $invoice->get_id(), 'wpinv_quote_valid_until', $data['valid_until'] );
379
        }
380
381
    }
382
383
    return $invoice;
384
}
385
386
/**
387
 * Retrieves an invoice.
388
 * 
389
 * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object.
390
 * @param $bool $deprecated
0 ignored issues
show
Documentation Bug introduced by
The doc comment $bool at position 0 could not be parsed: Unknown type name '$bool' at position 0 in $bool.
Loading history...
391
 * @return WPInv_Invoice|null
392
 */
393
function wpinv_get_invoice( $invoice = 0, $deprecated = false ) {
394
395
    // If we are retrieving the invoice from the cart...
396
    if ( $deprecated && empty( $invoice ) ) {
397
        $invoice = (int) getpaid_get_current_invoice_id();
398
    }
399
400
    // Retrieve the invoice.
401
    $invoice = new WPInv_Invoice( $invoice );
402
403
    // Check if it exists.
404
    if ( $invoice->get_id() != 0 ) {
405
        return $invoice;
406
    }
407
408
    return null;
409
}
410
411
/**
412
 * Retrieves several invoices.
413
 * 
414
 * @param array $args Args to search for.
415
 * @return WPInv_Invoice[]|int[]|object
416
 */
417
function wpinv_get_invoices( $args ) {
418
419
    // Prepare args.
420
    $args = wp_parse_args(
421
        $args,
422
        array(
423
            'status'   => array_keys( wpinv_get_invoice_statuses() ),
424
            'type'     => 'wpi_invoice',
425
            'limit'    => get_option( 'posts_per_page' ),
426
            'return'   => 'objects',
427
        )
428
    );
429
430
    // Map params to wp_query params.
431
    $map_legacy = array(
432
        'numberposts'    => 'limit',
433
        'post_type'      => 'type',
434
        'post_status'    => 'status',
435
        'post_parent'    => 'parent',
436
        'author'         => 'user',
437
        'posts_per_page' => 'limit',
438
        'paged'          => 'page',
439
        'post__not_in'   => 'exclude',
440
        'post__in'       => 'include',
441
    );
442
443
    foreach ( $map_legacy as $to => $from ) {
444
        if ( isset( $args[ $from ] ) ) {
445
            $args[ $to ] = $args[ $from ];
446
            unset( $args[ $from ] );
447
        }
448
    }
449
450
    // Backwards compatibility.
451
    if ( ! empty( $args['email'] ) && empty( $args['user'] ) ) {
452
        $args['user'] = $args['email'];
453
        unset( $args['email'] );
454
    }
455
456
    // Handle cases where the user is set as an email.
457
    if ( ! empty( $args['author'] ) && is_email( $args['author'] ) ) {
458
        $user = get_user_by( 'email', $args['user'] );
459
460
        if ( $user ) {
461
            $args['author'] = $user->user_email;
462
        }
463
464
    }
465
466
    // We only want invoice ids.
467
    $args['fields'] = 'ids';
468
469
    // Show all posts.
470
    $paginate = true;
471
    if ( isset( $args['paginate'] ) ) {
472
473
        $paginate = $args['paginate'];
474
        $args['no_found_rows'] = empty( $args['paginate'] );
475
        unset( $args['paginate'] );
476
477
    }
478
479
    // Whether to return objects or fields.
480
    $return = $args['return'];
481
    unset( $args['return'] );
482
483
    // Get invoices.
484
    $invoices = new WP_Query( apply_filters( 'wpinv_get_invoices_args', $args ) );
485
486
    // Prepare the results.
487
    if ( 'objects' === $return ) {
488
        $results = array_map( 'wpinv_get_invoice', $invoices->posts );
489
    } elseif ( 'self' === $return ) {
490
        return $invoices;
491
    } else {
492
        $results = $invoices->posts;
493
    }
494
495
    if ( $paginate ) {
496
        return (object) array(
497
            'invoices'      => $results,
498
            'total'         => $invoices->found_posts,
499
            'max_num_pages' => $invoices->max_num_pages,
500
        );
501
    }
502
503
    return $results;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $results returns an array which contains values of type WP_Post which are incompatible with the documented value type WPInv_Invoice|integer.
Loading history...
504
505
}
506
507
/**
508
 * Retrieves an invoice's id from a transaction id.
509
 * 
510
 * @param string $transaction_id The transaction id to check.
511
 * @return int Invoice id on success or 0 on failure
512
 */
513
function wpinv_get_id_by_transaction_id( $transaction_id ) {
514
    return WPInv_Invoice::get_invoice_id_by_field( $transaction_id, 'transaction_id' );
515
}
516
517
/**
518
 * Retrieves an invoice's id from the invoice number.
519
 * 
520
 * @param string $invoice_number The invoice number to check.
521
 * @return int Invoice id on success or 0 on failure
522
 */
523
function wpinv_get_id_by_invoice_number( $invoice_number ) {
524
    return WPInv_Invoice::get_invoice_id_by_field( $invoice_number, 'number' );
525
}
526
527
/**
528
 * Retrieves an invoice's id from the invoice key.
529
 * 
530
 * @param string $invoice_key The invoice key to check.
531
 * @return int Invoice id on success or 0 on failure
532
 */
533
function wpinv_get_invoice_id_by_key( $invoice_key ) {
534
    return WPInv_Invoice::get_invoice_id_by_field( $invoice_key, 'key' );
535
}
536
537
/**
538
 * Retrieves an invoice's notes.
539
 * 
540
 * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object.
541
 * @param string $type Optionally filter by type i.e customer|system
542
 * @return array|null
543
 */
544
function wpinv_get_invoice_notes( $invoice = 0, $type = '' ) {
545
546
    // Prepare the invoice.
547
    $invoice = wpinv_get_invoice( $invoice );
548
    if ( empty( $invoice ) ) {
549
        return NULL;
550
    }
551
552
    // Fetch notes.
553
    $notes = getpaid_notes()->get_invoice_notes( $invoice->get_id(), $type );
554
555
    // Filter the notes.
556
    return apply_filters( 'wpinv_invoice_notes', $notes, $invoice->get_id(), $type );
557
}
558
559
/**
560
 * Returns an array of columns to display on the invoices page.
561
 * 
562
 * @param string $post_type
563
 */
564
function wpinv_get_user_invoices_columns( $post_type = 'wpi_invoice' ) {
565
566
    $label   = getpaid_get_post_type_label( $post_type, false );
567
    $label   = empty( $label ) ? __( 'Invoice', 'invoicing' ) : sanitize_text_field( $label );
568
    $columns = array(
569
570
            'invoice-number'  => array(
571
                'title' => $label,
572
                'class' => 'text-left'
573
            ),
574
575
            'created-date'    => array(
576
                'title' => __( 'Created Date', 'invoicing' ),
577
                'class' => 'text-left'
578
            ),
579
580
            'payment-date'    => array(
581
                'title' => __( 'Payment Date', 'invoicing' ),
582
                'class' => 'text-left'
583
            ),
584
585
            'invoice-status'  => array(
586
                'title' => __( 'Status', 'invoicing' ),
587
                'class' => 'text-center'
588
            ),
589
590
            'invoice-total'   => array(
591
                'title' => __( 'Total', 'invoicing' ),
592
                'class' => 'text-right'
593
            ),
594
595
            'invoice-actions' => array(
596
                'title' => '&nbsp;',
597
                'class' => 'text-center'
598
            ),
599
600
        );
601
602
    return apply_filters( 'wpinv_user_invoices_columns', $columns, $post_type );
603
}
604
605
/**
606
 * Displays the invoice receipt.
607
 */
608
function wpinv_payment_receipt() {
609
610
    // Find the invoice.
611
    $invoice_id = getpaid_get_current_invoice_id();
612
    $invoice = new WPInv_Invoice( $invoice_id );
613
614
    // Abort if non was found.
615
    if ( empty( $invoice_id ) || $invoice->is_draft() ) {
616
617
        return aui()->alert(
618
            array(
619
                'type'    => 'warning',
620
                'content' => __( 'We could not find your invoice', 'invoicing' ),
621
            )
622
        );
623
624
    }
625
626
    // Can the user view this invoice?
627
    if ( ! wpinv_can_view_receipt( $invoice_id ) ) {
628
629
        return aui()->alert(
630
            array(
631
                'type'    => 'warning',
632
                'content' => __( 'You are not allowed to view this receipt', 'invoicing' ),
633
            )
634
        );
635
636
    }
637
638
    // Load the template.
639
    return wpinv_get_template_html( 'invoice-receipt.php', compact( 'invoice' ) );
640
641
}
642
643
/**
644
 * Displays the invoice history.
645
 */
646
function getpaid_invoice_history( $user_id = 0, $post_type = 'wpi_invoice' ) {
647
648
    // Ensure that we have a user id.
649
    if ( empty( $user_id ) || ! is_numeric( $user_id ) ) {
650
        $user_id = get_current_user_id();
651
    }
652
653
    $label = getpaid_get_post_type_label( $post_type );
654
    $label = empty( $label ) ? __( 'Invoices', 'invoicing' ) : sanitize_text_field( $label );
655
656
    // View user id.
657
    if ( empty( $user_id ) ) {
658
659
        return aui()->alert(
660
            array(
661
                'type'    => 'warning',
662
                'content' => sprintf(
663
                    __( 'You must be logged in to view your %s.', 'invoicing' ),
664
                    strtolower( $label )
665
                )
666
            )
667
        );
668
669
    }
670
671
    // Fetch invoices.
672
    $invoices = wpinv_get_invoices(
673
674
        array(
675
            'page'      => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
676
            'user'      => $user_id,
677
            'paginate'  => true,
678
            'type'      => $post_type,
679
            'status'    => array_keys( wpinv_get_invoice_statuses( false, false, $post_type ) ),
680
        )
681
682
    );
683
684
    if ( empty( $invoices->total ) ) {
685
686
        return aui()->alert(
687
            array(
688
                'type'    => 'info',
689
                'content' => sprintf(
690
                    __( 'No %s found.', 'invoicing' ),
691
                    strtolower( $label )
692
                )
693
            )
694
        );
695
696
    }
697
698
    // Load the template.
699
    return wpinv_get_template_html( 'invoice-history.php', compact( 'invoices', 'post_type' ) );
700
701
}
702
703
/**
704
 * Formats an invoice number given an invoice type.
705
 */
706
function wpinv_format_invoice_number( $number, $type = '' ) {
707
708
    // Allow other plugins to overide this.
709
    $check = apply_filters( 'wpinv_pre_format_invoice_number', null, $number, $type );
710
    if ( null !== $check ) {
711
        return $check;
712
    }
713
714
    // Ensure that we have a numeric number.
715
    if ( ! is_numeric( $number ) ) {
716
        return $number;
717
    }
718
719
    // Format the number.
720
    $padd             = absint( (int) wpinv_get_option( 'invoice_number_padd', 5 ) );
721
    $prefix           = sanitize_text_field( (string) wpinv_get_option( 'invoice_number_prefix', 'INV-' ) );
722
    $prefix           = sanitize_text_field( apply_filters( 'getpaid_invoice_type_prefix', $prefix, $type ) );
723
    $postfix          = sanitize_text_field( (string) wpinv_get_option( 'invoice_number_postfix' ) );
724
    $postfix          = sanitize_text_field( apply_filters( 'getpaid_invoice_type_postfix', $postfix, $type ) );
725
    $formatted_number = zeroise( absint( $number ), $padd );
726
727
    // Add the prefix and post fix.
728
    $formatted_number = $prefix . $formatted_number . $postfix;
729
730
    return apply_filters( 'wpinv_format_invoice_number', $formatted_number, $number, $prefix, $postfix, $padd );
731
}
732
733
/**
734
 * Returns the next invoice number.
735
 * 
736
 * @param string $type.
737
 * @return int|null|bool
738
 */
739
function wpinv_get_next_invoice_number( $type = '' ) {
740
741
    // Allow plugins to overide this.
742
    $check = apply_filters( 'wpinv_get_pre_next_invoice_number', null, $type );
743
    if ( null !== $check ) {
744
        return $check;
745
    }
746
747
    // Ensure sequential invoice numbers is active.
748
    if ( ! wpinv_sequential_number_active() ) {
749
        return false;
750
    }
751
752
    // Retrieve the current number and the start number.
753
    $number = (int) get_option( 'wpinv_last_invoice_number', 0 );
754
    $start  = absint( (int) wpinv_get_option( 'invoice_sequence_start', 1 ) );
755
756
    // Ensure that we are starting at a positive integer.
757
    $start  = max( $start, 1 );
758
759
    // If this is the first invoice, use the start number.
760
    $number = max( $start, $number );
761
762
    // Format the invoice number.
763
    $formatted_number = wpinv_format_invoice_number( $number, $type );
764
765
    // Ensure that this number is unique.
766
    $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $formatted_number, 'number' );
767
768
    // We found a match. Nice.
769
    if ( empty( $invoice_id ) ) {
770
        update_option( 'wpinv_last_invoice_number', $number );
771
        return apply_filters( 'wpinv_get_next_invoice_number', $number );
772
    }
773
774
    update_option( 'wpinv_last_invoice_number', $number + 1 );
775
    return wpinv_get_next_invoice_number( $type );
776
777
}
778
779
/**
780
 * The prefix used for invoice paths.
781
 */
782
function wpinv_post_name_prefix( $post_type = 'wpi_invoice' ) {
783
    return apply_filters( 'wpinv_post_name_prefix', 'inv-', $post_type );
784
}
785
786
function wpinv_generate_post_name( $post_ID ) {
787
    $prefix = wpinv_post_name_prefix( get_post_type( $post_ID ) );
788
    $post_name = sanitize_title( $prefix . $post_ID );
789
790
    return apply_filters( 'wpinv_generate_post_name', $post_name, $post_ID, $prefix );
791
}
792
793
/**
794
 * Checks if an invoice was viewed by the customer.
795
 * 
796
 * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object.
797
 */
798
function wpinv_is_invoice_viewed( $invoice ) {
799
    $invoice = new WPInv_Invoice( $invoice );
800
    return (bool) $invoice->get_is_viewed();
801
}
802
803
/**
804
 * Marks an invoice as viewed.
805
 * 
806
 * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object.
807
 */
808
function getpaid_maybe_mark_invoice_as_viewed( $invoice ) {
809
    $invoice = new WPInv_Invoice( $invoice );
810
811
    if ( get_current_user_id() == $invoice->get_user_id() && ! $invoice->get_is_viewed() ) {
812
        $invoice->set_is_viewed( true );
813
        $invoice->save();
814
    }
815
816
}
817
add_action( 'wpinv_invoice_print_before_display', 'getpaid_maybe_mark_invoice_as_viewed' );
818
add_action( 'wpinv_before_receipt', 'getpaid_maybe_mark_invoice_as_viewed' );
819
820
/**
821
 * Processes an invoice refund.
822
 * 
823
 * @param WPInv_Invoice $invoice
824
 * @param array $status_transition
825
 * @todo: descrease customer/store earnings
826
 */
827
function getpaid_maybe_process_refund( $invoice, $status_transition ) {
828
829
    if ( empty( $status_transition['from'] ) || ! in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ) ) ) {
830
        return;
831
    }
832
833
    $discount_code = $invoice->get_discount_code();
834
    if ( ! empty( $discount_code ) ) {
835
        $discount = wpinv_get_discount_obj( $discount_code );
836
837
        if ( $discount->exists() ) {
838
            $discount->increase_usage( -1 );
839
        }
840
841
    }
842
843
    do_action( 'wpinv_pre_refund_invoice', $invoice, $invoice->get_id() );
844
    do_action( 'wpinv_refund_invoice', $invoice, $invoice->get_id() );
845
    do_action( 'wpinv_post_refund_invoice', $invoice, $invoice->get_id() );
846
}
847
add_action( 'getpaid_invoice_status_wpi-refunded', 'getpaid_maybe_process_refund', 10, 2 );
848
849
850
/**
851
 * Processes invoice payments.
852
 *
853
 * @param int $invoice_id
854
 */
855
function getpaid_process_invoice_payment( $invoice_id ) {
856
857
    // Fetch the invoice.
858
    $invoice = new WPInv_Invoice( $invoice_id );
859
860
    // We only want to do this once.
861
    if ( 1 ==  get_post_meta( $invoice->get_id(), 'wpinv_processed_payment', true ) ) {
862
        return;
863
    }
864
865
    update_post_meta( $invoice->get_id(), 'wpinv_processed_payment', 1 );
866
867
    // Fires when processing a payment.
868
    do_action( 'getpaid_process_payment', $invoice );
869
870
    // Fire an action for each invoice item.
871
    foreach( $invoice->get_items() as $item ) {
872
        do_action( 'getpaid_process_item_payment', $item, $invoice );
873
    }
874
875
    // Increase discount usage.
876
    $discount_code = $invoice->get_discount_code();
877
    if ( ! empty( $discount_code ) && ! $invoice->is_renewal() ) {
878
        $discount = wpinv_get_discount_obj( $discount_code );
879
880
        if ( $discount->exists() ) {
881
            $discount->increase_usage();
882
        }
883
884
    }
885
886
    // Record reverse vat.
887
    if ( 'invoice' == $invoice->get_type() && wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) {
888
889
        $taxes = $invoice->get_total_tax();
890
        if ( empty( $taxes ) && GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $invoice->get_country() ) ) {
891
            $invoice->add_note( __( 'VAT was reverse charged', 'invoicing' ), false, false, true );
892
        }
893
894
    }
895
896
}
897
add_action( 'getpaid_invoice_payment_status_changed', 'getpaid_process_invoice_payment' );
898
899
/**
900
 * Returns an array of invoice item columns
901
 * 
902
 * @param int|WPInv_Invoice $invoice
903
 * @return array
904
 */
905
function getpaid_invoice_item_columns( $invoice ) {
906
907
    // Prepare the invoice.
908
    $invoice = new WPInv_Invoice( $invoice );
909
910
    // Abort if there is no invoice.
911
    if ( 0 == $invoice->get_id() ) {
912
        return array();
913
    }
914
915
    // Line item columns.
916
    $columns = apply_filters(
917
        'getpaid_invoice_item_columns',
918
        array(
919
            'name'     => __( 'Item', 'invoicing' ),
920
            'price'    => __( 'Price', 'invoicing' ),
921
            'tax_rate' => __( 'Tax Rate', 'invoicing' ),
922
            'quantity' => __( 'Quantity', 'invoicing' ),
923
            'subtotal' => __( 'Item Subtotal', 'invoicing' ),
924
        ),
925
        $invoice
926
    );
927
928
    // Quantities.
929
    if ( isset( $columns[ 'quantity' ] ) ) {
930
931
        if ( 'hours' == $invoice->get_template() ) {
932
            $columns[ 'quantity' ] = __( 'Hours', 'invoicing' );
933
        }
934
935
        if ( ! wpinv_item_quantities_enabled() || 'amount' == $invoice->get_template() ) {
936
            unset( $columns[ 'quantity' ] );
937
        }
938
939
    }
940
941
942
    // Price.
943
    if ( isset( $columns[ 'price' ] ) ) {
944
945
        if ( 'amount' == $invoice->get_template() ) {
946
            $columns[ 'price' ] = __( 'Amount', 'invoicing' );
947
        }
948
949
        if ( 'hours' == $invoice->get_template() ) {
950
            $columns[ 'price' ] = __( 'Rate', 'invoicing' );
951
        }
952
953
    }
954
955
956
    // Sub total.
957
    if ( isset( $columns[ 'subtotal' ] ) ) {
958
959
        if ( 'amount' == $invoice->get_template() ) {
960
            unset( $columns[ 'subtotal' ] );
961
        }
962
963
    }
964
965
    // Tax rates.
966
    if ( isset( $columns[ 'tax_rate' ] ) ) {
967
968
        if ( 0 == $invoice->get_tax() ) {
0 ignored issues
show
Bug Best Practice introduced by
It seems like you are loosely comparing $invoice->get_tax() of type mixed|null to 0; this is ambiguous as not only 0 == 0 is true, but null == 0 is true, too. Consider using a strict comparison ===.
Loading history...
969
            unset( $columns[ 'tax_rate' ] );
970
        }
971
972
    }
973
974
    return $columns;
975
}
976
977
/**
978
 * Returns an array of invoice totals rows
979
 * 
980
 * @param int|WPInv_Invoice $invoice
981
 * @return array
982
 */
983
function getpaid_invoice_totals_rows( $invoice ) {
984
985
    // Prepare the invoice.
986
    $invoice = new WPInv_Invoice( $invoice );
987
988
    // Abort if there is no invoice.
989
    if ( 0 == $invoice->get_id() ) {
990
        return array();
991
    }
992
993
    $totals = apply_filters(
994
        'getpaid_invoice_totals_rows',
995
        array(
996
            'subtotal' => __( 'Subtotal', 'invoicing' ),
997
            'tax'      => __( 'Tax', 'invoicing' ),
998
            'fee'      => __( 'Fee', 'invoicing' ),
999
            'discount' => __( 'Discount', 'invoicing' ),
1000
            'total'    => __( 'Total', 'invoicing' ),
1001
        ),
1002
        $invoice
1003
    );
1004
1005
    if ( ( $invoice->get_disable_taxes() || ! wpinv_use_taxes() ) && isset( $totals['tax'] ) ) {
1006
        unset( $totals['tax'] );
1007
    }
1008
1009
    if ( 0 == $invoice->get_total_fees() && isset( $totals['fee'] ) ) {
1010
        unset( $totals['fee'] );
1011
    }
1012
1013
    if ( 0 == $invoice->get_total_discount() && isset( $totals['discount'] ) ) {
1014
        unset( $totals['discount'] );
1015
    }
1016
1017
    return $totals;
1018
}
1019
1020
/**
1021
 * This function is called whenever an invoice is created.
1022
 * 
1023
 * @param WPInv_Invoice $invoice
1024
 */
1025
function getpaid_new_invoice( $invoice ) {
1026
1027
    if ( ! $invoice->get_status() ) {
1028
        return;
1029
    }
1030
1031
    // Add an invoice created note.
1032
    $invoice->add_note(
1033
        sprintf(
1034
            __( '%s created with the status "%s".', 'invoicing' ),
1035
            ucfirst( $invoice->get_invoice_quote_type() ),
1036
            wpinv_status_nicename( $invoice->get_status(), $invoice  )
1037
        )
1038
    );
1039
1040
}
1041
add_action( 'getpaid_new_invoice', 'getpaid_new_invoice' );
1042
1043
/**
1044
 * This function updates invoice caches.
1045
 * 
1046
 * @param WPInv_Invoice $invoice
1047
 */
1048
function getpaid_update_invoice_caches( $invoice ) {
1049
1050
    // Cache invoice number.
1051
    wp_cache_set( $invoice->get_number(), $invoice->get_id(), "getpaid_invoice_numbers_to_invoice_ids" );
1052
1053
    // Cache invoice key.
1054
    wp_cache_set( $invoice->get_key(), $invoice->get_id(), "getpaid_invoice_keys_to_invoice_ids" );
1055
1056
    // (Maybe) cache transaction id.
1057
    $transaction_id = $invoice->get_transaction_id();
1058
1059
    if ( ! empty( $transaction_id ) ) {
1060
        wp_cache_set( $transaction_id, $invoice->get_id(), "getpaid_invoice_transaction_ids_to_invoice_ids" );
1061
    }
1062
1063
}
1064
add_action( 'getpaid_new_invoice', 'getpaid_update_invoice_caches', 5 );
1065
add_action( 'getpaid_update_invoice', 'getpaid_update_invoice_caches', 5 );
1066
1067
/**
1068
 * Duplicates an invoice.
1069
 * 
1070
 * Please note that this function does not save the duplicated invoice.
1071
 * 
1072
 * @param  WPInv_Invoice $old_invoice The invoice to duplicate
1073
 * @return WPInv_Invoice The new invoice.
1074
 */
1075
function getpaid_duplicate_invoice( $old_invoice ) {
1076
1077
    // Create the new invoice.
1078
    $invoice = new WPInv_Invoice();
1079
    $invoice->set_props(
1080
1081
        array(
1082
1083
            // Basic info.
1084
            'template'             => $old_invoice->get_template(),
1085
            'email_cc'             => $old_invoice->get_email_cc(),
1086
            'post_type'            => $old_invoice->get_post_type(),
1087
            'user_ip'              => $old_invoice->get_user_ip(),
1088
            'parent_id'            => $old_invoice->get_parent_id(),
1089
            'mode'                 => $old_invoice->get_mode(),
1090
            'description'          => $old_invoice->get_description(),
1091
            'created_via'          => $old_invoice->get_created_via(),
1092
1093
            // Payment info.
1094
            'disable_taxes'        => $old_invoice->get_disable_taxes(),
1095
            'currency'             => $old_invoice->get_currency(),
1096
            'gateway'              => $old_invoice->get_gateway(),
1097
            'discount_code'        => $old_invoice->get_discount_code(),
1098
            'payment_form'         => $old_invoice->get_payment_form(),
1099
            'submission_id'        => $old_invoice->get_submission_id(),
1100
            'subscription_id'      => $old_invoice->get_subscription_id(),
1101
            'fees'                 => $old_invoice->get_fees(),
1102
            'discounts'            => $old_invoice->get_discounts(),
1103
            'taxes'                => $old_invoice->get_taxes(),
1104
            'items'                => $old_invoice->get_items(),
1105
1106
            // Billing details.
1107
            'user_id'              => $old_invoice->get_user_id(),
1108
            'first_name'           => $old_invoice->get_first_name(),
1109
            'last_name'            => $old_invoice->get_last_name(),
1110
            'address'              => $old_invoice->get_address(),
1111
            'vat_number'           => $old_invoice->get_vat_number(),
1112
            'company'              => $old_invoice->get_company(),
1113
            'zip'                  => $old_invoice->get_zip(),
1114
            'state'                => $old_invoice->get_state(),
1115
            'city'                 => $old_invoice->get_city(),
1116
            'country'              => $old_invoice->get_country(),
1117
            'phone'                => $old_invoice->get_phone(),
1118
            'address_confirmed'    => $old_invoice->get_address_confirmed(),
1119
1120
        )
1121
1122
    );
1123
1124
    // Recalculate totals.
1125
    $invoice->recalculate_total();
1126
1127
    return $invoice;
1128
}
1129
1130
/**
1131
 * Retrieves invoice meta fields.
1132
 *
1133
 * @param WPInv_Invoice $invoice
1134
 * @return array
1135
 */
1136
function getpaid_get_invoice_meta( $invoice ) {
1137
1138
    // Load the invoice meta.
1139
    $meta = array(
1140
1141
        'number' => array(
1142
            'label' => sprintf(
1143
                __( '%s Number', 'invoicing' ),
1144
                ucfirst( $invoice->get_invoice_quote_type() )
1145
            ),
1146
            'value' => sanitize_text_field( $invoice->get_number() ),
1147
        ),
1148
1149
        'status' => array(
1150
            'label' => sprintf(
1151
                __( '%s Status', 'invoicing' ),
1152
                ucfirst( $invoice->get_invoice_quote_type() )
1153
            ),
1154
            'value' => $invoice->get_status_label_html(),
1155
        ),
1156
1157
        'date' => array(
1158
            'label' => sprintf(
1159
                __( '%s Date', 'invoicing' ),
1160
                ucfirst( $invoice->get_invoice_quote_type() )
1161
            ),
1162
            'value' => getpaid_format_date( $invoice->get_created_date() ),
1163
        ),
1164
1165
        'date_paid' => array(
1166
            'label' => __( 'Paid On', 'invoicing' ),
1167
            'value' => getpaid_format_date( $invoice->get_completed_date() ),
1168
        ),
1169
1170
        'gateway'   => array(
1171
            'label' => __( 'Payment Method', 'invoicing' ),
1172
            'value' => sanitize_text_field( $invoice->get_gateway_title() ),
1173
        ),
1174
1175
        'transaction_id' => array(
1176
            'label' => __( 'Transaction ID', 'invoicing' ),
1177
            'value' => sanitize_text_field( $invoice->get_transaction_id() ),
1178
        ),
1179
1180
        'due_date'  => array(
1181
            'label' => __( 'Due Date', 'invoicing' ),
1182
            'value' => getpaid_format_date( $invoice->get_due_date() ),
1183
        ),
1184
1185
        'vat_number' => array(
1186
            'label' => __( 'VAT Number', 'invoicing' ),
1187
            'value' => sanitize_text_field( $invoice->get_vat_number() ),
1188
        ),
1189
1190
    );
1191
1192
    // If it is not paid, remove the date of payment.
1193
    if ( ! $invoice->is_paid() ) {
1194
        unset( $meta[ 'date_paid' ] );
1195
        unset( $meta[ 'transaction_id' ] );
1196
    }
1197
1198
    if ( ! $invoice->is_paid() || 'none' == $invoice->get_gateway() ) {
1199
        unset( $meta[ 'gateway' ] );
1200
    }
1201
1202
    // Only display the due date if due dates are enabled.
1203
    if ( ! $invoice->needs_payment() || ! wpinv_get_option( 'overdue_active' ) ) {
1204
        unset( $meta[ 'due_date' ] );
1205
    }
1206
1207
    // Only display the vat number if taxes are enabled.
1208
    if ( ! wpinv_use_taxes() ) {
1209
        unset( $meta[ 'vat_number' ] );
1210
    }
1211
1212
    if ( $invoice->is_recurring() ) {
1213
1214
        // Link to the parent invoice.
1215
        if ( $invoice->is_renewal() ) {
1216
1217
            $meta[ 'parent' ] = array(
1218
1219
                'label' => sprintf(
1220
                    __( 'Parent %s', 'invoicing' ),
1221
                    ucfirst( $invoice->get_invoice_quote_type() )
1222
                ),
1223
1224
                'value' => wpinv_invoice_link( $invoice->get_parent_id() ),
1225
1226
            );
1227
1228
        }
1229
1230
        $subscription = wpinv_get_subscription( $invoice );
1231
1232
        if ( ! empty ( $subscription ) ) {
1233
1234
            // Display the renewal date.
1235
            if ( $subscription->is_active() && 'cancelled' != $subscription->get_status() ) {
1236
1237
                $meta[ 'renewal_date' ] = array(
1238
1239
                    'label' => __( 'Renews On', 'invoicing' ),
1240
                    'value' => getpaid_format_date( $subscription->get_expiration() ),
1241
        
1242
                );
1243
1244
            }
1245
1246
            if ( $invoice->is_parent() ) {
1247
1248
                // Display the recurring amount.
1249
                $meta[ 'recurring_total' ] = array(
1250
1251
                    'label' => __( 'Recurring Amount', 'invoicing' ),
1252
                    'value' => wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ),
1253
        
1254
                );
1255
1256
            }
1257
            
1258
        }
1259
    }
1260
1261
    // Add the invoice total to the meta.
1262
    $meta[ 'invoice_total' ] = array(
1263
1264
        'label' => __( 'Total Amount', 'invoicing' ),
1265
        'value' => wpinv_price( $invoice->get_total(), $invoice->get_currency() ),
1266
1267
    );
1268
1269
    // Provide a way for third party plugins to filter the meta.
1270
    $meta = apply_filters( 'getpaid_invoice_meta_data', $meta, $invoice );
1271
1272
    return $meta;
1273
1274
}
1275
1276
/**
1277
 * Returns an array of valid invoice status classes.
1278
 *
1279
 * @return array
1280
 */
1281
function getpaid_get_invoice_status_classes() {
1282
1283
	return apply_filters(
1284
		'getpaid_get_invoice_status_classes',
1285
		array(
1286
            'wpi-quote-declined' => 'badge-danger',
1287
            'wpi-failed'         => 'badge-danger',
1288
			'wpi-processing'     => 'badge-info',
1289
			'wpi-onhold'         => 'badge-warning',
1290
			'wpi-quote-accepted' => 'badge-success',
1291
			'publish'            => 'badge-success',
1292
			'wpi-renewal'        => 'badge-primary',
1293
            'wpi-cancelled'      => 'badge-secondary',
1294
            'wpi-pending'        => 'badge-dark',
1295
            'wpi-quote-pending'  => 'badge-dark',
1296
            'wpi-refunded'       => 'badge-secondary',
1297
		)
1298
	);
1299
1300
}
1301
1302
/**
1303
 * Returns an invoice's tax rate percentage.
1304
 *
1305
 * @param WPInv_Invoice $invoice
1306
 * @param GetPaid_Form_Item $item
1307
 * @return float
1308
 */
1309
function getpaid_get_invoice_tax_rate( $invoice, $item ) {
1310
1311
    $rates   = getpaid_get_item_tax_rates( $item, $invoice->get_country(), $invoice->get_state() );
1312
	$rates   = getpaid_filter_item_tax_rates( $item, $rates );
1313
    $rates   = wp_list_pluck( $rates, 'rate' );
1314
	
1315
    return array_sum( $rates );
1316
1317
}
1318