@@ -13,72 +13,72 @@ discard block |
||
13 | 13 | class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'paypal'; |
21 | 21 | |
22 | 22 | /** |
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | 27 | protected $supports = array( 'subscription', 'sandbox' ); |
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | 34 | public $order = 1; |
35 | 35 | |
36 | 36 | /** |
37 | - * Stores line items to send to PayPal. |
|
38 | - * |
|
39 | - * @var array |
|
40 | - */ |
|
37 | + * Stores line items to send to PayPal. |
|
38 | + * |
|
39 | + * @var array |
|
40 | + */ |
|
41 | 41 | protected $line_items = array(); |
42 | 42 | |
43 | 43 | /** |
44 | - * Endpoint for requests from PayPal. |
|
45 | - * |
|
46 | - * @var string |
|
47 | - */ |
|
48 | - protected $notify_url; |
|
44 | + * Endpoint for requests from PayPal. |
|
45 | + * |
|
46 | + * @var string |
|
47 | + */ |
|
48 | + protected $notify_url; |
|
49 | 49 | |
50 | - /** |
|
51 | - * Endpoint for requests to PayPal. |
|
52 | - * |
|
53 | - * @var string |
|
54 | - */ |
|
50 | + /** |
|
51 | + * Endpoint for requests to PayPal. |
|
52 | + * |
|
53 | + * @var string |
|
54 | + */ |
|
55 | 55 | protected $endpoint; |
56 | 56 | |
57 | 57 | /** |
58 | - * Currencies this gateway is allowed for. |
|
59 | - * |
|
60 | - * @var array |
|
61 | - */ |
|
62 | - public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' ); |
|
58 | + * Currencies this gateway is allowed for. |
|
59 | + * |
|
60 | + * @var array |
|
61 | + */ |
|
62 | + public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' ); |
|
63 | 63 | |
64 | 64 | /** |
65 | - * URL to view a transaction. |
|
66 | - * |
|
67 | - * @var string |
|
68 | - */ |
|
65 | + * URL to view a transaction. |
|
66 | + * |
|
67 | + * @var string |
|
68 | + */ |
|
69 | 69 | public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s'; |
70 | 70 | |
71 | 71 | /** |
72 | - * URL to view a subscription. |
|
73 | - * |
|
74 | - * @var string |
|
75 | - */ |
|
76 | - public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s'; |
|
72 | + * URL to view a subscription. |
|
73 | + * |
|
74 | + * @var string |
|
75 | + */ |
|
76 | + public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s'; |
|
77 | 77 | |
78 | 78 | /** |
79 | - * Class constructor. |
|
80 | - */ |
|
81 | - public function __construct() { |
|
79 | + * Class constructor. |
|
80 | + */ |
|
81 | + public function __construct() { |
|
82 | 82 | |
83 | 83 | $this->title = __( 'PayPal Standard', 'invoicing' ); |
84 | 84 | $this->method_title = __( 'PayPal Standard', 'invoicing' ); |
@@ -92,15 +92,15 @@ discard block |
||
92 | 92 | } |
93 | 93 | |
94 | 94 | /** |
95 | - * Process Payment. |
|
96 | - * |
|
97 | - * |
|
98 | - * @param WPInv_Invoice $invoice Invoice. |
|
99 | - * @param array $submission_data Posted checkout fields. |
|
100 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
101 | - * @return array |
|
102 | - */ |
|
103 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
95 | + * Process Payment. |
|
96 | + * |
|
97 | + * |
|
98 | + * @param WPInv_Invoice $invoice Invoice. |
|
99 | + * @param array $submission_data Posted checkout fields. |
|
100 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
101 | + * @return array |
|
102 | + */ |
|
103 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
104 | 104 | |
105 | 105 | // Get redirect url. |
106 | 106 | $paypal_redirect = $this->get_request_url( $invoice ); |
@@ -123,15 +123,15 @@ discard block |
||
123 | 123 | } |
124 | 124 | |
125 | 125 | /** |
126 | - * Get the PayPal request URL for an invoice. |
|
127 | - * |
|
128 | - * @param WPInv_Invoice $invoice Invoice object. |
|
129 | - * @return string |
|
130 | - */ |
|
131 | - public function get_request_url( $invoice ) { |
|
126 | + * Get the PayPal request URL for an invoice. |
|
127 | + * |
|
128 | + * @param WPInv_Invoice $invoice Invoice object. |
|
129 | + * @return string |
|
130 | + */ |
|
131 | + public function get_request_url( $invoice ) { |
|
132 | 132 | |
133 | 133 | // Endpoint for this request |
134 | - $this->endpoint = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?'; |
|
134 | + $this->endpoint = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?'; |
|
135 | 135 | |
136 | 136 | // Retrieve paypal args. |
137 | 137 | $paypal_args = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' ); |
@@ -144,44 +144,44 @@ discard block |
||
144 | 144 | |
145 | 145 | return add_query_arg( $paypal_args, $this->endpoint ); |
146 | 146 | |
147 | - } |
|
147 | + } |
|
148 | 148 | |
149 | 149 | /** |
150 | - * Get PayPal Args for passing to PP. |
|
151 | - * |
|
152 | - * @param WPInv_Invoice $invoice Invoice object. |
|
153 | - * @return array |
|
154 | - */ |
|
155 | - protected function get_paypal_args( $invoice ) { |
|
150 | + * Get PayPal Args for passing to PP. |
|
151 | + * |
|
152 | + * @param WPInv_Invoice $invoice Invoice object. |
|
153 | + * @return array |
|
154 | + */ |
|
155 | + protected function get_paypal_args( $invoice ) { |
|
156 | 156 | |
157 | 157 | // Whether or not to send the line items as one item. |
158 | - $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice ); |
|
159 | - |
|
160 | - if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) { |
|
161 | - $force_one_line_item = true; |
|
162 | - } |
|
163 | - |
|
164 | - $paypal_args = apply_filters( |
|
165 | - 'getpaid_paypal_args', |
|
166 | - array_merge( |
|
167 | - $this->get_transaction_args( $invoice ), |
|
168 | - $this->get_line_item_args( $invoice, $force_one_line_item ) |
|
169 | - ), |
|
170 | - $invoice |
|
171 | - ); |
|
172 | - |
|
173 | - return $this->fix_request_length( $invoice, $paypal_args ); |
|
158 | + $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', false, $invoice ); |
|
159 | + |
|
160 | + if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) { |
|
161 | + $force_one_line_item = true; |
|
162 | + } |
|
163 | + |
|
164 | + $paypal_args = apply_filters( |
|
165 | + 'getpaid_paypal_args', |
|
166 | + array_merge( |
|
167 | + $this->get_transaction_args( $invoice ), |
|
168 | + $this->get_line_item_args( $invoice, $force_one_line_item ) |
|
169 | + ), |
|
170 | + $invoice |
|
171 | + ); |
|
172 | + |
|
173 | + return $this->fix_request_length( $invoice, $paypal_args ); |
|
174 | 174 | } |
175 | 175 | |
176 | 176 | /** |
177 | - * Get transaction args for paypal request. |
|
178 | - * |
|
179 | - * @param WPInv_Invoice $invoice Invoice object. |
|
180 | - * @return array |
|
181 | - */ |
|
182 | - protected function get_transaction_args( $invoice ) { |
|
177 | + * Get transaction args for paypal request. |
|
178 | + * |
|
179 | + * @param WPInv_Invoice $invoice Invoice object. |
|
180 | + * @return array |
|
181 | + */ |
|
182 | + protected function get_transaction_args( $invoice ) { |
|
183 | 183 | |
184 | - return array( |
|
184 | + return array( |
|
185 | 185 | 'cmd' => '_cart', |
186 | 186 | 'business' => wpinv_get_option( 'paypal_email', false ), |
187 | 187 | 'no_shipping' => '1', |
@@ -206,16 +206,16 @@ discard block |
||
206 | 206 | } |
207 | 207 | |
208 | 208 | /** |
209 | - * Get line item args for paypal request. |
|
210 | - * |
|
211 | - * @param WPInv_Invoice $invoice Invoice object. |
|
212 | - * @param bool $force_one_line_item Create only one item for this invoice. |
|
213 | - * @return array |
|
214 | - */ |
|
215 | - protected function get_line_item_args( $invoice, $force_one_line_item = false ) { |
|
209 | + * Get line item args for paypal request. |
|
210 | + * |
|
211 | + * @param WPInv_Invoice $invoice Invoice object. |
|
212 | + * @param bool $force_one_line_item Create only one item for this invoice. |
|
213 | + * @return array |
|
214 | + */ |
|
215 | + protected function get_line_item_args( $invoice, $force_one_line_item = false ) { |
|
216 | 216 | |
217 | 217 | // Maybe send invoice as a single item. |
218 | - if ( $force_one_line_item ) { |
|
218 | + if ( $force_one_line_item ) { |
|
219 | 219 | return $this->get_line_item_args_single_item( $invoice ); |
220 | 220 | } |
221 | 221 | |
@@ -235,129 +235,129 @@ discard block |
||
235 | 235 | $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 ); |
236 | 236 | } |
237 | 237 | |
238 | - return array_merge( $line_item_args, $this->get_line_items() ); |
|
238 | + return array_merge( $line_item_args, $this->get_line_items() ); |
|
239 | 239 | |
240 | 240 | } |
241 | 241 | |
242 | 242 | /** |
243 | - * Get line item args for paypal request as a single line item. |
|
244 | - * |
|
245 | - * @param WPInv_Invoice $invoice Invoice object. |
|
246 | - * @return array |
|
247 | - */ |
|
248 | - protected function get_line_item_args_single_item( $invoice ) { |
|
249 | - $this->delete_line_items(); |
|
243 | + * Get line item args for paypal request as a single line item. |
|
244 | + * |
|
245 | + * @param WPInv_Invoice $invoice Invoice object. |
|
246 | + * @return array |
|
247 | + */ |
|
248 | + protected function get_line_item_args_single_item( $invoice ) { |
|
249 | + $this->delete_line_items(); |
|
250 | 250 | |
251 | 251 | $item_name = sprintf( __( 'Invoice #%s', 'invoicing' ), $invoice->get_number() ); |
252 | - $this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() ); |
|
252 | + $this->add_line_item( $item_name, 1, wpinv_sanitize_amount( (float) $invoice->get_total(), 2 ), $invoice->get_id() ); |
|
253 | 253 | |
254 | - return $this->get_line_items(); |
|
254 | + return $this->get_line_items(); |
|
255 | 255 | } |
256 | 256 | |
257 | 257 | /** |
258 | - * Return all line items. |
|
259 | - */ |
|
260 | - protected function get_line_items() { |
|
261 | - return $this->line_items; |
|
262 | - } |
|
258 | + * Return all line items. |
|
259 | + */ |
|
260 | + protected function get_line_items() { |
|
261 | + return $this->line_items; |
|
262 | + } |
|
263 | 263 | |
264 | 264 | /** |
265 | - * Remove all line items. |
|
266 | - */ |
|
267 | - protected function delete_line_items() { |
|
268 | - $this->line_items = array(); |
|
265 | + * Remove all line items. |
|
266 | + */ |
|
267 | + protected function delete_line_items() { |
|
268 | + $this->line_items = array(); |
|
269 | 269 | } |
270 | 270 | |
271 | 271 | /** |
272 | - * Prepare line items to send to paypal. |
|
273 | - * |
|
274 | - * @param WPInv_Invoice $invoice Invoice object. |
|
275 | - */ |
|
276 | - protected function prepare_line_items( $invoice ) { |
|
277 | - $this->delete_line_items(); |
|
278 | - |
|
279 | - // Items. |
|
280 | - foreach ( $invoice->get_items() as $item ) { |
|
281 | - $amount = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total(); |
|
282 | - $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity(); |
|
283 | - $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() ); |
|
272 | + * Prepare line items to send to paypal. |
|
273 | + * |
|
274 | + * @param WPInv_Invoice $invoice Invoice object. |
|
275 | + */ |
|
276 | + protected function prepare_line_items( $invoice ) { |
|
277 | + $this->delete_line_items(); |
|
278 | + |
|
279 | + // Items. |
|
280 | + foreach ( $invoice->get_items() as $item ) { |
|
281 | + $amount = $invoice->get_template() == 'amount' ? $item->get_price() : $item->get_sub_total(); |
|
282 | + $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity(); |
|
283 | + $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() ); |
|
284 | 284 | } |
285 | 285 | |
286 | 286 | // Fees. |
287 | - foreach ( $invoice->get_fees() as $fee => $data ) { |
|
287 | + foreach ( $invoice->get_fees() as $fee => $data ) { |
|
288 | 288 | $this->add_line_item( $fee, 1, $data['amount'] ); |
289 | 289 | } |
290 | 290 | |
291 | 291 | } |
292 | 292 | |
293 | 293 | /** |
294 | - * Add PayPal Line Item. |
|
295 | - * |
|
296 | - * @param string $item_name Item name. |
|
297 | - * @param int $quantity Item quantity. |
|
298 | - * @param float $amount Amount. |
|
299 | - * @param string $item_number Item number. |
|
300 | - */ |
|
301 | - protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) { |
|
302 | - $index = ( count( $this->line_items ) / 4 ) + 1; |
|
303 | - |
|
304 | - $item = apply_filters( |
|
305 | - 'getpaid_paypal_line_item', |
|
306 | - array( |
|
307 | - 'item_name' => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ), |
|
308 | - 'quantity' => (int) $quantity, |
|
309 | - 'amount' => wpinv_sanitize_amount( (float) $amount, 2 ), |
|
310 | - 'item_number' => $item_number, |
|
311 | - ), |
|
312 | - $item_name, |
|
313 | - $quantity, |
|
314 | - $amount, |
|
315 | - $item_number |
|
316 | - ); |
|
317 | - |
|
318 | - $this->line_items[ 'item_name_' . $index ] = getpaid_limit_length( $item['item_name'], 127 ); |
|
294 | + * Add PayPal Line Item. |
|
295 | + * |
|
296 | + * @param string $item_name Item name. |
|
297 | + * @param int $quantity Item quantity. |
|
298 | + * @param float $amount Amount. |
|
299 | + * @param string $item_number Item number. |
|
300 | + */ |
|
301 | + protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) { |
|
302 | + $index = ( count( $this->line_items ) / 4 ) + 1; |
|
303 | + |
|
304 | + $item = apply_filters( |
|
305 | + 'getpaid_paypal_line_item', |
|
306 | + array( |
|
307 | + 'item_name' => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ), |
|
308 | + 'quantity' => (int) $quantity, |
|
309 | + 'amount' => wpinv_sanitize_amount( (float) $amount, 2 ), |
|
310 | + 'item_number' => $item_number, |
|
311 | + ), |
|
312 | + $item_name, |
|
313 | + $quantity, |
|
314 | + $amount, |
|
315 | + $item_number |
|
316 | + ); |
|
317 | + |
|
318 | + $this->line_items[ 'item_name_' . $index ] = getpaid_limit_length( $item['item_name'], 127 ); |
|
319 | 319 | $this->line_items[ 'quantity_' . $index ] = $item['quantity']; |
320 | 320 | |
321 | 321 | // The price or amount of the product, service, or contribution, not including shipping, handling, or tax. |
322 | - $this->line_items[ 'amount_' . $index ] = $item['amount']; |
|
323 | - $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 ); |
|
322 | + $this->line_items[ 'amount_' . $index ] = $item['amount']; |
|
323 | + $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 ); |
|
324 | 324 | } |
325 | 325 | |
326 | 326 | /** |
327 | - * If the default request with line items is too long, generate a new one with only one line item. |
|
328 | - * |
|
329 | - * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer. |
|
330 | - * |
|
331 | - * @param WPInv_Invoice $invoice Invoice to be sent to Paypal. |
|
332 | - * @param array $paypal_args Arguments sent to Paypal in the request. |
|
333 | - * @return array |
|
334 | - */ |
|
335 | - protected function fix_request_length( $invoice, $paypal_args ) { |
|
336 | - $max_paypal_length = 2083; |
|
337 | - $query_candidate = http_build_query( $paypal_args, '', '&' ); |
|
338 | - |
|
339 | - if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) { |
|
340 | - return $paypal_args; |
|
341 | - } |
|
342 | - |
|
343 | - return apply_filters( |
|
344 | - 'getpaid_paypal_args', |
|
345 | - array_merge( |
|
346 | - $this->get_transaction_args( $invoice ), |
|
347 | - $this->get_line_item_args( $invoice, true ) |
|
348 | - ), |
|
349 | - $invoice |
|
350 | - ); |
|
327 | + * If the default request with line items is too long, generate a new one with only one line item. |
|
328 | + * |
|
329 | + * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer. |
|
330 | + * |
|
331 | + * @param WPInv_Invoice $invoice Invoice to be sent to Paypal. |
|
332 | + * @param array $paypal_args Arguments sent to Paypal in the request. |
|
333 | + * @return array |
|
334 | + */ |
|
335 | + protected function fix_request_length( $invoice, $paypal_args ) { |
|
336 | + $max_paypal_length = 2083; |
|
337 | + $query_candidate = http_build_query( $paypal_args, '', '&' ); |
|
338 | + |
|
339 | + if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) { |
|
340 | + return $paypal_args; |
|
341 | + } |
|
342 | + |
|
343 | + return apply_filters( |
|
344 | + 'getpaid_paypal_args', |
|
345 | + array_merge( |
|
346 | + $this->get_transaction_args( $invoice ), |
|
347 | + $this->get_line_item_args( $invoice, true ) |
|
348 | + ), |
|
349 | + $invoice |
|
350 | + ); |
|
351 | 351 | |
352 | 352 | } |
353 | 353 | |
354 | 354 | /** |
355 | - * Processes recurring invoices. |
|
356 | - * |
|
357 | - * @param array $paypal_args PayPal args. |
|
358 | - * @param WPInv_Invoice $invoice Invoice object. |
|
359 | - */ |
|
360 | - public function process_subscription( $paypal_args, $invoice ) { |
|
355 | + * Processes recurring invoices. |
|
356 | + * |
|
357 | + * @param array $paypal_args PayPal args. |
|
358 | + * @param WPInv_Invoice $invoice Invoice object. |
|
359 | + */ |
|
360 | + public function process_subscription( $paypal_args, $invoice ) { |
|
361 | 361 | |
362 | 362 | // Make sure this is a subscription. |
363 | 363 | if ( ! $invoice->is_recurring() || ! $subscription = wpinv_get_subscription( $invoice ) ) { |
@@ -382,11 +382,11 @@ discard block |
||
382 | 382 | |
383 | 383 | $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount; |
384 | 384 | |
385 | - // Trial period length. |
|
386 | - $paypal_args['p1'] = $subscription_item->get_trial_interval(); |
|
385 | + // Trial period length. |
|
386 | + $paypal_args['p1'] = $subscription_item->get_trial_interval(); |
|
387 | 387 | |
388 | - // Trial period. |
|
389 | - $paypal_args['t1'] = $subscription_item->get_trial_period(); |
|
388 | + // Trial period. |
|
389 | + $paypal_args['t1'] = $subscription_item->get_trial_period(); |
|
390 | 390 | |
391 | 391 | } else if ( $initial_amount != $recurring_amount ) { |
392 | 392 | |
@@ -409,40 +409,40 @@ discard block |
||
409 | 409 | } |
410 | 410 | |
411 | 411 | // We have a recurring payment |
412 | - if ( ! isset( $param_number ) || 1 == $param_number ) { |
|
412 | + if ( ! isset( $param_number ) || 1 == $param_number ) { |
|
413 | 413 | |
414 | - // Subscription price |
|
415 | - $paypal_args['a3'] = $recurring_amount; |
|
414 | + // Subscription price |
|
415 | + $paypal_args['a3'] = $recurring_amount; |
|
416 | 416 | |
417 | - // Subscription duration |
|
418 | - $paypal_args['p3'] = $interval; |
|
417 | + // Subscription duration |
|
418 | + $paypal_args['p3'] = $interval; |
|
419 | 419 | |
420 | - // Subscription period |
|
421 | - $paypal_args['t3'] = $period; |
|
420 | + // Subscription period |
|
421 | + $paypal_args['t3'] = $period; |
|
422 | 422 | |
423 | 423 | } |
424 | 424 | |
425 | 425 | // Recurring payments |
426 | - if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) { |
|
426 | + if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) { |
|
427 | 427 | |
428 | - // Non-recurring payments |
|
429 | - $paypal_args['src'] = 0; |
|
428 | + // Non-recurring payments |
|
429 | + $paypal_args['src'] = 0; |
|
430 | 430 | |
431 | - } else { |
|
431 | + } else { |
|
432 | 432 | |
433 | - $paypal_args['src'] = 1; |
|
433 | + $paypal_args['src'] = 1; |
|
434 | 434 | |
435 | - if ( $bill_times > 0 ) { |
|
435 | + if ( $bill_times > 0 ) { |
|
436 | 436 | |
437 | - // An initial period is being used to charge a sign-up fee |
|
438 | - if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) { |
|
439 | - $bill_times--; |
|
440 | - } |
|
437 | + // An initial period is being used to charge a sign-up fee |
|
438 | + if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) { |
|
439 | + $bill_times--; |
|
440 | + } |
|
441 | 441 | |
442 | 442 | // Make sure it's not over the max of 52 |
443 | 443 | $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 ); |
444 | 444 | |
445 | - } |
|
445 | + } |
|
446 | 446 | } |
447 | 447 | |
448 | 448 | // Force return URL so that order description & instructions display |
@@ -458,24 +458,24 @@ discard block |
||
458 | 458 | } |
459 | 459 | |
460 | 460 | return apply_filters( |
461 | - 'getpaid_paypal_subscription_args', |
|
462 | - $paypal_args, |
|
463 | - $invoice |
|
461 | + 'getpaid_paypal_subscription_args', |
|
462 | + $paypal_args, |
|
463 | + $invoice |
|
464 | 464 | ); |
465 | 465 | |
466 | 466 | } |
467 | 467 | |
468 | 468 | /** |
469 | - * Processes ipns and marks payments as complete. |
|
470 | - * |
|
471 | - * @return void |
|
472 | - */ |
|
473 | - public function verify_ipn() { |
|
469 | + * Processes ipns and marks payments as complete. |
|
470 | + * |
|
471 | + * @return void |
|
472 | + */ |
|
473 | + public function verify_ipn() { |
|
474 | 474 | |
475 | 475 | // Validate the IPN. |
476 | 476 | if ( empty( $_POST ) || ! $this->validate_ipn() ) { |
477 | - wp_die( 'PayPal IPN Request Failure', 'PayPal IPN', array( 'response' => 500 ) ); |
|
478 | - } |
|
477 | + wp_die( 'PayPal IPN Request Failure', 'PayPal IPN', array( 'response' => 500 ) ); |
|
478 | + } |
|
479 | 479 | |
480 | 480 | // Process the IPN. |
481 | 481 | $posted = wp_unslash( $_POST ); |
@@ -483,13 +483,13 @@ discard block |
||
483 | 483 | |
484 | 484 | if ( $invoice && $this->id == $invoice->get_gateway() ) { |
485 | 485 | |
486 | - $posted['payment_status'] = strtolower( $posted['payment_status'] ); |
|
486 | + $posted['payment_status'] = strtolower( $posted['payment_status'] ); |
|
487 | 487 | |
488 | 488 | wpinv_error_log( 'Found invoice #' . $invoice->get_number() ); |
489 | 489 | wpinv_error_log( 'Payment status:' . $posted['payment_status'] ); |
490 | 490 | |
491 | - if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) { |
|
492 | - call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted ); |
|
491 | + if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) { |
|
492 | + call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted ); |
|
493 | 493 | } else { |
494 | 494 | wpinv_error_log( 'Aborting, Invalid type:' . $posted['txn_type'] ); |
495 | 495 | } |
@@ -501,33 +501,33 @@ discard block |
||
501 | 501 | } |
502 | 502 | |
503 | 503 | /** |
504 | - * Check PayPal IPN validity. |
|
505 | - */ |
|
506 | - public function validate_ipn() { |
|
507 | - |
|
508 | - wpinv_error_log( 'Validating PayPal IPN response' ); |
|
509 | - |
|
510 | - // Get received values from post data. |
|
511 | - $validate_ipn = wp_unslash( $_POST ); |
|
512 | - $validate_ipn['cmd'] = '_notify-validate'; |
|
513 | - |
|
514 | - // Send back post vars to paypal. |
|
515 | - $params = array( |
|
516 | - 'body' => $validate_ipn, |
|
517 | - 'timeout' => 60, |
|
518 | - 'httpversion' => '1.1', |
|
519 | - 'compress' => false, |
|
520 | - 'decompress' => false, |
|
521 | - 'user-agent' => 'GetPaid/' . WPINV_VERSION, |
|
522 | - ); |
|
504 | + * Check PayPal IPN validity. |
|
505 | + */ |
|
506 | + public function validate_ipn() { |
|
507 | + |
|
508 | + wpinv_error_log( 'Validating PayPal IPN response' ); |
|
509 | + |
|
510 | + // Get received values from post data. |
|
511 | + $validate_ipn = wp_unslash( $_POST ); |
|
512 | + $validate_ipn['cmd'] = '_notify-validate'; |
|
513 | + |
|
514 | + // Send back post vars to paypal. |
|
515 | + $params = array( |
|
516 | + 'body' => $validate_ipn, |
|
517 | + 'timeout' => 60, |
|
518 | + 'httpversion' => '1.1', |
|
519 | + 'compress' => false, |
|
520 | + 'decompress' => false, |
|
521 | + 'user-agent' => 'GetPaid/' . WPINV_VERSION, |
|
522 | + ); |
|
523 | 523 | |
524 | - // Post back to get a response. |
|
525 | - $response = wp_safe_remote_post( $this->is_sandbox() ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params ); |
|
524 | + // Post back to get a response. |
|
525 | + $response = wp_safe_remote_post( $this->is_sandbox() ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params ); |
|
526 | 526 | |
527 | 527 | // Check to see if the request was valid. |
528 | - if ( ! is_wp_error( $response ) && $response['response']['code'] >= 200 && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) { |
|
528 | + if ( ! is_wp_error( $response ) && $response['response']['code'] >= 200 && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) { |
|
529 | 529 | wpinv_error_log( $response['body'], 'Received valid response from PayPal IPN' ); |
530 | - return true; |
|
530 | + return true; |
|
531 | 531 | } |
532 | 532 | |
533 | 533 | if ( is_wp_error( $response ) ) { |
@@ -541,63 +541,63 @@ discard block |
||
541 | 541 | } |
542 | 542 | |
543 | 543 | /** |
544 | - * Check currency from IPN matches the invoice. |
|
545 | - * |
|
546 | - * @param WPInv_Invoice $invoice Invoice object. |
|
547 | - * @param string $currency currency to validate. |
|
548 | - */ |
|
549 | - protected function validate_ipn_currency( $invoice, $currency ) { |
|
550 | - if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) { |
|
544 | + * Check currency from IPN matches the invoice. |
|
545 | + * |
|
546 | + * @param WPInv_Invoice $invoice Invoice object. |
|
547 | + * @param string $currency currency to validate. |
|
548 | + */ |
|
549 | + protected function validate_ipn_currency( $invoice, $currency ) { |
|
550 | + if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) { |
|
551 | 551 | wpinv_record_gateway_error( 'IPN Error', "Currencies do not match: {$currency} instead of {$invoice->get_currency()}" ); |
552 | 552 | |
553 | - /* translators: %s: currency code. */ |
|
554 | - $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) ); |
|
555 | - exit; |
|
556 | - } |
|
557 | - } |
|
558 | - |
|
559 | - /** |
|
560 | - * Check payment amount from IPN matches the invoice. |
|
561 | - * |
|
562 | - * @param WPInv_Invoice $invoice Invoice object. |
|
563 | - * @param float $amount amount to validate. |
|
564 | - */ |
|
565 | - protected function validate_ipn_amount( $invoice, $amount ) { |
|
566 | - if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) { |
|
553 | + /* translators: %s: currency code. */ |
|
554 | + $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) ); |
|
555 | + exit; |
|
556 | + } |
|
557 | + } |
|
558 | + |
|
559 | + /** |
|
560 | + * Check payment amount from IPN matches the invoice. |
|
561 | + * |
|
562 | + * @param WPInv_Invoice $invoice Invoice object. |
|
563 | + * @param float $amount amount to validate. |
|
564 | + */ |
|
565 | + protected function validate_ipn_amount( $invoice, $amount ) { |
|
566 | + if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) { |
|
567 | 567 | wpinv_record_gateway_error( 'IPN Error', "Amounts do not match: {$amount} instead of {$invoice->get_total()}" ); |
568 | 568 | |
569 | - /* translators: %s: Amount. */ |
|
570 | - $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) ); |
|
571 | - exit; |
|
572 | - } |
|
573 | - } |
|
574 | - |
|
575 | - /** |
|
576 | - * Verify receiver email from PayPal. |
|
577 | - * |
|
578 | - * @param WPInv_Invoice $invoice Invoice object. |
|
579 | - * @param string $receiver_email Email to validate. |
|
580 | - */ |
|
581 | - protected function validate_ipn_receiver_email( $invoice, $receiver_email ) { |
|
569 | + /* translators: %s: Amount. */ |
|
570 | + $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) ); |
|
571 | + exit; |
|
572 | + } |
|
573 | + } |
|
574 | + |
|
575 | + /** |
|
576 | + * Verify receiver email from PayPal. |
|
577 | + * |
|
578 | + * @param WPInv_Invoice $invoice Invoice object. |
|
579 | + * @param string $receiver_email Email to validate. |
|
580 | + */ |
|
581 | + protected function validate_ipn_receiver_email( $invoice, $receiver_email ) { |
|
582 | 582 | $paypal_email = wpinv_get_option( 'paypal_email' ); |
583 | 583 | |
584 | - if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) { |
|
584 | + if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) { |
|
585 | 585 | wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" ); |
586 | 586 | |
587 | - /* translators: %s: email address . */ |
|
588 | - $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) ); |
|
589 | - exit; |
|
587 | + /* translators: %s: email address . */ |
|
588 | + $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) ); |
|
589 | + exit; |
|
590 | 590 | } |
591 | 591 | |
592 | - } |
|
592 | + } |
|
593 | 593 | |
594 | 594 | /** |
595 | - * Handles one time payments. |
|
596 | - * |
|
597 | - * @param WPInv_Invoice $invoice Invoice object. |
|
598 | - * @param array $posted Posted data. |
|
599 | - */ |
|
600 | - protected function ipn_txn_web_accept( $invoice, $posted ) { |
|
595 | + * Handles one time payments. |
|
596 | + * |
|
597 | + * @param WPInv_Invoice $invoice Invoice object. |
|
598 | + * @param array $posted Posted data. |
|
599 | + */ |
|
600 | + protected function ipn_txn_web_accept( $invoice, $posted ) { |
|
601 | 601 | |
602 | 602 | // Collect payment details |
603 | 603 | $payment_status = strtolower( $posted['payment_status'] ); |
@@ -658,27 +658,27 @@ discard block |
||
658 | 658 | // Process failures. |
659 | 659 | |
660 | 660 | /* translators: %s: payment status. */ |
661 | - $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), wpinv_clean( $posted['payment_status'] ) ) ); |
|
662 | - |
|
663 | - } |
|
664 | - |
|
665 | - /** |
|
666 | - * Handles one time payments. |
|
667 | - * |
|
668 | - * @param WPInv_Invoice $invoice Invoice object. |
|
669 | - * @param array $posted Posted data. |
|
670 | - */ |
|
671 | - protected function ipn_txn_cart( $invoice, $posted ) { |
|
672 | - $this->ipn_txn_web_accept( $invoice, $posted ); |
|
661 | + $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), wpinv_clean( $posted['payment_status'] ) ) ); |
|
662 | + |
|
663 | + } |
|
664 | + |
|
665 | + /** |
|
666 | + * Handles one time payments. |
|
667 | + * |
|
668 | + * @param WPInv_Invoice $invoice Invoice object. |
|
669 | + * @param array $posted Posted data. |
|
670 | + */ |
|
671 | + protected function ipn_txn_cart( $invoice, $posted ) { |
|
672 | + $this->ipn_txn_web_accept( $invoice, $posted ); |
|
673 | 673 | } |
674 | 674 | |
675 | 675 | /** |
676 | - * Handles subscription sign ups. |
|
677 | - * |
|
678 | - * @param WPInv_Invoice $invoice Invoice object. |
|
679 | - * @param array $posted Posted data. |
|
680 | - */ |
|
681 | - protected function ipn_txn_subscr_signup( $invoice, $posted ) { |
|
676 | + * Handles subscription sign ups. |
|
677 | + * |
|
678 | + * @param WPInv_Invoice $invoice Invoice object. |
|
679 | + * @param array $posted Posted data. |
|
680 | + */ |
|
681 | + protected function ipn_txn_subscr_signup( $invoice, $posted ) { |
|
682 | 682 | |
683 | 683 | // Make sure the invoice has a subscription. |
684 | 684 | $subscription = wpinv_get_subscription( $invoice ); |
@@ -717,12 +717,12 @@ discard block |
||
717 | 717 | } |
718 | 718 | |
719 | 719 | /** |
720 | - * Handles subscription renewals. |
|
721 | - * |
|
722 | - * @param WPInv_Invoice $invoice Invoice object. |
|
723 | - * @param array $posted Posted data. |
|
724 | - */ |
|
725 | - protected function ipn_txn_subscr_payment( $invoice, $posted ) { |
|
720 | + * Handles subscription renewals. |
|
721 | + * |
|
722 | + * @param WPInv_Invoice $invoice Invoice object. |
|
723 | + * @param array $posted Posted data. |
|
724 | + */ |
|
725 | + protected function ipn_txn_subscr_payment( $invoice, $posted ) { |
|
726 | 726 | |
727 | 727 | // Make sure the invoice has a subscription. |
728 | 728 | $subscription = wpinv_get_subscription( $invoice ); |
@@ -765,12 +765,12 @@ discard block |
||
765 | 765 | } |
766 | 766 | |
767 | 767 | /** |
768 | - * Handles subscription cancelations. |
|
769 | - * |
|
770 | - * @param WPInv_Invoice $invoice Invoice object. |
|
771 | - * @param array $posted Posted data. |
|
772 | - */ |
|
773 | - protected function ipn_txn_subscr_cancel( $invoice, $posted ) { |
|
768 | + * Handles subscription cancelations. |
|
769 | + * |
|
770 | + * @param WPInv_Invoice $invoice Invoice object. |
|
771 | + * @param array $posted Posted data. |
|
772 | + */ |
|
773 | + protected function ipn_txn_subscr_cancel( $invoice, $posted ) { |
|
774 | 774 | |
775 | 775 | if ( $subscription = wpinv_get_subscription( $invoice ) ) { |
776 | 776 | $subscription->cancel(); |
@@ -779,12 +779,12 @@ discard block |
||
779 | 779 | } |
780 | 780 | |
781 | 781 | /** |
782 | - * Handles subscription completions. |
|
783 | - * |
|
784 | - * @param WPInv_Invoice $invoice Invoice object. |
|
785 | - * @param array $posted Posted data. |
|
786 | - */ |
|
787 | - protected function ipn_txn_subscr_eot( $invoice, $posted ) { |
|
782 | + * Handles subscription completions. |
|
783 | + * |
|
784 | + * @param WPInv_Invoice $invoice Invoice object. |
|
785 | + * @param array $posted Posted data. |
|
786 | + */ |
|
787 | + protected function ipn_txn_subscr_eot( $invoice, $posted ) { |
|
788 | 788 | |
789 | 789 | if ( $subscription = wpinv_get_subscription( $invoice ) ) { |
790 | 790 | $subscription->complete(); |
@@ -793,12 +793,12 @@ discard block |
||
793 | 793 | } |
794 | 794 | |
795 | 795 | /** |
796 | - * Handles subscription fails. |
|
797 | - * |
|
798 | - * @param WPInv_Invoice $invoice Invoice object. |
|
799 | - * @param array $posted Posted data. |
|
800 | - */ |
|
801 | - protected function ipn_txn_subscr_failed( $invoice, $posted ) { |
|
796 | + * Handles subscription fails. |
|
797 | + * |
|
798 | + * @param WPInv_Invoice $invoice Invoice object. |
|
799 | + * @param array $posted Posted data. |
|
800 | + */ |
|
801 | + protected function ipn_txn_subscr_failed( $invoice, $posted ) { |
|
802 | 802 | |
803 | 803 | if ( $subscription = wpinv_get_subscription( $invoice ) ) { |
804 | 804 | $subscription->failing(); |
@@ -13,65 +13,65 @@ discard block |
||
13 | 13 | class GetPaid_Worldpay_Gateway extends GetPaid_Payment_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'worldpay'; |
21 | 21 | |
22 | 22 | /** |
23 | - * Payment method order. |
|
24 | - * |
|
25 | - * @var int |
|
26 | - */ |
|
23 | + * Payment method order. |
|
24 | + * |
|
25 | + * @var int |
|
26 | + */ |
|
27 | 27 | public $order = 5; |
28 | 28 | |
29 | 29 | /** |
30 | - * Endpoint for requests from Worldpay. |
|
31 | - * |
|
32 | - * @var string |
|
33 | - */ |
|
34 | - protected $notify_url; |
|
35 | - |
|
36 | - /** |
|
37 | - * Endpoint for requests to Worldpay. |
|
38 | - * |
|
39 | - * @var string |
|
40 | - */ |
|
30 | + * Endpoint for requests from Worldpay. |
|
31 | + * |
|
32 | + * @var string |
|
33 | + */ |
|
34 | + protected $notify_url; |
|
35 | + |
|
36 | + /** |
|
37 | + * Endpoint for requests to Worldpay. |
|
38 | + * |
|
39 | + * @var string |
|
40 | + */ |
|
41 | 41 | protected $endpoint; |
42 | 42 | |
43 | 43 | /** |
44 | - * An array of features that this gateway supports. |
|
45 | - * |
|
46 | - * @var array |
|
47 | - */ |
|
44 | + * An array of features that this gateway supports. |
|
45 | + * |
|
46 | + * @var array |
|
47 | + */ |
|
48 | 48 | protected $supports = array( 'sandbox' ); |
49 | 49 | |
50 | 50 | /** |
51 | - * Currencies this gateway is allowed for. |
|
52 | - * |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - public $currencies = array( 'AUD', 'ARS', 'CAD', 'CHF', 'DKK', 'EUR', 'HKD', 'MYR', 'GBP', 'NZD', 'NOK', 'SGD', 'LKR', 'SEK', 'TRY', 'USD', 'ZAR' ); |
|
51 | + * Currencies this gateway is allowed for. |
|
52 | + * |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + public $currencies = array( 'AUD', 'ARS', 'CAD', 'CHF', 'DKK', 'EUR', 'HKD', 'MYR', 'GBP', 'NZD', 'NOK', 'SGD', 'LKR', 'SEK', 'TRY', 'USD', 'ZAR' ); |
|
56 | 56 | |
57 | 57 | /** |
58 | - * URL to view a transaction. |
|
59 | - * |
|
60 | - * @var string |
|
61 | - */ |
|
58 | + * URL to view a transaction. |
|
59 | + * |
|
60 | + * @var string |
|
61 | + */ |
|
62 | 62 | public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s'; |
63 | 63 | |
64 | 64 | /** |
65 | - * URL to view a subscription. |
|
66 | - * |
|
67 | - * @var string |
|
68 | - */ |
|
69 | - public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s'; |
|
65 | + * URL to view a subscription. |
|
66 | + * |
|
67 | + * @var string |
|
68 | + */ |
|
69 | + public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s'; |
|
70 | 70 | |
71 | 71 | /** |
72 | - * Class constructor. |
|
73 | - */ |
|
74 | - public function __construct() { |
|
72 | + * Class constructor. |
|
73 | + */ |
|
74 | + public function __construct() { |
|
75 | 75 | |
76 | 76 | $this->method_title = __( 'Worldpay', 'invoicing' ); |
77 | 77 | $this->title = __( 'Worldpay - Credit Card / Debit Card', 'invoicing' ); |
@@ -85,15 +85,15 @@ discard block |
||
85 | 85 | } |
86 | 86 | |
87 | 87 | /** |
88 | - * Process Payment. |
|
89 | - * |
|
90 | - * |
|
91 | - * @param WPInv_Invoice $invoice Invoice. |
|
92 | - * @param array $submission_data Posted checkout fields. |
|
93 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
94 | - * @return array |
|
95 | - */ |
|
96 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
88 | + * Process Payment. |
|
89 | + * |
|
90 | + * |
|
91 | + * @param WPInv_Invoice $invoice Invoice. |
|
92 | + * @param array $submission_data Posted checkout fields. |
|
93 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
94 | + * @return array |
|
95 | + */ |
|
96 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
97 | 97 | |
98 | 98 | // Get redirect url. |
99 | 99 | $worldpay_redirect = esc_url( $this->get_request_url( $invoice ) ); |
@@ -128,31 +128,31 @@ discard block |
||
128 | 128 | } |
129 | 129 | |
130 | 130 | /** |
131 | - * Get the Worldpay request URL for an invoice. |
|
132 | - * |
|
133 | - * @param WPInv_Invoice $invoice Invoice object. |
|
134 | - * @return string |
|
135 | - */ |
|
136 | - public function get_request_url( $invoice ) { |
|
131 | + * Get the Worldpay request URL for an invoice. |
|
132 | + * |
|
133 | + * @param WPInv_Invoice $invoice Invoice object. |
|
134 | + * @return string |
|
135 | + */ |
|
136 | + public function get_request_url( $invoice ) { |
|
137 | 137 | |
138 | 138 | // Endpoint for this request |
139 | - $this->endpoint = $this->is_sandbox( $invoice ) ? 'https://secure-test.worldpay.com/wcc/purchase' : 'https://secure.worldpay.com/wcc/purchase'; |
|
139 | + $this->endpoint = $this->is_sandbox( $invoice ) ? 'https://secure-test.worldpay.com/wcc/purchase' : 'https://secure.worldpay.com/wcc/purchase'; |
|
140 | 140 | |
141 | 141 | return $this->endpoint; |
142 | 142 | |
143 | - } |
|
143 | + } |
|
144 | 144 | |
145 | 145 | /** |
146 | - * Get Worldpay Args for passing to Worldpay. |
|
147 | - * |
|
148 | - * @param WPInv_Invoice $invoice Invoice object. |
|
149 | - * @return array |
|
150 | - */ |
|
151 | - protected function get_worldpay_args( $invoice ) { |
|
152 | - |
|
153 | - return apply_filters( |
|
154 | - 'getpaid_worldpay_args', |
|
155 | - array( |
|
146 | + * Get Worldpay Args for passing to Worldpay. |
|
147 | + * |
|
148 | + * @param WPInv_Invoice $invoice Invoice object. |
|
149 | + * @return array |
|
150 | + */ |
|
151 | + protected function get_worldpay_args( $invoice ) { |
|
152 | + |
|
153 | + return apply_filters( |
|
154 | + 'getpaid_worldpay_args', |
|
155 | + array( |
|
156 | 156 | 'amount' => wpinv_sanitize_amount( $invoice->get_total() ), // mandatory |
157 | 157 | 'cartId' => wpinv_clean( $invoice->get_number() ), // mandatory reference for the item purchased |
158 | 158 | 'currency' => wpinv_clean( $invoice->get_currency() ), // mandatory |
@@ -177,18 +177,18 @@ discard block |
||
177 | 177 | 'countryString' => wpinv_clean( wpinv_country_name( $invoice->get_country() ) ), |
178 | 178 | 'compName' => wpinv_clean( $invoice->get_company() ), |
179 | 179 | ), |
180 | - $invoice |
|
181 | - ); |
|
180 | + $invoice |
|
181 | + ); |
|
182 | 182 | |
183 | 183 | } |
184 | 184 | |
185 | 185 | /** |
186 | - * Secures worldpay args with an md5 hash. |
|
187 | - * |
|
188 | - * @param array $args Gateway args. |
|
189 | - * @return array |
|
190 | - */ |
|
191 | - public function hash_args( $args ) { |
|
186 | + * Secures worldpay args with an md5 hash. |
|
187 | + * |
|
188 | + * @param array $args Gateway args. |
|
189 | + * @return array |
|
190 | + */ |
|
191 | + public function hash_args( $args ) { |
|
192 | 192 | |
193 | 193 | $md5_secret = $this->get_option( 'md5_secret' ); |
194 | 194 | |
@@ -204,16 +204,16 @@ discard block |
||
204 | 204 | } |
205 | 205 | |
206 | 206 | /** |
207 | - * Processes ipns and marks payments as complete. |
|
208 | - * |
|
209 | - * @return void |
|
210 | - */ |
|
211 | - public function verify_ipn() { |
|
207 | + * Processes ipns and marks payments as complete. |
|
208 | + * |
|
209 | + * @return void |
|
210 | + */ |
|
211 | + public function verify_ipn() { |
|
212 | 212 | |
213 | 213 | // Validate the IPN. |
214 | 214 | if ( empty( $_POST ) || ! $this->validate_ipn() ) { |
215 | - wp_die( 'Worldpay IPN Request Failure', 'Worldpay IPN', array( 'response' => 500 ) ); |
|
216 | - } |
|
215 | + wp_die( 'Worldpay IPN Request Failure', 'Worldpay IPN', array( 'response' => 500 ) ); |
|
216 | + } |
|
217 | 217 | |
218 | 218 | // Process the IPN. |
219 | 219 | $posted = wp_unslash( $_POST ); |
@@ -229,8 +229,8 @@ discard block |
||
229 | 229 | $invoice->set_transaction_id( wpinv_clean( $posted['transId'] ) ); |
230 | 230 | } |
231 | 231 | |
232 | - // Update the ip address. |
|
233 | - if ( ! empty( $posted['ipAddress'] ) ) { |
|
232 | + // Update the ip address. |
|
233 | + if ( ! empty( $posted['ipAddress'] ) ) { |
|
234 | 234 | $invoice->set_ip( wpinv_clean( $posted['ipAddress'] ) ); |
235 | 235 | } |
236 | 236 | |
@@ -257,9 +257,9 @@ discard block |
||
257 | 257 | } |
258 | 258 | |
259 | 259 | /** |
260 | - * Check Worldpay IPN validity. |
|
261 | - */ |
|
262 | - public function validate_ipn() { |
|
260 | + * Check Worldpay IPN validity. |
|
261 | + */ |
|
262 | + public function validate_ipn() { |
|
263 | 263 | |
264 | 264 | wpinv_error_log( 'Validating Worldpay IPN response' ); |
265 | 265 | |
@@ -305,11 +305,11 @@ discard block |
||
305 | 305 | } |
306 | 306 | |
307 | 307 | /** |
308 | - * Filters the gateway settings. |
|
309 | - * |
|
310 | - * @param array $admin_settings |
|
311 | - */ |
|
312 | - public function admin_settings( $admin_settings ) { |
|
308 | + * Filters the gateway settings. |
|
309 | + * |
|
310 | + * @param array $admin_settings |
|
311 | + */ |
|
312 | + public function admin_settings( $admin_settings ) { |
|
313 | 313 | |
314 | 314 | $currencies = sprintf( |
315 | 315 | __( 'Supported Currencies: %s', 'invoicing' ), |
@@ -350,7 +350,7 @@ discard block |
||
350 | 350 | 'readonly' => true |
351 | 351 | ); |
352 | 352 | |
353 | - return $admin_settings; |
|
354 | - } |
|
353 | + return $admin_settings; |
|
354 | + } |
|
355 | 355 | |
356 | 356 | } |
@@ -12,125 +12,125 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class WPInv_Session_Handler extends WPInv_Session { |
14 | 14 | |
15 | - /** |
|
16 | - * Cookie name used for the session. |
|
17 | - * |
|
18 | - * @var string cookie name |
|
19 | - */ |
|
20 | - protected $_cookie; |
|
21 | - |
|
22 | - /** |
|
23 | - * Stores session expiry. |
|
24 | - * |
|
25 | - * @var int session due to expire timestamp |
|
26 | - */ |
|
27 | - protected $_session_expiring; |
|
28 | - |
|
29 | - /** |
|
30 | - * Stores session due to expire timestamp. |
|
31 | - * |
|
32 | - * @var string session expiration timestamp |
|
33 | - */ |
|
34 | - protected $_session_expiration; |
|
35 | - |
|
36 | - /** |
|
37 | - * True when the cookie exists. |
|
38 | - * |
|
39 | - * @var bool Based on whether a cookie exists. |
|
40 | - */ |
|
41 | - protected $_has_cookie = false; |
|
42 | - |
|
43 | - /** |
|
44 | - * Table name for session data. |
|
45 | - * |
|
46 | - * @var string Custom session table name |
|
47 | - */ |
|
48 | - protected $_table; |
|
49 | - |
|
50 | - /** |
|
51 | - * Constructor for the session class. |
|
52 | - */ |
|
53 | - public function __construct() { |
|
54 | - |
|
55 | - $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
15 | + /** |
|
16 | + * Cookie name used for the session. |
|
17 | + * |
|
18 | + * @var string cookie name |
|
19 | + */ |
|
20 | + protected $_cookie; |
|
21 | + |
|
22 | + /** |
|
23 | + * Stores session expiry. |
|
24 | + * |
|
25 | + * @var int session due to expire timestamp |
|
26 | + */ |
|
27 | + protected $_session_expiring; |
|
28 | + |
|
29 | + /** |
|
30 | + * Stores session due to expire timestamp. |
|
31 | + * |
|
32 | + * @var string session expiration timestamp |
|
33 | + */ |
|
34 | + protected $_session_expiration; |
|
35 | + |
|
36 | + /** |
|
37 | + * True when the cookie exists. |
|
38 | + * |
|
39 | + * @var bool Based on whether a cookie exists. |
|
40 | + */ |
|
41 | + protected $_has_cookie = false; |
|
42 | + |
|
43 | + /** |
|
44 | + * Table name for session data. |
|
45 | + * |
|
46 | + * @var string Custom session table name |
|
47 | + */ |
|
48 | + protected $_table; |
|
49 | + |
|
50 | + /** |
|
51 | + * Constructor for the session class. |
|
52 | + */ |
|
53 | + public function __construct() { |
|
54 | + |
|
55 | + $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
56 | 56 | add_action( 'init', array( $this, 'init' ), -1 ); |
57 | - add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
58 | - add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
59 | - add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
60 | - |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Init hooks and session data. |
|
65 | - * |
|
66 | - * @since 3.3.0 |
|
67 | - */ |
|
68 | - public function init() { |
|
69 | - $this->init_session_cookie(); |
|
70 | - |
|
71 | - if ( ! is_user_logged_in() ) { |
|
72 | - add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ) ); |
|
73 | - } |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Setup cookie and customer ID. |
|
78 | - * |
|
79 | - * @since 3.6.0 |
|
80 | - */ |
|
81 | - public function init_session_cookie() { |
|
82 | - $cookie = $this->get_session_cookie(); |
|
83 | - |
|
84 | - if ( $cookie ) { |
|
85 | - $this->_customer_id = $cookie[0]; |
|
86 | - $this->_session_expiration = $cookie[1]; |
|
87 | - $this->_session_expiring = $cookie[2]; |
|
88 | - $this->_has_cookie = true; |
|
89 | - $this->_data = $this->get_session_data(); |
|
90 | - |
|
91 | - // If the user logs in, update session. |
|
92 | - if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
93 | - $this->_customer_id = get_current_user_id(); |
|
94 | - $this->_dirty = true; |
|
95 | - $this->save_data(); |
|
96 | - $this->set_customer_session_cookie( true ); |
|
97 | - } |
|
98 | - |
|
99 | - // Update session if its close to expiring. |
|
100 | - if ( time() > $this->_session_expiring ) { |
|
101 | - $this->set_session_expiration(); |
|
102 | - $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
103 | - } |
|
104 | - } else { |
|
105 | - $this->set_session_expiration(); |
|
106 | - $this->_customer_id = $this->generate_customer_id(); |
|
107 | - $this->_data = $this->get_session_data(); |
|
108 | - } |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
113 | - * |
|
114 | - * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
115 | - * |
|
116 | - * Warning: Cookies will only be set if this is called before the headers are sent. |
|
117 | - * |
|
118 | - * @param bool $set Should the session cookie be set. |
|
119 | - */ |
|
120 | - public function set_customer_session_cookie( $set ) { |
|
121 | - if ( $set ) { |
|
122 | - $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
123 | - $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
124 | - $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
125 | - $this->_has_cookie = true; |
|
126 | - |
|
127 | - if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
128 | - $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
129 | - } |
|
130 | - } |
|
131 | - } |
|
132 | - |
|
133 | - public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
57 | + add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
58 | + add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
59 | + add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
60 | + |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Init hooks and session data. |
|
65 | + * |
|
66 | + * @since 3.3.0 |
|
67 | + */ |
|
68 | + public function init() { |
|
69 | + $this->init_session_cookie(); |
|
70 | + |
|
71 | + if ( ! is_user_logged_in() ) { |
|
72 | + add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ) ); |
|
73 | + } |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Setup cookie and customer ID. |
|
78 | + * |
|
79 | + * @since 3.6.0 |
|
80 | + */ |
|
81 | + public function init_session_cookie() { |
|
82 | + $cookie = $this->get_session_cookie(); |
|
83 | + |
|
84 | + if ( $cookie ) { |
|
85 | + $this->_customer_id = $cookie[0]; |
|
86 | + $this->_session_expiration = $cookie[1]; |
|
87 | + $this->_session_expiring = $cookie[2]; |
|
88 | + $this->_has_cookie = true; |
|
89 | + $this->_data = $this->get_session_data(); |
|
90 | + |
|
91 | + // If the user logs in, update session. |
|
92 | + if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
93 | + $this->_customer_id = get_current_user_id(); |
|
94 | + $this->_dirty = true; |
|
95 | + $this->save_data(); |
|
96 | + $this->set_customer_session_cookie( true ); |
|
97 | + } |
|
98 | + |
|
99 | + // Update session if its close to expiring. |
|
100 | + if ( time() > $this->_session_expiring ) { |
|
101 | + $this->set_session_expiration(); |
|
102 | + $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
103 | + } |
|
104 | + } else { |
|
105 | + $this->set_session_expiration(); |
|
106 | + $this->_customer_id = $this->generate_customer_id(); |
|
107 | + $this->_data = $this->get_session_data(); |
|
108 | + } |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
113 | + * |
|
114 | + * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
115 | + * |
|
116 | + * Warning: Cookies will only be set if this is called before the headers are sent. |
|
117 | + * |
|
118 | + * @param bool $set Should the session cookie be set. |
|
119 | + */ |
|
120 | + public function set_customer_session_cookie( $set ) { |
|
121 | + if ( $set ) { |
|
122 | + $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
123 | + $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
124 | + $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
125 | + $this->_has_cookie = true; |
|
126 | + |
|
127 | + if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
128 | + $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
129 | + } |
|
130 | + } |
|
131 | + } |
|
132 | + |
|
133 | + public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
134 | 134 | if ( ! headers_sent() ) { |
135 | 135 | setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) ); |
136 | 136 | } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { |
@@ -139,86 +139,86 @@ discard block |
||
139 | 139 | } |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Should the session cookie be secure? |
|
144 | - * |
|
145 | - * @since 3.6.0 |
|
146 | - * @return bool |
|
147 | - */ |
|
148 | - protected function use_secure_cookie() { |
|
142 | + /** |
|
143 | + * Should the session cookie be secure? |
|
144 | + * |
|
145 | + * @since 3.6.0 |
|
146 | + * @return bool |
|
147 | + */ |
|
148 | + protected function use_secure_cookie() { |
|
149 | 149 | $is_https = false !== strstr( get_option( 'home' ), 'https:' ); |
150 | - return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
155 | - * |
|
156 | - * @return bool |
|
157 | - */ |
|
158 | - public function has_session() { |
|
159 | - return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Set session expiration. |
|
164 | - */ |
|
165 | - public function set_session_expiration() { |
|
166 | - $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
167 | - $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
168 | - } |
|
169 | - |
|
170 | - /** |
|
171 | - * Generates session ids. |
|
172 | - * |
|
173 | - * @return string |
|
174 | - */ |
|
175 | - public function generate_customer_id() { |
|
176 | - require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
177 | - $hasher = new PasswordHash( 8, false ); |
|
178 | - return md5( $hasher->get_random_bytes( 32 ) ); |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * Get the session cookie, if set. Otherwise return false. |
|
183 | - * |
|
184 | - * Session cookies without a customer ID are invalid. |
|
185 | - * |
|
186 | - * @return bool|array |
|
187 | - */ |
|
188 | - public function get_session_cookie() { |
|
189 | - $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
190 | - |
|
191 | - if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
192 | - return false; |
|
193 | - } |
|
194 | - |
|
195 | - list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
196 | - |
|
197 | - if ( empty( $customer_id ) ) { |
|
198 | - return false; |
|
199 | - } |
|
200 | - |
|
201 | - // Validate hash. |
|
202 | - $to_hash = $customer_id . '|' . $session_expiration; |
|
203 | - $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
204 | - |
|
205 | - if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
206 | - return false; |
|
207 | - } |
|
208 | - |
|
209 | - return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Get session data. |
|
214 | - * |
|
215 | - * @return array |
|
216 | - */ |
|
217 | - public function get_session_data() { |
|
218 | - return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
219 | - } |
|
220 | - |
|
221 | - public function generate_key($customer_id){ |
|
150 | + return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
155 | + * |
|
156 | + * @return bool |
|
157 | + */ |
|
158 | + public function has_session() { |
|
159 | + return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Set session expiration. |
|
164 | + */ |
|
165 | + public function set_session_expiration() { |
|
166 | + $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
167 | + $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
168 | + } |
|
169 | + |
|
170 | + /** |
|
171 | + * Generates session ids. |
|
172 | + * |
|
173 | + * @return string |
|
174 | + */ |
|
175 | + public function generate_customer_id() { |
|
176 | + require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
177 | + $hasher = new PasswordHash( 8, false ); |
|
178 | + return md5( $hasher->get_random_bytes( 32 ) ); |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * Get the session cookie, if set. Otherwise return false. |
|
183 | + * |
|
184 | + * Session cookies without a customer ID are invalid. |
|
185 | + * |
|
186 | + * @return bool|array |
|
187 | + */ |
|
188 | + public function get_session_cookie() { |
|
189 | + $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
190 | + |
|
191 | + if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
192 | + return false; |
|
193 | + } |
|
194 | + |
|
195 | + list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
196 | + |
|
197 | + if ( empty( $customer_id ) ) { |
|
198 | + return false; |
|
199 | + } |
|
200 | + |
|
201 | + // Validate hash. |
|
202 | + $to_hash = $customer_id . '|' . $session_expiration; |
|
203 | + $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
204 | + |
|
205 | + if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
206 | + return false; |
|
207 | + } |
|
208 | + |
|
209 | + return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Get session data. |
|
214 | + * |
|
215 | + * @return array |
|
216 | + */ |
|
217 | + public function get_session_data() { |
|
218 | + return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
219 | + } |
|
220 | + |
|
221 | + public function generate_key($customer_id){ |
|
222 | 222 | if(!$customer_id){ |
223 | 223 | return; |
224 | 224 | } |
@@ -226,62 +226,62 @@ discard block |
||
226 | 226 | return 'wpi_trans_'.$customer_id; |
227 | 227 | } |
228 | 228 | |
229 | - /** |
|
230 | - * Save data. |
|
231 | - */ |
|
232 | - public function save_data() { |
|
233 | - // Dirty if something changed - prevents saving nothing new. |
|
234 | - if ( $this->_dirty && $this->has_session() ) { |
|
229 | + /** |
|
230 | + * Save data. |
|
231 | + */ |
|
232 | + public function save_data() { |
|
233 | + // Dirty if something changed - prevents saving nothing new. |
|
234 | + if ( $this->_dirty && $this->has_session() ) { |
|
235 | 235 | |
236 | 236 | set_transient( $this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration); |
237 | 237 | |
238 | - $this->_dirty = false; |
|
239 | - } |
|
240 | - } |
|
241 | - |
|
242 | - /** |
|
243 | - * Destroy all session data. |
|
244 | - */ |
|
245 | - public function destroy_session() { |
|
246 | - $this->delete_session( $this->_customer_id ); |
|
247 | - $this->forget_session(); |
|
248 | - } |
|
249 | - |
|
250 | - /** |
|
251 | - * Forget all session data without destroying it. |
|
252 | - */ |
|
253 | - public function forget_session() { |
|
254 | - $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
255 | - |
|
256 | - wpinv_empty_cart(); |
|
257 | - |
|
258 | - $this->_data = array(); |
|
259 | - $this->_dirty = false; |
|
260 | - $this->_customer_id = $this->generate_customer_id(); |
|
261 | - } |
|
262 | - |
|
263 | - /** |
|
264 | - * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
265 | - * |
|
266 | - * @param int $uid User ID. |
|
267 | - * @return string |
|
268 | - */ |
|
269 | - public function nonce_user_logged_out( $uid ) { |
|
270 | - return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
271 | - } |
|
272 | - |
|
273 | - /** |
|
274 | - * Returns the session. |
|
275 | - * |
|
276 | - * @param string $customer_id Customer ID. |
|
277 | - * @param mixed $default Default session value. |
|
278 | - * @return string|array |
|
279 | - */ |
|
280 | - public function get_session( $customer_id, $default = false ) { |
|
281 | - |
|
282 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
283 | - return array(); |
|
284 | - } |
|
238 | + $this->_dirty = false; |
|
239 | + } |
|
240 | + } |
|
241 | + |
|
242 | + /** |
|
243 | + * Destroy all session data. |
|
244 | + */ |
|
245 | + public function destroy_session() { |
|
246 | + $this->delete_session( $this->_customer_id ); |
|
247 | + $this->forget_session(); |
|
248 | + } |
|
249 | + |
|
250 | + /** |
|
251 | + * Forget all session data without destroying it. |
|
252 | + */ |
|
253 | + public function forget_session() { |
|
254 | + $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
255 | + |
|
256 | + wpinv_empty_cart(); |
|
257 | + |
|
258 | + $this->_data = array(); |
|
259 | + $this->_dirty = false; |
|
260 | + $this->_customer_id = $this->generate_customer_id(); |
|
261 | + } |
|
262 | + |
|
263 | + /** |
|
264 | + * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
265 | + * |
|
266 | + * @param int $uid User ID. |
|
267 | + * @return string |
|
268 | + */ |
|
269 | + public function nonce_user_logged_out( $uid ) { |
|
270 | + return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
271 | + } |
|
272 | + |
|
273 | + /** |
|
274 | + * Returns the session. |
|
275 | + * |
|
276 | + * @param string $customer_id Customer ID. |
|
277 | + * @param mixed $default Default session value. |
|
278 | + * @return string|array |
|
279 | + */ |
|
280 | + public function get_session( $customer_id, $default = false ) { |
|
281 | + |
|
282 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
283 | + return array(); |
|
284 | + } |
|
285 | 285 | |
286 | 286 | $key = $this->generate_key($customer_id); |
287 | 287 | $value = get_transient($key); |
@@ -290,30 +290,30 @@ discard block |
||
290 | 290 | $value = $default; |
291 | 291 | } |
292 | 292 | |
293 | - return maybe_unserialize( $value ); |
|
294 | - } |
|
293 | + return maybe_unserialize( $value ); |
|
294 | + } |
|
295 | 295 | |
296 | - /** |
|
297 | - * Delete the session from the cache and database. |
|
298 | - * |
|
299 | - * @param int $customer_id Customer ID. |
|
300 | - */ |
|
301 | - public function delete_session( $customer_id ) { |
|
296 | + /** |
|
297 | + * Delete the session from the cache and database. |
|
298 | + * |
|
299 | + * @param int $customer_id Customer ID. |
|
300 | + */ |
|
301 | + public function delete_session( $customer_id ) { |
|
302 | 302 | |
303 | 303 | $key = $this->generate_key($customer_id); |
304 | 304 | |
305 | - delete_transient($key); |
|
306 | - } |
|
305 | + delete_transient($key); |
|
306 | + } |
|
307 | 307 | |
308 | - /** |
|
309 | - * Update the session expiry timestamp. |
|
310 | - * |
|
311 | - * @param string $customer_id Customer ID. |
|
312 | - * @param int $timestamp Timestamp to expire the cookie. |
|
313 | - */ |
|
314 | - public function update_session_timestamp( $customer_id, $timestamp ) { |
|
308 | + /** |
|
309 | + * Update the session expiry timestamp. |
|
310 | + * |
|
311 | + * @param string $customer_id Customer ID. |
|
312 | + * @param int $timestamp Timestamp to expire the cookie. |
|
313 | + */ |
|
314 | + public function update_session_timestamp( $customer_id, $timestamp ) { |
|
315 | 315 | |
316 | 316 | set_transient( $this->generate_key($customer_id), maybe_serialize( $this->_data ), $timestamp); |
317 | 317 | |
318 | - } |
|
318 | + } |
|
319 | 319 | } |
@@ -13,629 +13,629 @@ |
||
13 | 13 | |
14 | 14 | return array( |
15 | 15 | |
16 | - 'id' => array( |
|
17 | - 'description' => __( 'Unique identifier for the invoice.', 'invoicing' ), |
|
18 | - 'type' => 'integer', |
|
19 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | - 'readonly' => true, |
|
21 | - ), |
|
22 | - |
|
23 | - 'parent_id' => array( |
|
24 | - 'description' => __( 'Parent invoice ID.', 'invoicing' ), |
|
25 | - 'type' => 'integer', |
|
26 | - 'minimum' => 0, |
|
27 | - 'default' => 0, |
|
28 | - 'context' => array( 'view', 'edit' ), |
|
29 | - ), |
|
30 | - |
|
31 | - 'key' => array( |
|
32 | - 'description' => __( 'A unique key for the invoice.', 'invoicing' ), |
|
33 | - 'type' => 'string', |
|
34 | - 'context' => array( 'view', 'edit' ), |
|
35 | - 'readonly' => true, |
|
36 | - ), |
|
37 | - |
|
38 | - 'number' => array( |
|
39 | - 'description' => __( 'A unique number for the invoice.', 'invoicing' ), |
|
40 | - 'type' => 'string', |
|
41 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
42 | - ), |
|
43 | - |
|
44 | - 'type' => array( |
|
45 | - 'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ), |
|
46 | - 'type' => 'string', |
|
47 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
48 | - 'readonly' => true, |
|
49 | - ), |
|
50 | - |
|
51 | - 'post_type' => array( |
|
52 | - 'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ), |
|
53 | - 'type' => 'string', |
|
54 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | - 'readonly' => true, |
|
56 | - ), |
|
57 | - |
|
58 | - 'version' => array( |
|
59 | - 'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ), |
|
60 | - 'type' => 'integer', |
|
61 | - 'context' => array( 'view', 'edit' ), |
|
62 | - 'readonly' => true, |
|
63 | - ), |
|
64 | - |
|
65 | - 'template' => array( |
|
66 | - 'description' => __( 'The invoice template.', 'invoicing' ), |
|
67 | - 'type' => 'string', |
|
68 | - 'default' => 'quantity', |
|
69 | - 'enum' => array( 'quantity', 'hours', 'amount' ), |
|
70 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
71 | - ), |
|
72 | - |
|
73 | - 'status' => array( |
|
74 | - 'description' => __( 'Invoice status.', 'invoicing' ), |
|
75 | - 'type' => 'string', |
|
76 | - 'default' => 'wpi-pending', |
|
77 | - 'enum' => array_keys( wpinv_get_invoice_statuses( true ) ), |
|
78 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
79 | - ), |
|
80 | - |
|
81 | - 'status_nicename' => array( |
|
82 | - 'description' => __( 'A human readable name for the invoice status.', 'invoicing' ), |
|
83 | - 'type' => 'string', |
|
84 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
85 | - 'readonly' => true, |
|
86 | - ), |
|
87 | - |
|
88 | - 'currency' => array( |
|
89 | - 'description' => __( 'The invoice currency in ISO format.', 'invoicing' ), |
|
90 | - 'type' => 'string', |
|
91 | - 'default' => wpinv_get_currency(), |
|
92 | - 'enum' => array_keys( wpinv_get_currencies() ), |
|
93 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
94 | - ), |
|
95 | - |
|
96 | - 'date_created' => array( |
|
97 | - 'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ), |
|
98 | - 'type' => 'string', |
|
99 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
100 | - ), |
|
101 | - |
|
102 | - 'date_created_gmt' => array( |
|
103 | - 'description' => __( 'The GMT date the invoice was created.', 'invoicing' ), |
|
104 | - 'type' => 'string', |
|
105 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
106 | - 'readonly' => true, |
|
107 | - ), |
|
108 | - |
|
109 | - 'date_modified' => array( |
|
110 | - 'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ), |
|
111 | - 'type' => 'string', |
|
112 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
113 | - 'readonly' => true, |
|
114 | - ), |
|
115 | - |
|
116 | - 'date_modified_gmt' => array( |
|
117 | - 'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ), |
|
118 | - 'type' => 'string', |
|
119 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
120 | - 'readonly' => true, |
|
121 | - ), |
|
122 | - |
|
123 | - 'due_date' => array( |
|
124 | - 'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ), |
|
125 | - 'type' => 'string', |
|
126 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
127 | - ), |
|
128 | - |
|
129 | - 'due_date_gmt' => array( |
|
130 | - 'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ), |
|
131 | - 'type' => 'string', |
|
132 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
133 | - 'readonly' => true, |
|
134 | - ), |
|
135 | - |
|
136 | - 'completed_date' => array( |
|
137 | - 'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ), |
|
138 | - 'type' => 'string', |
|
139 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
140 | - 'readonly' => true, |
|
141 | - ), |
|
142 | - |
|
143 | - 'completed_date_gmt' => array( |
|
144 | - 'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ), |
|
145 | - 'type' => 'string', |
|
146 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
147 | - 'readonly' => true, |
|
148 | - ), |
|
149 | - |
|
150 | - 'total_discount' => array( |
|
151 | - 'description' => __( 'Total discount amount for the invoice.', 'invoicing' ), |
|
152 | - 'type' => 'number', |
|
153 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
154 | - 'readonly' => true, |
|
155 | - ), |
|
156 | - |
|
157 | - 'total_tax' => array( |
|
158 | - 'description' => __( 'Total tax amount for the invoice.', 'invoicing' ), |
|
159 | - 'type' => 'number', |
|
160 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
161 | - 'readonly' => true, |
|
162 | - ), |
|
163 | - |
|
164 | - 'total_fees' => array( |
|
165 | - 'description' => __( 'Total fees amount for the invoice.', 'invoicing' ), |
|
166 | - 'type' => 'number', |
|
167 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
168 | - 'readonly' => true, |
|
169 | - ), |
|
170 | - |
|
171 | - 'subtotal' => array( |
|
172 | - 'description' => __( 'Invoice subtotal.', 'invoicing' ), |
|
173 | - 'type' => 'number', |
|
174 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
175 | - 'readonly' => true, |
|
176 | - ), |
|
177 | - |
|
178 | - 'total' => array( |
|
179 | - 'description' => __( 'Grand total.', 'invoicing' ), |
|
180 | - 'type' => 'number', |
|
181 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
182 | - 'readonly' => true, |
|
183 | - ), |
|
184 | - |
|
185 | - 'initial_total' => array( |
|
186 | - 'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ), |
|
187 | - 'type' => 'number', |
|
188 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
189 | - 'readonly' => true, |
|
190 | - ), |
|
191 | - |
|
192 | - 'recurring_total' => array( |
|
193 | - 'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ), |
|
194 | - 'type' => 'number', |
|
195 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
196 | - 'readonly' => true, |
|
197 | - ), |
|
198 | - |
|
199 | - 'totals' => array( |
|
200 | - 'description' => __( 'Invoice totals.', 'invoicing' ), |
|
201 | - 'type' => 'object', |
|
202 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
203 | - 'readonly' => true, |
|
204 | - ), |
|
205 | - |
|
206 | - 'fees' => array( |
|
207 | - 'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ), |
|
208 | - 'type' => 'object', |
|
209 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
210 | - 'items' => array( |
|
211 | - 'type' => 'object', |
|
212 | - 'required' => array( 'amount' ), |
|
213 | - 'properties' => array( |
|
214 | - 'amount' => array( |
|
215 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
216 | - 'type' => 'string', |
|
217 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
218 | - ), |
|
219 | - 'recurring' => array( |
|
220 | - 'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ), |
|
221 | - 'type' => array( 'boolean', 'integer' ), |
|
222 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
223 | - ), |
|
224 | - ), |
|
225 | - ), |
|
226 | - ), |
|
227 | - |
|
228 | - 'discounts' => array( |
|
229 | - 'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ), |
|
230 | - 'type' => 'object', |
|
231 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
232 | - 'items' => array( |
|
233 | - 'type' => 'object', |
|
234 | - 'required' => array( 'amount' ), |
|
235 | - 'properties' => array( |
|
236 | - 'amount' => array( |
|
237 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
238 | - 'type' => 'string', |
|
239 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
240 | - ), |
|
241 | - 'recurring' => array( |
|
242 | - 'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ), |
|
243 | - 'type' => array( 'boolean', 'integer' ), |
|
244 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
245 | - ), |
|
246 | - ), |
|
247 | - ), |
|
248 | - ), |
|
249 | - |
|
250 | - 'taxes' => array( |
|
251 | - 'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ), |
|
252 | - 'type' => 'object', |
|
253 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
254 | - 'items' => array( |
|
255 | - 'type' => 'object', |
|
256 | - 'required' => array( 'amount' ), |
|
257 | - 'properties' => array( |
|
258 | - 'amount' => array( |
|
259 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
260 | - 'type' => 'string', |
|
261 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
262 | - ), |
|
263 | - 'recurring' => array( |
|
264 | - 'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ), |
|
265 | - 'type' => array( 'boolean', 'integer' ), |
|
266 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
267 | - ), |
|
268 | - ), |
|
269 | - ), |
|
270 | - ), |
|
271 | - |
|
272 | - 'items' => array( |
|
273 | - 'description' => __( 'Invoice items.', 'invoicing' ), |
|
274 | - 'type' => 'array', |
|
275 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
276 | - 'items' => array( |
|
277 | - 'type' => 'object', |
|
278 | - 'required' => array( 'item_id' ), |
|
279 | - 'properties' => array( |
|
280 | - 'item_id' => array( |
|
281 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
282 | - 'type' => 'integer', |
|
283 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
284 | - ), |
|
285 | - 'item_name' => array( |
|
286 | - 'description' => __( 'Item Name.', 'invoicing' ), |
|
287 | - 'type' => 'string', |
|
288 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
289 | - ), |
|
290 | - 'item_description' => array( |
|
291 | - 'description' => __( 'Item Description.', 'invoicing' ), |
|
292 | - 'type' => 'string', |
|
293 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
294 | - ), |
|
295 | - 'item_price' => array( |
|
296 | - 'description' => __( 'Item Price.', 'invoicing' ), |
|
297 | - 'type' => 'number', |
|
298 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
299 | - ), |
|
300 | - 'quantity' => array( |
|
301 | - 'description' => __( 'Item Quantity.', 'invoicing' ), |
|
302 | - 'type' => 'integer', |
|
303 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
304 | - ), |
|
305 | - 'subtotal' => array( |
|
306 | - 'description' => __( 'Item Subtotal.', 'invoicing' ), |
|
307 | - 'type' => 'number', |
|
308 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
309 | - 'readonly' => true, |
|
310 | - ), |
|
311 | - 'meta' => array( |
|
312 | - 'description' => __( 'Item Meta.', 'invoicing' ), |
|
313 | - 'type' => 'object', |
|
314 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
315 | - ), |
|
316 | - ), |
|
317 | - ), |
|
318 | - ), |
|
319 | - |
|
320 | - 'mode' => array( |
|
321 | - 'description' => __( 'The invoice transaction mode.', 'invoicing' ), |
|
322 | - 'type' => 'string', |
|
323 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
324 | - 'enum' => array( 'live', 'test' ), |
|
325 | - 'readonly' => true, |
|
326 | - ), |
|
16 | + 'id' => array( |
|
17 | + 'description' => __( 'Unique identifier for the invoice.', 'invoicing' ), |
|
18 | + 'type' => 'integer', |
|
19 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | + 'readonly' => true, |
|
21 | + ), |
|
22 | + |
|
23 | + 'parent_id' => array( |
|
24 | + 'description' => __( 'Parent invoice ID.', 'invoicing' ), |
|
25 | + 'type' => 'integer', |
|
26 | + 'minimum' => 0, |
|
27 | + 'default' => 0, |
|
28 | + 'context' => array( 'view', 'edit' ), |
|
29 | + ), |
|
30 | + |
|
31 | + 'key' => array( |
|
32 | + 'description' => __( 'A unique key for the invoice.', 'invoicing' ), |
|
33 | + 'type' => 'string', |
|
34 | + 'context' => array( 'view', 'edit' ), |
|
35 | + 'readonly' => true, |
|
36 | + ), |
|
37 | + |
|
38 | + 'number' => array( |
|
39 | + 'description' => __( 'A unique number for the invoice.', 'invoicing' ), |
|
40 | + 'type' => 'string', |
|
41 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
42 | + ), |
|
43 | + |
|
44 | + 'type' => array( |
|
45 | + 'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ), |
|
46 | + 'type' => 'string', |
|
47 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
48 | + 'readonly' => true, |
|
49 | + ), |
|
50 | + |
|
51 | + 'post_type' => array( |
|
52 | + 'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ), |
|
53 | + 'type' => 'string', |
|
54 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | + 'readonly' => true, |
|
56 | + ), |
|
57 | + |
|
58 | + 'version' => array( |
|
59 | + 'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ), |
|
60 | + 'type' => 'integer', |
|
61 | + 'context' => array( 'view', 'edit' ), |
|
62 | + 'readonly' => true, |
|
63 | + ), |
|
64 | + |
|
65 | + 'template' => array( |
|
66 | + 'description' => __( 'The invoice template.', 'invoicing' ), |
|
67 | + 'type' => 'string', |
|
68 | + 'default' => 'quantity', |
|
69 | + 'enum' => array( 'quantity', 'hours', 'amount' ), |
|
70 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
71 | + ), |
|
72 | + |
|
73 | + 'status' => array( |
|
74 | + 'description' => __( 'Invoice status.', 'invoicing' ), |
|
75 | + 'type' => 'string', |
|
76 | + 'default' => 'wpi-pending', |
|
77 | + 'enum' => array_keys( wpinv_get_invoice_statuses( true ) ), |
|
78 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
79 | + ), |
|
80 | + |
|
81 | + 'status_nicename' => array( |
|
82 | + 'description' => __( 'A human readable name for the invoice status.', 'invoicing' ), |
|
83 | + 'type' => 'string', |
|
84 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
85 | + 'readonly' => true, |
|
86 | + ), |
|
87 | + |
|
88 | + 'currency' => array( |
|
89 | + 'description' => __( 'The invoice currency in ISO format.', 'invoicing' ), |
|
90 | + 'type' => 'string', |
|
91 | + 'default' => wpinv_get_currency(), |
|
92 | + 'enum' => array_keys( wpinv_get_currencies() ), |
|
93 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
94 | + ), |
|
95 | + |
|
96 | + 'date_created' => array( |
|
97 | + 'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ), |
|
98 | + 'type' => 'string', |
|
99 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
100 | + ), |
|
101 | + |
|
102 | + 'date_created_gmt' => array( |
|
103 | + 'description' => __( 'The GMT date the invoice was created.', 'invoicing' ), |
|
104 | + 'type' => 'string', |
|
105 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
106 | + 'readonly' => true, |
|
107 | + ), |
|
108 | + |
|
109 | + 'date_modified' => array( |
|
110 | + 'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ), |
|
111 | + 'type' => 'string', |
|
112 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
113 | + 'readonly' => true, |
|
114 | + ), |
|
115 | + |
|
116 | + 'date_modified_gmt' => array( |
|
117 | + 'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ), |
|
118 | + 'type' => 'string', |
|
119 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
120 | + 'readonly' => true, |
|
121 | + ), |
|
122 | + |
|
123 | + 'due_date' => array( |
|
124 | + 'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ), |
|
125 | + 'type' => 'string', |
|
126 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
127 | + ), |
|
128 | + |
|
129 | + 'due_date_gmt' => array( |
|
130 | + 'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ), |
|
131 | + 'type' => 'string', |
|
132 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
133 | + 'readonly' => true, |
|
134 | + ), |
|
135 | + |
|
136 | + 'completed_date' => array( |
|
137 | + 'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ), |
|
138 | + 'type' => 'string', |
|
139 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
140 | + 'readonly' => true, |
|
141 | + ), |
|
142 | + |
|
143 | + 'completed_date_gmt' => array( |
|
144 | + 'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ), |
|
145 | + 'type' => 'string', |
|
146 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
147 | + 'readonly' => true, |
|
148 | + ), |
|
149 | + |
|
150 | + 'total_discount' => array( |
|
151 | + 'description' => __( 'Total discount amount for the invoice.', 'invoicing' ), |
|
152 | + 'type' => 'number', |
|
153 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
154 | + 'readonly' => true, |
|
155 | + ), |
|
156 | + |
|
157 | + 'total_tax' => array( |
|
158 | + 'description' => __( 'Total tax amount for the invoice.', 'invoicing' ), |
|
159 | + 'type' => 'number', |
|
160 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
161 | + 'readonly' => true, |
|
162 | + ), |
|
163 | + |
|
164 | + 'total_fees' => array( |
|
165 | + 'description' => __( 'Total fees amount for the invoice.', 'invoicing' ), |
|
166 | + 'type' => 'number', |
|
167 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
168 | + 'readonly' => true, |
|
169 | + ), |
|
170 | + |
|
171 | + 'subtotal' => array( |
|
172 | + 'description' => __( 'Invoice subtotal.', 'invoicing' ), |
|
173 | + 'type' => 'number', |
|
174 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
175 | + 'readonly' => true, |
|
176 | + ), |
|
177 | + |
|
178 | + 'total' => array( |
|
179 | + 'description' => __( 'Grand total.', 'invoicing' ), |
|
180 | + 'type' => 'number', |
|
181 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
182 | + 'readonly' => true, |
|
183 | + ), |
|
184 | + |
|
185 | + 'initial_total' => array( |
|
186 | + 'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ), |
|
187 | + 'type' => 'number', |
|
188 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
189 | + 'readonly' => true, |
|
190 | + ), |
|
191 | + |
|
192 | + 'recurring_total' => array( |
|
193 | + 'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ), |
|
194 | + 'type' => 'number', |
|
195 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
196 | + 'readonly' => true, |
|
197 | + ), |
|
198 | + |
|
199 | + 'totals' => array( |
|
200 | + 'description' => __( 'Invoice totals.', 'invoicing' ), |
|
201 | + 'type' => 'object', |
|
202 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
203 | + 'readonly' => true, |
|
204 | + ), |
|
205 | + |
|
206 | + 'fees' => array( |
|
207 | + 'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ), |
|
208 | + 'type' => 'object', |
|
209 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
210 | + 'items' => array( |
|
211 | + 'type' => 'object', |
|
212 | + 'required' => array( 'amount' ), |
|
213 | + 'properties' => array( |
|
214 | + 'amount' => array( |
|
215 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
216 | + 'type' => 'string', |
|
217 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
218 | + ), |
|
219 | + 'recurring' => array( |
|
220 | + 'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ), |
|
221 | + 'type' => array( 'boolean', 'integer' ), |
|
222 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
223 | + ), |
|
224 | + ), |
|
225 | + ), |
|
226 | + ), |
|
227 | + |
|
228 | + 'discounts' => array( |
|
229 | + 'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ), |
|
230 | + 'type' => 'object', |
|
231 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
232 | + 'items' => array( |
|
233 | + 'type' => 'object', |
|
234 | + 'required' => array( 'amount' ), |
|
235 | + 'properties' => array( |
|
236 | + 'amount' => array( |
|
237 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
238 | + 'type' => 'string', |
|
239 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
240 | + ), |
|
241 | + 'recurring' => array( |
|
242 | + 'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ), |
|
243 | + 'type' => array( 'boolean', 'integer' ), |
|
244 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
245 | + ), |
|
246 | + ), |
|
247 | + ), |
|
248 | + ), |
|
249 | + |
|
250 | + 'taxes' => array( |
|
251 | + 'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ), |
|
252 | + 'type' => 'object', |
|
253 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
254 | + 'items' => array( |
|
255 | + 'type' => 'object', |
|
256 | + 'required' => array( 'amount' ), |
|
257 | + 'properties' => array( |
|
258 | + 'amount' => array( |
|
259 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
260 | + 'type' => 'string', |
|
261 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
262 | + ), |
|
263 | + 'recurring' => array( |
|
264 | + 'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ), |
|
265 | + 'type' => array( 'boolean', 'integer' ), |
|
266 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
267 | + ), |
|
268 | + ), |
|
269 | + ), |
|
270 | + ), |
|
271 | + |
|
272 | + 'items' => array( |
|
273 | + 'description' => __( 'Invoice items.', 'invoicing' ), |
|
274 | + 'type' => 'array', |
|
275 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
276 | + 'items' => array( |
|
277 | + 'type' => 'object', |
|
278 | + 'required' => array( 'item_id' ), |
|
279 | + 'properties' => array( |
|
280 | + 'item_id' => array( |
|
281 | + 'description' => __( 'Item ID.', 'invoicing' ), |
|
282 | + 'type' => 'integer', |
|
283 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
284 | + ), |
|
285 | + 'item_name' => array( |
|
286 | + 'description' => __( 'Item Name.', 'invoicing' ), |
|
287 | + 'type' => 'string', |
|
288 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
289 | + ), |
|
290 | + 'item_description' => array( |
|
291 | + 'description' => __( 'Item Description.', 'invoicing' ), |
|
292 | + 'type' => 'string', |
|
293 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
294 | + ), |
|
295 | + 'item_price' => array( |
|
296 | + 'description' => __( 'Item Price.', 'invoicing' ), |
|
297 | + 'type' => 'number', |
|
298 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
299 | + ), |
|
300 | + 'quantity' => array( |
|
301 | + 'description' => __( 'Item Quantity.', 'invoicing' ), |
|
302 | + 'type' => 'integer', |
|
303 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
304 | + ), |
|
305 | + 'subtotal' => array( |
|
306 | + 'description' => __( 'Item Subtotal.', 'invoicing' ), |
|
307 | + 'type' => 'number', |
|
308 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
309 | + 'readonly' => true, |
|
310 | + ), |
|
311 | + 'meta' => array( |
|
312 | + 'description' => __( 'Item Meta.', 'invoicing' ), |
|
313 | + 'type' => 'object', |
|
314 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
315 | + ), |
|
316 | + ), |
|
317 | + ), |
|
318 | + ), |
|
319 | + |
|
320 | + 'mode' => array( |
|
321 | + 'description' => __( 'The invoice transaction mode.', 'invoicing' ), |
|
322 | + 'type' => 'string', |
|
323 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
324 | + 'enum' => array( 'live', 'test' ), |
|
325 | + 'readonly' => true, |
|
326 | + ), |
|
327 | 327 | |
328 | - 'discount_code' => array( |
|
329 | - 'description' => __( 'The discount code used on this invoice.', 'invoicing' ), |
|
330 | - 'type' => 'string', |
|
331 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
332 | - ), |
|
333 | - |
|
334 | - 'gateway' => array( |
|
335 | - 'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ), |
|
336 | - 'type' => 'string', |
|
337 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
338 | - ), |
|
339 | - |
|
340 | - 'gateway_title' => array( |
|
341 | - 'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ), |
|
342 | - 'type' => 'string', |
|
343 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
344 | - 'readonly' => true, |
|
345 | - ), |
|
346 | - |
|
347 | - 'transaction_id' => array( |
|
348 | - 'description' => __( 'The transaction id for this invoice.', 'invoicing' ), |
|
349 | - 'type' => 'string', |
|
350 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
351 | - ), |
|
328 | + 'discount_code' => array( |
|
329 | + 'description' => __( 'The discount code used on this invoice.', 'invoicing' ), |
|
330 | + 'type' => 'string', |
|
331 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
332 | + ), |
|
333 | + |
|
334 | + 'gateway' => array( |
|
335 | + 'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ), |
|
336 | + 'type' => 'string', |
|
337 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
338 | + ), |
|
339 | + |
|
340 | + 'gateway_title' => array( |
|
341 | + 'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ), |
|
342 | + 'type' => 'string', |
|
343 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
344 | + 'readonly' => true, |
|
345 | + ), |
|
346 | + |
|
347 | + 'transaction_id' => array( |
|
348 | + 'description' => __( 'The transaction id for this invoice.', 'invoicing' ), |
|
349 | + 'type' => 'string', |
|
350 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
351 | + ), |
|
352 | 352 | |
353 | - 'disable_taxes' => array( |
|
354 | - 'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ), |
|
355 | - 'type' => 'boolean ', |
|
356 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
357 | - ), |
|
358 | - |
|
359 | - 'is_viewed' => array( |
|
360 | - 'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ), |
|
361 | - 'type' => 'boolean ', |
|
362 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
363 | - 'readonly' => true, |
|
364 | - ), |
|
365 | - |
|
366 | - 'email_cc' => array( |
|
367 | - 'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ), |
|
368 | - 'type' => 'string ', |
|
369 | - 'context' => array( 'view', 'edit' ), |
|
370 | - ), |
|
371 | - |
|
372 | - 'subscription_id' => array( |
|
373 | - 'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ), |
|
374 | - 'type' => 'string ', |
|
375 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
376 | - 'readonly' => true, |
|
377 | - ), |
|
378 | - |
|
379 | - 'subscription_name' => array( |
|
380 | - 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
381 | - 'type' => 'string ', |
|
382 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
383 | - 'readonly' => true, |
|
384 | - ), |
|
385 | - |
|
386 | - 'subscription_name' => array( |
|
387 | - 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
388 | - 'type' => 'string ', |
|
389 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
390 | - 'readonly' => true, |
|
391 | - ), |
|
392 | - |
|
393 | - 'is_parent' => array( |
|
394 | - 'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ), |
|
395 | - 'type' => 'boolean', |
|
396 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
397 | - 'readonly' => true, |
|
398 | - ), |
|
399 | - |
|
400 | - 'is_renewal' => array( |
|
401 | - 'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ), |
|
402 | - 'type' => 'boolean', |
|
403 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
404 | - 'readonly' => true, |
|
405 | - ), |
|
406 | - |
|
407 | - 'is_recurring' => array( |
|
408 | - 'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ), |
|
409 | - 'type' => 'boolean', |
|
410 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
411 | - 'readonly' => true, |
|
412 | - ), |
|
413 | - |
|
414 | - 'is_free' => array( |
|
415 | - 'description' => __( 'Whether or not this invoice is free.', 'invoicing' ), |
|
416 | - 'type' => 'boolean', |
|
417 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
418 | - 'readonly' => true, |
|
419 | - ), |
|
420 | - |
|
421 | - 'is_paid' => array( |
|
422 | - 'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ), |
|
423 | - 'type' => 'boolean', |
|
424 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
425 | - 'readonly' => true, |
|
426 | - ), |
|
427 | - |
|
428 | - 'needs_payment' => array( |
|
429 | - 'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ), |
|
430 | - 'type' => 'boolean', |
|
431 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
432 | - 'readonly' => true, |
|
433 | - ), |
|
434 | - |
|
435 | - 'is_refunded' => array( |
|
436 | - 'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ), |
|
437 | - 'type' => 'boolean', |
|
438 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
439 | - 'readonly' => true, |
|
440 | - ), |
|
441 | - |
|
442 | - 'is_due' => array( |
|
443 | - 'description' => __( 'Whether or not this invoice is due.', 'invoicing' ), |
|
444 | - 'type' => 'boolean', |
|
445 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
446 | - 'readonly' => true, |
|
447 | - ), |
|
448 | - |
|
449 | - 'is_held' => array( |
|
450 | - 'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ), |
|
451 | - 'type' => 'boolean', |
|
452 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
453 | - 'readonly' => true, |
|
454 | - ), |
|
455 | - |
|
456 | - 'is_draft' => array( |
|
457 | - 'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ), |
|
458 | - 'type' => 'boolean', |
|
459 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
460 | - 'readonly' => true, |
|
461 | - ), |
|
462 | - |
|
463 | - 'path' => array( |
|
464 | - 'description' => __( 'The invoice path/slug/name.', 'invoicing' ), |
|
465 | - 'type' => 'string', |
|
466 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
467 | - 'readonly' => true, |
|
468 | - ), |
|
469 | - |
|
470 | - 'description' => array( |
|
471 | - 'description' => __( 'The invoice description.', 'invoicing' ), |
|
472 | - 'type' => 'string', |
|
473 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
474 | - ), |
|
475 | - |
|
476 | - 'payment_form' => array( |
|
477 | - 'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ), |
|
478 | - 'type' => 'integer', |
|
479 | - 'context' => array( 'view', 'edit' ), |
|
480 | - 'readonly' => true, |
|
481 | - ), |
|
482 | - |
|
483 | - 'submission_id' => array( |
|
484 | - 'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ), |
|
485 | - 'type' => 'string', |
|
486 | - 'context' => array( 'view', 'edit' ), |
|
487 | - 'readonly' => true, |
|
488 | - ), |
|
489 | - |
|
490 | - 'customer_id' => array( |
|
491 | - 'description' => __( 'The customer id.', 'invoicing' ), |
|
492 | - 'type' => 'integer', |
|
493 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
494 | - ), |
|
495 | - |
|
496 | - 'customer_ip' => array( |
|
497 | - 'description' => __( "The customer's ip address.", 'invoicing' ), |
|
498 | - 'type' => 'string', |
|
499 | - 'format' => 'ip', |
|
500 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
501 | - ), |
|
502 | - |
|
503 | - 'first_name' => array( |
|
504 | - 'description' => __( "The customer's first name.", 'invoicing' ), |
|
505 | - 'type' => 'string', |
|
506 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
507 | - ), |
|
508 | - |
|
509 | - 'last_name' => array( |
|
510 | - 'description' => __( "The customer's last name.", 'invoicing' ), |
|
511 | - 'type' => 'string', |
|
512 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
513 | - ), |
|
353 | + 'disable_taxes' => array( |
|
354 | + 'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ), |
|
355 | + 'type' => 'boolean ', |
|
356 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
357 | + ), |
|
358 | + |
|
359 | + 'is_viewed' => array( |
|
360 | + 'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ), |
|
361 | + 'type' => 'boolean ', |
|
362 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
363 | + 'readonly' => true, |
|
364 | + ), |
|
365 | + |
|
366 | + 'email_cc' => array( |
|
367 | + 'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ), |
|
368 | + 'type' => 'string ', |
|
369 | + 'context' => array( 'view', 'edit' ), |
|
370 | + ), |
|
371 | + |
|
372 | + 'subscription_id' => array( |
|
373 | + 'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ), |
|
374 | + 'type' => 'string ', |
|
375 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
376 | + 'readonly' => true, |
|
377 | + ), |
|
378 | + |
|
379 | + 'subscription_name' => array( |
|
380 | + 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
381 | + 'type' => 'string ', |
|
382 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
383 | + 'readonly' => true, |
|
384 | + ), |
|
385 | + |
|
386 | + 'subscription_name' => array( |
|
387 | + 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
388 | + 'type' => 'string ', |
|
389 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
390 | + 'readonly' => true, |
|
391 | + ), |
|
392 | + |
|
393 | + 'is_parent' => array( |
|
394 | + 'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ), |
|
395 | + 'type' => 'boolean', |
|
396 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
397 | + 'readonly' => true, |
|
398 | + ), |
|
399 | + |
|
400 | + 'is_renewal' => array( |
|
401 | + 'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ), |
|
402 | + 'type' => 'boolean', |
|
403 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
404 | + 'readonly' => true, |
|
405 | + ), |
|
406 | + |
|
407 | + 'is_recurring' => array( |
|
408 | + 'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ), |
|
409 | + 'type' => 'boolean', |
|
410 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
411 | + 'readonly' => true, |
|
412 | + ), |
|
413 | + |
|
414 | + 'is_free' => array( |
|
415 | + 'description' => __( 'Whether or not this invoice is free.', 'invoicing' ), |
|
416 | + 'type' => 'boolean', |
|
417 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
418 | + 'readonly' => true, |
|
419 | + ), |
|
420 | + |
|
421 | + 'is_paid' => array( |
|
422 | + 'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ), |
|
423 | + 'type' => 'boolean', |
|
424 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
425 | + 'readonly' => true, |
|
426 | + ), |
|
427 | + |
|
428 | + 'needs_payment' => array( |
|
429 | + 'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ), |
|
430 | + 'type' => 'boolean', |
|
431 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
432 | + 'readonly' => true, |
|
433 | + ), |
|
434 | + |
|
435 | + 'is_refunded' => array( |
|
436 | + 'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ), |
|
437 | + 'type' => 'boolean', |
|
438 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
439 | + 'readonly' => true, |
|
440 | + ), |
|
441 | + |
|
442 | + 'is_due' => array( |
|
443 | + 'description' => __( 'Whether or not this invoice is due.', 'invoicing' ), |
|
444 | + 'type' => 'boolean', |
|
445 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
446 | + 'readonly' => true, |
|
447 | + ), |
|
448 | + |
|
449 | + 'is_held' => array( |
|
450 | + 'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ), |
|
451 | + 'type' => 'boolean', |
|
452 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
453 | + 'readonly' => true, |
|
454 | + ), |
|
455 | + |
|
456 | + 'is_draft' => array( |
|
457 | + 'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ), |
|
458 | + 'type' => 'boolean', |
|
459 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
460 | + 'readonly' => true, |
|
461 | + ), |
|
462 | + |
|
463 | + 'path' => array( |
|
464 | + 'description' => __( 'The invoice path/slug/name.', 'invoicing' ), |
|
465 | + 'type' => 'string', |
|
466 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
467 | + 'readonly' => true, |
|
468 | + ), |
|
469 | + |
|
470 | + 'description' => array( |
|
471 | + 'description' => __( 'The invoice description.', 'invoicing' ), |
|
472 | + 'type' => 'string', |
|
473 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
474 | + ), |
|
475 | + |
|
476 | + 'payment_form' => array( |
|
477 | + 'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ), |
|
478 | + 'type' => 'integer', |
|
479 | + 'context' => array( 'view', 'edit' ), |
|
480 | + 'readonly' => true, |
|
481 | + ), |
|
482 | + |
|
483 | + 'submission_id' => array( |
|
484 | + 'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ), |
|
485 | + 'type' => 'string', |
|
486 | + 'context' => array( 'view', 'edit' ), |
|
487 | + 'readonly' => true, |
|
488 | + ), |
|
489 | + |
|
490 | + 'customer_id' => array( |
|
491 | + 'description' => __( 'The customer id.', 'invoicing' ), |
|
492 | + 'type' => 'integer', |
|
493 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
494 | + ), |
|
495 | + |
|
496 | + 'customer_ip' => array( |
|
497 | + 'description' => __( "The customer's ip address.", 'invoicing' ), |
|
498 | + 'type' => 'string', |
|
499 | + 'format' => 'ip', |
|
500 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
501 | + ), |
|
502 | + |
|
503 | + 'first_name' => array( |
|
504 | + 'description' => __( "The customer's first name.", 'invoicing' ), |
|
505 | + 'type' => 'string', |
|
506 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
507 | + ), |
|
508 | + |
|
509 | + 'last_name' => array( |
|
510 | + 'description' => __( "The customer's last name.", 'invoicing' ), |
|
511 | + 'type' => 'string', |
|
512 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
513 | + ), |
|
514 | 514 | |
515 | - 'full_name' => array( |
|
516 | - 'description' => __( "The customer's full name.", 'invoicing' ), |
|
517 | - 'type' => 'string', |
|
518 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
519 | - 'readonly' => true, |
|
520 | - ), |
|
521 | - |
|
522 | - 'phone_number' => array( |
|
523 | - 'description' => __( "The customer's phone number.", 'invoicing' ), |
|
524 | - 'type' => 'string', |
|
525 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
526 | - ), |
|
527 | - |
|
528 | - 'email_address' => array( |
|
529 | - 'description' => __( "The customer's email address.", 'invoicing' ), |
|
530 | - 'type' => 'string', |
|
531 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
532 | - 'readonly' => true, |
|
533 | - ), |
|
534 | - |
|
535 | - 'customer_country' => array( |
|
536 | - 'description' => __( "The customer's country.", 'invoicing' ), |
|
537 | - 'type' => 'string', |
|
538 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
539 | - 'default' => wpinv_get_default_country(), |
|
540 | - ), |
|
541 | - |
|
542 | - 'customer_state' => array( |
|
543 | - 'description' => __( "The customer's state.", 'invoicing' ), |
|
544 | - 'type' => 'string', |
|
545 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
546 | - ), |
|
547 | - |
|
548 | - 'customer_city' => array( |
|
549 | - 'description' => __( "The customer's city.", 'invoicing' ), |
|
550 | - 'type' => 'string', |
|
551 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
552 | - ), |
|
553 | - |
|
554 | - 'customer_zip' => array( |
|
555 | - 'description' => __( "The customer's zip/postal code.", 'invoicing' ), |
|
556 | - 'type' => 'string', |
|
557 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
558 | - ), |
|
559 | - |
|
560 | - 'customer_company' => array( |
|
561 | - 'description' => __( "The customer's company name.", 'invoicing' ), |
|
562 | - 'type' => 'string', |
|
563 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
564 | - ), |
|
565 | - |
|
566 | - 'vat_number' => array( |
|
567 | - 'description' => __( "The customer's VAT number.", 'invoicing' ), |
|
568 | - 'type' => 'string', |
|
569 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
570 | - ), |
|
571 | - |
|
572 | - 'vat_rate' => array( |
|
573 | - 'description' => __( "The customer's VAT rate.", 'invoicing' ), |
|
574 | - 'type' => 'number', |
|
575 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
576 | - 'readonly' => true, |
|
577 | - ), |
|
578 | - |
|
579 | - 'customer_address' => array( |
|
580 | - 'description' => __( "The customer's address.", 'invoicing' ), |
|
581 | - 'type' => 'string', |
|
582 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
583 | - ), |
|
584 | - |
|
585 | - 'address_confirmed' => array( |
|
586 | - 'description' => __( "Whether or not the customer's address is confirmed.", 'invoicing' ), |
|
587 | - 'type' => 'boolean', |
|
588 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
589 | - ), |
|
590 | - |
|
591 | - 'meta_data' => array( |
|
592 | - 'description' => __( 'Invoice meta data.', 'invoicing' ), |
|
593 | - 'type' => 'array', |
|
594 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
595 | - 'items' => array( |
|
596 | - 'type' => 'object', |
|
597 | - 'properties' => array( |
|
598 | - 'id' => array( |
|
599 | - 'description' => __( 'Meta ID.', 'invoicing' ), |
|
600 | - 'type' => 'string', |
|
601 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
602 | - ), |
|
603 | - 'key' => array( |
|
604 | - 'description' => __( 'Meta key.', 'invoicing' ), |
|
605 | - 'type' => 'string', |
|
606 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
607 | - ), |
|
608 | - 'value' => array( |
|
609 | - 'description' => __( 'Meta Value.', 'invoicing' ), |
|
610 | - 'type' => array( 'string', 'array', 'object', 'integer', 'null' ), |
|
611 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
612 | - ), |
|
613 | - ), |
|
614 | - ), |
|
615 | - ), |
|
616 | - |
|
617 | - 'view_url' => array( |
|
618 | - 'description' => __( 'URL to the invoice.', 'invoicing' ), |
|
619 | - 'type' => 'string', |
|
620 | - 'format' => 'uri', |
|
621 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
622 | - 'readonly' => true, |
|
623 | - ), |
|
624 | - |
|
625 | - 'checkout_payment_url' => array( |
|
626 | - 'description' => __( 'URL to the invoice checkout page.', 'invoicing' ), |
|
627 | - 'type' => 'string', |
|
628 | - 'format' => 'uri', |
|
629 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
630 | - 'readonly' => true, |
|
631 | - ), |
|
632 | - |
|
633 | - 'receipt_url' => array( |
|
634 | - 'description' => __( 'URL to the invoice receipt page.', 'invoicing' ), |
|
635 | - 'type' => 'string', |
|
636 | - 'format' => 'uri', |
|
637 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
515 | + 'full_name' => array( |
|
516 | + 'description' => __( "The customer's full name.", 'invoicing' ), |
|
517 | + 'type' => 'string', |
|
518 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
519 | + 'readonly' => true, |
|
520 | + ), |
|
521 | + |
|
522 | + 'phone_number' => array( |
|
523 | + 'description' => __( "The customer's phone number.", 'invoicing' ), |
|
524 | + 'type' => 'string', |
|
525 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
526 | + ), |
|
527 | + |
|
528 | + 'email_address' => array( |
|
529 | + 'description' => __( "The customer's email address.", 'invoicing' ), |
|
530 | + 'type' => 'string', |
|
531 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
532 | + 'readonly' => true, |
|
533 | + ), |
|
534 | + |
|
535 | + 'customer_country' => array( |
|
536 | + 'description' => __( "The customer's country.", 'invoicing' ), |
|
537 | + 'type' => 'string', |
|
538 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
539 | + 'default' => wpinv_get_default_country(), |
|
540 | + ), |
|
541 | + |
|
542 | + 'customer_state' => array( |
|
543 | + 'description' => __( "The customer's state.", 'invoicing' ), |
|
544 | + 'type' => 'string', |
|
545 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
546 | + ), |
|
547 | + |
|
548 | + 'customer_city' => array( |
|
549 | + 'description' => __( "The customer's city.", 'invoicing' ), |
|
550 | + 'type' => 'string', |
|
551 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
552 | + ), |
|
553 | + |
|
554 | + 'customer_zip' => array( |
|
555 | + 'description' => __( "The customer's zip/postal code.", 'invoicing' ), |
|
556 | + 'type' => 'string', |
|
557 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
558 | + ), |
|
559 | + |
|
560 | + 'customer_company' => array( |
|
561 | + 'description' => __( "The customer's company name.", 'invoicing' ), |
|
562 | + 'type' => 'string', |
|
563 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
564 | + ), |
|
565 | + |
|
566 | + 'vat_number' => array( |
|
567 | + 'description' => __( "The customer's VAT number.", 'invoicing' ), |
|
568 | + 'type' => 'string', |
|
569 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
570 | + ), |
|
571 | + |
|
572 | + 'vat_rate' => array( |
|
573 | + 'description' => __( "The customer's VAT rate.", 'invoicing' ), |
|
574 | + 'type' => 'number', |
|
575 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
576 | + 'readonly' => true, |
|
577 | + ), |
|
578 | + |
|
579 | + 'customer_address' => array( |
|
580 | + 'description' => __( "The customer's address.", 'invoicing' ), |
|
581 | + 'type' => 'string', |
|
582 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
583 | + ), |
|
584 | + |
|
585 | + 'address_confirmed' => array( |
|
586 | + 'description' => __( "Whether or not the customer's address is confirmed.", 'invoicing' ), |
|
587 | + 'type' => 'boolean', |
|
588 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
589 | + ), |
|
590 | + |
|
591 | + 'meta_data' => array( |
|
592 | + 'description' => __( 'Invoice meta data.', 'invoicing' ), |
|
593 | + 'type' => 'array', |
|
594 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
595 | + 'items' => array( |
|
596 | + 'type' => 'object', |
|
597 | + 'properties' => array( |
|
598 | + 'id' => array( |
|
599 | + 'description' => __( 'Meta ID.', 'invoicing' ), |
|
600 | + 'type' => 'string', |
|
601 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
602 | + ), |
|
603 | + 'key' => array( |
|
604 | + 'description' => __( 'Meta key.', 'invoicing' ), |
|
605 | + 'type' => 'string', |
|
606 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
607 | + ), |
|
608 | + 'value' => array( |
|
609 | + 'description' => __( 'Meta Value.', 'invoicing' ), |
|
610 | + 'type' => array( 'string', 'array', 'object', 'integer', 'null' ), |
|
611 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
612 | + ), |
|
613 | + ), |
|
614 | + ), |
|
615 | + ), |
|
616 | + |
|
617 | + 'view_url' => array( |
|
618 | + 'description' => __( 'URL to the invoice.', 'invoicing' ), |
|
619 | + 'type' => 'string', |
|
620 | + 'format' => 'uri', |
|
621 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
622 | + 'readonly' => true, |
|
623 | + ), |
|
624 | + |
|
625 | + 'checkout_payment_url' => array( |
|
626 | + 'description' => __( 'URL to the invoice checkout page.', 'invoicing' ), |
|
627 | + 'type' => 'string', |
|
628 | + 'format' => 'uri', |
|
629 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
630 | + 'readonly' => true, |
|
631 | + ), |
|
632 | + |
|
633 | + 'receipt_url' => array( |
|
634 | + 'description' => __( 'URL to the invoice receipt page.', 'invoicing' ), |
|
635 | + 'type' => 'string', |
|
636 | + 'format' => 'uri', |
|
637 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | 640 | |
641 | 641 | ); |
@@ -11,166 +11,166 @@ |
||
11 | 11 | defined( 'ABSPATH' ) || exit; |
12 | 12 | |
13 | 13 | return array( |
14 | - 'AED' => 'د.إ', |
|
15 | - 'AFN' => '؋', |
|
16 | - 'ALL' => 'L', |
|
17 | - 'AMD' => 'AMD', |
|
18 | - 'ANG' => 'ƒ', |
|
19 | - 'AOA' => 'Kz', |
|
20 | - 'ARS' => '$', |
|
21 | - 'AUD' => '$', |
|
22 | - 'AWG' => 'ƒ', |
|
23 | - 'AZN' => 'AZN', |
|
24 | - 'BAM' => 'KM', |
|
25 | - 'BBD' => '$', |
|
26 | - 'BDT' => '৳', |
|
27 | - 'BGN' => 'лв.', |
|
28 | - 'BHD' => '.د.ب', |
|
29 | - 'BIF' => 'Fr', |
|
30 | - 'BMD' => '$', |
|
31 | - 'BND' => '$', |
|
32 | - 'BOB' => 'Bs.', |
|
33 | - 'BRL' => 'R$', |
|
34 | - 'BSD' => '$', |
|
35 | - 'BTC' => '฿', |
|
36 | - 'BTN' => 'Nu.', |
|
37 | - 'BWP' => 'P', |
|
38 | - 'BYN' => 'Br', |
|
39 | - 'BZD' => '$', |
|
40 | - 'CAD' => '$', |
|
41 | - 'CDF' => 'Fr', |
|
42 | - 'CHF' => 'CHF', |
|
43 | - 'CLP' => '$', |
|
44 | - 'CNY' => '¥', |
|
45 | - 'COP' => '$', |
|
46 | - 'CRC' => '₡', |
|
47 | - 'CUC' => '$', |
|
48 | - 'CUP' => '$', |
|
49 | - 'CVE' => '$', |
|
50 | - 'CZK' => 'Kč', |
|
51 | - 'DJF' => 'Fr', |
|
52 | - 'DKK' => 'DKK', |
|
53 | - 'DOP' => 'RD$', |
|
54 | - 'DZD' => 'د.ج', |
|
55 | - 'EGP' => 'EGP', |
|
56 | - 'ERN' => 'Nfk', |
|
57 | - 'ETB' => 'Br', |
|
58 | - 'EUR' => '€', |
|
59 | - 'FJD' => '$', |
|
60 | - 'FKP' => '£', |
|
61 | - 'GBP' => '£', |
|
62 | - 'GEL' => 'ლ', |
|
63 | - 'GGP' => '£', |
|
64 | - 'GHS' => '₵', |
|
65 | - 'GIP' => '£', |
|
66 | - 'GMD' => 'D', |
|
67 | - 'GNF' => 'Fr', |
|
68 | - 'GTQ' => 'Q', |
|
69 | - 'GYD' => '$', |
|
70 | - 'HKD' => '$', |
|
71 | - 'HNL' => 'L', |
|
72 | - 'HRK' => 'Kn', |
|
73 | - 'HTG' => 'G', |
|
74 | - 'HUF' => 'Ft', |
|
75 | - 'IDR' => 'Rp', |
|
76 | - 'ILS' => '₪', |
|
77 | - 'IMP' => '£', |
|
78 | - 'INR' => '₹', |
|
79 | - 'IQD' => 'ع.د', |
|
80 | - 'IRR' => '﷼', |
|
81 | - 'IRT' => 'تومان', |
|
82 | - 'ISK' => 'kr.', |
|
83 | - 'JEP' => '£', |
|
84 | - 'JMD' => '$', |
|
85 | - 'JOD' => 'د.ا', |
|
86 | - 'JPY' => '¥', |
|
87 | - 'KES' => 'KSh', |
|
88 | - 'KGS' => 'сом', |
|
89 | - 'KHR' => '៛', |
|
90 | - 'KMF' => 'Fr', |
|
91 | - 'KPW' => '₩', |
|
92 | - 'KRW' => '₩', |
|
93 | - 'KWD' => 'د.ك', |
|
94 | - 'KYD' => '$', |
|
95 | - 'KZT' => 'KZT', |
|
96 | - 'LAK' => '₭', |
|
97 | - 'LBP' => 'ل.ل', |
|
98 | - 'LKR' => 'රු', |
|
99 | - 'LRD' => '$', |
|
100 | - 'LSL' => 'L', |
|
101 | - 'LYD' => 'ل.د', |
|
102 | - 'MAD' => 'د.م.', |
|
103 | - 'MDL' => 'MDL', |
|
104 | - 'MGA' => 'Ar', |
|
105 | - 'MKD' => 'ден', |
|
106 | - 'MMK' => 'Ks', |
|
107 | - 'MNT' => '₮', |
|
108 | - 'MOP' => 'P', |
|
109 | - 'MRO' => 'UM', |
|
110 | - 'MUR' => '₨', |
|
111 | - 'MVR' => '.ރ', |
|
112 | - 'MWK' => 'MK', |
|
113 | - 'MXN' => '$', |
|
114 | - 'MYR' => 'RM', |
|
115 | - 'MZN' => 'MT', |
|
116 | - 'NAD' => '$', |
|
117 | - 'NGN' => '₦', |
|
118 | - 'NIO' => 'C$', |
|
119 | - 'NOK' => 'kr', |
|
120 | - 'NPR' => '₨', |
|
121 | - 'NZD' => '$', |
|
122 | - 'OMR' => 'ر.ع.', |
|
123 | - 'PAB' => 'B/.', |
|
124 | - 'PEN' => 'S/.', |
|
125 | - 'PGK' => 'K', |
|
126 | - 'PHP' => '₱', |
|
127 | - 'PKR' => '₨', |
|
128 | - 'PLN' => 'zł', |
|
129 | - 'PRB' => 'р.', |
|
130 | - 'PYG' => '₲', |
|
131 | - 'QAR' => 'ر.ق', |
|
132 | - 'RMB' => '¥', |
|
133 | - 'RON' => 'lei', |
|
134 | - 'RSD' => 'дин.', |
|
135 | - 'RUB' => '₽', |
|
136 | - 'RWF' => 'Fr', |
|
137 | - 'SAR' => 'ر.س', |
|
138 | - 'SBD' => '$', |
|
139 | - 'SCR' => '₨', |
|
140 | - 'SDG' => 'ج.س.', |
|
141 | - 'SEK' => 'kr', |
|
142 | - 'SGD' => '$', |
|
143 | - 'SHP' => '£', |
|
144 | - 'SLL' => 'Le', |
|
145 | - 'SOS' => 'Sh', |
|
146 | - 'SRD' => '$', |
|
147 | - 'SSP' => '£', |
|
148 | - 'STD' => 'Db', |
|
149 | - 'SYP' => 'ل.س', |
|
150 | - 'SZL' => 'L', |
|
151 | - 'THB' => '฿', |
|
152 | - 'TJS' => 'ЅМ', |
|
153 | - 'TMT' => 'm', |
|
154 | - 'TND' => 'د.ت', |
|
155 | - 'TOP' => 'T$', |
|
156 | - 'TRY' => '₺', |
|
157 | - 'TTD' => '$', |
|
158 | - 'TWD' => 'NT$', |
|
159 | - 'TZS' => 'Sh', |
|
160 | - 'UAH' => '₴', |
|
161 | - 'UGX' => 'UGX', |
|
162 | - 'USD' => '$', |
|
163 | - 'UYU' => '$', |
|
164 | - 'UZS' => 'UZS', |
|
165 | - 'VEF' => 'Bs.', |
|
166 | - 'VND' => '₫', |
|
167 | - 'VUV' => 'Vt', |
|
168 | - 'WST' => 'T', |
|
169 | - 'XAF' => 'Fr', |
|
170 | - 'XCD' => '$', |
|
171 | - 'XOF' => 'Fr', |
|
172 | - 'XPF' => 'Fr', |
|
173 | - 'YER' => '﷼', |
|
174 | - 'ZAR' => 'R', |
|
175 | - 'ZMW' => 'ZK', |
|
14 | + 'AED' => 'د.إ', |
|
15 | + 'AFN' => '؋', |
|
16 | + 'ALL' => 'L', |
|
17 | + 'AMD' => 'AMD', |
|
18 | + 'ANG' => 'ƒ', |
|
19 | + 'AOA' => 'Kz', |
|
20 | + 'ARS' => '$', |
|
21 | + 'AUD' => '$', |
|
22 | + 'AWG' => 'ƒ', |
|
23 | + 'AZN' => 'AZN', |
|
24 | + 'BAM' => 'KM', |
|
25 | + 'BBD' => '$', |
|
26 | + 'BDT' => '৳', |
|
27 | + 'BGN' => 'лв.', |
|
28 | + 'BHD' => '.د.ب', |
|
29 | + 'BIF' => 'Fr', |
|
30 | + 'BMD' => '$', |
|
31 | + 'BND' => '$', |
|
32 | + 'BOB' => 'Bs.', |
|
33 | + 'BRL' => 'R$', |
|
34 | + 'BSD' => '$', |
|
35 | + 'BTC' => '฿', |
|
36 | + 'BTN' => 'Nu.', |
|
37 | + 'BWP' => 'P', |
|
38 | + 'BYN' => 'Br', |
|
39 | + 'BZD' => '$', |
|
40 | + 'CAD' => '$', |
|
41 | + 'CDF' => 'Fr', |
|
42 | + 'CHF' => 'CHF', |
|
43 | + 'CLP' => '$', |
|
44 | + 'CNY' => '¥', |
|
45 | + 'COP' => '$', |
|
46 | + 'CRC' => '₡', |
|
47 | + 'CUC' => '$', |
|
48 | + 'CUP' => '$', |
|
49 | + 'CVE' => '$', |
|
50 | + 'CZK' => 'Kč', |
|
51 | + 'DJF' => 'Fr', |
|
52 | + 'DKK' => 'DKK', |
|
53 | + 'DOP' => 'RD$', |
|
54 | + 'DZD' => 'د.ج', |
|
55 | + 'EGP' => 'EGP', |
|
56 | + 'ERN' => 'Nfk', |
|
57 | + 'ETB' => 'Br', |
|
58 | + 'EUR' => '€', |
|
59 | + 'FJD' => '$', |
|
60 | + 'FKP' => '£', |
|
61 | + 'GBP' => '£', |
|
62 | + 'GEL' => 'ლ', |
|
63 | + 'GGP' => '£', |
|
64 | + 'GHS' => '₵', |
|
65 | + 'GIP' => '£', |
|
66 | + 'GMD' => 'D', |
|
67 | + 'GNF' => 'Fr', |
|
68 | + 'GTQ' => 'Q', |
|
69 | + 'GYD' => '$', |
|
70 | + 'HKD' => '$', |
|
71 | + 'HNL' => 'L', |
|
72 | + 'HRK' => 'Kn', |
|
73 | + 'HTG' => 'G', |
|
74 | + 'HUF' => 'Ft', |
|
75 | + 'IDR' => 'Rp', |
|
76 | + 'ILS' => '₪', |
|
77 | + 'IMP' => '£', |
|
78 | + 'INR' => '₹', |
|
79 | + 'IQD' => 'ع.د', |
|
80 | + 'IRR' => '﷼', |
|
81 | + 'IRT' => 'تومان', |
|
82 | + 'ISK' => 'kr.', |
|
83 | + 'JEP' => '£', |
|
84 | + 'JMD' => '$', |
|
85 | + 'JOD' => 'د.ا', |
|
86 | + 'JPY' => '¥', |
|
87 | + 'KES' => 'KSh', |
|
88 | + 'KGS' => 'сом', |
|
89 | + 'KHR' => '៛', |
|
90 | + 'KMF' => 'Fr', |
|
91 | + 'KPW' => '₩', |
|
92 | + 'KRW' => '₩', |
|
93 | + 'KWD' => 'د.ك', |
|
94 | + 'KYD' => '$', |
|
95 | + 'KZT' => 'KZT', |
|
96 | + 'LAK' => '₭', |
|
97 | + 'LBP' => 'ل.ل', |
|
98 | + 'LKR' => 'රු', |
|
99 | + 'LRD' => '$', |
|
100 | + 'LSL' => 'L', |
|
101 | + 'LYD' => 'ل.د', |
|
102 | + 'MAD' => 'د.م.', |
|
103 | + 'MDL' => 'MDL', |
|
104 | + 'MGA' => 'Ar', |
|
105 | + 'MKD' => 'ден', |
|
106 | + 'MMK' => 'Ks', |
|
107 | + 'MNT' => '₮', |
|
108 | + 'MOP' => 'P', |
|
109 | + 'MRO' => 'UM', |
|
110 | + 'MUR' => '₨', |
|
111 | + 'MVR' => '.ރ', |
|
112 | + 'MWK' => 'MK', |
|
113 | + 'MXN' => '$', |
|
114 | + 'MYR' => 'RM', |
|
115 | + 'MZN' => 'MT', |
|
116 | + 'NAD' => '$', |
|
117 | + 'NGN' => '₦', |
|
118 | + 'NIO' => 'C$', |
|
119 | + 'NOK' => 'kr', |
|
120 | + 'NPR' => '₨', |
|
121 | + 'NZD' => '$', |
|
122 | + 'OMR' => 'ر.ع.', |
|
123 | + 'PAB' => 'B/.', |
|
124 | + 'PEN' => 'S/.', |
|
125 | + 'PGK' => 'K', |
|
126 | + 'PHP' => '₱', |
|
127 | + 'PKR' => '₨', |
|
128 | + 'PLN' => 'zł', |
|
129 | + 'PRB' => 'р.', |
|
130 | + 'PYG' => '₲', |
|
131 | + 'QAR' => 'ر.ق', |
|
132 | + 'RMB' => '¥', |
|
133 | + 'RON' => 'lei', |
|
134 | + 'RSD' => 'дин.', |
|
135 | + 'RUB' => '₽', |
|
136 | + 'RWF' => 'Fr', |
|
137 | + 'SAR' => 'ر.س', |
|
138 | + 'SBD' => '$', |
|
139 | + 'SCR' => '₨', |
|
140 | + 'SDG' => 'ج.س.', |
|
141 | + 'SEK' => 'kr', |
|
142 | + 'SGD' => '$', |
|
143 | + 'SHP' => '£', |
|
144 | + 'SLL' => 'Le', |
|
145 | + 'SOS' => 'Sh', |
|
146 | + 'SRD' => '$', |
|
147 | + 'SSP' => '£', |
|
148 | + 'STD' => 'Db', |
|
149 | + 'SYP' => 'ل.س', |
|
150 | + 'SZL' => 'L', |
|
151 | + 'THB' => '฿', |
|
152 | + 'TJS' => 'ЅМ', |
|
153 | + 'TMT' => 'm', |
|
154 | + 'TND' => 'د.ت', |
|
155 | + 'TOP' => 'T$', |
|
156 | + 'TRY' => '₺', |
|
157 | + 'TTD' => '$', |
|
158 | + 'TWD' => 'NT$', |
|
159 | + 'TZS' => 'Sh', |
|
160 | + 'UAH' => '₴', |
|
161 | + 'UGX' => 'UGX', |
|
162 | + 'USD' => '$', |
|
163 | + 'UYU' => '$', |
|
164 | + 'UZS' => 'UZS', |
|
165 | + 'VEF' => 'Bs.', |
|
166 | + 'VND' => '₫', |
|
167 | + 'VUV' => 'Vt', |
|
168 | + 'WST' => 'T', |
|
169 | + 'XAF' => 'Fr', |
|
170 | + 'XCD' => '$', |
|
171 | + 'XOF' => 'Fr', |
|
172 | + 'XPF' => 'Fr', |
|
173 | + 'YER' => '﷼', |
|
174 | + 'ZAR' => 'R', |
|
175 | + 'ZMW' => 'ZK', |
|
176 | 176 | ); |
@@ -11,165 +11,165 @@ |
||
11 | 11 | defined( 'ABSPATH' ) || exit; |
12 | 12 | |
13 | 13 | return array( |
14 | - 'USD' => __( 'US Dollar', 'invoicing' ), |
|
15 | - 'EUR' => __( 'Euro', 'invoicing' ), |
|
16 | - 'GBP' => __( 'Pound Sterling', 'invoicing' ), |
|
17 | - 'AED' => __( 'United Arab Emirates', 'invoicing' ), |
|
18 | - 'AFN' => __( 'Afghan Afghani', 'invoicing' ), |
|
19 | - 'ALL' => __( 'Albanian Lek', 'invoicing' ), |
|
20 | - 'AMD' => __( 'Armenian Dram', 'invoicing' ), |
|
21 | - 'ANG' => __( 'Netherlands Antillean Guilder', 'invoicing' ), |
|
22 | - 'AOA' => __( 'Angolan Kwanza', 'invoicing' ), |
|
23 | - 'ARS' => __( 'Argentine Peso', 'invoicing' ), |
|
24 | - 'AUD' => __( 'Australian Dollar', 'invoicing' ), |
|
25 | - 'AWG' => __( 'Aruban Florin', 'invoicing' ), |
|
26 | - 'AZN' => __( 'Azerbaijani Manat', 'invoicing' ), |
|
27 | - 'BAM' => __( 'Bosnia and Herzegovina Convertible Marka', 'invoicing' ), |
|
28 | - 'BBD' => __( 'Barbadian Dollar', 'invoicing' ), |
|
29 | - 'BDT' => __( 'Bangladeshi Taka', 'invoicing' ), |
|
30 | - 'BGN' => __( 'Bulgarian Lev', 'invoicing' ), |
|
31 | - 'BHD' => __( 'Bahraini Dinar', 'invoicing' ), |
|
32 | - 'BIF' => __( 'Burundian Franc', 'invoicing' ), |
|
33 | - 'BMD' => __( 'Bermudian Dollar', 'invoicing' ), |
|
34 | - 'BND' => __( 'Brunei Dollar', 'invoicing' ), |
|
35 | - 'BOB' => __( 'Bolivian Boliviano', 'invoicing' ), |
|
36 | - 'BRL' => __( 'Brazilian Real', 'invoicing' ), |
|
37 | - 'BSD' => __( 'Bahamian Dollar', 'invoicing' ), |
|
38 | - 'BTC' => __( 'Bitcoin', 'invoicing' ), |
|
39 | - 'BTN' => __( 'Bhutanese Ngultrum', 'invoicing' ), |
|
40 | - 'BWP' => __( 'Botswana Pula', 'invoicing' ), |
|
41 | - 'BYN' => __( 'Belarusian Ruble', 'invoicing' ), |
|
42 | - 'BZD' => __( 'Belize Dollar', 'invoicing' ), |
|
43 | - 'CAD' => __( 'Canadian Dollar', 'invoicing' ), |
|
44 | - 'CDF' => __( 'Congolese Franc', 'invoicing' ), |
|
45 | - 'CHF' => __( 'Swiss Franc', 'invoicing' ), |
|
46 | - 'CLP' => __( 'Chilean Peso', 'invoicing' ), |
|
47 | - 'CNY' => __( 'Chinese Yuan', 'invoicing' ), |
|
48 | - 'COP' => __( 'Colombian Peso', 'invoicing' ), |
|
49 | - 'CRC' => __( 'Costa Rican Colon', 'invoicing' ), |
|
50 | - 'CUC' => __( 'Cuban Convertible Peso', 'invoicing' ), |
|
51 | - 'CUP' => __( 'Cuban Peso', 'invoicing' ), |
|
52 | - 'CVE' => __( 'Cape Verdean escudo', 'invoicing' ), |
|
53 | - 'CZK' => __( 'Czech Koruna', 'invoicing' ), |
|
54 | - 'DJF' => __( 'Djiboutian Franc', 'invoicing' ), |
|
55 | - 'DKK' => __( 'Danish Krone', 'invoicing' ), |
|
56 | - 'DOP' => __( 'Dominican Peso', 'invoicing' ), |
|
57 | - 'DZD' => __( 'Algerian Dinar', 'invoicing' ), |
|
58 | - 'EGP' => __( 'Egyptian Pound', 'invoicing' ), |
|
59 | - 'ERN' => __( 'Eritrean Nakfa', 'invoicing' ), |
|
60 | - 'ETB' => __( 'Ethiopian Irr', 'invoicing' ), |
|
61 | - 'FJD' => __( 'Fijian Dollar', 'invoicing' ), |
|
62 | - 'FKP' => __( 'Falkland Islands Pound', 'invoicing' ), |
|
63 | - 'GEL' => __( 'Georgian Lari', 'invoicing' ), |
|
64 | - 'GGP' => __( 'Guernsey Pound', 'invoicing' ), |
|
65 | - 'GHS' => __( 'Ghana Cedi', 'invoicing' ), |
|
66 | - 'GIP' => __( 'Gibraltar Pound', 'invoicing' ), |
|
67 | - 'GMD' => __( 'Gambian Dalasi', 'invoicing' ), |
|
68 | - 'GNF' => __( 'Guinean Franc', 'invoicing' ), |
|
69 | - 'GTQ' => __( 'Guatemalan Quetzal', 'invoicing' ), |
|
70 | - 'GYD' => __( 'Guyanese Dollar', 'invoicing' ), |
|
71 | - 'HKD' => __( 'Hong Kong Dollar', 'invoicing' ), |
|
72 | - 'HNL' => __( 'Honduran Lempira', 'invoicing' ), |
|
73 | - 'HRK' => __( 'Croatian Kuna', 'invoicing' ), |
|
74 | - 'HTG' => __( 'Haitian Gourde', 'invoicing' ), |
|
75 | - 'HUF' => __( 'Hungarian Forint', 'invoicing' ), |
|
76 | - 'IDR' => __( 'Indonesian Rupiah', 'invoicing' ), |
|
77 | - 'ILS' => __( 'Israeli New Shekel', 'invoicing' ), |
|
78 | - 'IMP' => __( 'Manx Pound', 'invoicing' ), |
|
79 | - 'INR' => __( 'Indian Rupee', 'invoicing' ), |
|
80 | - 'IQD' => __( 'Iraqi Dinar', 'invoicing' ), |
|
81 | - 'IRR' => __( 'Iranian Rial', 'invoicing' ), |
|
82 | - 'IRT' => __( 'Iranian Toman', 'invoicing' ), |
|
83 | - 'ISK' => __( 'Icelandic Krona', 'invoicing' ), |
|
84 | - 'JEP' => __( 'Jersey Pound', 'invoicing' ), |
|
85 | - 'JMD' => __( 'Jamaican Dollar', 'invoicing' ), |
|
86 | - 'JOD' => __( 'Jordanian Dinar', 'invoicing' ), |
|
87 | - 'JPY' => __( 'Japanese Yen', 'invoicing' ), |
|
88 | - 'KES' => __( 'Kenyan Shilling', 'invoicing' ), |
|
89 | - 'KGS' => __( 'Kyrgyzstani Som', 'invoicing' ), |
|
90 | - 'KHR' => __( 'Cambodian Riel', 'invoicing' ), |
|
91 | - 'KMF' => __( 'Comorian Franc', 'invoicing' ), |
|
92 | - 'KPW' => __( 'North Korean Won', 'invoicing' ), |
|
93 | - 'KRW' => __( 'South Korean Won', 'invoicing' ), |
|
94 | - 'KWD' => __( 'Kuwaiti Dinar', 'invoicing' ), |
|
95 | - 'KYD' => __( 'Cayman Islands Dollar', 'invoicing' ), |
|
96 | - 'KZT' => __( 'Kazakhstani Tenge', 'invoicing' ), |
|
97 | - 'LAK' => __( 'Lao Kip', 'invoicing' ), |
|
98 | - 'LBP' => __( 'Lebanese Pound', 'invoicing' ), |
|
99 | - 'LKR' => __( 'Sri Lankan Rupee', 'invoicing' ), |
|
100 | - 'LRD' => __( 'Liberian Dollar', 'invoicing' ), |
|
101 | - 'LSL' => __( 'Lesotho Loti', 'invoicing' ), |
|
102 | - 'LYD' => __( 'Libyan Dinar', 'invoicing' ), |
|
103 | - 'MAD' => __( 'Moroccan Dirham', 'invoicing' ), |
|
104 | - 'MDL' => __( 'Moldovan Leu', 'invoicing' ), |
|
105 | - 'MGA' => __( 'Malagasy Ariary', 'invoicing' ), |
|
106 | - 'MKD' => __( 'Macedonian Denar', 'invoicing' ), |
|
107 | - 'MMK' => __( 'Burmese Kyat', 'invoicing' ), |
|
108 | - 'MNT' => __( 'Mongolian Tughrik', 'invoicing' ), |
|
109 | - 'MOP' => __( 'Macanese Pataca', 'invoicing' ), |
|
110 | - 'MRO' => __( 'Mauritanian Ouguiya', 'invoicing' ), |
|
111 | - 'MUR' => __( 'Mauritian Rupee', 'invoicing' ), |
|
112 | - 'MVR' => __( 'Maldivian Rufiyaa', 'invoicing' ), |
|
113 | - 'MWK' => __( 'Malawian Kwacha', 'invoicing' ), |
|
114 | - 'MXN' => __( 'Mexican Peso', 'invoicing' ), |
|
115 | - 'MYR' => __( 'Malaysian Ringgit', 'invoicing' ), |
|
116 | - 'MZN' => __( 'Mozambican Metical', 'invoicing' ), |
|
117 | - 'NAD' => __( 'Namibian Dollar', 'invoicing' ), |
|
118 | - 'NGN' => __( 'Nigerian Naira', 'invoicing' ), |
|
119 | - 'NIO' => __( 'Nicaraguan Cordoba', 'invoicing' ), |
|
120 | - 'NOK' => __( 'Norwegian Krone', 'invoicing' ), |
|
121 | - 'NPR' => __( 'Nepalese Rupee', 'invoicing' ), |
|
122 | - 'NZD' => __( 'New Zealand Dollar', 'invoicing' ), |
|
123 | - 'OMR' => __( 'Omani Rial', 'invoicing' ), |
|
124 | - 'PAB' => __( 'Panamanian Balboa', 'invoicing' ), |
|
125 | - 'PEN' => __( 'Peruvian Nuevo Sol', 'invoicing' ), |
|
126 | - 'PGK' => __( 'Papua New Guinean Kina', 'invoicing' ), |
|
127 | - 'PHP' => __( 'Philippine Peso', 'invoicing' ), |
|
128 | - 'PKR' => __( 'Pakistani Rupee', 'invoicing' ), |
|
129 | - 'PLN' => __( 'Polish Zloty', 'invoicing' ), |
|
130 | - 'PRB' => __( 'Transnistrian Ruble', 'invoicing' ), |
|
131 | - 'PYG' => __( 'Paraguayan Guarani', 'invoicing' ), |
|
132 | - 'QAR' => __( 'Qatari Riyal', 'invoicing' ), |
|
133 | - 'RON' => __( 'Romanian Leu', 'invoicing' ), |
|
134 | - 'RSD' => __( 'Serbian Dinar', 'invoicing' ), |
|
135 | - 'RUB' => __( 'Russian Ruble', 'invoicing' ), |
|
136 | - 'RWF' => __( 'Rwandan Franc', 'invoicing' ), |
|
137 | - 'SAR' => __( 'Saudi Riyal', 'invoicing' ), |
|
138 | - 'SBD' => __( 'Solomon Islands Dollar', 'invoicing' ), |
|
139 | - 'SCR' => __( 'Seychellois Rupee', 'invoicing' ), |
|
140 | - 'SDG' => __( 'Sudanese Pound', 'invoicing' ), |
|
141 | - 'SEK' => __( 'Swedish Krona', 'invoicing' ), |
|
142 | - 'SGD' => __( 'Singapore Dollar', 'invoicing' ), |
|
143 | - 'SHP' => __( 'Saint Helena Pound', 'invoicing' ), |
|
144 | - 'SLL' => __( 'Sierra Leonean Leone', 'invoicing' ), |
|
145 | - 'SOS' => __( 'Somali Shilling', 'invoicing' ), |
|
146 | - 'SRD' => __( 'Surinamese Dollar', 'invoicing' ), |
|
147 | - 'SSP' => __( 'South Sudanese Pound', 'invoicing' ), |
|
148 | - 'STD' => __( 'Sao Tomean Dobra', 'invoicing' ), |
|
149 | - 'SYP' => __( 'Syrian Pound', 'invoicing' ), |
|
150 | - 'SZL' => __( 'Swazi Lilangeni', 'invoicing' ), |
|
151 | - 'THB' => __( 'Thai Baht', 'invoicing' ), |
|
152 | - 'TJS' => __( 'Tajikistani Somoni', 'invoicing' ), |
|
153 | - 'TMT' => __( 'Turkmenistan Manat', 'invoicing' ), |
|
154 | - 'TND' => __( 'Tunisian Dinar', 'invoicing' ), |
|
155 | - 'TOP' => __( 'Tongan Paʻanga', 'invoicing' ), |
|
156 | - 'TRY' => __( 'Turkish Lira', 'invoicing' ), |
|
157 | - 'TTD' => __( 'Trinidad and Tobago Dollar', 'invoicing' ), |
|
158 | - 'TWD' => __( 'New Taiwan Dollar', 'invoicing' ), |
|
159 | - 'TZS' => __( 'Tanzanian Shilling', 'invoicing' ), |
|
160 | - 'UAH' => __( 'Ukrainian Hryvnia', 'invoicing' ), |
|
161 | - 'UGX' => __( 'Ugandan Shilling', 'invoicing' ), |
|
162 | - 'UYU' => __( 'Uruguayan Peso', 'invoicing' ), |
|
163 | - 'UZS' => __( 'Uzbekistani Som', 'invoicing' ), |
|
164 | - 'VEF' => __( 'Venezuelan Bolívar', 'invoicing' ), |
|
165 | - 'VND' => __( 'Vietnamese Dong', 'invoicing' ), |
|
166 | - 'VUV' => __( 'Vanuatu Vatu', 'invoicing' ), |
|
167 | - 'WST' => __( 'Samoan Tala', 'invoicing' ), |
|
168 | - 'XAF' => __( 'Central African CFA Franc', 'invoicing' ), |
|
169 | - 'XCD' => __( 'East Caribbean Dollar', 'invoicing' ), |
|
170 | - 'XOF' => __( 'West African CFA Franc', 'invoicing' ), |
|
171 | - 'XPF' => __( 'CFP Franc', 'invoicing' ), |
|
172 | - 'YER' => __( 'Yemeni Rial', 'invoicing' ), |
|
173 | - 'ZAR' => __( 'South African Rand', 'invoicing' ), |
|
174 | - 'ZMW' => __( 'Zambian Kwacha', 'invoicing' ), |
|
14 | + 'USD' => __( 'US Dollar', 'invoicing' ), |
|
15 | + 'EUR' => __( 'Euro', 'invoicing' ), |
|
16 | + 'GBP' => __( 'Pound Sterling', 'invoicing' ), |
|
17 | + 'AED' => __( 'United Arab Emirates', 'invoicing' ), |
|
18 | + 'AFN' => __( 'Afghan Afghani', 'invoicing' ), |
|
19 | + 'ALL' => __( 'Albanian Lek', 'invoicing' ), |
|
20 | + 'AMD' => __( 'Armenian Dram', 'invoicing' ), |
|
21 | + 'ANG' => __( 'Netherlands Antillean Guilder', 'invoicing' ), |
|
22 | + 'AOA' => __( 'Angolan Kwanza', 'invoicing' ), |
|
23 | + 'ARS' => __( 'Argentine Peso', 'invoicing' ), |
|
24 | + 'AUD' => __( 'Australian Dollar', 'invoicing' ), |
|
25 | + 'AWG' => __( 'Aruban Florin', 'invoicing' ), |
|
26 | + 'AZN' => __( 'Azerbaijani Manat', 'invoicing' ), |
|
27 | + 'BAM' => __( 'Bosnia and Herzegovina Convertible Marka', 'invoicing' ), |
|
28 | + 'BBD' => __( 'Barbadian Dollar', 'invoicing' ), |
|
29 | + 'BDT' => __( 'Bangladeshi Taka', 'invoicing' ), |
|
30 | + 'BGN' => __( 'Bulgarian Lev', 'invoicing' ), |
|
31 | + 'BHD' => __( 'Bahraini Dinar', 'invoicing' ), |
|
32 | + 'BIF' => __( 'Burundian Franc', 'invoicing' ), |
|
33 | + 'BMD' => __( 'Bermudian Dollar', 'invoicing' ), |
|
34 | + 'BND' => __( 'Brunei Dollar', 'invoicing' ), |
|
35 | + 'BOB' => __( 'Bolivian Boliviano', 'invoicing' ), |
|
36 | + 'BRL' => __( 'Brazilian Real', 'invoicing' ), |
|
37 | + 'BSD' => __( 'Bahamian Dollar', 'invoicing' ), |
|
38 | + 'BTC' => __( 'Bitcoin', 'invoicing' ), |
|
39 | + 'BTN' => __( 'Bhutanese Ngultrum', 'invoicing' ), |
|
40 | + 'BWP' => __( 'Botswana Pula', 'invoicing' ), |
|
41 | + 'BYN' => __( 'Belarusian Ruble', 'invoicing' ), |
|
42 | + 'BZD' => __( 'Belize Dollar', 'invoicing' ), |
|
43 | + 'CAD' => __( 'Canadian Dollar', 'invoicing' ), |
|
44 | + 'CDF' => __( 'Congolese Franc', 'invoicing' ), |
|
45 | + 'CHF' => __( 'Swiss Franc', 'invoicing' ), |
|
46 | + 'CLP' => __( 'Chilean Peso', 'invoicing' ), |
|
47 | + 'CNY' => __( 'Chinese Yuan', 'invoicing' ), |
|
48 | + 'COP' => __( 'Colombian Peso', 'invoicing' ), |
|
49 | + 'CRC' => __( 'Costa Rican Colon', 'invoicing' ), |
|
50 | + 'CUC' => __( 'Cuban Convertible Peso', 'invoicing' ), |
|
51 | + 'CUP' => __( 'Cuban Peso', 'invoicing' ), |
|
52 | + 'CVE' => __( 'Cape Verdean escudo', 'invoicing' ), |
|
53 | + 'CZK' => __( 'Czech Koruna', 'invoicing' ), |
|
54 | + 'DJF' => __( 'Djiboutian Franc', 'invoicing' ), |
|
55 | + 'DKK' => __( 'Danish Krone', 'invoicing' ), |
|
56 | + 'DOP' => __( 'Dominican Peso', 'invoicing' ), |
|
57 | + 'DZD' => __( 'Algerian Dinar', 'invoicing' ), |
|
58 | + 'EGP' => __( 'Egyptian Pound', 'invoicing' ), |
|
59 | + 'ERN' => __( 'Eritrean Nakfa', 'invoicing' ), |
|
60 | + 'ETB' => __( 'Ethiopian Irr', 'invoicing' ), |
|
61 | + 'FJD' => __( 'Fijian Dollar', 'invoicing' ), |
|
62 | + 'FKP' => __( 'Falkland Islands Pound', 'invoicing' ), |
|
63 | + 'GEL' => __( 'Georgian Lari', 'invoicing' ), |
|
64 | + 'GGP' => __( 'Guernsey Pound', 'invoicing' ), |
|
65 | + 'GHS' => __( 'Ghana Cedi', 'invoicing' ), |
|
66 | + 'GIP' => __( 'Gibraltar Pound', 'invoicing' ), |
|
67 | + 'GMD' => __( 'Gambian Dalasi', 'invoicing' ), |
|
68 | + 'GNF' => __( 'Guinean Franc', 'invoicing' ), |
|
69 | + 'GTQ' => __( 'Guatemalan Quetzal', 'invoicing' ), |
|
70 | + 'GYD' => __( 'Guyanese Dollar', 'invoicing' ), |
|
71 | + 'HKD' => __( 'Hong Kong Dollar', 'invoicing' ), |
|
72 | + 'HNL' => __( 'Honduran Lempira', 'invoicing' ), |
|
73 | + 'HRK' => __( 'Croatian Kuna', 'invoicing' ), |
|
74 | + 'HTG' => __( 'Haitian Gourde', 'invoicing' ), |
|
75 | + 'HUF' => __( 'Hungarian Forint', 'invoicing' ), |
|
76 | + 'IDR' => __( 'Indonesian Rupiah', 'invoicing' ), |
|
77 | + 'ILS' => __( 'Israeli New Shekel', 'invoicing' ), |
|
78 | + 'IMP' => __( 'Manx Pound', 'invoicing' ), |
|
79 | + 'INR' => __( 'Indian Rupee', 'invoicing' ), |
|
80 | + 'IQD' => __( 'Iraqi Dinar', 'invoicing' ), |
|
81 | + 'IRR' => __( 'Iranian Rial', 'invoicing' ), |
|
82 | + 'IRT' => __( 'Iranian Toman', 'invoicing' ), |
|
83 | + 'ISK' => __( 'Icelandic Krona', 'invoicing' ), |
|
84 | + 'JEP' => __( 'Jersey Pound', 'invoicing' ), |
|
85 | + 'JMD' => __( 'Jamaican Dollar', 'invoicing' ), |
|
86 | + 'JOD' => __( 'Jordanian Dinar', 'invoicing' ), |
|
87 | + 'JPY' => __( 'Japanese Yen', 'invoicing' ), |
|
88 | + 'KES' => __( 'Kenyan Shilling', 'invoicing' ), |
|
89 | + 'KGS' => __( 'Kyrgyzstani Som', 'invoicing' ), |
|
90 | + 'KHR' => __( 'Cambodian Riel', 'invoicing' ), |
|
91 | + 'KMF' => __( 'Comorian Franc', 'invoicing' ), |
|
92 | + 'KPW' => __( 'North Korean Won', 'invoicing' ), |
|
93 | + 'KRW' => __( 'South Korean Won', 'invoicing' ), |
|
94 | + 'KWD' => __( 'Kuwaiti Dinar', 'invoicing' ), |
|
95 | + 'KYD' => __( 'Cayman Islands Dollar', 'invoicing' ), |
|
96 | + 'KZT' => __( 'Kazakhstani Tenge', 'invoicing' ), |
|
97 | + 'LAK' => __( 'Lao Kip', 'invoicing' ), |
|
98 | + 'LBP' => __( 'Lebanese Pound', 'invoicing' ), |
|
99 | + 'LKR' => __( 'Sri Lankan Rupee', 'invoicing' ), |
|
100 | + 'LRD' => __( 'Liberian Dollar', 'invoicing' ), |
|
101 | + 'LSL' => __( 'Lesotho Loti', 'invoicing' ), |
|
102 | + 'LYD' => __( 'Libyan Dinar', 'invoicing' ), |
|
103 | + 'MAD' => __( 'Moroccan Dirham', 'invoicing' ), |
|
104 | + 'MDL' => __( 'Moldovan Leu', 'invoicing' ), |
|
105 | + 'MGA' => __( 'Malagasy Ariary', 'invoicing' ), |
|
106 | + 'MKD' => __( 'Macedonian Denar', 'invoicing' ), |
|
107 | + 'MMK' => __( 'Burmese Kyat', 'invoicing' ), |
|
108 | + 'MNT' => __( 'Mongolian Tughrik', 'invoicing' ), |
|
109 | + 'MOP' => __( 'Macanese Pataca', 'invoicing' ), |
|
110 | + 'MRO' => __( 'Mauritanian Ouguiya', 'invoicing' ), |
|
111 | + 'MUR' => __( 'Mauritian Rupee', 'invoicing' ), |
|
112 | + 'MVR' => __( 'Maldivian Rufiyaa', 'invoicing' ), |
|
113 | + 'MWK' => __( 'Malawian Kwacha', 'invoicing' ), |
|
114 | + 'MXN' => __( 'Mexican Peso', 'invoicing' ), |
|
115 | + 'MYR' => __( 'Malaysian Ringgit', 'invoicing' ), |
|
116 | + 'MZN' => __( 'Mozambican Metical', 'invoicing' ), |
|
117 | + 'NAD' => __( 'Namibian Dollar', 'invoicing' ), |
|
118 | + 'NGN' => __( 'Nigerian Naira', 'invoicing' ), |
|
119 | + 'NIO' => __( 'Nicaraguan Cordoba', 'invoicing' ), |
|
120 | + 'NOK' => __( 'Norwegian Krone', 'invoicing' ), |
|
121 | + 'NPR' => __( 'Nepalese Rupee', 'invoicing' ), |
|
122 | + 'NZD' => __( 'New Zealand Dollar', 'invoicing' ), |
|
123 | + 'OMR' => __( 'Omani Rial', 'invoicing' ), |
|
124 | + 'PAB' => __( 'Panamanian Balboa', 'invoicing' ), |
|
125 | + 'PEN' => __( 'Peruvian Nuevo Sol', 'invoicing' ), |
|
126 | + 'PGK' => __( 'Papua New Guinean Kina', 'invoicing' ), |
|
127 | + 'PHP' => __( 'Philippine Peso', 'invoicing' ), |
|
128 | + 'PKR' => __( 'Pakistani Rupee', 'invoicing' ), |
|
129 | + 'PLN' => __( 'Polish Zloty', 'invoicing' ), |
|
130 | + 'PRB' => __( 'Transnistrian Ruble', 'invoicing' ), |
|
131 | + 'PYG' => __( 'Paraguayan Guarani', 'invoicing' ), |
|
132 | + 'QAR' => __( 'Qatari Riyal', 'invoicing' ), |
|
133 | + 'RON' => __( 'Romanian Leu', 'invoicing' ), |
|
134 | + 'RSD' => __( 'Serbian Dinar', 'invoicing' ), |
|
135 | + 'RUB' => __( 'Russian Ruble', 'invoicing' ), |
|
136 | + 'RWF' => __( 'Rwandan Franc', 'invoicing' ), |
|
137 | + 'SAR' => __( 'Saudi Riyal', 'invoicing' ), |
|
138 | + 'SBD' => __( 'Solomon Islands Dollar', 'invoicing' ), |
|
139 | + 'SCR' => __( 'Seychellois Rupee', 'invoicing' ), |
|
140 | + 'SDG' => __( 'Sudanese Pound', 'invoicing' ), |
|
141 | + 'SEK' => __( 'Swedish Krona', 'invoicing' ), |
|
142 | + 'SGD' => __( 'Singapore Dollar', 'invoicing' ), |
|
143 | + 'SHP' => __( 'Saint Helena Pound', 'invoicing' ), |
|
144 | + 'SLL' => __( 'Sierra Leonean Leone', 'invoicing' ), |
|
145 | + 'SOS' => __( 'Somali Shilling', 'invoicing' ), |
|
146 | + 'SRD' => __( 'Surinamese Dollar', 'invoicing' ), |
|
147 | + 'SSP' => __( 'South Sudanese Pound', 'invoicing' ), |
|
148 | + 'STD' => __( 'Sao Tomean Dobra', 'invoicing' ), |
|
149 | + 'SYP' => __( 'Syrian Pound', 'invoicing' ), |
|
150 | + 'SZL' => __( 'Swazi Lilangeni', 'invoicing' ), |
|
151 | + 'THB' => __( 'Thai Baht', 'invoicing' ), |
|
152 | + 'TJS' => __( 'Tajikistani Somoni', 'invoicing' ), |
|
153 | + 'TMT' => __( 'Turkmenistan Manat', 'invoicing' ), |
|
154 | + 'TND' => __( 'Tunisian Dinar', 'invoicing' ), |
|
155 | + 'TOP' => __( 'Tongan Paʻanga', 'invoicing' ), |
|
156 | + 'TRY' => __( 'Turkish Lira', 'invoicing' ), |
|
157 | + 'TTD' => __( 'Trinidad and Tobago Dollar', 'invoicing' ), |
|
158 | + 'TWD' => __( 'New Taiwan Dollar', 'invoicing' ), |
|
159 | + 'TZS' => __( 'Tanzanian Shilling', 'invoicing' ), |
|
160 | + 'UAH' => __( 'Ukrainian Hryvnia', 'invoicing' ), |
|
161 | + 'UGX' => __( 'Ugandan Shilling', 'invoicing' ), |
|
162 | + 'UYU' => __( 'Uruguayan Peso', 'invoicing' ), |
|
163 | + 'UZS' => __( 'Uzbekistani Som', 'invoicing' ), |
|
164 | + 'VEF' => __( 'Venezuelan Bolívar', 'invoicing' ), |
|
165 | + 'VND' => __( 'Vietnamese Dong', 'invoicing' ), |
|
166 | + 'VUV' => __( 'Vanuatu Vatu', 'invoicing' ), |
|
167 | + 'WST' => __( 'Samoan Tala', 'invoicing' ), |
|
168 | + 'XAF' => __( 'Central African CFA Franc', 'invoicing' ), |
|
169 | + 'XCD' => __( 'East Caribbean Dollar', 'invoicing' ), |
|
170 | + 'XOF' => __( 'West African CFA Franc', 'invoicing' ), |
|
171 | + 'XPF' => __( 'CFP Franc', 'invoicing' ), |
|
172 | + 'YER' => __( 'Yemeni Rial', 'invoicing' ), |
|
173 | + 'ZAR' => __( 'South African Rand', 'invoicing' ), |
|
174 | + 'ZMW' => __( 'Zambian Kwacha', 'invoicing' ), |
|
175 | 175 | ); |
@@ -13,240 +13,240 @@ |
||
13 | 13 | |
14 | 14 | return array( |
15 | 15 | |
16 | - 'id' => array( |
|
17 | - 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
18 | - 'type' => 'integer', |
|
19 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | - 'readonly' => true, |
|
21 | - ), |
|
22 | - |
|
23 | - 'parent_id' => array( |
|
24 | - 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
25 | - 'type' => 'integer', |
|
26 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
27 | - 'default' => 0, |
|
28 | - ), |
|
29 | - |
|
30 | - 'status' => array( |
|
31 | - 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
32 | - 'type' => 'string', |
|
33 | - 'enum' => array( 'draft', 'pending', 'publish' ), |
|
34 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
35 | - 'default' => 'draft', |
|
36 | - ), |
|
37 | - |
|
38 | - 'version' => array( |
|
39 | - 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
40 | - 'type' => 'string', |
|
41 | - 'context' => array( 'view', 'edit' ), |
|
42 | - 'readonly' => true, |
|
43 | - ), |
|
44 | - |
|
45 | - 'date_created' => array( |
|
46 | - 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
47 | - 'type' => 'string', |
|
48 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
49 | - ), |
|
50 | - |
|
51 | - 'date_created_gmt' => array( |
|
52 | - 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
53 | - 'type' => 'string', |
|
54 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | - 'readonly' => true, |
|
56 | - ), |
|
57 | - |
|
58 | - 'date_modified' => array( |
|
59 | - 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
60 | - 'type' => 'string', |
|
61 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
62 | - 'readonly' => true, |
|
63 | - ), |
|
64 | - |
|
65 | - 'date_modified_gmt' => array( |
|
66 | - 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
67 | - 'type' => 'string', |
|
68 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
69 | - 'readonly' => true, |
|
70 | - ), |
|
71 | - |
|
72 | - 'name' => array( |
|
73 | - 'description' => __( "The item's name.", 'invoicing' ), |
|
74 | - 'type' => 'string', |
|
75 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
76 | - 'required' => true, |
|
77 | - ), |
|
78 | - |
|
79 | - 'description' => array( |
|
80 | - 'description' => __( "The item's description.", 'invoicing' ), |
|
81 | - 'type' => 'string', |
|
82 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
83 | - ), |
|
84 | - |
|
85 | - 'owner' => array( |
|
86 | - 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
87 | - 'type' => 'integer', |
|
88 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
89 | - ), |
|
90 | - |
|
91 | - 'price' => array( |
|
92 | - 'description' => __( 'The price of the item.', 'invoicing' ), |
|
93 | - 'type' => 'number', |
|
94 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
95 | - 'required' => true, |
|
96 | - ), |
|
97 | - |
|
98 | - 'the_price' => array( |
|
99 | - 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
100 | - 'type' => 'string', |
|
101 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
102 | - 'readonly' => true, |
|
103 | - ), |
|
104 | - |
|
105 | - 'type' => array( |
|
106 | - 'description' => __( 'The item type.', 'invoicing' ), |
|
107 | - 'type' => 'string', |
|
108 | - 'enum' => wpinv_item_types(), |
|
109 | - 'default' => 'custom', |
|
110 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
111 | - ), |
|
112 | - |
|
113 | - 'vat_rule' => array( |
|
114 | - 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'enum' => array_keys( getpaid_tax()->get_rules() ), |
|
117 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
118 | - ), |
|
119 | - |
|
120 | - 'vat_class' => array( |
|
121 | - 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
122 | - 'type' => 'string', |
|
123 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
124 | - 'enum' => array_keys( getpaid_tax()->get_vat_groups() ), |
|
125 | - ), |
|
126 | - |
|
127 | - 'custom_id' => array( |
|
128 | - 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
129 | - 'type' => 'string', |
|
130 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
131 | - ), |
|
16 | + 'id' => array( |
|
17 | + 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
18 | + 'type' => 'integer', |
|
19 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | + 'readonly' => true, |
|
21 | + ), |
|
22 | + |
|
23 | + 'parent_id' => array( |
|
24 | + 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
25 | + 'type' => 'integer', |
|
26 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
27 | + 'default' => 0, |
|
28 | + ), |
|
29 | + |
|
30 | + 'status' => array( |
|
31 | + 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
32 | + 'type' => 'string', |
|
33 | + 'enum' => array( 'draft', 'pending', 'publish' ), |
|
34 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
35 | + 'default' => 'draft', |
|
36 | + ), |
|
37 | + |
|
38 | + 'version' => array( |
|
39 | + 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
40 | + 'type' => 'string', |
|
41 | + 'context' => array( 'view', 'edit' ), |
|
42 | + 'readonly' => true, |
|
43 | + ), |
|
44 | + |
|
45 | + 'date_created' => array( |
|
46 | + 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
47 | + 'type' => 'string', |
|
48 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
49 | + ), |
|
50 | + |
|
51 | + 'date_created_gmt' => array( |
|
52 | + 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
53 | + 'type' => 'string', |
|
54 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | + 'readonly' => true, |
|
56 | + ), |
|
57 | + |
|
58 | + 'date_modified' => array( |
|
59 | + 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
60 | + 'type' => 'string', |
|
61 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
62 | + 'readonly' => true, |
|
63 | + ), |
|
64 | + |
|
65 | + 'date_modified_gmt' => array( |
|
66 | + 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
67 | + 'type' => 'string', |
|
68 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
69 | + 'readonly' => true, |
|
70 | + ), |
|
71 | + |
|
72 | + 'name' => array( |
|
73 | + 'description' => __( "The item's name.", 'invoicing' ), |
|
74 | + 'type' => 'string', |
|
75 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
76 | + 'required' => true, |
|
77 | + ), |
|
78 | + |
|
79 | + 'description' => array( |
|
80 | + 'description' => __( "The item's description.", 'invoicing' ), |
|
81 | + 'type' => 'string', |
|
82 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
83 | + ), |
|
84 | + |
|
85 | + 'owner' => array( |
|
86 | + 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
87 | + 'type' => 'integer', |
|
88 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
89 | + ), |
|
90 | + |
|
91 | + 'price' => array( |
|
92 | + 'description' => __( 'The price of the item.', 'invoicing' ), |
|
93 | + 'type' => 'number', |
|
94 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
95 | + 'required' => true, |
|
96 | + ), |
|
97 | + |
|
98 | + 'the_price' => array( |
|
99 | + 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
100 | + 'type' => 'string', |
|
101 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
102 | + 'readonly' => true, |
|
103 | + ), |
|
104 | + |
|
105 | + 'type' => array( |
|
106 | + 'description' => __( 'The item type.', 'invoicing' ), |
|
107 | + 'type' => 'string', |
|
108 | + 'enum' => wpinv_item_types(), |
|
109 | + 'default' => 'custom', |
|
110 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
111 | + ), |
|
112 | + |
|
113 | + 'vat_rule' => array( |
|
114 | + 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'enum' => array_keys( getpaid_tax()->get_rules() ), |
|
117 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
118 | + ), |
|
119 | + |
|
120 | + 'vat_class' => array( |
|
121 | + 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
122 | + 'type' => 'string', |
|
123 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
124 | + 'enum' => array_keys( getpaid_tax()->get_vat_groups() ), |
|
125 | + ), |
|
126 | + |
|
127 | + 'custom_id' => array( |
|
128 | + 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
129 | + 'type' => 'string', |
|
130 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
131 | + ), |
|
132 | 132 | |
133 | - 'custom_name' => array( |
|
134 | - 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
135 | - 'type' => 'string', |
|
136 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
137 | - ), |
|
138 | - |
|
139 | - 'custom_singular_name' => array( |
|
140 | - 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
143 | - ), |
|
144 | - |
|
145 | - 'is_editable' => array( |
|
146 | - 'description' => __( 'Whether or not the item is editable.', 'invoicing' ), |
|
147 | - 'type' => 'integer', |
|
148 | - 'enum' => array( 0, 1 ), |
|
149 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
150 | - ), |
|
151 | - |
|
152 | - 'is_dynamic_pricing' => array( |
|
153 | - 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
154 | - 'type' => 'integer', |
|
155 | - 'enum' => array( 0, 1 ), |
|
156 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
157 | - ), |
|
158 | - |
|
159 | - 'minimum_price' => array( |
|
160 | - 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
161 | - 'type' => 'number', |
|
162 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
163 | - ), |
|
164 | - |
|
165 | - 'is_recurring' => array( |
|
166 | - 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
167 | - 'type' => 'integer', |
|
168 | - 'enum' => array( 0, 1 ), |
|
169 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
170 | - ), |
|
171 | - |
|
172 | - 'initial_price' => array( |
|
173 | - 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
174 | - 'type' => 'number', |
|
175 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
176 | - 'readonly' => true, |
|
177 | - ), |
|
178 | - |
|
179 | - 'the_initial_price' => array( |
|
180 | - 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
181 | - 'type' => 'string', |
|
182 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
183 | - 'readonly' => true, |
|
184 | - ), |
|
185 | - |
|
186 | - 'recurring_price' => array( |
|
187 | - 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
188 | - 'type' => 'number', |
|
189 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
190 | - 'readonly' => true, |
|
191 | - ), |
|
192 | - |
|
193 | - 'the_recurring_price' => array( |
|
194 | - 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
195 | - 'type' => 'string', |
|
196 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
197 | - 'readonly' => true, |
|
198 | - ), |
|
199 | - |
|
200 | - 'recurring_period' => array( |
|
201 | - 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
202 | - 'type' => 'string', |
|
203 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
204 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
205 | - ), |
|
206 | - |
|
207 | - 'recurring_interval' => array( |
|
208 | - 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
209 | - 'type' => 'integer', |
|
210 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
211 | - ), |
|
212 | - |
|
213 | - 'recurring_limit' => array( |
|
214 | - 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
215 | - 'type' => 'integer', |
|
216 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
217 | - ), |
|
218 | - |
|
219 | - 'is_free_trial' => array( |
|
220 | - 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
221 | - 'type' => 'integer', |
|
222 | - 'enum' => array( 0, 1 ), |
|
223 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
224 | - ), |
|
225 | - |
|
226 | - 'trial_period' => array( |
|
227 | - 'description' => __( 'The trial period.', 'invoicing' ), |
|
228 | - 'type' => 'string', |
|
229 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
230 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
231 | - ), |
|
232 | - |
|
233 | - 'trial_interval' => array( |
|
234 | - 'description' => __( 'The trial interval.', 'invoicing' ), |
|
235 | - 'type' => 'integer', |
|
236 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
237 | - ), |
|
238 | - |
|
239 | - 'first_renewal_date' => array( |
|
240 | - 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
241 | - 'type' => 'string', |
|
242 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
243 | - 'readonly' => true, |
|
244 | - ), |
|
245 | - |
|
246 | - 'edit_url' => array( |
|
247 | - 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
248 | - 'type' => 'string', |
|
249 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
250 | - 'readonly' => true, |
|
251 | - ), |
|
133 | + 'custom_name' => array( |
|
134 | + 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
135 | + 'type' => 'string', |
|
136 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
137 | + ), |
|
138 | + |
|
139 | + 'custom_singular_name' => array( |
|
140 | + 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
143 | + ), |
|
144 | + |
|
145 | + 'is_editable' => array( |
|
146 | + 'description' => __( 'Whether or not the item is editable.', 'invoicing' ), |
|
147 | + 'type' => 'integer', |
|
148 | + 'enum' => array( 0, 1 ), |
|
149 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
150 | + ), |
|
151 | + |
|
152 | + 'is_dynamic_pricing' => array( |
|
153 | + 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
154 | + 'type' => 'integer', |
|
155 | + 'enum' => array( 0, 1 ), |
|
156 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
157 | + ), |
|
158 | + |
|
159 | + 'minimum_price' => array( |
|
160 | + 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
161 | + 'type' => 'number', |
|
162 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
163 | + ), |
|
164 | + |
|
165 | + 'is_recurring' => array( |
|
166 | + 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
167 | + 'type' => 'integer', |
|
168 | + 'enum' => array( 0, 1 ), |
|
169 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
170 | + ), |
|
171 | + |
|
172 | + 'initial_price' => array( |
|
173 | + 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
174 | + 'type' => 'number', |
|
175 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
176 | + 'readonly' => true, |
|
177 | + ), |
|
178 | + |
|
179 | + 'the_initial_price' => array( |
|
180 | + 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
181 | + 'type' => 'string', |
|
182 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
183 | + 'readonly' => true, |
|
184 | + ), |
|
185 | + |
|
186 | + 'recurring_price' => array( |
|
187 | + 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
188 | + 'type' => 'number', |
|
189 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
190 | + 'readonly' => true, |
|
191 | + ), |
|
192 | + |
|
193 | + 'the_recurring_price' => array( |
|
194 | + 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
195 | + 'type' => 'string', |
|
196 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
197 | + 'readonly' => true, |
|
198 | + ), |
|
199 | + |
|
200 | + 'recurring_period' => array( |
|
201 | + 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
202 | + 'type' => 'string', |
|
203 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
204 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
205 | + ), |
|
206 | + |
|
207 | + 'recurring_interval' => array( |
|
208 | + 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
209 | + 'type' => 'integer', |
|
210 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
211 | + ), |
|
212 | + |
|
213 | + 'recurring_limit' => array( |
|
214 | + 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
215 | + 'type' => 'integer', |
|
216 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
217 | + ), |
|
218 | + |
|
219 | + 'is_free_trial' => array( |
|
220 | + 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
221 | + 'type' => 'integer', |
|
222 | + 'enum' => array( 0, 1 ), |
|
223 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
224 | + ), |
|
225 | + |
|
226 | + 'trial_period' => array( |
|
227 | + 'description' => __( 'The trial period.', 'invoicing' ), |
|
228 | + 'type' => 'string', |
|
229 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
230 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
231 | + ), |
|
232 | + |
|
233 | + 'trial_interval' => array( |
|
234 | + 'description' => __( 'The trial interval.', 'invoicing' ), |
|
235 | + 'type' => 'integer', |
|
236 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
237 | + ), |
|
238 | + |
|
239 | + 'first_renewal_date' => array( |
|
240 | + 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
241 | + 'type' => 'string', |
|
242 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
243 | + 'readonly' => true, |
|
244 | + ), |
|
245 | + |
|
246 | + 'edit_url' => array( |
|
247 | + 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
248 | + 'type' => 'string', |
|
249 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
250 | + 'readonly' => true, |
|
251 | + ), |
|
252 | 252 | ); |
@@ -15,30 +15,30 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class WPInv_Discount extends GetPaid_Data { |
17 | 17 | |
18 | - /** |
|
19 | - * Which data store to load. |
|
20 | - * |
|
21 | - * @var string |
|
22 | - */ |
|
18 | + /** |
|
19 | + * Which data store to load. |
|
20 | + * |
|
21 | + * @var string |
|
22 | + */ |
|
23 | 23 | protected $data_store_name = 'discount'; |
24 | 24 | |
25 | 25 | /** |
26 | - * This is the name of this object type. |
|
27 | - * |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $object_type = 'discount'; |
|
31 | - |
|
32 | - /** |
|
33 | - * Discount Data array. This is the core item data exposed in APIs. |
|
34 | - * |
|
35 | - * @since 1.0.19 |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - protected $data = array( |
|
39 | - 'status' => 'draft', |
|
40 | - 'version' => '', |
|
41 | - 'date_created' => null, |
|
26 | + * This is the name of this object type. |
|
27 | + * |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $object_type = 'discount'; |
|
31 | + |
|
32 | + /** |
|
33 | + * Discount Data array. This is the core item data exposed in APIs. |
|
34 | + * |
|
35 | + * @since 1.0.19 |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + protected $data = array( |
|
39 | + 'status' => 'draft', |
|
40 | + 'version' => '', |
|
41 | + 'date_created' => null, |
|
42 | 42 | 'date_modified' => null, |
43 | 43 | 'name' => 'no-name', |
44 | 44 | 'description' => null, |
@@ -58,144 +58,144 @@ discard block |
||
58 | 58 | 'amount' => null, |
59 | 59 | ); |
60 | 60 | |
61 | - /** |
|
62 | - * Stores meta in cache for future reads. |
|
63 | - * |
|
64 | - * A group must be set to to enable caching. |
|
65 | - * |
|
66 | - * @var string |
|
67 | - */ |
|
68 | - protected $cache_group = 'getpaid_discounts'; |
|
61 | + /** |
|
62 | + * Stores meta in cache for future reads. |
|
63 | + * |
|
64 | + * A group must be set to to enable caching. |
|
65 | + * |
|
66 | + * @var string |
|
67 | + */ |
|
68 | + protected $cache_group = 'getpaid_discounts'; |
|
69 | 69 | |
70 | 70 | /** |
71 | 71 | * Stores a reference to the original WP_Post object |
72 | 72 | * |
73 | 73 | * @var WP_Post |
74 | 74 | */ |
75 | - protected $post = null; |
|
76 | - |
|
77 | - /** |
|
78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
79 | - * |
|
80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
81 | - */ |
|
82 | - public function __construct( $discount = 0 ) { |
|
83 | - parent::__construct( $discount ); |
|
84 | - |
|
85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
86 | - $this->set_id( $discount ); |
|
87 | - } elseif ( $discount instanceof self ) { |
|
88 | - $this->set_id( $discount->get_id() ); |
|
89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
90 | - $this->set_id( $discount->ID ); |
|
91 | - } elseif ( is_array( $discount ) ) { |
|
92 | - $this->set_props( $discount ); |
|
93 | - |
|
94 | - if ( isset( $discount['ID'] ) ) { |
|
95 | - $this->set_id( $discount['ID'] ); |
|
96 | - } |
|
97 | - |
|
98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
99 | - $this->set_id( $discount ); |
|
100 | - } else { |
|
101 | - $this->set_object_read( true ); |
|
102 | - } |
|
75 | + protected $post = null; |
|
76 | + |
|
77 | + /** |
|
78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
79 | + * |
|
80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
81 | + */ |
|
82 | + public function __construct( $discount = 0 ) { |
|
83 | + parent::__construct( $discount ); |
|
84 | + |
|
85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
86 | + $this->set_id( $discount ); |
|
87 | + } elseif ( $discount instanceof self ) { |
|
88 | + $this->set_id( $discount->get_id() ); |
|
89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
90 | + $this->set_id( $discount->ID ); |
|
91 | + } elseif ( is_array( $discount ) ) { |
|
92 | + $this->set_props( $discount ); |
|
93 | + |
|
94 | + if ( isset( $discount['ID'] ) ) { |
|
95 | + $this->set_id( $discount['ID'] ); |
|
96 | + } |
|
97 | + |
|
98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
99 | + $this->set_id( $discount ); |
|
100 | + } else { |
|
101 | + $this->set_object_read( true ); |
|
102 | + } |
|
103 | 103 | |
104 | 104 | // Load the datastore. |
105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
106 | 106 | |
107 | - if ( $this->get_id() > 0 ) { |
|
107 | + if ( $this->get_id() > 0 ) { |
|
108 | 108 | $this->post = get_post( $this->get_id() ); |
109 | 109 | $this->ID = $this->get_id(); |
110 | - $this->data_store->read( $this ); |
|
110 | + $this->data_store->read( $this ); |
|
111 | + } |
|
112 | + |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Fetch a discount from the db/cache |
|
117 | + * |
|
118 | + * |
|
119 | + * @static |
|
120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
121 | + * @param string|int $value The field value |
|
122 | + * @deprecated |
|
123 | + * @since 1.0.15 |
|
124 | + * @return array|bool array of discount details on success. False otherwise. |
|
125 | + */ |
|
126 | + public static function get_data_by( $field, $value ) { |
|
127 | + |
|
128 | + if ( 'id' == strtolower( $field ) ) { |
|
129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
130 | + // to int 1. |
|
131 | + if ( ! is_numeric( $value ) ) |
|
132 | + return false; |
|
133 | + $value = intval( $value ); |
|
134 | + if ( $value < 1 ) |
|
135 | + return false; |
|
136 | + } |
|
137 | + |
|
138 | + if ( ! $value || ! is_string( $field ) ) { |
|
139 | + return false; |
|
140 | + } |
|
141 | + |
|
142 | + $field = trim( $field ); |
|
143 | + |
|
144 | + // prepare query args |
|
145 | + switch ( strtolower( $field ) ) { |
|
146 | + case 'id': |
|
147 | + $discount_id = $value; |
|
148 | + $args = array( 'include' => array( $value ) ); |
|
149 | + break; |
|
150 | + case 'discount_code': |
|
151 | + case 'code': |
|
152 | + $value = trim( $value ); |
|
153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
155 | + break; |
|
156 | + case 'name': |
|
157 | + $discount_id = 0; |
|
158 | + $args = array( 'name' => trim( $value ) ); |
|
159 | + break; |
|
160 | + default: |
|
161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
162 | + if ( ! is_array( $args ) ) { |
|
163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
164 | + } |
|
165 | + |
|
166 | + } |
|
167 | + |
|
168 | + // Check if there is a cached value. |
|
169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
170 | + return $discount; |
|
171 | + } |
|
172 | + |
|
173 | + $args = array_merge( |
|
174 | + $args, |
|
175 | + array( |
|
176 | + 'post_type' => 'wpi_discount', |
|
177 | + 'posts_per_page' => 1, |
|
178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
179 | + ) |
|
180 | + ); |
|
181 | + |
|
182 | + $discount = get_posts( $args ); |
|
183 | + |
|
184 | + if( empty( $discount ) ) { |
|
185 | + return false; |
|
111 | 186 | } |
112 | 187 | |
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Fetch a discount from the db/cache |
|
117 | - * |
|
118 | - * |
|
119 | - * @static |
|
120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
121 | - * @param string|int $value The field value |
|
122 | - * @deprecated |
|
123 | - * @since 1.0.15 |
|
124 | - * @return array|bool array of discount details on success. False otherwise. |
|
125 | - */ |
|
126 | - public static function get_data_by( $field, $value ) { |
|
127 | - |
|
128 | - if ( 'id' == strtolower( $field ) ) { |
|
129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
130 | - // to int 1. |
|
131 | - if ( ! is_numeric( $value ) ) |
|
132 | - return false; |
|
133 | - $value = intval( $value ); |
|
134 | - if ( $value < 1 ) |
|
135 | - return false; |
|
136 | - } |
|
137 | - |
|
138 | - if ( ! $value || ! is_string( $field ) ) { |
|
139 | - return false; |
|
140 | - } |
|
141 | - |
|
142 | - $field = trim( $field ); |
|
143 | - |
|
144 | - // prepare query args |
|
145 | - switch ( strtolower( $field ) ) { |
|
146 | - case 'id': |
|
147 | - $discount_id = $value; |
|
148 | - $args = array( 'include' => array( $value ) ); |
|
149 | - break; |
|
150 | - case 'discount_code': |
|
151 | - case 'code': |
|
152 | - $value = trim( $value ); |
|
153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
155 | - break; |
|
156 | - case 'name': |
|
157 | - $discount_id = 0; |
|
158 | - $args = array( 'name' => trim( $value ) ); |
|
159 | - break; |
|
160 | - default: |
|
161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
162 | - if ( ! is_array( $args ) ) { |
|
163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
164 | - } |
|
165 | - |
|
166 | - } |
|
167 | - |
|
168 | - // Check if there is a cached value. |
|
169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
170 | - return $discount; |
|
171 | - } |
|
172 | - |
|
173 | - $args = array_merge( |
|
174 | - $args, |
|
175 | - array( |
|
176 | - 'post_type' => 'wpi_discount', |
|
177 | - 'posts_per_page' => 1, |
|
178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
179 | - ) |
|
180 | - ); |
|
181 | - |
|
182 | - $discount = get_posts( $args ); |
|
183 | - |
|
184 | - if( empty( $discount ) ) { |
|
185 | - return false; |
|
186 | - } |
|
187 | - |
|
188 | - $discount = $discount[0]; |
|
189 | - |
|
190 | - // Prepare the return data. |
|
191 | - $return = array( |
|
188 | + $discount = $discount[0]; |
|
189 | + |
|
190 | + // Prepare the return data. |
|
191 | + $return = array( |
|
192 | 192 | 'ID' => $discount->ID, |
193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
195 | 195 | 'date_created' => $discount->post_date, |
196 | - 'date_modified' => $discount->post_modified, |
|
197 | - 'status' => $discount->post_status, |
|
198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
196 | + 'date_modified' => $discount->post_modified, |
|
197 | + 'status' => $discount->post_status, |
|
198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
210 | 210 | ); |
211 | 211 | |
212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
213 | - |
|
214 | - // Update the cache with our data |
|
215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
217 | - |
|
218 | - return $return; |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * Given a discount code, it returns a discount id. |
|
223 | - * |
|
224 | - * |
|
225 | - * @static |
|
226 | - * @param string $discount_code |
|
227 | - * @since 1.0.15 |
|
228 | - * @return int |
|
229 | - */ |
|
230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
231 | - |
|
232 | - // Trim the code. |
|
233 | - $discount_code = trim( $discount_code ); |
|
234 | - |
|
235 | - // Ensure a value has been passed. |
|
236 | - if ( empty( $discount_code ) ) { |
|
237 | - return 0; |
|
238 | - } |
|
239 | - |
|
240 | - // Maybe retrieve from the cache. |
|
241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
242 | - if ( ! empty( $discount_id ) ) { |
|
243 | - return $discount_id; |
|
244 | - } |
|
245 | - |
|
246 | - // Fetch the first discount codes. |
|
247 | - $discounts = get_posts( |
|
248 | - array( |
|
249 | - 'meta_key' => '_wpi_discount_code', |
|
250 | - 'meta_value' => $discount_code, |
|
251 | - 'post_type' => 'wpi_discount', |
|
252 | - 'posts_per_page' => 1, |
|
253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
254 | - 'fields' => 'ids', |
|
255 | - ) |
|
256 | - ); |
|
257 | - |
|
258 | - if ( empty( $discounts ) ) { |
|
259 | - return 0; |
|
260 | - } |
|
261 | - |
|
262 | - $discount_id = $discounts[0]; |
|
263 | - |
|
264 | - // Update the cache with our data |
|
265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
266 | - |
|
267 | - return $discount_id; |
|
268 | - } |
|
269 | - |
|
270 | - /** |
|
271 | - * Magic method for checking the existence of a certain custom field. |
|
272 | - * |
|
273 | - * @since 1.0.15 |
|
274 | - * @access public |
|
275 | - * |
|
276 | - * @return bool Whether the given discount field is set. |
|
277 | - */ |
|
278 | - public function __isset( $key ){ |
|
279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
280 | - } |
|
281 | - |
|
282 | - /* |
|
212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
213 | + |
|
214 | + // Update the cache with our data |
|
215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
217 | + |
|
218 | + return $return; |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * Given a discount code, it returns a discount id. |
|
223 | + * |
|
224 | + * |
|
225 | + * @static |
|
226 | + * @param string $discount_code |
|
227 | + * @since 1.0.15 |
|
228 | + * @return int |
|
229 | + */ |
|
230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
231 | + |
|
232 | + // Trim the code. |
|
233 | + $discount_code = trim( $discount_code ); |
|
234 | + |
|
235 | + // Ensure a value has been passed. |
|
236 | + if ( empty( $discount_code ) ) { |
|
237 | + return 0; |
|
238 | + } |
|
239 | + |
|
240 | + // Maybe retrieve from the cache. |
|
241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
242 | + if ( ! empty( $discount_id ) ) { |
|
243 | + return $discount_id; |
|
244 | + } |
|
245 | + |
|
246 | + // Fetch the first discount codes. |
|
247 | + $discounts = get_posts( |
|
248 | + array( |
|
249 | + 'meta_key' => '_wpi_discount_code', |
|
250 | + 'meta_value' => $discount_code, |
|
251 | + 'post_type' => 'wpi_discount', |
|
252 | + 'posts_per_page' => 1, |
|
253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
254 | + 'fields' => 'ids', |
|
255 | + ) |
|
256 | + ); |
|
257 | + |
|
258 | + if ( empty( $discounts ) ) { |
|
259 | + return 0; |
|
260 | + } |
|
261 | + |
|
262 | + $discount_id = $discounts[0]; |
|
263 | + |
|
264 | + // Update the cache with our data |
|
265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
266 | + |
|
267 | + return $discount_id; |
|
268 | + } |
|
269 | + |
|
270 | + /** |
|
271 | + * Magic method for checking the existence of a certain custom field. |
|
272 | + * |
|
273 | + * @since 1.0.15 |
|
274 | + * @access public |
|
275 | + * |
|
276 | + * @return bool Whether the given discount field is set. |
|
277 | + */ |
|
278 | + public function __isset( $key ){ |
|
279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
280 | + } |
|
281 | + |
|
282 | + /* |
|
283 | 283 | |-------------------------------------------------------------------------- |
284 | 284 | | CRUD methods |
285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
294 | 294 | |-------------------------------------------------------------------------- |
295 | 295 | */ |
296 | 296 | |
297 | - /** |
|
298 | - * Get discount status. |
|
299 | - * |
|
300 | - * @since 1.0.19 |
|
301 | - * @param string $context View or edit context. |
|
302 | - * @return string |
|
303 | - */ |
|
304 | - public function get_status( $context = 'view' ) { |
|
305 | - return $this->get_prop( 'status', $context ); |
|
297 | + /** |
|
298 | + * Get discount status. |
|
299 | + * |
|
300 | + * @since 1.0.19 |
|
301 | + * @param string $context View or edit context. |
|
302 | + * @return string |
|
303 | + */ |
|
304 | + public function get_status( $context = 'view' ) { |
|
305 | + return $this->get_prop( 'status', $context ); |
|
306 | 306 | } |
307 | 307 | |
308 | 308 | /** |
309 | - * Get plugin version when the discount was created. |
|
310 | - * |
|
311 | - * @since 1.0.19 |
|
312 | - * @param string $context View or edit context. |
|
313 | - * @return string |
|
314 | - */ |
|
315 | - public function get_version( $context = 'view' ) { |
|
316 | - return $this->get_prop( 'version', $context ); |
|
309 | + * Get plugin version when the discount was created. |
|
310 | + * |
|
311 | + * @since 1.0.19 |
|
312 | + * @param string $context View or edit context. |
|
313 | + * @return string |
|
314 | + */ |
|
315 | + public function get_version( $context = 'view' ) { |
|
316 | + return $this->get_prop( 'version', $context ); |
|
317 | 317 | } |
318 | 318 | |
319 | 319 | /** |
320 | - * Get date when the discount was created. |
|
321 | - * |
|
322 | - * @since 1.0.19 |
|
323 | - * @param string $context View or edit context. |
|
324 | - * @return string |
|
325 | - */ |
|
326 | - public function get_date_created( $context = 'view' ) { |
|
327 | - return $this->get_prop( 'date_created', $context ); |
|
320 | + * Get date when the discount was created. |
|
321 | + * |
|
322 | + * @since 1.0.19 |
|
323 | + * @param string $context View or edit context. |
|
324 | + * @return string |
|
325 | + */ |
|
326 | + public function get_date_created( $context = 'view' ) { |
|
327 | + return $this->get_prop( 'date_created', $context ); |
|
328 | 328 | } |
329 | 329 | |
330 | 330 | /** |
331 | - * Get GMT date when the discount was created. |
|
332 | - * |
|
333 | - * @since 1.0.19 |
|
334 | - * @param string $context View or edit context. |
|
335 | - * @return string |
|
336 | - */ |
|
337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
331 | + * Get GMT date when the discount was created. |
|
332 | + * |
|
333 | + * @since 1.0.19 |
|
334 | + * @param string $context View or edit context. |
|
335 | + * @return string |
|
336 | + */ |
|
337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
338 | 338 | $date = $this->get_date_created( $context ); |
339 | 339 | |
340 | 340 | if ( $date ) { |
341 | 341 | $date = get_gmt_from_date( $date ); |
342 | 342 | } |
343 | - return $date; |
|
343 | + return $date; |
|
344 | 344 | } |
345 | 345 | |
346 | 346 | /** |
347 | - * Get date when the discount was last modified. |
|
348 | - * |
|
349 | - * @since 1.0.19 |
|
350 | - * @param string $context View or edit context. |
|
351 | - * @return string |
|
352 | - */ |
|
353 | - public function get_date_modified( $context = 'view' ) { |
|
354 | - return $this->get_prop( 'date_modified', $context ); |
|
347 | + * Get date when the discount was last modified. |
|
348 | + * |
|
349 | + * @since 1.0.19 |
|
350 | + * @param string $context View or edit context. |
|
351 | + * @return string |
|
352 | + */ |
|
353 | + public function get_date_modified( $context = 'view' ) { |
|
354 | + return $this->get_prop( 'date_modified', $context ); |
|
355 | 355 | } |
356 | 356 | |
357 | 357 | /** |
358 | - * Get GMT date when the discount was last modified. |
|
359 | - * |
|
360 | - * @since 1.0.19 |
|
361 | - * @param string $context View or edit context. |
|
362 | - * @return string |
|
363 | - */ |
|
364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
358 | + * Get GMT date when the discount was last modified. |
|
359 | + * |
|
360 | + * @since 1.0.19 |
|
361 | + * @param string $context View or edit context. |
|
362 | + * @return string |
|
363 | + */ |
|
364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
365 | 365 | $date = $this->get_date_modified( $context ); |
366 | 366 | |
367 | 367 | if ( $date ) { |
368 | 368 | $date = get_gmt_from_date( $date ); |
369 | 369 | } |
370 | - return $date; |
|
370 | + return $date; |
|
371 | 371 | } |
372 | 372 | |
373 | 373 | /** |
374 | - * Get the discount name. |
|
375 | - * |
|
376 | - * @since 1.0.19 |
|
377 | - * @param string $context View or edit context. |
|
378 | - * @return string |
|
379 | - */ |
|
380 | - public function get_name( $context = 'view' ) { |
|
381 | - return $this->get_prop( 'name', $context ); |
|
374 | + * Get the discount name. |
|
375 | + * |
|
376 | + * @since 1.0.19 |
|
377 | + * @param string $context View or edit context. |
|
378 | + * @return string |
|
379 | + */ |
|
380 | + public function get_name( $context = 'view' ) { |
|
381 | + return $this->get_prop( 'name', $context ); |
|
382 | 382 | } |
383 | 383 | |
384 | 384 | /** |
385 | - * Alias of self::get_name(). |
|
386 | - * |
|
387 | - * @since 1.0.19 |
|
388 | - * @param string $context View or edit context. |
|
389 | - * @return string |
|
390 | - */ |
|
391 | - public function get_title( $context = 'view' ) { |
|
392 | - return $this->get_name( $context ); |
|
385 | + * Alias of self::get_name(). |
|
386 | + * |
|
387 | + * @since 1.0.19 |
|
388 | + * @param string $context View or edit context. |
|
389 | + * @return string |
|
390 | + */ |
|
391 | + public function get_title( $context = 'view' ) { |
|
392 | + return $this->get_name( $context ); |
|
393 | 393 | } |
394 | 394 | |
395 | 395 | /** |
396 | - * Get the discount description. |
|
397 | - * |
|
398 | - * @since 1.0.19 |
|
399 | - * @param string $context View or edit context. |
|
400 | - * @return string |
|
401 | - */ |
|
402 | - public function get_description( $context = 'view' ) { |
|
403 | - return $this->get_prop( 'description', $context ); |
|
396 | + * Get the discount description. |
|
397 | + * |
|
398 | + * @since 1.0.19 |
|
399 | + * @param string $context View or edit context. |
|
400 | + * @return string |
|
401 | + */ |
|
402 | + public function get_description( $context = 'view' ) { |
|
403 | + return $this->get_prop( 'description', $context ); |
|
404 | 404 | } |
405 | 405 | |
406 | 406 | /** |
407 | - * Alias of self::get_description(). |
|
408 | - * |
|
409 | - * @since 1.0.19 |
|
410 | - * @param string $context View or edit context. |
|
411 | - * @return string |
|
412 | - */ |
|
413 | - public function get_excerpt( $context = 'view' ) { |
|
414 | - return $this->get_description( $context ); |
|
407 | + * Alias of self::get_description(). |
|
408 | + * |
|
409 | + * @since 1.0.19 |
|
410 | + * @param string $context View or edit context. |
|
411 | + * @return string |
|
412 | + */ |
|
413 | + public function get_excerpt( $context = 'view' ) { |
|
414 | + return $this->get_description( $context ); |
|
415 | 415 | } |
416 | 416 | |
417 | 417 | /** |
418 | - * Alias of self::get_description(). |
|
419 | - * |
|
420 | - * @since 1.0.19 |
|
421 | - * @param string $context View or edit context. |
|
422 | - * @return string |
|
423 | - */ |
|
424 | - public function get_summary( $context = 'view' ) { |
|
425 | - return $this->get_description( $context ); |
|
418 | + * Alias of self::get_description(). |
|
419 | + * |
|
420 | + * @since 1.0.19 |
|
421 | + * @param string $context View or edit context. |
|
422 | + * @return string |
|
423 | + */ |
|
424 | + public function get_summary( $context = 'view' ) { |
|
425 | + return $this->get_description( $context ); |
|
426 | 426 | } |
427 | 427 | |
428 | 428 | /** |
429 | - * Get the owner of the discount. |
|
430 | - * |
|
431 | - * @since 1.0.19 |
|
432 | - * @param string $context View or edit context. |
|
433 | - * @return string |
|
434 | - */ |
|
435 | - public function get_author( $context = 'view' ) { |
|
436 | - return (int) $this->get_prop( 'author', $context ); |
|
437 | - } |
|
429 | + * Get the owner of the discount. |
|
430 | + * |
|
431 | + * @since 1.0.19 |
|
432 | + * @param string $context View or edit context. |
|
433 | + * @return string |
|
434 | + */ |
|
435 | + public function get_author( $context = 'view' ) { |
|
436 | + return (int) $this->get_prop( 'author', $context ); |
|
437 | + } |
|
438 | 438 | |
439 | - /** |
|
440 | - * Get the discount code. |
|
441 | - * |
|
442 | - * @since 1.0.19 |
|
443 | - * @param string $context View or edit context. |
|
444 | - * @return string |
|
445 | - */ |
|
446 | - public function get_code( $context = 'view' ) { |
|
447 | - return $this->get_prop( 'code', $context ); |
|
448 | - } |
|
439 | + /** |
|
440 | + * Get the discount code. |
|
441 | + * |
|
442 | + * @since 1.0.19 |
|
443 | + * @param string $context View or edit context. |
|
444 | + * @return string |
|
445 | + */ |
|
446 | + public function get_code( $context = 'view' ) { |
|
447 | + return $this->get_prop( 'code', $context ); |
|
448 | + } |
|
449 | 449 | |
450 | - /** |
|
451 | - * Alias for self::get_code(). |
|
452 | - * |
|
453 | - * @since 1.0.19 |
|
454 | - * @param string $context View or edit context. |
|
455 | - * @return string |
|
456 | - */ |
|
457 | - public function get_coupon_code( $context = 'view' ) { |
|
458 | - return $this->get_code( $context ); |
|
459 | - } |
|
450 | + /** |
|
451 | + * Alias for self::get_code(). |
|
452 | + * |
|
453 | + * @since 1.0.19 |
|
454 | + * @param string $context View or edit context. |
|
455 | + * @return string |
|
456 | + */ |
|
457 | + public function get_coupon_code( $context = 'view' ) { |
|
458 | + return $this->get_code( $context ); |
|
459 | + } |
|
460 | 460 | |
461 | - /** |
|
462 | - * Alias for self::get_code(). |
|
463 | - * |
|
464 | - * @since 1.0.19 |
|
465 | - * @param string $context View or edit context. |
|
466 | - * @return string |
|
467 | - */ |
|
468 | - public function get_discount_code( $context = 'view' ) { |
|
469 | - return $this->get_code( $context ); |
|
470 | - } |
|
461 | + /** |
|
462 | + * Alias for self::get_code(). |
|
463 | + * |
|
464 | + * @since 1.0.19 |
|
465 | + * @param string $context View or edit context. |
|
466 | + * @return string |
|
467 | + */ |
|
468 | + public function get_discount_code( $context = 'view' ) { |
|
469 | + return $this->get_code( $context ); |
|
470 | + } |
|
471 | 471 | |
472 | - /** |
|
473 | - * Get the discount's amount. |
|
474 | - * |
|
475 | - * @since 1.0.19 |
|
476 | - * @param string $context View or edit context. |
|
477 | - * @return float |
|
478 | - */ |
|
479 | - public function get_amount( $context = 'view' ) { |
|
480 | - return $this->get_prop( 'amount', $context ); |
|
481 | - } |
|
482 | - |
|
483 | - /** |
|
484 | - * Get the discount's formated amount/rate. |
|
485 | - * |
|
486 | - * @since 1.0.19 |
|
487 | - * @return string |
|
488 | - */ |
|
489 | - public function get_formatted_amount() { |
|
490 | - |
|
491 | - if ( $this->is_type( 'flat' ) ) { |
|
492 | - $rate = wpinv_price( wpinv_format_amount( $this->get_amount() ) ); |
|
493 | - } else { |
|
494 | - $rate = $this->get_amount() . '%'; |
|
495 | - } |
|
496 | - |
|
497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
498 | - } |
|
472 | + /** |
|
473 | + * Get the discount's amount. |
|
474 | + * |
|
475 | + * @since 1.0.19 |
|
476 | + * @param string $context View or edit context. |
|
477 | + * @return float |
|
478 | + */ |
|
479 | + public function get_amount( $context = 'view' ) { |
|
480 | + return $this->get_prop( 'amount', $context ); |
|
481 | + } |
|
482 | + |
|
483 | + /** |
|
484 | + * Get the discount's formated amount/rate. |
|
485 | + * |
|
486 | + * @since 1.0.19 |
|
487 | + * @return string |
|
488 | + */ |
|
489 | + public function get_formatted_amount() { |
|
490 | + |
|
491 | + if ( $this->is_type( 'flat' ) ) { |
|
492 | + $rate = wpinv_price( wpinv_format_amount( $this->get_amount() ) ); |
|
493 | + } else { |
|
494 | + $rate = $this->get_amount() . '%'; |
|
495 | + } |
|
496 | + |
|
497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
498 | + } |
|
499 | 499 | |
500 | - /** |
|
501 | - * Get the discount's start date. |
|
502 | - * |
|
503 | - * @since 1.0.19 |
|
504 | - * @param string $context View or edit context. |
|
505 | - * @return string |
|
506 | - */ |
|
507 | - public function get_start( $context = 'view' ) { |
|
508 | - return $this->get_prop( 'start', $context ); |
|
509 | - } |
|
500 | + /** |
|
501 | + * Get the discount's start date. |
|
502 | + * |
|
503 | + * @since 1.0.19 |
|
504 | + * @param string $context View or edit context. |
|
505 | + * @return string |
|
506 | + */ |
|
507 | + public function get_start( $context = 'view' ) { |
|
508 | + return $this->get_prop( 'start', $context ); |
|
509 | + } |
|
510 | 510 | |
511 | - /** |
|
512 | - * Alias for self::get_start(). |
|
513 | - * |
|
514 | - * @since 1.0.19 |
|
515 | - * @param string $context View or edit context. |
|
516 | - * @return string |
|
517 | - */ |
|
518 | - public function get_start_date( $context = 'view' ) { |
|
519 | - return $this->get_start( $context ); |
|
520 | - } |
|
511 | + /** |
|
512 | + * Alias for self::get_start(). |
|
513 | + * |
|
514 | + * @since 1.0.19 |
|
515 | + * @param string $context View or edit context. |
|
516 | + * @return string |
|
517 | + */ |
|
518 | + public function get_start_date( $context = 'view' ) { |
|
519 | + return $this->get_start( $context ); |
|
520 | + } |
|
521 | 521 | |
522 | - /** |
|
523 | - * Get the discount's expiration date. |
|
524 | - * |
|
525 | - * @since 1.0.19 |
|
526 | - * @param string $context View or edit context. |
|
527 | - * @return string |
|
528 | - */ |
|
529 | - public function get_expiration( $context = 'view' ) { |
|
530 | - return $this->get_prop( 'expiration', $context ); |
|
531 | - } |
|
522 | + /** |
|
523 | + * Get the discount's expiration date. |
|
524 | + * |
|
525 | + * @since 1.0.19 |
|
526 | + * @param string $context View or edit context. |
|
527 | + * @return string |
|
528 | + */ |
|
529 | + public function get_expiration( $context = 'view' ) { |
|
530 | + return $this->get_prop( 'expiration', $context ); |
|
531 | + } |
|
532 | 532 | |
533 | - /** |
|
534 | - * Alias for self::get_expiration(). |
|
535 | - * |
|
536 | - * @since 1.0.19 |
|
537 | - * @param string $context View or edit context. |
|
538 | - * @return string |
|
539 | - */ |
|
540 | - public function get_expiration_date( $context = 'view' ) { |
|
541 | - return $this->get_expiration( $context ); |
|
542 | - } |
|
543 | - |
|
544 | - /** |
|
545 | - * Alias for self::get_expiration(). |
|
546 | - * |
|
547 | - * @since 1.0.19 |
|
548 | - * @param string $context View or edit context. |
|
549 | - * @return string |
|
550 | - */ |
|
551 | - public function get_end_date( $context = 'view' ) { |
|
552 | - return $this->get_expiration( $context ); |
|
553 | - } |
|
533 | + /** |
|
534 | + * Alias for self::get_expiration(). |
|
535 | + * |
|
536 | + * @since 1.0.19 |
|
537 | + * @param string $context View or edit context. |
|
538 | + * @return string |
|
539 | + */ |
|
540 | + public function get_expiration_date( $context = 'view' ) { |
|
541 | + return $this->get_expiration( $context ); |
|
542 | + } |
|
543 | + |
|
544 | + /** |
|
545 | + * Alias for self::get_expiration(). |
|
546 | + * |
|
547 | + * @since 1.0.19 |
|
548 | + * @param string $context View or edit context. |
|
549 | + * @return string |
|
550 | + */ |
|
551 | + public function get_end_date( $context = 'view' ) { |
|
552 | + return $this->get_expiration( $context ); |
|
553 | + } |
|
554 | 554 | |
555 | - /** |
|
556 | - * Get the discount's type. |
|
557 | - * |
|
558 | - * @since 1.0.19 |
|
559 | - * @param string $context View or edit context. |
|
560 | - * @return string |
|
561 | - */ |
|
562 | - public function get_type( $context = 'view' ) { |
|
563 | - return $this->get_prop( 'type', $context ); |
|
564 | - } |
|
565 | - |
|
566 | - /** |
|
567 | - * Get the number of times a discount has been used. |
|
568 | - * |
|
569 | - * @since 1.0.19 |
|
570 | - * @param string $context View or edit context. |
|
571 | - * @return int |
|
572 | - */ |
|
573 | - public function get_uses( $context = 'view' ) { |
|
574 | - return (int) $this->get_prop( 'uses', $context ); |
|
575 | - } |
|
576 | - |
|
577 | - /** |
|
578 | - * Get the discount's usage, i.e uses / max uses. |
|
579 | - * |
|
580 | - * @since 1.0.19 |
|
581 | - * @return string |
|
582 | - */ |
|
583 | - public function get_usage() { |
|
584 | - |
|
585 | - if ( ! $this->has_limit() ) { |
|
586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
587 | - } |
|
588 | - |
|
589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
590 | - |
|
591 | - } |
|
592 | - |
|
593 | - /** |
|
594 | - * Get the maximum number of time a discount can be used. |
|
595 | - * |
|
596 | - * @since 1.0.19 |
|
597 | - * @param string $context View or edit context. |
|
598 | - * @return int |
|
599 | - */ |
|
600 | - public function get_max_uses( $context = 'view' ) { |
|
601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
602 | - return empty( $max_uses ) ? null : $max_uses; |
|
603 | - } |
|
604 | - |
|
605 | - /** |
|
606 | - * Checks if this is a single use discount or not. |
|
607 | - * |
|
608 | - * @since 1.0.19 |
|
609 | - * @param string $context View or edit context. |
|
610 | - * @return bool |
|
611 | - */ |
|
612 | - public function get_is_single_use( $context = 'view' ) { |
|
613 | - return $this->get_prop( 'is_single_use', $context ); |
|
614 | - } |
|
615 | - |
|
616 | - /** |
|
617 | - * Get the items that can be used with this discount. |
|
618 | - * |
|
619 | - * @since 1.0.19 |
|
620 | - * @param string $context View or edit context. |
|
621 | - * @return array |
|
622 | - */ |
|
623 | - public function get_items( $context = 'view' ) { |
|
624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
625 | - } |
|
626 | - |
|
627 | - /** |
|
628 | - * Alias for self::get_items(). |
|
629 | - * |
|
630 | - * @since 1.0.19 |
|
631 | - * @param string $context View or edit context. |
|
632 | - * @return array |
|
633 | - */ |
|
634 | - public function get_allowed_items( $context = 'view' ) { |
|
635 | - return $this->get_items( $context ); |
|
636 | - } |
|
637 | - |
|
638 | - /** |
|
639 | - * Get the items that are not allowed to use this discount. |
|
640 | - * |
|
641 | - * @since 1.0.19 |
|
642 | - * @param string $context View or edit context. |
|
643 | - * @return array |
|
644 | - */ |
|
645 | - public function get_excluded_items( $context = 'view' ) { |
|
646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
647 | - } |
|
648 | - |
|
649 | - /** |
|
650 | - * Checks if this is a recurring discount or not. |
|
651 | - * |
|
652 | - * @since 1.0.19 |
|
653 | - * @param string $context View or edit context. |
|
654 | - * @return int|string|bool |
|
655 | - */ |
|
656 | - public function get_is_recurring( $context = 'view' ) { |
|
657 | - return $this->get_prop( 'is_recurring', $context ); |
|
658 | - } |
|
659 | - |
|
660 | - /** |
|
661 | - * Get's the minimum total amount allowed for this discount. |
|
662 | - * |
|
663 | - * @since 1.0.19 |
|
664 | - * @param string $context View or edit context. |
|
665 | - * @return float |
|
666 | - */ |
|
667 | - public function get_min_total( $context = 'view' ) { |
|
668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
669 | - return empty( $minimum ) ? null : $minimum; |
|
670 | - } |
|
671 | - |
|
672 | - /** |
|
673 | - * Alias for self::get_min_total(). |
|
674 | - * |
|
675 | - * @since 1.0.19 |
|
676 | - * @param string $context View or edit context. |
|
677 | - * @return float |
|
678 | - */ |
|
679 | - public function get_minimum_total( $context = 'view' ) { |
|
680 | - return $this->get_min_total( $context ); |
|
681 | - } |
|
682 | - |
|
683 | - /** |
|
684 | - * Get's the maximum total amount allowed for this discount. |
|
685 | - * |
|
686 | - * @since 1.0.19 |
|
687 | - * @param string $context View or edit context. |
|
688 | - * @return float |
|
689 | - */ |
|
690 | - public function get_max_total( $context = 'view' ) { |
|
691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
692 | - return empty( $maximum ) ? null : $maximum; |
|
693 | - } |
|
694 | - |
|
695 | - /** |
|
696 | - * Alias for self::get_max_total(). |
|
697 | - * |
|
698 | - * @since 1.0.19 |
|
699 | - * @param string $context View or edit context. |
|
700 | - * @return float |
|
701 | - */ |
|
702 | - public function get_maximum_total( $context = 'view' ) { |
|
703 | - return $this->get_max_total( $context ); |
|
704 | - } |
|
705 | - |
|
706 | - /** |
|
707 | - * Magic method for accessing discount properties. |
|
708 | - * |
|
709 | - * @since 1.0.15 |
|
710 | - * @access public |
|
711 | - * |
|
712 | - * @param string $key Discount data to retrieve |
|
713 | - * @param string $context View or edit context. |
|
714 | - * @return mixed Value of the given discount property (if set). |
|
715 | - */ |
|
716 | - public function get( $key, $context = 'view' ) { |
|
555 | + /** |
|
556 | + * Get the discount's type. |
|
557 | + * |
|
558 | + * @since 1.0.19 |
|
559 | + * @param string $context View or edit context. |
|
560 | + * @return string |
|
561 | + */ |
|
562 | + public function get_type( $context = 'view' ) { |
|
563 | + return $this->get_prop( 'type', $context ); |
|
564 | + } |
|
565 | + |
|
566 | + /** |
|
567 | + * Get the number of times a discount has been used. |
|
568 | + * |
|
569 | + * @since 1.0.19 |
|
570 | + * @param string $context View or edit context. |
|
571 | + * @return int |
|
572 | + */ |
|
573 | + public function get_uses( $context = 'view' ) { |
|
574 | + return (int) $this->get_prop( 'uses', $context ); |
|
575 | + } |
|
576 | + |
|
577 | + /** |
|
578 | + * Get the discount's usage, i.e uses / max uses. |
|
579 | + * |
|
580 | + * @since 1.0.19 |
|
581 | + * @return string |
|
582 | + */ |
|
583 | + public function get_usage() { |
|
584 | + |
|
585 | + if ( ! $this->has_limit() ) { |
|
586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
587 | + } |
|
588 | + |
|
589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
590 | + |
|
591 | + } |
|
592 | + |
|
593 | + /** |
|
594 | + * Get the maximum number of time a discount can be used. |
|
595 | + * |
|
596 | + * @since 1.0.19 |
|
597 | + * @param string $context View or edit context. |
|
598 | + * @return int |
|
599 | + */ |
|
600 | + public function get_max_uses( $context = 'view' ) { |
|
601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
602 | + return empty( $max_uses ) ? null : $max_uses; |
|
603 | + } |
|
604 | + |
|
605 | + /** |
|
606 | + * Checks if this is a single use discount or not. |
|
607 | + * |
|
608 | + * @since 1.0.19 |
|
609 | + * @param string $context View or edit context. |
|
610 | + * @return bool |
|
611 | + */ |
|
612 | + public function get_is_single_use( $context = 'view' ) { |
|
613 | + return $this->get_prop( 'is_single_use', $context ); |
|
614 | + } |
|
615 | + |
|
616 | + /** |
|
617 | + * Get the items that can be used with this discount. |
|
618 | + * |
|
619 | + * @since 1.0.19 |
|
620 | + * @param string $context View or edit context. |
|
621 | + * @return array |
|
622 | + */ |
|
623 | + public function get_items( $context = 'view' ) { |
|
624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
625 | + } |
|
626 | + |
|
627 | + /** |
|
628 | + * Alias for self::get_items(). |
|
629 | + * |
|
630 | + * @since 1.0.19 |
|
631 | + * @param string $context View or edit context. |
|
632 | + * @return array |
|
633 | + */ |
|
634 | + public function get_allowed_items( $context = 'view' ) { |
|
635 | + return $this->get_items( $context ); |
|
636 | + } |
|
637 | + |
|
638 | + /** |
|
639 | + * Get the items that are not allowed to use this discount. |
|
640 | + * |
|
641 | + * @since 1.0.19 |
|
642 | + * @param string $context View or edit context. |
|
643 | + * @return array |
|
644 | + */ |
|
645 | + public function get_excluded_items( $context = 'view' ) { |
|
646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
647 | + } |
|
648 | + |
|
649 | + /** |
|
650 | + * Checks if this is a recurring discount or not. |
|
651 | + * |
|
652 | + * @since 1.0.19 |
|
653 | + * @param string $context View or edit context. |
|
654 | + * @return int|string|bool |
|
655 | + */ |
|
656 | + public function get_is_recurring( $context = 'view' ) { |
|
657 | + return $this->get_prop( 'is_recurring', $context ); |
|
658 | + } |
|
659 | + |
|
660 | + /** |
|
661 | + * Get's the minimum total amount allowed for this discount. |
|
662 | + * |
|
663 | + * @since 1.0.19 |
|
664 | + * @param string $context View or edit context. |
|
665 | + * @return float |
|
666 | + */ |
|
667 | + public function get_min_total( $context = 'view' ) { |
|
668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
669 | + return empty( $minimum ) ? null : $minimum; |
|
670 | + } |
|
671 | + |
|
672 | + /** |
|
673 | + * Alias for self::get_min_total(). |
|
674 | + * |
|
675 | + * @since 1.0.19 |
|
676 | + * @param string $context View or edit context. |
|
677 | + * @return float |
|
678 | + */ |
|
679 | + public function get_minimum_total( $context = 'view' ) { |
|
680 | + return $this->get_min_total( $context ); |
|
681 | + } |
|
682 | + |
|
683 | + /** |
|
684 | + * Get's the maximum total amount allowed for this discount. |
|
685 | + * |
|
686 | + * @since 1.0.19 |
|
687 | + * @param string $context View or edit context. |
|
688 | + * @return float |
|
689 | + */ |
|
690 | + public function get_max_total( $context = 'view' ) { |
|
691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
692 | + return empty( $maximum ) ? null : $maximum; |
|
693 | + } |
|
694 | + |
|
695 | + /** |
|
696 | + * Alias for self::get_max_total(). |
|
697 | + * |
|
698 | + * @since 1.0.19 |
|
699 | + * @param string $context View or edit context. |
|
700 | + * @return float |
|
701 | + */ |
|
702 | + public function get_maximum_total( $context = 'view' ) { |
|
703 | + return $this->get_max_total( $context ); |
|
704 | + } |
|
705 | + |
|
706 | + /** |
|
707 | + * Magic method for accessing discount properties. |
|
708 | + * |
|
709 | + * @since 1.0.15 |
|
710 | + * @access public |
|
711 | + * |
|
712 | + * @param string $key Discount data to retrieve |
|
713 | + * @param string $context View or edit context. |
|
714 | + * @return mixed Value of the given discount property (if set). |
|
715 | + */ |
|
716 | + public function get( $key, $context = 'view' ) { |
|
717 | 717 | return $this->get_prop( $key, $context ); |
718 | - } |
|
718 | + } |
|
719 | 719 | |
720 | - /* |
|
720 | + /* |
|
721 | 721 | |-------------------------------------------------------------------------- |
722 | 722 | | Setters |
723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
727 | 727 | | object. |
728 | 728 | */ |
729 | 729 | |
730 | - /** |
|
731 | - * Sets discount status. |
|
732 | - * |
|
733 | - * @since 1.0.19 |
|
734 | - * @param string $status New status. |
|
735 | - * @return array details of change. |
|
736 | - */ |
|
737 | - public function set_status( $status ) { |
|
730 | + /** |
|
731 | + * Sets discount status. |
|
732 | + * |
|
733 | + * @since 1.0.19 |
|
734 | + * @param string $status New status. |
|
735 | + * @return array details of change. |
|
736 | + */ |
|
737 | + public function set_status( $status ) { |
|
738 | 738 | $old_status = $this->get_status(); |
739 | 739 | |
740 | 740 | $this->set_prop( 'status', $status ); |
741 | 741 | |
742 | - return array( |
|
743 | - 'from' => $old_status, |
|
744 | - 'to' => $status, |
|
745 | - ); |
|
742 | + return array( |
|
743 | + 'from' => $old_status, |
|
744 | + 'to' => $status, |
|
745 | + ); |
|
746 | 746 | } |
747 | 747 | |
748 | 748 | /** |
749 | - * Set plugin version when the discount was created. |
|
750 | - * |
|
751 | - * @since 1.0.19 |
|
752 | - */ |
|
753 | - public function set_version( $value ) { |
|
754 | - $this->set_prop( 'version', $value ); |
|
749 | + * Set plugin version when the discount was created. |
|
750 | + * |
|
751 | + * @since 1.0.19 |
|
752 | + */ |
|
753 | + public function set_version( $value ) { |
|
754 | + $this->set_prop( 'version', $value ); |
|
755 | 755 | } |
756 | 756 | |
757 | 757 | /** |
758 | - * Set date when the discount was created. |
|
759 | - * |
|
760 | - * @since 1.0.19 |
|
761 | - * @param string $value Value to set. |
|
758 | + * Set date when the discount was created. |
|
759 | + * |
|
760 | + * @since 1.0.19 |
|
761 | + * @param string $value Value to set. |
|
762 | 762 | * @return bool Whether or not the date was set. |
763 | - */ |
|
764 | - public function set_date_created( $value ) { |
|
763 | + */ |
|
764 | + public function set_date_created( $value ) { |
|
765 | 765 | $date = strtotime( $value ); |
766 | 766 | |
767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
774 | 774 | } |
775 | 775 | |
776 | 776 | /** |
777 | - * Set date when the discount was last modified. |
|
778 | - * |
|
779 | - * @since 1.0.19 |
|
780 | - * @param string $value Value to set. |
|
777 | + * Set date when the discount was last modified. |
|
778 | + * |
|
779 | + * @since 1.0.19 |
|
780 | + * @param string $value Value to set. |
|
781 | 781 | * @return bool Whether or not the date was set. |
782 | - */ |
|
783 | - public function set_date_modified( $value ) { |
|
782 | + */ |
|
783 | + public function set_date_modified( $value ) { |
|
784 | 784 | $date = strtotime( $value ); |
785 | 785 | |
786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
793 | 793 | } |
794 | 794 | |
795 | 795 | /** |
796 | - * Set the discount name. |
|
797 | - * |
|
798 | - * @since 1.0.19 |
|
799 | - * @param string $value New name. |
|
800 | - */ |
|
801 | - public function set_name( $value ) { |
|
796 | + * Set the discount name. |
|
797 | + * |
|
798 | + * @since 1.0.19 |
|
799 | + * @param string $value New name. |
|
800 | + */ |
|
801 | + public function set_name( $value ) { |
|
802 | 802 | $name = sanitize_text_field( $value ); |
803 | - $this->set_prop( 'name', $name ); |
|
803 | + $this->set_prop( 'name', $name ); |
|
804 | 804 | } |
805 | 805 | |
806 | 806 | /** |
807 | - * Alias of self::set_name(). |
|
808 | - * |
|
809 | - * @since 1.0.19 |
|
810 | - * @param string $value New name. |
|
811 | - */ |
|
812 | - public function set_title( $value ) { |
|
813 | - $this->set_name( $value ); |
|
807 | + * Alias of self::set_name(). |
|
808 | + * |
|
809 | + * @since 1.0.19 |
|
810 | + * @param string $value New name. |
|
811 | + */ |
|
812 | + public function set_title( $value ) { |
|
813 | + $this->set_name( $value ); |
|
814 | 814 | } |
815 | 815 | |
816 | 816 | /** |
817 | - * Set the discount description. |
|
818 | - * |
|
819 | - * @since 1.0.19 |
|
820 | - * @param string $value New description. |
|
821 | - */ |
|
822 | - public function set_description( $value ) { |
|
817 | + * Set the discount description. |
|
818 | + * |
|
819 | + * @since 1.0.19 |
|
820 | + * @param string $value New description. |
|
821 | + */ |
|
822 | + public function set_description( $value ) { |
|
823 | 823 | $description = wp_kses_post( $value ); |
824 | - return $this->set_prop( 'description', $description ); |
|
824 | + return $this->set_prop( 'description', $description ); |
|
825 | 825 | } |
826 | 826 | |
827 | 827 | /** |
828 | - * Alias of self::set_description(). |
|
829 | - * |
|
830 | - * @since 1.0.19 |
|
831 | - * @param string $value New description. |
|
832 | - */ |
|
833 | - public function set_excerpt( $value ) { |
|
834 | - $this->set_description( $value ); |
|
828 | + * Alias of self::set_description(). |
|
829 | + * |
|
830 | + * @since 1.0.19 |
|
831 | + * @param string $value New description. |
|
832 | + */ |
|
833 | + public function set_excerpt( $value ) { |
|
834 | + $this->set_description( $value ); |
|
835 | 835 | } |
836 | 836 | |
837 | 837 | /** |
838 | - * Alias of self::set_description(). |
|
839 | - * |
|
840 | - * @since 1.0.19 |
|
841 | - * @param string $value New description. |
|
842 | - */ |
|
843 | - public function set_summary( $value ) { |
|
844 | - $this->set_description( $value ); |
|
838 | + * Alias of self::set_description(). |
|
839 | + * |
|
840 | + * @since 1.0.19 |
|
841 | + * @param string $value New description. |
|
842 | + */ |
|
843 | + public function set_summary( $value ) { |
|
844 | + $this->set_description( $value ); |
|
845 | 845 | } |
846 | 846 | |
847 | 847 | /** |
848 | - * Set the owner of the discount. |
|
849 | - * |
|
850 | - * @since 1.0.19 |
|
851 | - * @param int $value New author. |
|
852 | - */ |
|
853 | - public function set_author( $value ) { |
|
854 | - $this->set_prop( 'author', (int) $value ); |
|
855 | - } |
|
848 | + * Set the owner of the discount. |
|
849 | + * |
|
850 | + * @since 1.0.19 |
|
851 | + * @param int $value New author. |
|
852 | + */ |
|
853 | + public function set_author( $value ) { |
|
854 | + $this->set_prop( 'author', (int) $value ); |
|
855 | + } |
|
856 | 856 | |
857 | - /** |
|
858 | - * Sets the discount code. |
|
859 | - * |
|
860 | - * @since 1.0.19 |
|
861 | - * @param string $value New discount code. |
|
862 | - */ |
|
863 | - public function set_code( $value ) { |
|
864 | - $code = sanitize_text_field( $value ); |
|
865 | - $this->set_prop( 'code', $code ); |
|
866 | - } |
|
857 | + /** |
|
858 | + * Sets the discount code. |
|
859 | + * |
|
860 | + * @since 1.0.19 |
|
861 | + * @param string $value New discount code. |
|
862 | + */ |
|
863 | + public function set_code( $value ) { |
|
864 | + $code = sanitize_text_field( $value ); |
|
865 | + $this->set_prop( 'code', $code ); |
|
866 | + } |
|
867 | 867 | |
868 | - /** |
|
869 | - * Alias of self::set_code(). |
|
870 | - * |
|
871 | - * @since 1.0.19 |
|
872 | - * @param string $value New discount code. |
|
873 | - */ |
|
874 | - public function set_coupon_code( $value ) { |
|
875 | - $this->set_code( $value ); |
|
876 | - } |
|
868 | + /** |
|
869 | + * Alias of self::set_code(). |
|
870 | + * |
|
871 | + * @since 1.0.19 |
|
872 | + * @param string $value New discount code. |
|
873 | + */ |
|
874 | + public function set_coupon_code( $value ) { |
|
875 | + $this->set_code( $value ); |
|
876 | + } |
|
877 | 877 | |
878 | - /** |
|
879 | - * Alias of self::set_code(). |
|
880 | - * |
|
881 | - * @since 1.0.19 |
|
882 | - * @param string $value New discount code. |
|
883 | - */ |
|
884 | - public function set_discount_code( $value ) { |
|
885 | - $this->set_code( $value ); |
|
886 | - } |
|
878 | + /** |
|
879 | + * Alias of self::set_code(). |
|
880 | + * |
|
881 | + * @since 1.0.19 |
|
882 | + * @param string $value New discount code. |
|
883 | + */ |
|
884 | + public function set_discount_code( $value ) { |
|
885 | + $this->set_code( $value ); |
|
886 | + } |
|
887 | 887 | |
888 | - /** |
|
889 | - * Sets the discount amount. |
|
890 | - * |
|
891 | - * @since 1.0.19 |
|
892 | - * @param float $value New discount code. |
|
893 | - */ |
|
894 | - public function set_amount( $value ) { |
|
895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
896 | - $this->set_prop( 'amount', $amount ); |
|
897 | - } |
|
898 | - |
|
899 | - /** |
|
900 | - * Sets the discount's start date. |
|
901 | - * |
|
902 | - * @since 1.0.19 |
|
903 | - * @param float $value New start date. |
|
904 | - */ |
|
905 | - public function set_start( $value ) { |
|
906 | - $date = strtotime( $value ); |
|
888 | + /** |
|
889 | + * Sets the discount amount. |
|
890 | + * |
|
891 | + * @since 1.0.19 |
|
892 | + * @param float $value New discount code. |
|
893 | + */ |
|
894 | + public function set_amount( $value ) { |
|
895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
896 | + $this->set_prop( 'amount', $amount ); |
|
897 | + } |
|
907 | 898 | |
908 | - if ( $date ) { |
|
909 | - $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
910 | - return true; |
|
911 | - } |
|
899 | + /** |
|
900 | + * Sets the discount's start date. |
|
901 | + * |
|
902 | + * @since 1.0.19 |
|
903 | + * @param float $value New start date. |
|
904 | + */ |
|
905 | + public function set_start( $value ) { |
|
906 | + $date = strtotime( $value ); |
|
907 | + |
|
908 | + if ( $date ) { |
|
909 | + $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
910 | + return true; |
|
911 | + } |
|
912 | 912 | |
913 | - $this->set_prop( 'start', '' ); |
|
913 | + $this->set_prop( 'start', '' ); |
|
914 | 914 | |
915 | 915 | return false; |
916 | - } |
|
917 | - |
|
918 | - /** |
|
919 | - * Alias of self::set_start(). |
|
920 | - * |
|
921 | - * @since 1.0.19 |
|
922 | - * @param string $value New start date. |
|
923 | - */ |
|
924 | - public function set_start_date( $value ) { |
|
925 | - $this->set_start( $value ); |
|
926 | - } |
|
927 | - |
|
928 | - /** |
|
929 | - * Sets the discount's expiration date. |
|
930 | - * |
|
931 | - * @since 1.0.19 |
|
932 | - * @param float $value New expiration date. |
|
933 | - */ |
|
934 | - public function set_expiration( $value ) { |
|
935 | - $date = strtotime( $value ); |
|
916 | + } |
|
917 | + |
|
918 | + /** |
|
919 | + * Alias of self::set_start(). |
|
920 | + * |
|
921 | + * @since 1.0.19 |
|
922 | + * @param string $value New start date. |
|
923 | + */ |
|
924 | + public function set_start_date( $value ) { |
|
925 | + $this->set_start( $value ); |
|
926 | + } |
|
927 | + |
|
928 | + /** |
|
929 | + * Sets the discount's expiration date. |
|
930 | + * |
|
931 | + * @since 1.0.19 |
|
932 | + * @param float $value New expiration date. |
|
933 | + */ |
|
934 | + public function set_expiration( $value ) { |
|
935 | + $date = strtotime( $value ); |
|
936 | 936 | |
937 | 937 | if ( $date ) { |
938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
939 | 939 | return true; |
940 | 940 | } |
941 | 941 | |
942 | - $this->set_prop( 'expiration', '' ); |
|
942 | + $this->set_prop( 'expiration', '' ); |
|
943 | 943 | return false; |
944 | - } |
|
945 | - |
|
946 | - /** |
|
947 | - * Alias of self::set_expiration(). |
|
948 | - * |
|
949 | - * @since 1.0.19 |
|
950 | - * @param string $value New expiration date. |
|
951 | - */ |
|
952 | - public function set_expiration_date( $value ) { |
|
953 | - $this->set_expiration( $value ); |
|
954 | - } |
|
955 | - |
|
956 | - /** |
|
957 | - * Alias of self::set_expiration(). |
|
958 | - * |
|
959 | - * @since 1.0.19 |
|
960 | - * @param string $value New expiration date. |
|
961 | - */ |
|
962 | - public function set_end_date( $value ) { |
|
963 | - $this->set_expiration( $value ); |
|
964 | - } |
|
965 | - |
|
966 | - /** |
|
967 | - * Sets the discount type. |
|
968 | - * |
|
969 | - * @since 1.0.19 |
|
970 | - * @param string $value New discount type. |
|
971 | - */ |
|
972 | - public function set_type( $value ) { |
|
973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
975 | - } |
|
976 | - } |
|
977 | - |
|
978 | - /** |
|
979 | - * Sets the number of times a discount has been used. |
|
980 | - * |
|
981 | - * @since 1.0.19 |
|
982 | - * @param int $value usage count. |
|
983 | - */ |
|
984 | - public function set_uses( $value ) { |
|
985 | - |
|
986 | - $value = (int) $value; |
|
987 | - |
|
988 | - if ( $value < 0 ) { |
|
989 | - $value = 0; |
|
990 | - } |
|
991 | - |
|
992 | - $this->set_prop( 'uses', (int) $value ); |
|
993 | - } |
|
994 | - |
|
995 | - /** |
|
996 | - * Sets the maximum number of times a discount can be used. |
|
997 | - * |
|
998 | - * @since 1.0.19 |
|
999 | - * @param int $value maximum usage count. |
|
1000 | - */ |
|
1001 | - public function set_max_uses( $value ) { |
|
1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
1003 | - } |
|
1004 | - |
|
1005 | - /** |
|
1006 | - * Sets if this is a single use discount or not. |
|
1007 | - * |
|
1008 | - * @since 1.0.19 |
|
1009 | - * @param int|bool $value is single use. |
|
1010 | - */ |
|
1011 | - public function set_is_single_use( $value ) { |
|
1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
1013 | - } |
|
1014 | - |
|
1015 | - /** |
|
1016 | - * Sets the items that can be used with this discount. |
|
1017 | - * |
|
1018 | - * @since 1.0.19 |
|
1019 | - * @param array $value items. |
|
1020 | - */ |
|
1021 | - public function set_items( $value ) { |
|
1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
1023 | - } |
|
1024 | - |
|
1025 | - /** |
|
1026 | - * Alias for self::set_items(). |
|
1027 | - * |
|
1028 | - * @since 1.0.19 |
|
1029 | - * @param array $value items. |
|
1030 | - */ |
|
1031 | - public function set_allowed_items( $value ) { |
|
1032 | - $this->set_items( $value ); |
|
1033 | - } |
|
1034 | - |
|
1035 | - /** |
|
1036 | - * Sets the items that can not be used with this discount. |
|
1037 | - * |
|
1038 | - * @since 1.0.19 |
|
1039 | - * @param array $value items. |
|
1040 | - */ |
|
1041 | - public function set_excluded_items( $value ) { |
|
1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
1043 | - } |
|
1044 | - |
|
1045 | - /** |
|
1046 | - * Sets if this is a recurring discounts or not. |
|
1047 | - * |
|
1048 | - * @since 1.0.19 |
|
1049 | - * @param int|bool $value is recurring. |
|
1050 | - */ |
|
1051 | - public function set_is_recurring( $value ) { |
|
1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
1053 | - } |
|
1054 | - |
|
1055 | - /** |
|
1056 | - * Sets the minimum total that can not be used with this discount. |
|
1057 | - * |
|
1058 | - * @since 1.0.19 |
|
1059 | - * @param float $value minimum total. |
|
1060 | - */ |
|
1061 | - public function set_min_total( $value ) { |
|
1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1063 | - } |
|
1064 | - |
|
1065 | - /** |
|
1066 | - * Alias for self::set_min_total(). |
|
1067 | - * |
|
1068 | - * @since 1.0.19 |
|
1069 | - * @param float $value minimum total. |
|
1070 | - */ |
|
1071 | - public function set_minimum_total( $value ) { |
|
1072 | - $this->set_min_total( $value ); |
|
1073 | - } |
|
1074 | - |
|
1075 | - /** |
|
1076 | - * Sets the maximum total that can not be used with this discount. |
|
1077 | - * |
|
1078 | - * @since 1.0.19 |
|
1079 | - * @param float $value maximum total. |
|
1080 | - */ |
|
1081 | - public function set_max_total( $value ) { |
|
1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1083 | - } |
|
1084 | - |
|
1085 | - /** |
|
1086 | - * Alias for self::set_max_total(). |
|
1087 | - * |
|
1088 | - * @since 1.0.19 |
|
1089 | - * @param float $value maximum total. |
|
1090 | - */ |
|
1091 | - public function set_maximum_total( $value ) { |
|
1092 | - $this->set_max_total( $value ); |
|
1093 | - } |
|
1094 | - |
|
1095 | - /** |
|
1096 | - * @deprecated |
|
1097 | - */ |
|
1098 | - public function refresh(){} |
|
1099 | - |
|
1100 | - /** |
|
1101 | - * @deprecated |
|
1102 | - * |
|
1103 | - */ |
|
1104 | - public function update_status( $status = 'publish' ){ |
|
1105 | - |
|
1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
1107 | - $this->set_status( $status ); |
|
1108 | - $this->save(); |
|
1109 | - } |
|
1110 | - |
|
1111 | - } |
|
1112 | - |
|
1113 | - /* |
|
944 | + } |
|
945 | + |
|
946 | + /** |
|
947 | + * Alias of self::set_expiration(). |
|
948 | + * |
|
949 | + * @since 1.0.19 |
|
950 | + * @param string $value New expiration date. |
|
951 | + */ |
|
952 | + public function set_expiration_date( $value ) { |
|
953 | + $this->set_expiration( $value ); |
|
954 | + } |
|
955 | + |
|
956 | + /** |
|
957 | + * Alias of self::set_expiration(). |
|
958 | + * |
|
959 | + * @since 1.0.19 |
|
960 | + * @param string $value New expiration date. |
|
961 | + */ |
|
962 | + public function set_end_date( $value ) { |
|
963 | + $this->set_expiration( $value ); |
|
964 | + } |
|
965 | + |
|
966 | + /** |
|
967 | + * Sets the discount type. |
|
968 | + * |
|
969 | + * @since 1.0.19 |
|
970 | + * @param string $value New discount type. |
|
971 | + */ |
|
972 | + public function set_type( $value ) { |
|
973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
975 | + } |
|
976 | + } |
|
977 | + |
|
978 | + /** |
|
979 | + * Sets the number of times a discount has been used. |
|
980 | + * |
|
981 | + * @since 1.0.19 |
|
982 | + * @param int $value usage count. |
|
983 | + */ |
|
984 | + public function set_uses( $value ) { |
|
985 | + |
|
986 | + $value = (int) $value; |
|
987 | + |
|
988 | + if ( $value < 0 ) { |
|
989 | + $value = 0; |
|
990 | + } |
|
991 | + |
|
992 | + $this->set_prop( 'uses', (int) $value ); |
|
993 | + } |
|
994 | + |
|
995 | + /** |
|
996 | + * Sets the maximum number of times a discount can be used. |
|
997 | + * |
|
998 | + * @since 1.0.19 |
|
999 | + * @param int $value maximum usage count. |
|
1000 | + */ |
|
1001 | + public function set_max_uses( $value ) { |
|
1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
1003 | + } |
|
1004 | + |
|
1005 | + /** |
|
1006 | + * Sets if this is a single use discount or not. |
|
1007 | + * |
|
1008 | + * @since 1.0.19 |
|
1009 | + * @param int|bool $value is single use. |
|
1010 | + */ |
|
1011 | + public function set_is_single_use( $value ) { |
|
1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
1013 | + } |
|
1014 | + |
|
1015 | + /** |
|
1016 | + * Sets the items that can be used with this discount. |
|
1017 | + * |
|
1018 | + * @since 1.0.19 |
|
1019 | + * @param array $value items. |
|
1020 | + */ |
|
1021 | + public function set_items( $value ) { |
|
1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
1023 | + } |
|
1024 | + |
|
1025 | + /** |
|
1026 | + * Alias for self::set_items(). |
|
1027 | + * |
|
1028 | + * @since 1.0.19 |
|
1029 | + * @param array $value items. |
|
1030 | + */ |
|
1031 | + public function set_allowed_items( $value ) { |
|
1032 | + $this->set_items( $value ); |
|
1033 | + } |
|
1034 | + |
|
1035 | + /** |
|
1036 | + * Sets the items that can not be used with this discount. |
|
1037 | + * |
|
1038 | + * @since 1.0.19 |
|
1039 | + * @param array $value items. |
|
1040 | + */ |
|
1041 | + public function set_excluded_items( $value ) { |
|
1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
1043 | + } |
|
1044 | + |
|
1045 | + /** |
|
1046 | + * Sets if this is a recurring discounts or not. |
|
1047 | + * |
|
1048 | + * @since 1.0.19 |
|
1049 | + * @param int|bool $value is recurring. |
|
1050 | + */ |
|
1051 | + public function set_is_recurring( $value ) { |
|
1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
1053 | + } |
|
1054 | + |
|
1055 | + /** |
|
1056 | + * Sets the minimum total that can not be used with this discount. |
|
1057 | + * |
|
1058 | + * @since 1.0.19 |
|
1059 | + * @param float $value minimum total. |
|
1060 | + */ |
|
1061 | + public function set_min_total( $value ) { |
|
1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1063 | + } |
|
1064 | + |
|
1065 | + /** |
|
1066 | + * Alias for self::set_min_total(). |
|
1067 | + * |
|
1068 | + * @since 1.0.19 |
|
1069 | + * @param float $value minimum total. |
|
1070 | + */ |
|
1071 | + public function set_minimum_total( $value ) { |
|
1072 | + $this->set_min_total( $value ); |
|
1073 | + } |
|
1074 | + |
|
1075 | + /** |
|
1076 | + * Sets the maximum total that can not be used with this discount. |
|
1077 | + * |
|
1078 | + * @since 1.0.19 |
|
1079 | + * @param float $value maximum total. |
|
1080 | + */ |
|
1081 | + public function set_max_total( $value ) { |
|
1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1083 | + } |
|
1084 | + |
|
1085 | + /** |
|
1086 | + * Alias for self::set_max_total(). |
|
1087 | + * |
|
1088 | + * @since 1.0.19 |
|
1089 | + * @param float $value maximum total. |
|
1090 | + */ |
|
1091 | + public function set_maximum_total( $value ) { |
|
1092 | + $this->set_max_total( $value ); |
|
1093 | + } |
|
1094 | + |
|
1095 | + /** |
|
1096 | + * @deprecated |
|
1097 | + */ |
|
1098 | + public function refresh(){} |
|
1099 | + |
|
1100 | + /** |
|
1101 | + * @deprecated |
|
1102 | + * |
|
1103 | + */ |
|
1104 | + public function update_status( $status = 'publish' ){ |
|
1105 | + |
|
1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
1107 | + $this->set_status( $status ); |
|
1108 | + $this->save(); |
|
1109 | + } |
|
1110 | + |
|
1111 | + } |
|
1112 | + |
|
1113 | + /* |
|
1114 | 1114 | |-------------------------------------------------------------------------- |
1115 | 1115 | | Conditionals |
1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
1119 | 1119 | | |
1120 | 1120 | */ |
1121 | 1121 | |
1122 | - /** |
|
1123 | - * Checks whether a discount exists in the database or not |
|
1124 | - * |
|
1125 | - * @since 1.0.15 |
|
1126 | - */ |
|
1127 | - public function exists(){ |
|
1128 | - $id = $this->get_id(); |
|
1129 | - return ! empty( $id ); |
|
1130 | - } |
|
1131 | - |
|
1132 | - /** |
|
1133 | - * Checks the discount type. |
|
1134 | - * |
|
1135 | - * |
|
1136 | - * @param string $type the discount type to check against |
|
1137 | - * @since 1.0.15 |
|
1138 | - * @return bool |
|
1139 | - */ |
|
1140 | - public function is_type( $type ) { |
|
1141 | - return $this->get_type() == $type; |
|
1142 | - } |
|
1143 | - |
|
1144 | - /** |
|
1145 | - * Checks whether the discount is published or not |
|
1146 | - * |
|
1147 | - * @since 1.0.15 |
|
1148 | - * @return bool |
|
1149 | - */ |
|
1150 | - public function is_active() { |
|
1151 | - return $this->get_status() == 'publish'; |
|
1152 | - } |
|
1153 | - |
|
1154 | - /** |
|
1155 | - * Checks whether the discount has max uses |
|
1156 | - * |
|
1157 | - * @since 1.0.15 |
|
1158 | - * @return bool |
|
1159 | - */ |
|
1160 | - public function has_limit() { |
|
1161 | - $limit = $this->get_max_uses(); |
|
1162 | - return ! empty( $limit ); |
|
1163 | - } |
|
1164 | - |
|
1165 | - /** |
|
1166 | - * Checks whether the discount has ever been used. |
|
1167 | - * |
|
1168 | - * @since 1.0.15 |
|
1169 | - * @return bool |
|
1170 | - */ |
|
1171 | - public function has_uses() { |
|
1172 | - return $this->get_uses() > 0; |
|
1173 | - } |
|
1174 | - |
|
1175 | - /** |
|
1176 | - * Checks whether the discount is has exided the usage limit or not |
|
1177 | - * |
|
1178 | - * @since 1.0.15 |
|
1179 | - * @return bool |
|
1180 | - */ |
|
1181 | - public function has_exceeded_limit() { |
|
1182 | - |
|
1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
1184 | - $exceeded = false ; |
|
1185 | - } else { |
|
1186 | - $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
1187 | - } |
|
1188 | - |
|
1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->ID, $this, $this->code ); |
|
1190 | - } |
|
1191 | - |
|
1192 | - /** |
|
1193 | - * Checks whether the discount has an expiration date. |
|
1194 | - * |
|
1195 | - * @since 1.0.15 |
|
1196 | - * @return bool |
|
1197 | - */ |
|
1198 | - public function has_expiration_date() { |
|
1199 | - $date = $this->get_expiration_date(); |
|
1200 | - return ! empty( $date ); |
|
1201 | - } |
|
1202 | - |
|
1203 | - /** |
|
1204 | - * Checks if the discount is expired |
|
1205 | - * |
|
1206 | - * @since 1.0.15 |
|
1207 | - * @return bool |
|
1208 | - */ |
|
1209 | - public function is_expired() { |
|
1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->ID, $this, $this->code ); |
|
1212 | - } |
|
1213 | - |
|
1214 | - /** |
|
1215 | - * Checks whether the discount has a start date. |
|
1216 | - * |
|
1217 | - * @since 1.0.15 |
|
1218 | - * @return bool |
|
1219 | - */ |
|
1220 | - public function has_start_date() { |
|
1221 | - $date = $this->get_start_date(); |
|
1222 | - return ! empty( $date ); |
|
1223 | - } |
|
1224 | - |
|
1225 | - /** |
|
1226 | - * Checks the discount start date. |
|
1227 | - * |
|
1228 | - * @since 1.0.15 |
|
1229 | - * @return bool |
|
1230 | - */ |
|
1231 | - public function has_started() { |
|
1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->ID, $this, $this->code ); |
|
1234 | - } |
|
1235 | - |
|
1236 | - /** |
|
1237 | - * Checks the discount has allowed items or not. |
|
1238 | - * |
|
1239 | - * @since 1.0.15 |
|
1240 | - * @return bool |
|
1241 | - */ |
|
1242 | - public function has_allowed_items() { |
|
1243 | - $allowed_items = $this->get_allowed_items(); |
|
1244 | - return empty( $allowed_items ); |
|
1245 | - } |
|
1246 | - |
|
1247 | - /** |
|
1248 | - * Checks the discount has excluded items or not. |
|
1249 | - * |
|
1250 | - * @since 1.0.15 |
|
1251 | - * @return bool |
|
1252 | - */ |
|
1253 | - public function has_excluded_items() { |
|
1254 | - $excluded_items = $this->get_excluded_items(); |
|
1255 | - return empty( $excluded_items ); |
|
1256 | - } |
|
1257 | - |
|
1258 | - /** |
|
1259 | - * Check if a discount is valid for a given item id. |
|
1260 | - * |
|
1261 | - * @param int|int[] $item_ids |
|
1262 | - * @since 1.0.15 |
|
1263 | - * @return boolean |
|
1264 | - */ |
|
1265 | - public function is_valid_for_items( $item_ids ) { |
|
1266 | - |
|
1267 | - $item_ids = array_map( 'intval', wpinv_parse_list( $item_ids ) ); |
|
1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
1270 | - |
|
1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
1272 | - return false; |
|
1273 | - } |
|
1274 | - |
|
1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
1276 | - return false; |
|
1277 | - } |
|
1278 | - return true; |
|
1279 | - } |
|
1280 | - |
|
1281 | - /** |
|
1282 | - * Check if a discount is valid for the given amount |
|
1283 | - * |
|
1284 | - * @param float $amount The amount to check against |
|
1285 | - * @since 1.0.15 |
|
1286 | - * @return boolean |
|
1287 | - */ |
|
1288 | - public function is_valid_for_amount( $amount ) { |
|
1289 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
1290 | - } |
|
1291 | - |
|
1292 | - /** |
|
1293 | - * Checks if the minimum amount is set |
|
1294 | - * |
|
1295 | - * @since 1.0.15 |
|
1296 | - * @return boolean |
|
1297 | - */ |
|
1298 | - public function has_minimum_amount() { |
|
1299 | - $minimum = $this->get_minimum_total(); |
|
1300 | - return ! empty( $minimum ); |
|
1301 | - } |
|
1302 | - |
|
1303 | - /** |
|
1304 | - * Checks if the minimum amount is met |
|
1305 | - * |
|
1306 | - * @param float $amount The amount to check against |
|
1307 | - * @since 1.0.15 |
|
1308 | - * @return boolean |
|
1309 | - */ |
|
1310 | - public function is_minimum_amount_met( $amount ) { |
|
1311 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1312 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
1313 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->ID, $this, $this->code, $amount ); |
|
1314 | - } |
|
1315 | - |
|
1316 | - /** |
|
1317 | - * Checks if the maximum amount is set |
|
1318 | - * |
|
1319 | - * @since 1.0.15 |
|
1320 | - * @return boolean |
|
1321 | - */ |
|
1322 | - public function has_maximum_amount() { |
|
1323 | - $maximum = $this->get_maximum_total(); |
|
1324 | - return ! empty( $maximum ); |
|
1325 | - } |
|
1326 | - |
|
1327 | - /** |
|
1328 | - * Checks if the maximum amount is met |
|
1329 | - * |
|
1330 | - * @param float $amount The amount to check against |
|
1331 | - * @since 1.0.15 |
|
1332 | - * @return boolean |
|
1333 | - */ |
|
1334 | - public function is_maximum_amount_met( $amount ) { |
|
1335 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1336 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
1337 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->ID, $this, $this->code, $amount ); |
|
1338 | - } |
|
1339 | - |
|
1340 | - /** |
|
1341 | - * Checks if the discount is recurring. |
|
1342 | - * |
|
1343 | - * @since 1.0.15 |
|
1344 | - * @return boolean |
|
1345 | - */ |
|
1346 | - public function is_recurring() { |
|
1347 | - $recurring = $this->get_is_recurring(); |
|
1348 | - return ! empty( $recurring ); |
|
1349 | - } |
|
1350 | - |
|
1351 | - /** |
|
1352 | - * Checks if the discount is single use. |
|
1353 | - * |
|
1354 | - * @since 1.0.15 |
|
1355 | - * @return boolean |
|
1356 | - */ |
|
1357 | - public function is_single_use() { |
|
1358 | - $usage = $this->get_is_single_use(); |
|
1359 | - return ! empty( $usage ); |
|
1360 | - } |
|
1361 | - |
|
1362 | - /** |
|
1363 | - * Check if a discount is valid for the given user |
|
1364 | - * |
|
1365 | - * @param int|string $user |
|
1366 | - * @since 1.0.15 |
|
1367 | - * @return boolean |
|
1368 | - */ |
|
1369 | - public function is_valid_for_user( $user ) { |
|
1370 | - global $wpi_checkout_id; |
|
1371 | - |
|
1372 | - // Ensure that the discount is single use. |
|
1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
1374 | - return true; |
|
1375 | - } |
|
1376 | - |
|
1377 | - // Prepare the user id. |
|
1378 | - $user_id = 0; |
|
1122 | + /** |
|
1123 | + * Checks whether a discount exists in the database or not |
|
1124 | + * |
|
1125 | + * @since 1.0.15 |
|
1126 | + */ |
|
1127 | + public function exists(){ |
|
1128 | + $id = $this->get_id(); |
|
1129 | + return ! empty( $id ); |
|
1130 | + } |
|
1131 | + |
|
1132 | + /** |
|
1133 | + * Checks the discount type. |
|
1134 | + * |
|
1135 | + * |
|
1136 | + * @param string $type the discount type to check against |
|
1137 | + * @since 1.0.15 |
|
1138 | + * @return bool |
|
1139 | + */ |
|
1140 | + public function is_type( $type ) { |
|
1141 | + return $this->get_type() == $type; |
|
1142 | + } |
|
1143 | + |
|
1144 | + /** |
|
1145 | + * Checks whether the discount is published or not |
|
1146 | + * |
|
1147 | + * @since 1.0.15 |
|
1148 | + * @return bool |
|
1149 | + */ |
|
1150 | + public function is_active() { |
|
1151 | + return $this->get_status() == 'publish'; |
|
1152 | + } |
|
1153 | + |
|
1154 | + /** |
|
1155 | + * Checks whether the discount has max uses |
|
1156 | + * |
|
1157 | + * @since 1.0.15 |
|
1158 | + * @return bool |
|
1159 | + */ |
|
1160 | + public function has_limit() { |
|
1161 | + $limit = $this->get_max_uses(); |
|
1162 | + return ! empty( $limit ); |
|
1163 | + } |
|
1164 | + |
|
1165 | + /** |
|
1166 | + * Checks whether the discount has ever been used. |
|
1167 | + * |
|
1168 | + * @since 1.0.15 |
|
1169 | + * @return bool |
|
1170 | + */ |
|
1171 | + public function has_uses() { |
|
1172 | + return $this->get_uses() > 0; |
|
1173 | + } |
|
1174 | + |
|
1175 | + /** |
|
1176 | + * Checks whether the discount is has exided the usage limit or not |
|
1177 | + * |
|
1178 | + * @since 1.0.15 |
|
1179 | + * @return bool |
|
1180 | + */ |
|
1181 | + public function has_exceeded_limit() { |
|
1182 | + |
|
1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
1184 | + $exceeded = false ; |
|
1185 | + } else { |
|
1186 | + $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
1187 | + } |
|
1188 | + |
|
1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->ID, $this, $this->code ); |
|
1190 | + } |
|
1191 | + |
|
1192 | + /** |
|
1193 | + * Checks whether the discount has an expiration date. |
|
1194 | + * |
|
1195 | + * @since 1.0.15 |
|
1196 | + * @return bool |
|
1197 | + */ |
|
1198 | + public function has_expiration_date() { |
|
1199 | + $date = $this->get_expiration_date(); |
|
1200 | + return ! empty( $date ); |
|
1201 | + } |
|
1202 | + |
|
1203 | + /** |
|
1204 | + * Checks if the discount is expired |
|
1205 | + * |
|
1206 | + * @since 1.0.15 |
|
1207 | + * @return bool |
|
1208 | + */ |
|
1209 | + public function is_expired() { |
|
1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->ID, $this, $this->code ); |
|
1212 | + } |
|
1213 | + |
|
1214 | + /** |
|
1215 | + * Checks whether the discount has a start date. |
|
1216 | + * |
|
1217 | + * @since 1.0.15 |
|
1218 | + * @return bool |
|
1219 | + */ |
|
1220 | + public function has_start_date() { |
|
1221 | + $date = $this->get_start_date(); |
|
1222 | + return ! empty( $date ); |
|
1223 | + } |
|
1224 | + |
|
1225 | + /** |
|
1226 | + * Checks the discount start date. |
|
1227 | + * |
|
1228 | + * @since 1.0.15 |
|
1229 | + * @return bool |
|
1230 | + */ |
|
1231 | + public function has_started() { |
|
1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->ID, $this, $this->code ); |
|
1234 | + } |
|
1235 | + |
|
1236 | + /** |
|
1237 | + * Checks the discount has allowed items or not. |
|
1238 | + * |
|
1239 | + * @since 1.0.15 |
|
1240 | + * @return bool |
|
1241 | + */ |
|
1242 | + public function has_allowed_items() { |
|
1243 | + $allowed_items = $this->get_allowed_items(); |
|
1244 | + return empty( $allowed_items ); |
|
1245 | + } |
|
1246 | + |
|
1247 | + /** |
|
1248 | + * Checks the discount has excluded items or not. |
|
1249 | + * |
|
1250 | + * @since 1.0.15 |
|
1251 | + * @return bool |
|
1252 | + */ |
|
1253 | + public function has_excluded_items() { |
|
1254 | + $excluded_items = $this->get_excluded_items(); |
|
1255 | + return empty( $excluded_items ); |
|
1256 | + } |
|
1257 | + |
|
1258 | + /** |
|
1259 | + * Check if a discount is valid for a given item id. |
|
1260 | + * |
|
1261 | + * @param int|int[] $item_ids |
|
1262 | + * @since 1.0.15 |
|
1263 | + * @return boolean |
|
1264 | + */ |
|
1265 | + public function is_valid_for_items( $item_ids ) { |
|
1266 | + |
|
1267 | + $item_ids = array_map( 'intval', wpinv_parse_list( $item_ids ) ); |
|
1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
1270 | + |
|
1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
1272 | + return false; |
|
1273 | + } |
|
1274 | + |
|
1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
1276 | + return false; |
|
1277 | + } |
|
1278 | + return true; |
|
1279 | + } |
|
1280 | + |
|
1281 | + /** |
|
1282 | + * Check if a discount is valid for the given amount |
|
1283 | + * |
|
1284 | + * @param float $amount The amount to check against |
|
1285 | + * @since 1.0.15 |
|
1286 | + * @return boolean |
|
1287 | + */ |
|
1288 | + public function is_valid_for_amount( $amount ) { |
|
1289 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
1290 | + } |
|
1291 | + |
|
1292 | + /** |
|
1293 | + * Checks if the minimum amount is set |
|
1294 | + * |
|
1295 | + * @since 1.0.15 |
|
1296 | + * @return boolean |
|
1297 | + */ |
|
1298 | + public function has_minimum_amount() { |
|
1299 | + $minimum = $this->get_minimum_total(); |
|
1300 | + return ! empty( $minimum ); |
|
1301 | + } |
|
1302 | + |
|
1303 | + /** |
|
1304 | + * Checks if the minimum amount is met |
|
1305 | + * |
|
1306 | + * @param float $amount The amount to check against |
|
1307 | + * @since 1.0.15 |
|
1308 | + * @return boolean |
|
1309 | + */ |
|
1310 | + public function is_minimum_amount_met( $amount ) { |
|
1311 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1312 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
1313 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->ID, $this, $this->code, $amount ); |
|
1314 | + } |
|
1315 | + |
|
1316 | + /** |
|
1317 | + * Checks if the maximum amount is set |
|
1318 | + * |
|
1319 | + * @since 1.0.15 |
|
1320 | + * @return boolean |
|
1321 | + */ |
|
1322 | + public function has_maximum_amount() { |
|
1323 | + $maximum = $this->get_maximum_total(); |
|
1324 | + return ! empty( $maximum ); |
|
1325 | + } |
|
1326 | + |
|
1327 | + /** |
|
1328 | + * Checks if the maximum amount is met |
|
1329 | + * |
|
1330 | + * @param float $amount The amount to check against |
|
1331 | + * @since 1.0.15 |
|
1332 | + * @return boolean |
|
1333 | + */ |
|
1334 | + public function is_maximum_amount_met( $amount ) { |
|
1335 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1336 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
1337 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->ID, $this, $this->code, $amount ); |
|
1338 | + } |
|
1339 | + |
|
1340 | + /** |
|
1341 | + * Checks if the discount is recurring. |
|
1342 | + * |
|
1343 | + * @since 1.0.15 |
|
1344 | + * @return boolean |
|
1345 | + */ |
|
1346 | + public function is_recurring() { |
|
1347 | + $recurring = $this->get_is_recurring(); |
|
1348 | + return ! empty( $recurring ); |
|
1349 | + } |
|
1350 | + |
|
1351 | + /** |
|
1352 | + * Checks if the discount is single use. |
|
1353 | + * |
|
1354 | + * @since 1.0.15 |
|
1355 | + * @return boolean |
|
1356 | + */ |
|
1357 | + public function is_single_use() { |
|
1358 | + $usage = $this->get_is_single_use(); |
|
1359 | + return ! empty( $usage ); |
|
1360 | + } |
|
1361 | + |
|
1362 | + /** |
|
1363 | + * Check if a discount is valid for the given user |
|
1364 | + * |
|
1365 | + * @param int|string $user |
|
1366 | + * @since 1.0.15 |
|
1367 | + * @return boolean |
|
1368 | + */ |
|
1369 | + public function is_valid_for_user( $user ) { |
|
1370 | + global $wpi_checkout_id; |
|
1371 | + |
|
1372 | + // Ensure that the discount is single use. |
|
1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
1374 | + return true; |
|
1375 | + } |
|
1376 | + |
|
1377 | + // Prepare the user id. |
|
1378 | + $user_id = 0; |
|
1379 | 1379 | if ( is_int( $user ) ) { |
1380 | 1380 | $user_id = absint( $user ); |
1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,135 +1384,135 @@ discard block |
||
1384 | 1384 | $user_id = $user_data->ID; |
1385 | 1385 | } else if ( absint( $user ) > 0 ) { |
1386 | 1386 | $user_id = absint( $user ); |
1387 | - } |
|
1387 | + } |
|
1388 | 1388 | |
1389 | - // Ensure that we have a user. |
|
1390 | - if ( empty( $user_id ) ) { |
|
1391 | - return true; |
|
1392 | - } |
|
1389 | + // Ensure that we have a user. |
|
1390 | + if ( empty( $user_id ) ) { |
|
1391 | + return true; |
|
1392 | + } |
|
1393 | 1393 | |
1394 | - // Get all payments with matching user id. |
|
1394 | + // Get all payments with matching user id. |
|
1395 | 1395 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false ) ); |
1396 | - $code = strtolower( $this->get_code() ); |
|
1397 | - |
|
1398 | - // For each payment... |
|
1399 | - foreach ( $payments as $payment ) { |
|
1400 | - |
|
1401 | - // ... skip the current payment. |
|
1402 | - if ( ! empty( $wpi_checkout_id ) && $wpi_checkout_id == $payment->ID ) { |
|
1403 | - continue; |
|
1404 | - } |
|
1405 | - |
|
1406 | - // And failed payments. |
|
1407 | - if ( $payment->has_status( array( 'wpi-cancelled', 'wpi-failed' ) ) ) { |
|
1408 | - continue; |
|
1409 | - } |
|
1410 | - |
|
1411 | - // Retrieve all the discounts for the payment. |
|
1412 | - $discounts = $payment->get_discounts( true ); |
|
1413 | - if ( empty( $discounts ) ) { |
|
1414 | - continue; |
|
1415 | - } |
|
1416 | - |
|
1417 | - // And check if the current discount is amongst them. |
|
1418 | - $discounts = array_map( 'strtolower', wpinv_parse_list( $discounts ) ); |
|
1419 | - if ( ! empty( $discounts ) && in_array( $code, $discounts ) ) { |
|
1420 | - return false; |
|
1421 | - } |
|
1422 | - } |
|
1423 | - |
|
1424 | - return true; |
|
1425 | - } |
|
1426 | - |
|
1427 | - /** |
|
1428 | - * Deletes the discount from the database |
|
1429 | - * |
|
1430 | - * @since 1.0.15 |
|
1431 | - * @return boolean |
|
1432 | - */ |
|
1433 | - public function remove() { |
|
1434 | - return $this->delete(); |
|
1435 | - } |
|
1436 | - |
|
1437 | - /** |
|
1438 | - * Increases a discount's usage. |
|
1439 | - * |
|
1440 | - * @since 1.0.15 |
|
1441 | - * @param int $by The number of usages to increas by. |
|
1442 | - * @return int |
|
1443 | - */ |
|
1444 | - public function increase_usage( $by = 1 ) { |
|
1445 | - |
|
1446 | - // Abort if zero. |
|
1447 | - if ( empty( $by ) ) { |
|
1448 | - return; |
|
1449 | - } |
|
1450 | - |
|
1451 | - // Increase the usage. |
|
1452 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
1453 | - |
|
1454 | - // Save the discount. |
|
1455 | - $this->save(); |
|
1456 | - |
|
1457 | - // Fire relevant hooks. |
|
1458 | - if( (int) $by > 0 ) { |
|
1459 | - do_action( 'wpinv_discount_increase_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
1460 | - } else { |
|
1461 | - do_action( 'wpinv_discount_decrease_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
1462 | - } |
|
1463 | - |
|
1464 | - // Return the number of times the discount has been used. |
|
1465 | - return $this->get_uses(); |
|
1466 | - } |
|
1467 | - |
|
1468 | - /** |
|
1469 | - * Alias of self::__toString() |
|
1470 | - * |
|
1471 | - * @since 1.0.15 |
|
1472 | - * @return string|false |
|
1473 | - */ |
|
1474 | - public function get_data_as_json() { |
|
1475 | - return $this->__toString(); |
|
1476 | - } |
|
1477 | - |
|
1478 | - /** |
|
1479 | - * Returns a discount's discounted amount. |
|
1480 | - * |
|
1481 | - * @since 1.0.15 |
|
1482 | - * @param float $amount |
|
1483 | - * @return float |
|
1484 | - */ |
|
1485 | - public function get_discounted_amount( $amount ) { |
|
1486 | - |
|
1487 | - // Convert amount to float. |
|
1488 | - $amount = (float) $amount; |
|
1489 | - |
|
1490 | - // Get discount amount. |
|
1491 | - $discount_amount = $this->get_amount(); |
|
1492 | - |
|
1493 | - if ( empty( $discount_amount ) ) { |
|
1494 | - return 0; |
|
1495 | - } |
|
1496 | - |
|
1497 | - // Format the amount. |
|
1498 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
1396 | + $code = strtolower( $this->get_code() ); |
|
1397 | + |
|
1398 | + // For each payment... |
|
1399 | + foreach ( $payments as $payment ) { |
|
1400 | + |
|
1401 | + // ... skip the current payment. |
|
1402 | + if ( ! empty( $wpi_checkout_id ) && $wpi_checkout_id == $payment->ID ) { |
|
1403 | + continue; |
|
1404 | + } |
|
1405 | + |
|
1406 | + // And failed payments. |
|
1407 | + if ( $payment->has_status( array( 'wpi-cancelled', 'wpi-failed' ) ) ) { |
|
1408 | + continue; |
|
1409 | + } |
|
1410 | + |
|
1411 | + // Retrieve all the discounts for the payment. |
|
1412 | + $discounts = $payment->get_discounts( true ); |
|
1413 | + if ( empty( $discounts ) ) { |
|
1414 | + continue; |
|
1415 | + } |
|
1416 | + |
|
1417 | + // And check if the current discount is amongst them. |
|
1418 | + $discounts = array_map( 'strtolower', wpinv_parse_list( $discounts ) ); |
|
1419 | + if ( ! empty( $discounts ) && in_array( $code, $discounts ) ) { |
|
1420 | + return false; |
|
1421 | + } |
|
1422 | + } |
|
1423 | + |
|
1424 | + return true; |
|
1425 | + } |
|
1426 | + |
|
1427 | + /** |
|
1428 | + * Deletes the discount from the database |
|
1429 | + * |
|
1430 | + * @since 1.0.15 |
|
1431 | + * @return boolean |
|
1432 | + */ |
|
1433 | + public function remove() { |
|
1434 | + return $this->delete(); |
|
1435 | + } |
|
1436 | + |
|
1437 | + /** |
|
1438 | + * Increases a discount's usage. |
|
1439 | + * |
|
1440 | + * @since 1.0.15 |
|
1441 | + * @param int $by The number of usages to increas by. |
|
1442 | + * @return int |
|
1443 | + */ |
|
1444 | + public function increase_usage( $by = 1 ) { |
|
1445 | + |
|
1446 | + // Abort if zero. |
|
1447 | + if ( empty( $by ) ) { |
|
1448 | + return; |
|
1449 | + } |
|
1450 | + |
|
1451 | + // Increase the usage. |
|
1452 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
1453 | + |
|
1454 | + // Save the discount. |
|
1455 | + $this->save(); |
|
1456 | + |
|
1457 | + // Fire relevant hooks. |
|
1458 | + if( (int) $by > 0 ) { |
|
1459 | + do_action( 'wpinv_discount_increase_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
1460 | + } else { |
|
1461 | + do_action( 'wpinv_discount_decrease_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
1462 | + } |
|
1463 | + |
|
1464 | + // Return the number of times the discount has been used. |
|
1465 | + return $this->get_uses(); |
|
1466 | + } |
|
1467 | + |
|
1468 | + /** |
|
1469 | + * Alias of self::__toString() |
|
1470 | + * |
|
1471 | + * @since 1.0.15 |
|
1472 | + * @return string|false |
|
1473 | + */ |
|
1474 | + public function get_data_as_json() { |
|
1475 | + return $this->__toString(); |
|
1476 | + } |
|
1477 | + |
|
1478 | + /** |
|
1479 | + * Returns a discount's discounted amount. |
|
1480 | + * |
|
1481 | + * @since 1.0.15 |
|
1482 | + * @param float $amount |
|
1483 | + * @return float |
|
1484 | + */ |
|
1485 | + public function get_discounted_amount( $amount ) { |
|
1486 | + |
|
1487 | + // Convert amount to float. |
|
1488 | + $amount = (float) $amount; |
|
1489 | + |
|
1490 | + // Get discount amount. |
|
1491 | + $discount_amount = $this->get_amount(); |
|
1492 | + |
|
1493 | + if ( empty( $discount_amount ) ) { |
|
1494 | + return 0; |
|
1495 | + } |
|
1496 | + |
|
1497 | + // Format the amount. |
|
1498 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
1499 | 1499 | |
1500 | - // If this is a percentage discount. |
|
1501 | - if ( $this->is_type( 'percent' ) ) { |
|
1500 | + // If this is a percentage discount. |
|
1501 | + if ( $this->is_type( 'percent' ) ) { |
|
1502 | 1502 | $discount_amount = $amount * ( $discount_amount / 100 ); |
1503 | - } |
|
1503 | + } |
|
1504 | 1504 | |
1505 | - // Discount can not be less than zero... |
|
1506 | - if ( $discount_amount < 0 ) { |
|
1507 | - $discount_amount = 0; |
|
1508 | - } |
|
1505 | + // Discount can not be less than zero... |
|
1506 | + if ( $discount_amount < 0 ) { |
|
1507 | + $discount_amount = 0; |
|
1508 | + } |
|
1509 | 1509 | |
1510 | - // ... or more than the amount. |
|
1511 | - if ( $discount_amount > $amount ) { |
|
1512 | - $discount_amount = $amount; |
|
1513 | - } |
|
1510 | + // ... or more than the amount. |
|
1511 | + if ( $discount_amount > $amount ) { |
|
1512 | + $discount_amount = $amount; |
|
1513 | + } |
|
1514 | 1514 | |
1515 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
1516 | - } |
|
1515 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
1516 | + } |
|
1517 | 1517 | |
1518 | 1518 | } |
@@ -15,172 +15,172 @@ |
||
15 | 15 | class WPInv_REST_Items_Controller extends GetPaid_REST_Posts_Controller { |
16 | 16 | |
17 | 17 | /** |
18 | - * Post type. |
|
19 | - * |
|
20 | - * @var string |
|
21 | - */ |
|
22 | - protected $post_type = 'wpi_item'; |
|
18 | + * Post type. |
|
19 | + * |
|
20 | + * @var string |
|
21 | + */ |
|
22 | + protected $post_type = 'wpi_item'; |
|
23 | 23 | |
24 | - /** |
|
25 | - * The base of this controller's route. |
|
26 | - * |
|
27 | - * @since 1.0.13 |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $rest_base = 'items'; |
|
31 | - |
|
32 | - /** Contains this controller's class name. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public $crud_class = 'WPInv_Item'; |
|
37 | - |
|
38 | - /** |
|
39 | - * Registers the routes for the objects of the controller. |
|
40 | - * |
|
41 | - * @since 1.0.19 |
|
42 | - * |
|
43 | - * @see register_rest_route() |
|
44 | - */ |
|
45 | - public function register_namespace_routes( $namespace ) { |
|
46 | - |
|
47 | - parent::register_namespace_routes( $namespace ); |
|
48 | - |
|
49 | - register_rest_route( |
|
50 | - $this->namespace, |
|
51 | - '/' . $this->rest_base . '/item-types', |
|
52 | - array( |
|
53 | - array( |
|
54 | - 'methods' => WP_REST_Server::READABLE, |
|
55 | - 'callback' => array( $this, 'get_item_types' ), |
|
56 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | - ), |
|
58 | - ) |
|
59 | - ); |
|
60 | - |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Handles rest requests for item types. |
|
65 | - * |
|
66 | - * @since 1.0.13 |
|
67 | - * |
|
68 | - * |
|
69 | - * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | - */ |
|
71 | - public function get_item_types() { |
|
72 | - return rest_ensure_response( wpinv_get_item_types() ); |
|
73 | - } |
|
24 | + /** |
|
25 | + * The base of this controller's route. |
|
26 | + * |
|
27 | + * @since 1.0.13 |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $rest_base = 'items'; |
|
31 | + |
|
32 | + /** Contains this controller's class name. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public $crud_class = 'WPInv_Item'; |
|
37 | + |
|
38 | + /** |
|
39 | + * Registers the routes for the objects of the controller. |
|
40 | + * |
|
41 | + * @since 1.0.19 |
|
42 | + * |
|
43 | + * @see register_rest_route() |
|
44 | + */ |
|
45 | + public function register_namespace_routes( $namespace ) { |
|
46 | + |
|
47 | + parent::register_namespace_routes( $namespace ); |
|
48 | + |
|
49 | + register_rest_route( |
|
50 | + $this->namespace, |
|
51 | + '/' . $this->rest_base . '/item-types', |
|
52 | + array( |
|
53 | + array( |
|
54 | + 'methods' => WP_REST_Server::READABLE, |
|
55 | + 'callback' => array( $this, 'get_item_types' ), |
|
56 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
57 | + ), |
|
58 | + ) |
|
59 | + ); |
|
60 | + |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Handles rest requests for item types. |
|
65 | + * |
|
66 | + * @since 1.0.13 |
|
67 | + * |
|
68 | + * |
|
69 | + * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
70 | + */ |
|
71 | + public function get_item_types() { |
|
72 | + return rest_ensure_response( wpinv_get_item_types() ); |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * Retrieves the query params for the items collection. |
|
77 | + * |
|
78 | + * @since 1.0.13 |
|
79 | + * |
|
80 | + * @return array Collection parameters. |
|
81 | + */ |
|
82 | + public function get_collection_params() { |
|
83 | + |
|
84 | + $params = array_merge( |
|
85 | + |
|
86 | + parent::get_collection_params(), |
|
87 | + |
|
88 | + array( |
|
89 | + |
|
90 | + // Item types |
|
91 | + 'type' => array( |
|
92 | + 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
93 | + 'type' => array( 'array', 'string' ), |
|
94 | + 'default' => 'any', |
|
95 | + 'validate_callback' => 'rest_validate_request_arg', |
|
96 | + 'sanitize_callback' => 'wpinv_parse_list', |
|
97 | + 'items' => array( |
|
98 | + 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
99 | + 'type' => 'string', |
|
100 | + ), |
|
101 | + ), |
|
102 | + |
|
103 | + ) |
|
104 | + ); |
|
105 | + |
|
106 | + // Filter collection parameters for the items controller. |
|
107 | + return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
108 | + |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Determine the allowed query_vars for a get_items() response and |
|
113 | + * prepare for WP_Query. |
|
114 | + * |
|
115 | + * @param array $prepared_args Prepared arguments. |
|
116 | + * @param WP_REST_Request $request Request object. |
|
117 | + * @return array $query_args |
|
118 | + */ |
|
119 | + protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
120 | + |
|
121 | + $query_args = parent::prepare_items_query( $prepared_args ); |
|
122 | + |
|
123 | + // Retrieve items by type. |
|
124 | + if ( ! in_array( 'any', $request['type'] ) ) { |
|
125 | + |
|
126 | + if ( empty( $query_args['meta_query'] ) ) { |
|
127 | + $query_args['meta_query'] = array(); |
|
128 | + } |
|
129 | + |
|
130 | + $query_args['meta_query'][] = array( |
|
131 | + 'key' => '_wpinv_type', |
|
132 | + 'value' => implode( ',', $request['type'] ), |
|
133 | + 'compare' => 'IN', |
|
134 | + ); |
|
135 | + |
|
136 | + } |
|
137 | + |
|
138 | + return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
139 | + |
|
140 | + } |
|
141 | + |
|
142 | + /** |
|
143 | + * Retrieves a valid list of post statuses. |
|
144 | + * |
|
145 | + * @since 1.0.15 |
|
146 | + * |
|
147 | + * @return array A list of registered item statuses. |
|
148 | + */ |
|
149 | + public function get_post_statuses() { |
|
150 | + return array( 'draft', 'pending', 'publish' ); |
|
151 | + } |
|
74 | 152 | |
75 | 153 | /** |
76 | - * Retrieves the query params for the items collection. |
|
77 | - * |
|
78 | - * @since 1.0.13 |
|
79 | - * |
|
80 | - * @return array Collection parameters. |
|
81 | - */ |
|
82 | - public function get_collection_params() { |
|
83 | - |
|
84 | - $params = array_merge( |
|
85 | - |
|
86 | - parent::get_collection_params(), |
|
87 | - |
|
88 | - array( |
|
89 | - |
|
90 | - // Item types |
|
91 | - 'type' => array( |
|
92 | - 'description' => __( 'Type of items to fetch.', 'invoicing' ), |
|
93 | - 'type' => array( 'array', 'string' ), |
|
94 | - 'default' => 'any', |
|
95 | - 'validate_callback' => 'rest_validate_request_arg', |
|
96 | - 'sanitize_callback' => 'wpinv_parse_list', |
|
97 | - 'items' => array( |
|
98 | - 'enum' => array_merge( array( 'any' ), wpinv_item_types() ), |
|
99 | - 'type' => 'string', |
|
100 | - ), |
|
101 | - ), |
|
102 | - |
|
103 | - ) |
|
104 | - ); |
|
105 | - |
|
106 | - // Filter collection parameters for the items controller. |
|
107 | - return apply_filters( 'getpaid_rest_items_collection_params', $params, $this ); |
|
108 | - |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Determine the allowed query_vars for a get_items() response and |
|
113 | - * prepare for WP_Query. |
|
114 | - * |
|
115 | - * @param array $prepared_args Prepared arguments. |
|
116 | - * @param WP_REST_Request $request Request object. |
|
117 | - * @return array $query_args |
|
118 | - */ |
|
119 | - protected function prepare_items_query( $prepared_args = array(), $request = null ) { |
|
120 | - |
|
121 | - $query_args = parent::prepare_items_query( $prepared_args ); |
|
122 | - |
|
123 | - // Retrieve items by type. |
|
124 | - if ( ! in_array( 'any', $request['type'] ) ) { |
|
125 | - |
|
126 | - if ( empty( $query_args['meta_query'] ) ) { |
|
127 | - $query_args['meta_query'] = array(); |
|
128 | - } |
|
129 | - |
|
130 | - $query_args['meta_query'][] = array( |
|
131 | - 'key' => '_wpinv_type', |
|
132 | - 'value' => implode( ',', $request['type'] ), |
|
133 | - 'compare' => 'IN', |
|
134 | - ); |
|
135 | - |
|
136 | - } |
|
137 | - |
|
138 | - return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this ); |
|
139 | - |
|
140 | - } |
|
141 | - |
|
142 | - /** |
|
143 | - * Retrieves a valid list of post statuses. |
|
144 | - * |
|
145 | - * @since 1.0.15 |
|
146 | - * |
|
147 | - * @return array A list of registered item statuses. |
|
148 | - */ |
|
149 | - public function get_post_statuses() { |
|
150 | - return array( 'draft', 'pending', 'publish' ); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Checks if a key should be included in a response. |
|
155 | - * |
|
156 | - * @since 1.0.19 |
|
157 | - * @param WPInv_Item $item Item object. |
|
158 | - * @param string $field_key The key to check for. |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - public function object_supports_field( $item, $field_key ) { |
|
162 | - |
|
163 | - if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
164 | - return false; |
|
165 | - } |
|
166 | - |
|
167 | - foreach( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
168 | - |
|
169 | - if ( $key == $field_key && ! $item->is_recurring() ) { |
|
170 | - return false; |
|
171 | - } |
|
172 | - |
|
173 | - } |
|
174 | - |
|
175 | - foreach( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
176 | - |
|
177 | - if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
178 | - return false; |
|
179 | - } |
|
180 | - |
|
181 | - } |
|
154 | + * Checks if a key should be included in a response. |
|
155 | + * |
|
156 | + * @since 1.0.19 |
|
157 | + * @param WPInv_Item $item Item object. |
|
158 | + * @param string $field_key The key to check for. |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + public function object_supports_field( $item, $field_key ) { |
|
162 | + |
|
163 | + if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) { |
|
164 | + return false; |
|
165 | + } |
|
166 | + |
|
167 | + foreach( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) { |
|
168 | + |
|
169 | + if ( $key == $field_key && ! $item->is_recurring() ) { |
|
170 | + return false; |
|
171 | + } |
|
172 | + |
|
173 | + } |
|
174 | + |
|
175 | + foreach( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) { |
|
176 | + |
|
177 | + if ( $key == $field_key && ! $item->has_free_trial() ) { |
|
178 | + return false; |
|
179 | + } |
|
180 | + |
|
181 | + } |
|
182 | 182 | |
183 | - return parent::object_supports_field( $item, $field_key ); |
|
184 | - } |
|
183 | + return parent::object_supports_field( $item, $field_key ); |
|
184 | + } |
|
185 | 185 | |
186 | 186 | } |