|
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
|
|
|
return apply_filters( 'getpaid_invoice_post_types', $post_types ); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* Checks if this is an invocing post type. |
|
89
|
|
|
* |
|
90
|
|
|
* |
|
91
|
|
|
* @param string $post_type The post type to check for. |
|
92
|
|
|
*/ |
|
93
|
|
|
function getpaid_is_invoice_post_type( $post_type ) { |
|
94
|
|
|
return ! empty( $post_type ) && array_key_exists( $post_type, getpaid_get_invoice_post_types() ); |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* Creates a new invoice. |
|
99
|
|
|
* |
|
100
|
|
|
* @param array $data An array of invoice properties. |
|
101
|
|
|
* @param bool $wp_error Whether to return false or WP_Error on failure. |
|
102
|
|
|
* @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
|
103
|
|
|
*/ |
|
104
|
|
|
function wpinv_create_invoice( $data = array(), $deprecated = null, $wp_error = false ) { |
|
|
|
|
|
|
105
|
|
|
$data[ 'invoice_id' ] = 0; |
|
106
|
|
|
return wpinv_insert_invoice( $data, $wp_error ); |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
/** |
|
110
|
|
|
* Updates an existing invoice. |
|
111
|
|
|
* |
|
112
|
|
|
* @param array $data An array of invoice properties. |
|
113
|
|
|
* @param bool $wp_error Whether to return false or WP_Error on failure. |
|
114
|
|
|
* @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
|
115
|
|
|
*/ |
|
116
|
|
|
function wpinv_update_invoice( $data = array(), $wp_error = false ) { |
|
117
|
|
|
|
|
118
|
|
|
// Backwards compatibility. |
|
119
|
|
|
if ( ! empty( $data['ID'] ) ) { |
|
120
|
|
|
$data['invoice_id'] = $data['ID']; |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
// Do we have an invoice id? |
|
124
|
|
|
if ( empty( $data['invoice_id'] ) ) { |
|
125
|
|
|
return $wp_error ? new WP_Error( 'invalid_invoice_id', __( 'Invalid invoice ID.', 'invoicing' ) ) : 0; |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
// Retrieve the invoice. |
|
129
|
|
|
$invoice = wpinv_get_invoice( $data['invoice_id'] ); |
|
130
|
|
|
|
|
131
|
|
|
// And abort if it does not exist. |
|
132
|
|
|
if ( empty( $invoice ) ) { |
|
133
|
|
|
return $wp_error ? new WP_Error( 'missing_invoice', __( 'Invoice not found.', 'invoicing' ) ) : 0; |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
// Do not update totals for paid / refunded invoices. |
|
137
|
|
|
if ( $invoice->is_paid() || $invoice->is_refunded() ) { |
|
138
|
|
|
|
|
139
|
|
|
if ( ! empty( $data['items'] ) || ! empty( $data['cart_details'] ) ) { |
|
140
|
|
|
return $wp_error ? new WP_Error( 'paid_invoice', __( 'You can not update cart items for invoices that have already been paid for.', 'invoicing' ) ) : 0; |
|
141
|
|
|
} |
|
142
|
|
|
|
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
return wpinv_insert_invoice( $data, $wp_error ); |
|
146
|
|
|
|
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
|
|
/** |
|
150
|
|
|
* Create/Update an invoice |
|
151
|
|
|
* |
|
152
|
|
|
* @param array $data An array of invoice properties. |
|
153
|
|
|
* @param bool $wp_error Whether to return false or WP_Error on failure. |
|
154
|
|
|
* @return int|WP_Error|WPInv_Invoice The value 0 or WP_Error on failure. The WPInv_Invoice object on success. |
|
155
|
|
|
*/ |
|
156
|
|
|
function wpinv_insert_invoice( $data = array(), $wp_error = false ) { |
|
157
|
|
|
|
|
158
|
|
|
// Ensure that we have invoice data. |
|
159
|
|
|
if ( empty( $data ) ) { |
|
160
|
|
|
return false; |
|
|
|
|
|
|
161
|
|
|
} |
|
162
|
|
|
|
|
163
|
|
|
// The invoice id will be provided when updating an invoice. |
|
164
|
|
|
$data['invoice_id'] = ! empty( $data['invoice_id'] ) ? (int) $data['invoice_id'] : false; |
|
165
|
|
|
|
|
166
|
|
|
// Retrieve the invoice. |
|
167
|
|
|
$invoice = new WPInv_Invoice( $data['invoice_id'] ); |
|
168
|
|
|
|
|
169
|
|
|
// Do we have an error? |
|
170
|
|
|
if ( ! empty( $invoice->last_error ) ) { |
|
171
|
|
|
return $wp_error ? new WP_Error( 'invalid_invoice_id', $invoice->last_error ) : 0; |
|
172
|
|
|
} |
|
173
|
|
|
|
|
174
|
|
|
// Backwards compatibility (billing address). |
|
175
|
|
|
if ( ! empty( $data['user_info'] ) ) { |
|
176
|
|
|
|
|
177
|
|
|
foreach ( $data['user_info'] as $key => $value ) { |
|
178
|
|
|
|
|
179
|
|
|
if ( $key == 'discounts' ) { |
|
180
|
|
|
$value = (array) $value; |
|
181
|
|
|
$data[ 'discount_code' ] = empty( $value ) ? null : $value[0]; |
|
182
|
|
|
} else { |
|
183
|
|
|
$data[ $key ] = $value; |
|
184
|
|
|
} |
|
185
|
|
|
|
|
186
|
|
|
} |
|
187
|
|
|
|
|
188
|
|
|
} |
|
189
|
|
|
|
|
190
|
|
|
// Backwards compatibility. |
|
191
|
|
|
if ( ! empty( $data['payment_details'] ) ) { |
|
192
|
|
|
|
|
193
|
|
|
foreach ( $data['payment_details'] as $key => $value ) { |
|
194
|
|
|
$data[ $key ] = $value; |
|
195
|
|
|
} |
|
196
|
|
|
|
|
197
|
|
|
} |
|
198
|
|
|
|
|
199
|
|
|
// Set up the owner of the invoice. |
|
200
|
|
|
$user_id = ! empty( $data['user_id'] ) ? wpinv_clean( $data['user_id'] ) : get_current_user_id(); |
|
201
|
|
|
|
|
202
|
|
|
// Make sure the user exists. |
|
203
|
|
|
if ( ! get_userdata( $user_id ) ) { |
|
204
|
|
|
return $wp_error ? new WP_Error( 'wpinv_invalid_user', __( 'There is no user with that ID.', 'invoicing' ) ) : 0; |
|
205
|
|
|
} |
|
206
|
|
|
|
|
207
|
|
|
$address = wpinv_get_user_address( $user_id ); |
|
208
|
|
|
|
|
209
|
|
|
foreach ( $address as $key => $value ) { |
|
210
|
|
|
|
|
211
|
|
|
if ( $value == '' ) { |
|
212
|
|
|
$address[ $key ] = null; |
|
213
|
|
|
} else { |
|
214
|
|
|
$address[ $key ] = wpinv_clean( $value ); |
|
215
|
|
|
} |
|
216
|
|
|
|
|
217
|
|
|
} |
|
218
|
|
|
|
|
219
|
|
|
// Load new data. |
|
220
|
|
|
$invoice->set_props( |
|
221
|
|
|
|
|
222
|
|
|
array( |
|
223
|
|
|
|
|
224
|
|
|
// Basic info. |
|
225
|
|
|
'template' => isset( $data['template'] ) ? wpinv_clean( $data['template'] ) : null, |
|
226
|
|
|
'email_cc' => isset( $data['email_cc'] ) ? wpinv_clean( $data['email_cc'] ) : null, |
|
227
|
|
|
'date_created' => isset( $data['created_date'] ) ? wpinv_clean( $data['created_date'] ) : null, |
|
228
|
|
|
'due_date' => isset( $data['due_date'] ) ? wpinv_clean( $data['due_date'] ) : null, |
|
229
|
|
|
'date_completed' => isset( $data['date_completed'] ) ? wpinv_clean( $data['date_completed'] ) : null, |
|
230
|
|
|
'number' => isset( $data['number'] ) ? wpinv_clean( $data['number'] ) : null, |
|
231
|
|
|
'key' => isset( $data['key'] ) ? wpinv_clean( $data['key'] ) : null, |
|
232
|
|
|
'status' => isset( $data['status'] ) ? wpinv_clean( $data['status'] ) : null, |
|
233
|
|
|
'post_type' => isset( $data['post_type'] ) ? wpinv_clean( $data['post_type'] ) : null, |
|
234
|
|
|
'user_ip' => isset( $data['ip'] ) ? wpinv_clean( $data['ip'] ) : wpinv_get_ip(), |
|
235
|
|
|
'parent_id' => isset( $data['parent'] ) ? intval( $data['parent'] ) : null, |
|
236
|
|
|
'mode' => isset( $data['mode'] ) ? wpinv_clean( $data['mode'] ) : null, |
|
237
|
|
|
'description' => isset( $data['description'] ) ? wp_kses_post( $data['description'] ) : null, |
|
238
|
|
|
|
|
239
|
|
|
// Payment info. |
|
240
|
|
|
'disable_taxes' => ! empty( $data['disable_taxes'] ), |
|
241
|
|
|
'currency' => isset( $data['currency'] ) ? wpinv_clean( $data['currency'] ) : wpinv_get_currency(), |
|
242
|
|
|
'gateway' => isset( $data['gateway'] ) ? wpinv_clean( $data['gateway'] ) : null, |
|
243
|
|
|
'transaction_id' => isset( $data['transaction_id'] ) ? wpinv_clean( $data['transaction_id'] ) : null, |
|
244
|
|
|
'discount_code' => isset( $data['discount_code'] ) ? wpinv_clean( $data['discount_code'] ) : null, |
|
245
|
|
|
'payment_form' => isset( $data['payment_form'] ) ? intval( $data['payment_form'] ) : null, |
|
246
|
|
|
'submission_id' => isset( $data['submission_id'] ) ? wpinv_clean( $data['submission_id'] ) : null, |
|
247
|
|
|
'subscription_id' => isset( $data['subscription_id'] ) ? wpinv_clean( $data['subscription_id'] ) : null, |
|
248
|
|
|
'is_viewed' => isset( $data['is_viewed'] ) ? wpinv_clean( $data['is_viewed'] ) : null, |
|
249
|
|
|
'fees' => isset( $data['fees'] ) ? wpinv_clean( $data['fees'] ) : null, |
|
250
|
|
|
'discounts' => isset( $data['discounts'] ) ? wpinv_clean( $data['discounts'] ) : null, |
|
251
|
|
|
'taxes' => isset( $data['taxes'] ) ? wpinv_clean( $data['taxes'] ) : null, |
|
252
|
|
|
|
|
253
|
|
|
|
|
254
|
|
|
// Billing details. |
|
255
|
|
|
'user_id' => $data['user_id'], |
|
256
|
|
|
'first_name' => isset( $data['first_name'] ) ? wpinv_clean( $data['first_name'] ) : $address['first_name'], |
|
257
|
|
|
'last_name' => isset( $data['last_name'] ) ? wpinv_clean( $data['last_name'] ) : $address['last_name'], |
|
258
|
|
|
'address' => isset( $data['address'] ) ? wpinv_clean( $data['address'] ) : $address['address'] , |
|
259
|
|
|
'vat_number' => isset( $data['vat_number'] ) ? wpinv_clean( $data['vat_number'] ) : $address['vat_number'], |
|
260
|
|
|
'company' => isset( $data['company'] ) ? wpinv_clean( $data['company'] ) : $address['company'], |
|
261
|
|
|
'zip' => isset( $data['zip'] ) ? wpinv_clean( $data['zip'] ) : $address['zip'], |
|
262
|
|
|
'state' => isset( $data['state'] ) ? wpinv_clean( $data['state'] ) : $address['state'], |
|
263
|
|
|
'city' => isset( $data['city'] ) ? wpinv_clean( $data['city'] ) : $address['city'], |
|
264
|
|
|
'country' => isset( $data['country'] ) ? wpinv_clean( $data['country'] ) : $address['country'], |
|
265
|
|
|
'phone' => isset( $data['phone'] ) ? wpinv_clean( $data['phone'] ) : $address['phone'], |
|
266
|
|
|
'address_confirmed' => ! empty( $data['address_confirmed'] ), |
|
267
|
|
|
|
|
268
|
|
|
) |
|
269
|
|
|
|
|
270
|
|
|
); |
|
271
|
|
|
|
|
272
|
|
|
// Backwards compatibililty. |
|
273
|
|
|
if ( ! empty( $data['cart_details'] ) && is_array( $data['cart_details'] ) ) { |
|
274
|
|
|
$data['items'] = array(); |
|
275
|
|
|
|
|
276
|
|
|
foreach( $data['cart_details'] as $_item ) { |
|
277
|
|
|
|
|
278
|
|
|
// Ensure that we have an item id. |
|
279
|
|
|
if ( empty( $_item['id'] ) ) { |
|
280
|
|
|
continue; |
|
281
|
|
|
} |
|
282
|
|
|
|
|
283
|
|
|
// Retrieve the item. |
|
284
|
|
|
$item = new GetPaid_Form_Item( $_item['id'] ); |
|
285
|
|
|
|
|
286
|
|
|
// Ensure that it is purchasable. |
|
287
|
|
|
if ( ! $item->can_purchase() ) { |
|
288
|
|
|
continue; |
|
289
|
|
|
} |
|
290
|
|
|
|
|
291
|
|
|
// Set quantity. |
|
292
|
|
|
if ( ! empty( $_item['quantity'] ) && is_numeric( $_item['quantity'] ) ) { |
|
293
|
|
|
$item->set_quantity( $_item['quantity'] ); |
|
294
|
|
|
} |
|
295
|
|
|
|
|
296
|
|
|
// Set price. |
|
297
|
|
|
if ( isset( $_item['item_price'] ) ) { |
|
298
|
|
|
$item->set_price( $_item['item_price'] ); |
|
299
|
|
|
} |
|
300
|
|
|
|
|
301
|
|
|
if ( isset( $_item['custom_price'] ) ) { |
|
302
|
|
|
$item->set_price( $_item['custom_price'] ); |
|
303
|
|
|
} |
|
304
|
|
|
|
|
305
|
|
|
// Set name. |
|
306
|
|
|
if ( ! empty( $_item['name'] ) ) { |
|
307
|
|
|
$item->set_name( $_item['name'] ); |
|
308
|
|
|
} |
|
309
|
|
|
|
|
310
|
|
|
// Set description. |
|
311
|
|
|
if ( isset( $_item['description'] ) ) { |
|
312
|
|
|
$item->set_custom_description( $_item['description'] ); |
|
313
|
|
|
} |
|
314
|
|
|
|
|
315
|
|
|
// Set meta. |
|
316
|
|
|
if ( isset( $_item['meta'] ) && is_array( $_item['meta'] ) ) { |
|
317
|
|
|
|
|
318
|
|
|
$item->set_item_meta( $_item['meta'] ); |
|
319
|
|
|
|
|
320
|
|
|
if ( isset( $_item['meta']['description'] ) ) { |
|
321
|
|
|
$item->set_custom_description( $_item['meta']['description'] ); |
|
322
|
|
|
} |
|
323
|
|
|
|
|
324
|
|
|
} |
|
325
|
|
|
|
|
326
|
|
|
$data['items'][] = $item; |
|
327
|
|
|
|
|
328
|
|
|
} |
|
329
|
|
|
} |
|
330
|
|
|
|
|
331
|
|
|
// Add invoice items. |
|
332
|
|
|
if ( ! empty( $data['items'] ) && is_array( $data['items'] ) ) { |
|
333
|
|
|
|
|
334
|
|
|
$invoice->set_items( array() ); |
|
335
|
|
|
|
|
336
|
|
|
foreach ( $data['items'] as $item ) { |
|
337
|
|
|
|
|
338
|
|
|
if ( is_object( $item ) && is_a( $item, 'GetPaid_Form_Item' ) && $item->can_purchase() ) { |
|
339
|
|
|
$invoice->add_item( $item ); |
|
340
|
|
|
} |
|
341
|
|
|
|
|
342
|
|
|
} |
|
343
|
|
|
|
|
344
|
|
|
} |
|
345
|
|
|
|
|
346
|
|
|
// Save the invoice. |
|
347
|
|
|
$invoice->save(); |
|
348
|
|
|
|
|
349
|
|
|
if ( ! $invoice->get_id() ) { |
|
350
|
|
|
return $wp_error ? new WP_Error( 'wpinv_insert_invoice_error', __( 'An error occured when saving your invoice.', 'invoicing' ) ) : 0; |
|
351
|
|
|
} |
|
352
|
|
|
|
|
353
|
|
|
// Add private note. |
|
354
|
|
|
if ( ! empty( $data['private_note'] ) ) { |
|
355
|
|
|
$invoice->add_note( $data['private_note'] ); |
|
356
|
|
|
} |
|
357
|
|
|
|
|
358
|
|
|
// User notes. |
|
359
|
|
|
if ( !empty( $data['user_note'] ) ) { |
|
360
|
|
|
$invoice->add_note( $data['user_note'], true ); |
|
361
|
|
|
} |
|
362
|
|
|
|
|
363
|
|
|
// Created via. |
|
364
|
|
|
if ( isset( $data['created_via'] ) ) { |
|
365
|
|
|
update_post_meta( $invoice->get_id(), 'wpinv_created_via', $data['created_via'] ); |
|
366
|
|
|
} |
|
367
|
|
|
|
|
368
|
|
|
// Backwards compatiblity. |
|
369
|
|
|
if ( $invoice->is_quote() ) { |
|
370
|
|
|
|
|
371
|
|
|
if ( isset( $data['valid_until'] ) ) { |
|
372
|
|
|
update_post_meta( $invoice->get_id(), 'wpinv_quote_valid_until', $data['valid_until'] ); |
|
373
|
|
|
} |
|
374
|
|
|
return $invoice; |
|
375
|
|
|
|
|
376
|
|
|
} |
|
377
|
|
|
|
|
378
|
|
|
} |
|
379
|
|
|
|
|
380
|
|
|
/** |
|
381
|
|
|
* Retrieves an invoice. |
|
382
|
|
|
* |
|
383
|
|
|
* @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
|
384
|
|
|
* @param $bool $deprecated |
|
|
|
|
|
|
385
|
|
|
* @return WPInv_Invoice|null |
|
386
|
|
|
*/ |
|
387
|
|
|
function wpinv_get_invoice( $invoice = 0, $deprecated = false ) { |
|
388
|
|
|
|
|
389
|
|
|
// If we are retrieving the invoice from the cart... |
|
390
|
|
|
if ( $deprecated && empty( $invoice ) ) { |
|
391
|
|
|
$invoice = (int) getpaid_get_current_invoice_id(); |
|
392
|
|
|
} |
|
393
|
|
|
|
|
394
|
|
|
// Retrieve the invoice. |
|
395
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
396
|
|
|
|
|
397
|
|
|
// Check if it exists. |
|
398
|
|
|
if ( $invoice->get_id() != 0 ) { |
|
399
|
|
|
return $invoice; |
|
400
|
|
|
} |
|
401
|
|
|
|
|
402
|
|
|
return null; |
|
403
|
|
|
} |
|
404
|
|
|
|
|
405
|
|
|
/** |
|
406
|
|
|
* Retrieves several invoices. |
|
407
|
|
|
* |
|
408
|
|
|
* @param array $args Args to search for. |
|
409
|
|
|
* @return WPInv_Invoice[]|int[]|object |
|
410
|
|
|
*/ |
|
411
|
|
|
function wpinv_get_invoices( $args ) { |
|
412
|
|
|
|
|
413
|
|
|
// Prepare args. |
|
414
|
|
|
$args = wp_parse_args( |
|
415
|
|
|
$args, |
|
416
|
|
|
array( |
|
417
|
|
|
'status' => array_keys( wpinv_get_invoice_statuses() ), |
|
418
|
|
|
'type' => 'wpi_invoice', |
|
419
|
|
|
'limit' => get_option( 'posts_per_page' ), |
|
420
|
|
|
'return' => 'objects', |
|
421
|
|
|
) |
|
422
|
|
|
); |
|
423
|
|
|
|
|
424
|
|
|
// Map params to wp_query params. |
|
425
|
|
|
$map_legacy = array( |
|
426
|
|
|
'numberposts' => 'limit', |
|
427
|
|
|
'post_type' => 'type', |
|
428
|
|
|
'post_status' => 'status', |
|
429
|
|
|
'post_parent' => 'parent', |
|
430
|
|
|
'author' => 'user', |
|
431
|
|
|
'posts_per_page' => 'limit', |
|
432
|
|
|
'paged' => 'page', |
|
433
|
|
|
'post__not_in' => 'exclude', |
|
434
|
|
|
'post__in' => 'include', |
|
435
|
|
|
); |
|
436
|
|
|
|
|
437
|
|
|
foreach ( $map_legacy as $to => $from ) { |
|
438
|
|
|
if ( isset( $args[ $from ] ) ) { |
|
439
|
|
|
$args[ $to ] = $args[ $from ]; |
|
440
|
|
|
unset( $args[ $from ] ); |
|
441
|
|
|
} |
|
442
|
|
|
} |
|
443
|
|
|
|
|
444
|
|
|
// Backwards compatibility. |
|
445
|
|
|
if ( ! empty( $args['email'] ) && empty( $args['user'] ) ) { |
|
446
|
|
|
$args['user'] = $args['email']; |
|
447
|
|
|
unset( $args['email'] ); |
|
448
|
|
|
} |
|
449
|
|
|
|
|
450
|
|
|
// Handle cases where the user is set as an email. |
|
451
|
|
|
if ( ! empty( $args['author'] ) && is_email( $args['author'] ) ) { |
|
452
|
|
|
$user = get_user_by( 'email', $args['user'] ); |
|
453
|
|
|
|
|
454
|
|
|
if ( $user ) { |
|
455
|
|
|
$args['author'] = $user->user_email; |
|
456
|
|
|
} |
|
457
|
|
|
|
|
458
|
|
|
} |
|
459
|
|
|
|
|
460
|
|
|
// We only want invoice ids. |
|
461
|
|
|
$args['fields'] = 'ids'; |
|
462
|
|
|
|
|
463
|
|
|
// Show all posts. |
|
464
|
|
|
$paginate = true; |
|
465
|
|
|
if ( isset( $args['paginate'] ) ) { |
|
466
|
|
|
|
|
467
|
|
|
$paginate = $args['paginate']; |
|
468
|
|
|
$args['no_found_rows'] = empty( $args['paginate'] ); |
|
469
|
|
|
unset( $args['paginate'] ); |
|
470
|
|
|
|
|
471
|
|
|
} |
|
472
|
|
|
|
|
473
|
|
|
// Whether to return objects or fields. |
|
474
|
|
|
$return = $args['return']; |
|
475
|
|
|
unset( $args['return'] ); |
|
476
|
|
|
|
|
477
|
|
|
// Get invoices. |
|
478
|
|
|
$invoices = new WP_Query( apply_filters( 'wpinv_get_invoices_args', $args ) ); |
|
479
|
|
|
|
|
480
|
|
|
// Prepare the results. |
|
481
|
|
|
if ( 'objects' === $return ) { |
|
482
|
|
|
$results = array_map( 'wpinv_get_invoice', $invoices->posts ); |
|
483
|
|
|
} elseif ( 'self' === $return ) { |
|
484
|
|
|
return $invoices; |
|
485
|
|
|
} else { |
|
486
|
|
|
$results = $invoices->posts; |
|
487
|
|
|
} |
|
488
|
|
|
|
|
489
|
|
|
if ( $paginate ) { |
|
490
|
|
|
return (object) array( |
|
491
|
|
|
'invoices' => $results, |
|
492
|
|
|
'total' => $invoices->found_posts, |
|
493
|
|
|
'max_num_pages' => $invoices->max_num_pages, |
|
494
|
|
|
); |
|
495
|
|
|
} else { |
|
496
|
|
|
return $results; |
|
497
|
|
|
} |
|
498
|
|
|
|
|
499
|
|
|
} |
|
500
|
|
|
|
|
501
|
|
|
/** |
|
502
|
|
|
* Retrieves an invoice's id from a transaction id. |
|
503
|
|
|
* |
|
504
|
|
|
* @param string $transaction_id The transaction id to check. |
|
505
|
|
|
* @return int Invoice id on success or 0 on failure |
|
506
|
|
|
*/ |
|
507
|
|
|
function wpinv_get_id_by_transaction_id( $transaction_id ) { |
|
508
|
|
|
return WPInv_Invoice::get_invoice_id_by_field( $transaction_id, 'transaction_id' ); |
|
509
|
|
|
} |
|
510
|
|
|
|
|
511
|
|
|
/** |
|
512
|
|
|
* Retrieves an invoice's id from the invoice number. |
|
513
|
|
|
* |
|
514
|
|
|
* @param string $invoice_number The invoice number to check. |
|
515
|
|
|
* @return int Invoice id on success or 0 on failure |
|
516
|
|
|
*/ |
|
517
|
|
|
function wpinv_get_id_by_invoice_number( $invoice_number ) { |
|
518
|
|
|
return WPInv_Invoice::get_invoice_id_by_field( $invoice_number, 'number' ); |
|
519
|
|
|
} |
|
520
|
|
|
|
|
521
|
|
|
/** |
|
522
|
|
|
* Retrieves an invoice's id from the invoice key. |
|
523
|
|
|
* |
|
524
|
|
|
* @param string $invoice_key The invoice key to check. |
|
525
|
|
|
* @return int Invoice id on success or 0 on failure |
|
526
|
|
|
*/ |
|
527
|
|
|
function wpinv_get_invoice_id_by_key( $invoice_key ) { |
|
528
|
|
|
return WPInv_Invoice::get_invoice_id_by_field( $invoice_key, 'key' ); |
|
529
|
|
|
} |
|
530
|
|
|
|
|
531
|
|
|
/** |
|
532
|
|
|
* Retrieves an invoice's notes. |
|
533
|
|
|
* |
|
534
|
|
|
* @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
|
535
|
|
|
* @param string $type Optionally filter by type i.e customer|system |
|
536
|
|
|
* @return array|null |
|
537
|
|
|
*/ |
|
538
|
|
|
function wpinv_get_invoice_notes( $invoice = 0, $type = '' ) { |
|
539
|
|
|
|
|
540
|
|
|
// Prepare the invoice. |
|
541
|
|
|
$invoice = wpinv_get_invoice( $invoice ); |
|
542
|
|
|
if ( empty( $invoice ) ) { |
|
543
|
|
|
return NULL; |
|
544
|
|
|
} |
|
545
|
|
|
|
|
546
|
|
|
// Fetch notes. |
|
547
|
|
|
$notes = getpaid_notes()->get_invoice_notes( $invoice->get_id(), $type ); |
|
548
|
|
|
|
|
549
|
|
|
// Filter the notes. |
|
550
|
|
|
return apply_filters( 'wpinv_invoice_notes', $notes, $invoice->get_id(), $type ); |
|
551
|
|
|
} |
|
552
|
|
|
|
|
553
|
|
|
/** |
|
554
|
|
|
* Returns an array of columns to display on the invoices page. |
|
555
|
|
|
*/ |
|
556
|
|
|
function wpinv_get_user_invoices_columns() { |
|
557
|
|
|
$columns = array( |
|
558
|
|
|
|
|
559
|
|
|
'invoice-number' => array( |
|
560
|
|
|
'title' => __( 'Invoice', 'invoicing' ), |
|
561
|
|
|
'class' => 'text-left' |
|
562
|
|
|
), |
|
563
|
|
|
|
|
564
|
|
|
'created-date' => array( |
|
565
|
|
|
'title' => __( 'Created Date', 'invoicing' ), |
|
566
|
|
|
'class' => 'text-left' |
|
567
|
|
|
), |
|
568
|
|
|
|
|
569
|
|
|
'payment-date' => array( |
|
570
|
|
|
'title' => __( 'Payment Date', 'invoicing' ), |
|
571
|
|
|
'class' => 'text-left' |
|
572
|
|
|
), |
|
573
|
|
|
|
|
574
|
|
|
'invoice-status' => array( |
|
575
|
|
|
'title' => __( 'Status', 'invoicing' ), |
|
576
|
|
|
'class' => 'text-center' |
|
577
|
|
|
), |
|
578
|
|
|
|
|
579
|
|
|
'invoice-total' => array( |
|
580
|
|
|
'title' => __( 'Total', 'invoicing' ), |
|
581
|
|
|
'class' => 'text-right' |
|
582
|
|
|
), |
|
583
|
|
|
|
|
584
|
|
|
'invoice-actions' => array( |
|
585
|
|
|
'title' => ' ', |
|
586
|
|
|
'class' => 'text-center' |
|
587
|
|
|
), |
|
588
|
|
|
|
|
589
|
|
|
); |
|
590
|
|
|
|
|
591
|
|
|
return apply_filters( 'wpinv_user_invoices_columns', $columns ); |
|
592
|
|
|
} |
|
593
|
|
|
|
|
594
|
|
|
/** |
|
595
|
|
|
* Displays the invoice receipt. |
|
596
|
|
|
*/ |
|
597
|
|
|
function wpinv_payment_receipt() { |
|
598
|
|
|
|
|
599
|
|
|
// Find the invoice. |
|
600
|
|
|
$invoice_id = getpaid_get_current_invoice_id(); |
|
601
|
|
|
$invoice = new WPInv_Invoice( $invoice_id ); |
|
602
|
|
|
|
|
603
|
|
|
// Abort if non was found. |
|
604
|
|
|
if ( empty( $invoice_id ) || $invoice->is_draft() ) { |
|
605
|
|
|
|
|
606
|
|
|
return aui()->alert( |
|
607
|
|
|
array( |
|
608
|
|
|
'type' => 'warning', |
|
609
|
|
|
'content' => __( 'We could not find your invoice', 'invoicing' ), |
|
610
|
|
|
) |
|
611
|
|
|
); |
|
612
|
|
|
|
|
613
|
|
|
} |
|
614
|
|
|
|
|
615
|
|
|
// Can the user view this invoice? |
|
616
|
|
|
if ( ! wpinv_can_view_receipt( $invoice_id ) ) { |
|
617
|
|
|
|
|
618
|
|
|
return aui()->alert( |
|
619
|
|
|
array( |
|
620
|
|
|
'type' => 'warning', |
|
621
|
|
|
'content' => __( 'You are not allowed to view this receipt', 'invoicing' ), |
|
622
|
|
|
) |
|
623
|
|
|
); |
|
624
|
|
|
|
|
625
|
|
|
} |
|
626
|
|
|
|
|
627
|
|
|
// Load the template. |
|
628
|
|
|
return wpinv_get_template_html( 'invoice-receipt.php', compact( 'invoice' ) ); |
|
629
|
|
|
|
|
630
|
|
|
} |
|
631
|
|
|
|
|
632
|
|
|
/** |
|
633
|
|
|
* Displays the invoice history. |
|
634
|
|
|
*/ |
|
635
|
|
|
function getpaid_invoice_history( $user_id = 0 ) { |
|
636
|
|
|
|
|
637
|
|
|
// Ensure that we have a user id. |
|
638
|
|
|
if ( empty( $user_id ) || ! is_numeric( $user_id ) ) { |
|
639
|
|
|
$user_id = get_current_user_id(); |
|
640
|
|
|
} |
|
641
|
|
|
|
|
642
|
|
|
// View user id. |
|
643
|
|
|
if ( empty( $user_id ) ) { |
|
644
|
|
|
|
|
645
|
|
|
return aui()->alert( |
|
646
|
|
|
array( |
|
647
|
|
|
'type' => 'warning', |
|
648
|
|
|
'content' => __( 'You must be logged in to view your invoice history.', 'invoicing' ), |
|
649
|
|
|
) |
|
650
|
|
|
); |
|
651
|
|
|
|
|
652
|
|
|
} |
|
653
|
|
|
|
|
654
|
|
|
// Fetch invoices. |
|
655
|
|
|
$invoices = wpinv_get_invoices( |
|
656
|
|
|
|
|
657
|
|
|
array( |
|
658
|
|
|
'page' => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1, |
|
659
|
|
|
'user' => $user_id, |
|
660
|
|
|
'paginate' => true, |
|
661
|
|
|
) |
|
662
|
|
|
|
|
663
|
|
|
); |
|
664
|
|
|
|
|
665
|
|
|
if ( empty( $invoices->total ) ) { |
|
666
|
|
|
|
|
667
|
|
|
return aui()->alert( |
|
668
|
|
|
array( |
|
669
|
|
|
'type' => 'info', |
|
670
|
|
|
'content' => __( 'No invoices found.', 'invoicing' ), |
|
671
|
|
|
) |
|
672
|
|
|
); |
|
673
|
|
|
|
|
674
|
|
|
} |
|
675
|
|
|
|
|
676
|
|
|
// Load the template. |
|
677
|
|
|
return wpinv_get_template_html( 'invoice-history.php', compact( 'invoices' ) ); |
|
678
|
|
|
|
|
679
|
|
|
} |
|
680
|
|
|
|
|
681
|
|
|
function wpinv_invoice_status_label( $status, $status_display = '' ) { |
|
682
|
|
|
if ( empty( $status_display ) ) { |
|
683
|
|
|
$status_display = wpinv_status_nicename( $status ); |
|
684
|
|
|
} |
|
685
|
|
|
|
|
686
|
|
|
switch ( $status ) { |
|
687
|
|
|
case 'publish' : |
|
688
|
|
|
case 'wpi-renewal' : |
|
689
|
|
|
$class = 'label-success'; |
|
690
|
|
|
break; |
|
691
|
|
|
case 'wpi-pending' : |
|
692
|
|
|
$class = 'label-primary'; |
|
693
|
|
|
break; |
|
694
|
|
|
case 'wpi-processing' : |
|
695
|
|
|
$class = 'label-warning'; |
|
696
|
|
|
break; |
|
697
|
|
|
case 'wpi-onhold' : |
|
698
|
|
|
$class = 'label-info'; |
|
699
|
|
|
break; |
|
700
|
|
|
case 'wpi-cancelled' : |
|
701
|
|
|
case 'wpi-failed' : |
|
702
|
|
|
$class = 'label-danger'; |
|
703
|
|
|
break; |
|
704
|
|
|
default: |
|
705
|
|
|
$class = 'label-default'; |
|
706
|
|
|
break; |
|
707
|
|
|
} |
|
708
|
|
|
|
|
709
|
|
|
$label = '<span class="label label-inv-' . $status . ' ' . $class . '">' . $status_display . '</span>'; |
|
710
|
|
|
|
|
711
|
|
|
return apply_filters( 'wpinv_invoice_status_label', $label, $status, $status_display ); |
|
712
|
|
|
} |
|
713
|
|
|
|
|
714
|
|
|
function wpinv_format_invoice_number( $number, $type = '' ) { |
|
715
|
|
|
$check = apply_filters( 'wpinv_pre_format_invoice_number', null, $number, $type ); |
|
716
|
|
|
if ( null !== $check ) { |
|
717
|
|
|
return $check; |
|
718
|
|
|
} |
|
719
|
|
|
|
|
720
|
|
|
if ( !empty( $number ) && !is_numeric( $number ) ) { |
|
721
|
|
|
return $number; |
|
722
|
|
|
} |
|
723
|
|
|
|
|
724
|
|
|
$padd = wpinv_get_option( 'invoice_number_padd' ); |
|
725
|
|
|
$prefix = wpinv_get_option( 'invoice_number_prefix' ); |
|
726
|
|
|
$postfix = wpinv_get_option( 'invoice_number_postfix' ); |
|
727
|
|
|
|
|
728
|
|
|
$padd = absint( $padd ); |
|
729
|
|
|
$formatted_number = absint( $number ); |
|
730
|
|
|
|
|
731
|
|
|
if ( $padd > 0 ) { |
|
732
|
|
|
$formatted_number = zeroise( $formatted_number, $padd ); |
|
733
|
|
|
} |
|
734
|
|
|
|
|
735
|
|
|
$formatted_number = $prefix . $formatted_number . $postfix; |
|
|
|
|
|
|
736
|
|
|
|
|
737
|
|
|
return apply_filters( 'wpinv_format_invoice_number', $formatted_number, $number, $prefix, $postfix, $padd ); |
|
738
|
|
|
} |
|
739
|
|
|
|
|
740
|
|
|
function wpinv_get_next_invoice_number( $type = '' ) { |
|
741
|
|
|
$check = apply_filters( 'wpinv_get_pre_next_invoice_number', null, $type ); |
|
742
|
|
|
if ( null !== $check ) { |
|
743
|
|
|
return $check; |
|
744
|
|
|
} |
|
745
|
|
|
|
|
746
|
|
|
if ( !wpinv_sequential_number_active() ) { |
|
747
|
|
|
return false; |
|
748
|
|
|
} |
|
749
|
|
|
|
|
750
|
|
|
$number = $last_number = get_option( 'wpinv_last_invoice_number', 0 ); |
|
751
|
|
|
$start = wpinv_get_option( 'invoice_sequence_start', 1 ); |
|
752
|
|
|
if ( !absint( $start ) > 0 ) { |
|
753
|
|
|
$start = 1; |
|
754
|
|
|
} |
|
755
|
|
|
$increment_number = true; |
|
756
|
|
|
$save_number = false; |
|
757
|
|
|
|
|
758
|
|
|
if ( !empty( $number ) && !is_numeric( $number ) && $number == wpinv_format_invoice_number( $number ) ) { |
|
759
|
|
|
$number = wpinv_clean_invoice_number( $number ); |
|
760
|
|
|
} |
|
761
|
|
|
|
|
762
|
|
|
if ( empty( $number ) ) { |
|
763
|
|
|
if ( !( $last_number === 0 || $last_number === '0' ) ) { |
|
764
|
|
|
$last_invoice = wpinv_get_invoices( array( 'limit' => 1, 'order' => 'DESC', 'orderby' => 'ID', 'return' => 'posts', 'fields' => 'ids', 'status' => array_keys( wpinv_get_invoice_statuses( true, true ) ) ) ); |
|
765
|
|
|
|
|
766
|
|
|
if ( !empty( $last_invoice[0] ) && $invoice_number = wpinv_get_invoice_number( $last_invoice[0] ) ) { |
|
|
|
|
|
|
767
|
|
|
if ( is_numeric( $invoice_number ) ) { |
|
768
|
|
|
$number = $invoice_number; |
|
769
|
|
|
} else { |
|
770
|
|
|
$number = wpinv_clean_invoice_number( $invoice_number ); |
|
771
|
|
|
} |
|
772
|
|
|
} |
|
773
|
|
|
|
|
774
|
|
|
if ( empty( $number ) ) { |
|
775
|
|
|
$increment_number = false; |
|
776
|
|
|
$number = $start; |
|
777
|
|
|
$save_number = ( $number - 1 ); |
|
778
|
|
|
} else { |
|
779
|
|
|
$save_number = $number; |
|
780
|
|
|
} |
|
781
|
|
|
} |
|
782
|
|
|
} |
|
783
|
|
|
|
|
784
|
|
|
if ( $start > $number ) { |
|
785
|
|
|
$increment_number = false; |
|
786
|
|
|
$number = $start; |
|
787
|
|
|
$save_number = ( $number - 1 ); |
|
788
|
|
|
} |
|
789
|
|
|
|
|
790
|
|
|
if ( $save_number !== false ) { |
|
791
|
|
|
update_option( 'wpinv_last_invoice_number', $save_number ); |
|
792
|
|
|
} |
|
793
|
|
|
|
|
794
|
|
|
$increment_number = apply_filters( 'wpinv_increment_payment_number', $increment_number, $number ); |
|
795
|
|
|
|
|
796
|
|
|
if ( $increment_number ) { |
|
797
|
|
|
$number++; |
|
798
|
|
|
} |
|
799
|
|
|
|
|
800
|
|
|
return apply_filters( 'wpinv_get_next_invoice_number', $number ); |
|
801
|
|
|
} |
|
802
|
|
|
|
|
803
|
|
|
function wpinv_clean_invoice_number( $number, $type = '' ) { |
|
804
|
|
|
$check = apply_filters( 'wpinv_pre_clean_invoice_number', null, $number, $type ); |
|
805
|
|
|
if ( null !== $check ) { |
|
806
|
|
|
return $check; |
|
807
|
|
|
} |
|
808
|
|
|
|
|
809
|
|
|
$prefix = wpinv_get_option( 'invoice_number_prefix' ); |
|
810
|
|
|
$postfix = wpinv_get_option( 'invoice_number_postfix' ); |
|
811
|
|
|
|
|
812
|
|
|
$number = preg_replace( '/' . $prefix . '/', '', $number, 1 ); |
|
|
|
|
|
|
813
|
|
|
|
|
814
|
|
|
$length = strlen( $number ); |
|
815
|
|
|
$postfix_pos = strrpos( $number, $postfix ); |
|
|
|
|
|
|
816
|
|
|
|
|
817
|
|
|
if ( false !== $postfix_pos ) { |
|
818
|
|
|
$number = substr_replace( $number, '', $postfix_pos, $length ); |
|
819
|
|
|
} |
|
820
|
|
|
|
|
821
|
|
|
$number = intval( $number ); |
|
822
|
|
|
|
|
823
|
|
|
return apply_filters( 'wpinv_clean_invoice_number', $number, $prefix, $postfix ); |
|
824
|
|
|
} |
|
825
|
|
|
|
|
826
|
|
|
function wpinv_update_invoice_number( $post_ID, $save_sequential = false, $type = '' ) { |
|
827
|
|
|
global $wpdb; |
|
828
|
|
|
|
|
829
|
|
|
$check = apply_filters( 'wpinv_pre_update_invoice_number', null, $post_ID, $save_sequential, $type ); |
|
830
|
|
|
if ( null !== $check ) { |
|
831
|
|
|
return $check; |
|
832
|
|
|
} |
|
833
|
|
|
|
|
834
|
|
|
if ( wpinv_sequential_number_active() ) { |
|
835
|
|
|
$number = wpinv_get_next_invoice_number(); |
|
836
|
|
|
|
|
837
|
|
|
if ( $save_sequential ) { |
|
838
|
|
|
update_option( 'wpinv_last_invoice_number', $number ); |
|
839
|
|
|
} |
|
840
|
|
|
} else { |
|
841
|
|
|
$number = $post_ID; |
|
842
|
|
|
} |
|
843
|
|
|
|
|
844
|
|
|
$number = wpinv_format_invoice_number( $number ); |
|
845
|
|
|
|
|
846
|
|
|
update_post_meta( $post_ID, '_wpinv_number', $number ); |
|
847
|
|
|
|
|
848
|
|
|
$wpdb->update( $wpdb->posts, array( 'post_title' => $number ), array( 'ID' => $post_ID ) ); |
|
849
|
|
|
|
|
850
|
|
|
clean_post_cache( $post_ID ); |
|
851
|
|
|
|
|
852
|
|
|
return $number; |
|
853
|
|
|
} |
|
854
|
|
|
|
|
855
|
|
|
function wpinv_post_name_prefix( $post_type = 'wpi_invoice' ) { |
|
856
|
|
|
return apply_filters( 'wpinv_post_name_prefix', 'inv-', $post_type ); |
|
857
|
|
|
} |
|
858
|
|
|
|
|
859
|
|
|
function wpinv_generate_post_name( $post_ID ) { |
|
860
|
|
|
$prefix = wpinv_post_name_prefix( get_post_type( $post_ID ) ); |
|
861
|
|
|
$post_name = sanitize_title( $prefix . $post_ID ); |
|
862
|
|
|
|
|
863
|
|
|
return apply_filters( 'wpinv_generate_post_name', $post_name, $post_ID, $prefix ); |
|
864
|
|
|
} |
|
865
|
|
|
|
|
866
|
|
|
/** |
|
867
|
|
|
* Checks if an invoice was viewed by the customer. |
|
868
|
|
|
* |
|
869
|
|
|
* @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
|
870
|
|
|
*/ |
|
871
|
|
|
function wpinv_is_invoice_viewed( $invoice ) { |
|
872
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
873
|
|
|
return (bool) $invoice->get_is_viewed(); |
|
874
|
|
|
} |
|
875
|
|
|
|
|
876
|
|
|
/** |
|
877
|
|
|
* Marks an invoice as viewed. |
|
878
|
|
|
* |
|
879
|
|
|
* @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object. |
|
880
|
|
|
*/ |
|
881
|
|
|
function getpaid_maybe_mark_invoice_as_viewed( $invoice ) { |
|
882
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
883
|
|
|
|
|
884
|
|
|
if ( get_current_user_id() == $invoice->get_user_id() && ! $invoice->get_is_viewed() ) { |
|
885
|
|
|
$invoice->set_is_viewed( true ); |
|
886
|
|
|
$invoice->save(); |
|
887
|
|
|
} |
|
888
|
|
|
|
|
889
|
|
|
} |
|
890
|
|
|
add_action( 'wpinv_invoice_print_before_display', 'getpaid_maybe_mark_invoice_as_viewed' ); |
|
891
|
|
|
add_action( 'wpinv_before_receipt', 'getpaid_maybe_mark_invoice_as_viewed' ); |
|
892
|
|
|
|
|
893
|
|
|
/** |
|
894
|
|
|
* Fetch a subscription given an invoice. |
|
895
|
|
|
* |
|
896
|
|
|
* @return WPInv_Subscription|bool |
|
897
|
|
|
*/ |
|
898
|
|
|
function wpinv_get_subscription( $invoice ) { |
|
899
|
|
|
|
|
900
|
|
|
// Abort if we do not have an invoice. |
|
901
|
|
|
if ( empty( $invoice ) ) { |
|
902
|
|
|
return false; |
|
903
|
|
|
} |
|
904
|
|
|
|
|
905
|
|
|
// Retrieve the invoice. |
|
906
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
907
|
|
|
|
|
908
|
|
|
// Ensure it is a recurring invoice. |
|
909
|
|
|
if ( ! $invoice->is_recurring() ) { |
|
910
|
|
|
return false; |
|
911
|
|
|
} |
|
912
|
|
|
|
|
913
|
|
|
// Fetch the subscription handler. |
|
914
|
|
|
$subs_db = new WPInv_Subscriptions_DB(); |
|
915
|
|
|
|
|
916
|
|
|
// Fetch the parent in case it is a renewal. |
|
917
|
|
|
if ( $invoice->is_renewal() ) { |
|
918
|
|
|
$subs = $subs_db->get_subscriptions( array( 'parent_payment_id' => $invoice->get_parent_id(), 'number' => 1 ) ); |
|
919
|
|
|
} else { |
|
920
|
|
|
$subs = $subs_db->get_subscriptions( array( 'parent_payment_id' => $invoice->get_id(), 'number' => 1 ) ); |
|
921
|
|
|
} |
|
922
|
|
|
|
|
923
|
|
|
// Return the subscription if it exists. |
|
924
|
|
|
if ( ! empty( $subs ) ) { |
|
925
|
|
|
return reset( $subs ); |
|
926
|
|
|
} |
|
927
|
|
|
|
|
928
|
|
|
return false; |
|
929
|
|
|
} |
|
930
|
|
|
|
|
931
|
|
|
/** |
|
932
|
|
|
* Processes an invoice refund. |
|
933
|
|
|
* |
|
934
|
|
|
* @param int $invoice_id |
|
935
|
|
|
* @param WPInv_Invoice $invoice |
|
936
|
|
|
* @param array $status_transition |
|
937
|
|
|
* @todo: descrease customer/store earnings |
|
938
|
|
|
*/ |
|
939
|
|
|
function getpaid_maybe_process_refund( $invoice_id, $invoice, $status_transition ) { |
|
940
|
|
|
|
|
941
|
|
|
if ( empty( $status_transition['from'] ) || ! in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ) ) ) { |
|
942
|
|
|
return; |
|
943
|
|
|
} |
|
944
|
|
|
|
|
945
|
|
|
$discount_code = $invoice->get_discount_code(); |
|
946
|
|
|
if ( ! empty( $discount_code ) ) { |
|
947
|
|
|
$discount = wpinv_get_discount_obj( $discount_code ); |
|
948
|
|
|
|
|
949
|
|
|
if ( $discount->exists() ) { |
|
950
|
|
|
$discount->increase_usage( -1 ); |
|
951
|
|
|
} |
|
952
|
|
|
|
|
953
|
|
|
} |
|
954
|
|
|
|
|
955
|
|
|
do_action( 'wpinv_pre_refund_invoice', $invoice, $invoice_id ); |
|
956
|
|
|
do_action( 'wpinv_refund_invoice', $invoice, $invoice_id ); |
|
957
|
|
|
do_action( 'wpinv_post_refund_invoice', $invoice, $invoice_id ); |
|
958
|
|
|
} |
|
959
|
|
|
add_action( 'getpaid_invoice_status_wpi-refunded', 'getpaid_maybe_process_refund', 10, 3 ); |
|
960
|
|
|
|
|
961
|
|
|
|
|
962
|
|
|
/** |
|
963
|
|
|
* Processes invoice payments. |
|
964
|
|
|
* |
|
965
|
|
|
* @param int $invoice_id |
|
966
|
|
|
*/ |
|
967
|
|
|
function getpaid_process_invoice_payment( $invoice_id ) { |
|
968
|
|
|
|
|
969
|
|
|
// Fetch the invoice. |
|
970
|
|
|
$invoice = new WPInv_Invoice( $invoice_id ); |
|
971
|
|
|
|
|
972
|
|
|
// We only want to do this once. |
|
973
|
|
|
if ( 1 == get_post_meta( $invoice_id, 'wpinv_processed_payment', true ) ) { |
|
974
|
|
|
return; |
|
975
|
|
|
} |
|
976
|
|
|
|
|
977
|
|
|
update_post_meta( $invoice_id, 'wpinv_processed_payment', 1 ); |
|
978
|
|
|
|
|
979
|
|
|
// Fires when processing a payment. |
|
980
|
|
|
do_action( 'getpaid_process_payment', $invoice ); |
|
981
|
|
|
|
|
982
|
|
|
// Fire an action for each invoice item. |
|
983
|
|
|
foreach( $invoice->get_items() as $item ) { |
|
984
|
|
|
do_action( 'getpaid_process_item_payment', $item, $invoice ); |
|
985
|
|
|
} |
|
986
|
|
|
|
|
987
|
|
|
// Increase discount usage. |
|
988
|
|
|
$discount_code = $invoice->get_discount_code(); |
|
989
|
|
|
if ( ! empty( $discount_code ) ) { |
|
990
|
|
|
$discount = wpinv_get_discount_obj( $discount_code ); |
|
991
|
|
|
|
|
992
|
|
|
if ( $discount->exists() ) { |
|
993
|
|
|
$discount->increase_usage(); |
|
994
|
|
|
} |
|
995
|
|
|
|
|
996
|
|
|
} |
|
997
|
|
|
|
|
998
|
|
|
// Record reverse vat. |
|
999
|
|
|
if ( 'invoice' == $invoice->get_type() && wpinv_use_taxes() && ! $invoice->get_disable_taxes() ) { |
|
1000
|
|
|
|
|
1001
|
|
|
if ( WPInv_EUVat::same_country_rule() == 'no' && wpinv_is_base_country( $invoice->get_country() ) ) { |
|
1002
|
|
|
$invoice->add_note( __( 'VAT was reverse charged', 'invoicing' ), false, false, true ); |
|
1003
|
|
|
} |
|
1004
|
|
|
|
|
1005
|
|
|
} |
|
1006
|
|
|
|
|
1007
|
|
|
} |
|
1008
|
|
|
add_action( 'getpaid_invoice_payment_status_changed', 'getpaid_process_invoice_payment' ); |
|
1009
|
|
|
|
|
1010
|
|
|
/** |
|
1011
|
|
|
* Returns an array of invoice item columns |
|
1012
|
|
|
* |
|
1013
|
|
|
* @param int|WPInv_Invoice $invoice |
|
1014
|
|
|
* @return array |
|
1015
|
|
|
*/ |
|
1016
|
|
|
function getpaid_invoice_item_columns( $invoice ) { |
|
1017
|
|
|
|
|
1018
|
|
|
// Prepare the invoice. |
|
1019
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
1020
|
|
|
|
|
1021
|
|
|
// Abort if there is no invoice. |
|
1022
|
|
|
if ( 0 == $invoice->get_id() ) { |
|
1023
|
|
|
return array(); |
|
1024
|
|
|
} |
|
1025
|
|
|
|
|
1026
|
|
|
// Line item columns. |
|
1027
|
|
|
$columns = apply_filters( |
|
1028
|
|
|
'getpaid_invoice_item_columns', |
|
1029
|
|
|
array( |
|
1030
|
|
|
'name' => __( 'Item', 'invoicing' ), |
|
1031
|
|
|
'price' => __( 'Price', 'invoicing' ), |
|
1032
|
|
|
'quantity' => __( 'Quantity', 'invoicing' ), |
|
1033
|
|
|
'subtotal' => __( 'Subtotal', 'invoicing' ), |
|
1034
|
|
|
), |
|
1035
|
|
|
$invoice |
|
1036
|
|
|
); |
|
1037
|
|
|
|
|
1038
|
|
|
// Quantities. |
|
1039
|
|
|
if ( isset( $columns[ 'quantity' ] ) ) { |
|
1040
|
|
|
|
|
1041
|
|
|
if ( 'hours' == $invoice->get_template() ) { |
|
1042
|
|
|
$columns[ 'quantity' ] = __( 'Hours', 'invoicing' ); |
|
1043
|
|
|
} |
|
1044
|
|
|
|
|
1045
|
|
|
if ( ! wpinv_item_quantities_enabled() || 'amount' == $invoice->get_template() ) { |
|
1046
|
|
|
unset( $columns[ 'quantity' ] ); |
|
1047
|
|
|
} |
|
1048
|
|
|
|
|
1049
|
|
|
} |
|
1050
|
|
|
|
|
1051
|
|
|
|
|
1052
|
|
|
// Price. |
|
1053
|
|
|
if ( isset( $columns[ 'price' ] ) ) { |
|
1054
|
|
|
|
|
1055
|
|
|
if ( 'amount' == $invoice->get_template() ) { |
|
1056
|
|
|
$columns[ 'price' ] = __( 'Amount', 'invoicing' ); |
|
1057
|
|
|
} |
|
1058
|
|
|
|
|
1059
|
|
|
if ( 'hours' == $invoice->get_template() ) { |
|
1060
|
|
|
$columns[ 'price' ] = __( 'Rate', 'invoicing' ); |
|
1061
|
|
|
} |
|
1062
|
|
|
|
|
1063
|
|
|
} |
|
1064
|
|
|
|
|
1065
|
|
|
|
|
1066
|
|
|
// Sub total. |
|
1067
|
|
|
if ( isset( $columns[ 'subtotal' ] ) ) { |
|
1068
|
|
|
|
|
1069
|
|
|
if ( 'amount' == $invoice->get_template() ) { |
|
1070
|
|
|
unset( $columns[ 'subtotal' ] ); |
|
1071
|
|
|
} |
|
1072
|
|
|
|
|
1073
|
|
|
} |
|
1074
|
|
|
|
|
1075
|
|
|
return $columns; |
|
1076
|
|
|
} |
|
1077
|
|
|
|
|
1078
|
|
|
/** |
|
1079
|
|
|
* Returns an array of invoice totals rows |
|
1080
|
|
|
* |
|
1081
|
|
|
* @param int|WPInv_Invoice $invoice |
|
1082
|
|
|
* @return array |
|
1083
|
|
|
*/ |
|
1084
|
|
|
function getpaid_invoice_totals_rows( $invoice ) { |
|
1085
|
|
|
|
|
1086
|
|
|
// Prepare the invoice. |
|
1087
|
|
|
$invoice = new WPInv_Invoice( $invoice ); |
|
1088
|
|
|
|
|
1089
|
|
|
// Abort if there is no invoice. |
|
1090
|
|
|
if ( 0 == $invoice->get_id() ) { |
|
1091
|
|
|
return array(); |
|
1092
|
|
|
} |
|
1093
|
|
|
|
|
1094
|
|
|
$totals = apply_filters( |
|
1095
|
|
|
'getpaid_invoice_totals_rows', |
|
1096
|
|
|
array( |
|
1097
|
|
|
'subtotal' => __( 'Subtotal', 'invoicing' ), |
|
1098
|
|
|
'tax' => __( 'Tax', 'invoicing' ), |
|
1099
|
|
|
'discount' => __( 'Discount', 'invoicing' ), |
|
1100
|
|
|
'total' => __( 'Total', 'invoicing' ), |
|
1101
|
|
|
), |
|
1102
|
|
|
$invoice |
|
1103
|
|
|
); |
|
1104
|
|
|
|
|
1105
|
|
|
if ( ( $invoice->get_disable_taxes() || ! wpinv_use_taxes() ) && isset( $totals['tax'] ) ) { |
|
1106
|
|
|
unset( $totals['tax'] ); |
|
1107
|
|
|
} |
|
1108
|
|
|
|
|
1109
|
|
|
return $totals; |
|
1110
|
|
|
} |
|
1111
|
|
|
|
|
1112
|
|
|
/** |
|
1113
|
|
|
* This function is called whenever an invoice is created. |
|
1114
|
|
|
* |
|
1115
|
|
|
* @param int $invoice_id |
|
1116
|
|
|
* @param WPInv_Invoice $invoice |
|
1117
|
|
|
*/ |
|
1118
|
|
|
function getpaid_new_invoice( $invoice_id, $invoice ) { |
|
|
|
|
|
|
1119
|
|
|
|
|
1120
|
|
|
if ( ! $invoice->get_status() ) { |
|
1121
|
|
|
return; |
|
1122
|
|
|
} |
|
1123
|
|
|
|
|
1124
|
|
|
// Add an invoice created note. |
|
1125
|
|
|
$invoice->add_note( |
|
1126
|
|
|
wp_sprintf( |
|
1127
|
|
|
__( 'Invoice created with the status "%s".', 'invoicing' ), |
|
1128
|
|
|
wpinv_status_nicename( $invoice->get_status() ) |
|
1129
|
|
|
) |
|
1130
|
|
|
); |
|
1131
|
|
|
|
|
1132
|
|
|
} |
|
1133
|
|
|
add_action( 'getpaid_new_invoice', 'getpaid_new_invoice', 10, 2 ); |
|
1134
|
|
|
|
|
1135
|
|
|
/** |
|
1136
|
|
|
* This function updates invoice caches. |
|
1137
|
|
|
* |
|
1138
|
|
|
* @param int $invoice_id |
|
1139
|
|
|
* @param WPInv_Invoice $invoice |
|
1140
|
|
|
*/ |
|
1141
|
|
|
function getpaid_update_invoice_caches( $invoice_id, $invoice ) { |
|
1142
|
|
|
|
|
1143
|
|
|
// Cache invoice number. |
|
1144
|
|
|
wp_cache_set( $invoice->get_number(), $invoice_id, "getpaid_invoice_numbers_to_invoice_ids" ); |
|
1145
|
|
|
|
|
1146
|
|
|
// Cache invoice key. |
|
1147
|
|
|
wp_cache_set( $invoice->get_key(), $invoice_id, "getpaid_invoice_keys_to_invoice_ids" ); |
|
1148
|
|
|
|
|
1149
|
|
|
// (Maybe) cache transaction id. |
|
1150
|
|
|
$transaction_id = $invoice->get_transaction_id(); |
|
1151
|
|
|
|
|
1152
|
|
|
if ( ! empty( $transaction_id ) ) { |
|
1153
|
|
|
wp_cache_set( $transaction_id, $invoice_id, "getpaid_invoice_transaction_ids_to_invoice_ids" ); |
|
1154
|
|
|
} |
|
1155
|
|
|
|
|
1156
|
|
|
} |
|
1157
|
|
|
add_action( 'getpaid_new_invoice', 'getpaid_update_invoice_caches', 5, 2 ); |
|
1158
|
|
|
add_action( 'getpaid_update_invoice', 'getpaid_update_invoice_caches', 5, 2 ); |
|
1159
|
|
|
|
AyeCode /
invoicing
Loading history...
This check looks for parameters that have been defined for a function or method, but which are not used in the method body.