1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
|
<?php
/**
* Performs tax calculations and loads tax rates.
*
* @class WC_Tax
* @version 2.2.0
* @package WooCommerce/Classes
* @category Class
* @author WooThemes
*/
class WC_Tax {
public static $precision;
public static $round_at_subtotal;
/**
* Load options
*
* @access public
*/
public static function init() {
self::$precision = WC_ROUNDING_PRECISION;
self::$round_at_subtotal = 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' );
}
/**
* Calculate tax for a line
* @param float $price Price to calc tax on
* @param array $rates Rates to apply
* @param boolean $price_includes_tax Whether the passed price has taxes included
* @param boolean $suppress_rounding Whether to suppress any rounding from taking place
* @return array Array of rates + prices after tax
*/
public static function calc_tax( $price, $rates, $price_includes_tax = false, $suppress_rounding = false ) {
// Work in pence to X precision
$price = self::precision( $price );
if ( $price_includes_tax )
$taxes = self::calc_inclusive_tax( $price, $rates );
else
$taxes = self::calc_exclusive_tax( $price, $rates );
// Round to precision
if ( ! self::$round_at_subtotal && ! $suppress_rounding ) {
$taxes = array_map( 'round', $taxes ); // Round to precision
}
// Remove precision
$price = self::remove_precision( $price );
$taxes = array_map( array( __CLASS__, 'remove_precision' ), $taxes );
return apply_filters( 'woocommerce_calc_tax', $taxes, $price, $rates, $price_includes_tax, $suppress_rounding );
}
/**
* Calculate the shipping tax using a passed array of rates.
*
* @param float Price
* @param array Taxation Rate
* @return array
*/
public static function calc_shipping_tax( $price, $rates ) {
return self::calc_exclusive_tax( $price, $rates );
}
/**
* Multiply cost by pow precision
* @param float $price
* @return float
*/
private static function precision( $price ) {
return $price * ( pow( 10, self::$precision ) );
}
/**
* Divide cost by pow precision
* @param float $price
* @return float
*/
private static function remove_precision( $price ) {
return $price / ( pow( 10, self::$precision ) );
}
/**
* Round to precision.
*
* Filter example: to return rounding to .5 cents you'd use:
*
* public function euro_5cent_rounding( $in ) {
* return round( $in / 5, 2 ) * 5;
* }
* add_filter( 'woocommerce_tax_round', 'euro_5cent_rounding' );
*/
public static function round( $in ) {
return apply_filters( 'woocommerce_tax_round', round( $in, self::$precision ), $in );
}
/**
* Calc tax from inclusive price
*
* @param float $price
* @param array $rates
* @return array
*/
private static function calc_inclusive_tax( $price, $rates ) {
$taxes = array();
$regular_tax_rates = $compound_tax_rates = 0;
foreach ( $rates as $key => $rate )
if ( $rate['compound'] == 'yes' )
$compound_tax_rates = $compound_tax_rates + $rate['rate'];
else
$regular_tax_rates = $regular_tax_rates + $rate['rate'];
$regular_tax_rate = 1 + ( $regular_tax_rates / 100 );
$compound_tax_rate = 1 + ( $compound_tax_rates / 100 );
$non_compound_price = $price / $compound_tax_rate;
foreach ( $rates as $key => $rate ) {
if ( ! isset( $taxes[ $key ] ) )
$taxes[ $key ] = 0;
$the_rate = $rate['rate'] / 100;
if ( $rate['compound'] == 'yes' ) {
$the_price = $price;
$the_rate = $the_rate / $compound_tax_rate;
} else {
$the_price = $non_compound_price;
$the_rate = $the_rate / $regular_tax_rate;
}
$net_price = $price - ( $the_rate * $the_price );
$tax_amount = $price - $net_price;
$taxes[ $key ] += apply_filters( 'woocommerce_price_inc_tax_amount', $tax_amount, $key, $rate, $price );
}
return $taxes;
}
/**
* Calc tax from exclusive price
*
* @param float $price
* @param array $rates
* @return array
*/
private static function calc_exclusive_tax( $price, $rates ) {
$taxes = array();
// Multiple taxes
foreach ( $rates as $key => $rate ) {
if ( $rate['compound'] == 'yes' )
continue;
$tax_amount = $price * ( $rate['rate'] / 100 );
// ADVANCED: Allow third parties to modify this rate
$tax_amount = apply_filters( 'woocommerce_price_ex_tax_amount', $tax_amount, $key, $rate, $price );
// Add rate
if ( ! isset( $taxes[ $key ] ) )
$taxes[ $key ] = $tax_amount;
else
$taxes[ $key ] += $tax_amount;
}
$pre_compound_total = array_sum( $taxes );
// Compound taxes
if ( $rates ) {
foreach ( $rates as $key => $rate ) {
if ( $rate['compound'] == 'no' )
continue;
$the_price_inc_tax = $price + ( $pre_compound_total );
$tax_amount = $the_price_inc_tax * ( $rate['rate'] / 100 );
// ADVANCED: Allow third parties to modify this rate
$tax_amount = apply_filters( 'woocommerce_price_ex_tax_amount', $tax_amount, $key, $rate, $price, $the_price_inc_tax, $pre_compound_total );
// Add rate
if ( ! isset( $taxes[ $key ] ) )
$taxes[ $key ] = $tax_amount;
else
$taxes[ $key ] += $tax_amount;
}
}
return $taxes;
}
/**
* Searches for all matching country/state/postcode tax rates.
*
* @access public
* @param array $args
* @return array
*/
public static function find_rates( $args = array() ) {
global $wpdb;
$defaults = array(
'country' => '',
'state' => '',
'city' => '',
'postcode' => '',
'tax_class' => ''
);
$args = wp_parse_args( $args, $defaults );
extract( $args, EXTR_SKIP );
if ( ! $country ) {
return array();
}
// Handle postcodes
$valid_postcodes = array( '*', strtoupper( wc_clean( $postcode ) ) );
// Work out possible valid wildcard postcodes
$postcode_length = strlen( $postcode );
$wildcard_postcode = strtoupper( wc_clean( $postcode ) );
for ( $i = 0; $i < $postcode_length; $i ++ ) {
$wildcard_postcode = substr( $wildcard_postcode, 0, -1 );
$valid_postcodes[] = $wildcard_postcode . '*';
}
// Build transient key and try to retrieve them from cache
$rates_transient_key = 'wc_tax_rates_' . md5( sprintf( '%s+%s+%s+%s+%s', $country, $state, $city, implode( ',', $valid_postcodes), $tax_class ) );
$matched_tax_rates = get_transient( $rates_transient_key );
if ( false === $matched_tax_rates ) {
// Run the query
$found_rates = $wpdb->get_results( $wpdb->prepare( "
SELECT tax_rates.*
FROM {$wpdb->prefix}woocommerce_tax_rates as tax_rates
LEFT OUTER JOIN {$wpdb->prefix}woocommerce_tax_rate_locations as locations ON tax_rates.tax_rate_id = locations.tax_rate_id
LEFT OUTER JOIN {$wpdb->prefix}woocommerce_tax_rate_locations as locations2 ON tax_rates.tax_rate_id = locations2.tax_rate_id
WHERE tax_rate_country IN ( %s, '' )
AND tax_rate_state IN ( %s, '' )
AND tax_rate_class = %s
AND (
locations.location_type IS NULL
OR (
locations.location_type = 'postcode'
AND locations.location_code IN ('" . implode( "','", $valid_postcodes ) . "')
AND (
locations2.location_type = 'city' AND locations2.location_code = %s
OR 0 = (
SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_tax_rate_locations as sublocations
WHERE sublocations.location_type = 'city'
AND sublocations.tax_rate_id = tax_rates.tax_rate_id
)
)
)
OR (
locations.location_type = 'city'
AND locations.location_code = %s
AND 0 = (
SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_tax_rate_locations as sublocations
WHERE sublocations.location_type = 'postcode'
AND sublocations.tax_rate_id = tax_rates.tax_rate_id
)
)
)
GROUP BY tax_rate_id
ORDER BY tax_rate_priority, tax_rate_order
",
strtoupper( $country ),
strtoupper( $state ),
sanitize_title( $tax_class ),
strtoupper( $city ),
strtoupper( $city )
) );
$matched_tax_rates = array();
$found_priority = array();
foreach ( $found_rates as $found_rate ) {
if ( in_array( $found_rate->tax_rate_priority, $found_priority ) ) {
continue;
}
$matched_tax_rates[ $found_rate->tax_rate_id ] = array(
'rate' => $found_rate->tax_rate,
'label' => $found_rate->tax_rate_name,
'shipping' => $found_rate->tax_rate_shipping ? 'yes' : 'no',
'compound' => $found_rate->tax_rate_compound ? 'yes' : 'no'
);
$found_priority[] = $found_rate->tax_rate_priority;
}
$matched_tax_rates = apply_filters( 'woocommerce_matched_tax_rates', $matched_tax_rates, $country, $state, $postcode, $city, $tax_class );
set_transient( $rates_transient_key, $matched_tax_rates, DAY_IN_SECONDS );
}
return $matched_tax_rates;
}
/**
* Get's an array of matching rates for a tax class.
* @param string $tax_class
* @return array
*/
public static function get_rates( $tax_class = '' ) {
$tax_class = sanitize_title( $tax_class );
/* Checkout uses customer location for the tax rates. Also, if shipping has been calculated, use the customers address. */
if ( ( defined('WOOCOMMERCE_CHECKOUT') && WOOCOMMERCE_CHECKOUT ) || ( ! empty( WC()->customer ) && WC()->customer->has_calculated_shipping() ) ) {
list( $country, $state, $postcode, $city ) = WC()->customer->get_taxable_address();
$matched_tax_rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'postcode' => $postcode,
'city' => $city,
'tax_class' => $tax_class
) );
} else {
// Prices which include tax should always use the base rate if we don't know where the user is located
// Prices excluding tax however should just not add any taxes, as they will be added during checkout.
// The woocommerce_default_customer_address option (when set to base) is also used here.
$matched_tax_rates = get_option( 'woocommerce_prices_include_tax' ) == 'yes' || get_option( 'woocommerce_default_customer_address' ) == 'base'
? self::get_shop_base_rate( $tax_class )
: array();
}
return apply_filters('woocommerce_matched_rates', $matched_tax_rates, $tax_class);
}
/**
* Get's an array of matching rates for the shop's base country.
*
* @param string Tax Class
* @return array
*/
public static function get_shop_base_rate( $tax_class = '' ) {
return self::find_rates( array(
'country' => WC()->countries->get_base_country(),
'state' => WC()->countries->get_base_state(),
'postcode' => WC()->countries->get_base_postcode(),
'city' => WC()->countries->get_base_city(),
'tax_class' => $tax_class
) );
}
/**
* Gets an array of matching shipping tax rates for a given class.
*
* @param string Tax Class
* @return mixed
*/
public static function get_shipping_tax_rates( $tax_class = null ) {
// See if we have an explicitly set shipping tax class
if ( $shipping_tax_class = get_option( 'woocommerce_shipping_tax_class' ) ) {
$tax_class = $shipping_tax_class == 'standard' ? '' : $shipping_tax_class;
}
if ( ( defined('WOOCOMMERCE_CHECKOUT') && WOOCOMMERCE_CHECKOUT ) || ( ! empty( WC()->customer ) && WC()->customer->has_calculated_shipping() ) ) {
list( $country, $state, $postcode, $city ) = WC()->customer->get_taxable_address();
} else {
// Prices which include tax should always use the base rate if we don't know where the user is located
// Prices excluding tax however should just not add any taxes, as they will be added during checkout
if ( get_option( 'woocommerce_prices_include_tax' ) == 'yes' || get_option( 'woocommerce_default_customer_address' ) == 'base' ) {
$country = WC()->countries->get_base_country();
$state = WC()->countries->get_base_state();
$postcode = '';
$city = '';
} else {
return array();
}
}
// If we are here then shipping is taxable - work it out
if ( ! is_null( $tax_class ) ) {
$matched_tax_rates = array();
// This will be per item shipping
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'postcode' => $postcode,
'city' => $city,
'tax_class' => $tax_class
) );
if ( $rates )
foreach ( $rates as $key => $rate )
if ( isset( $rate['shipping'] ) && $rate['shipping'] == 'yes' )
$matched_tax_rates[ $key ] = $rate;
if ( sizeof( $matched_tax_rates ) == 0 ) {
// Get standard rate
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'city' => $city,
'postcode' => $postcode,
) );
if ( $rates )
foreach ( $rates as $key => $rate )
if ( isset( $rate['shipping'] ) && $rate['shipping'] == 'yes' )
$matched_tax_rates[ $key ] = $rate;
}
return $matched_tax_rates;
} else {
// This will be per order shipping - loop through the order and find the highest tax class rate
$found_tax_classes = array();
$matched_tax_rates = array();
$rates = false;
// Loop cart and find the highest tax band
if ( sizeof( WC()->cart->get_cart() ) > 0 )
foreach ( WC()->cart->get_cart() as $item )
$found_tax_classes[] = $item['data']->get_tax_class();
$found_tax_classes = array_unique( $found_tax_classes );
// If multiple classes are found, use highest
if ( sizeof( $found_tax_classes ) > 1 ) {
if ( in_array( '', $found_tax_classes ) ) {
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'city' => $city,
'postcode' => $postcode,
) );
} else {
$tax_classes = array_filter( array_map( 'trim', explode( "\n", get_option( 'woocommerce_tax_classes' ) ) ) );
foreach ( $tax_classes as $tax_class ) {
if ( in_array( $tax_class, $found_tax_classes ) ) {
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'postcode' => $postcode,
'city' => $city,
'tax_class' => $tax_class
) );
break;
}
}
}
// If a single tax class is found, use it
} elseif ( sizeof( $found_tax_classes ) == 1 ) {
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'postcode' => $postcode,
'city' => $city,
'tax_class' => $found_tax_classes[0]
) );
}
// If no class rate are found, use standard rates
if ( ! $rates )
$rates = self::find_rates( array(
'country' => $country,
'state' => $state,
'postcode' => $postcode,
'city' => $city,
) );
if ( $rates )
foreach ( $rates as $key => $rate )
if ( isset( $rate['shipping'] ) && $rate['shipping'] == 'yes' )
$matched_tax_rates[ $key ] = $rate;
return $matched_tax_rates;
}
return array(); // return false
}
/**
* Return true/false depending on if a rate is a compound rate.
*
* @param int key
* @return bool
*/
public static function is_compound( $key ) {
global $wpdb;
return $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate_compound FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %s", $key ) ) ? true : false;
}
/**
* Return a given rates label.
*
* @param mixed $key_or_rate Tax rate ID, or the db row itself in object format
* @return string
*/
public static function get_rate_label( $key_or_rate ) {
global $wpdb;
if ( is_object( $key_or_rate ) ) {
$key = $key_or_rate->tax_rate_id;
$rate_name = $key_or_rate->tax_rate_name;
} else {
$key = $key_or_rate;
$rate_name = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate_name FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %s", $key ) );
}
if ( ! $rate_name ) {
$rate_name = WC()->countries->tax_or_vat();
}
return apply_filters( 'woocommerce_rate_label', $rate_name, $key );
}
/**
* Return a given rates percent.
*
* @param mixed $key_or_rate Tax rate ID, or the db row itself in object format
* @return string
*/
public static function get_rate_percent( $key_or_rate ) {
global $wpdb;
if ( is_object( $key_or_rate ) ) {
$key = $key_or_rate->tax_rate_id;
$tax_rate = $key_or_rate->tax_rate;
} else {
$key = $key_or_rate;
$tax_rate = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %s", $key ) );
}
return apply_filters( 'woocommerce_rate_percent', floatval( $tax_rate ) . '%', $key );
}
/**
* Get a rates code. Code is made up of COUNTRY-STATE-NAME-Priority. E.g GB-VAT-1, US-AL-TAX-1
*
* @access public
* @param mixed $key_or_rate Tax rate ID, or the db row itself in object format
* @return string
*/
public static function get_rate_code( $key_or_rate ) {
global $wpdb;
if ( is_object( $key_or_rate ) ) {
$key = $key_or_rate->tax_rate_id;
$rate = $key_or_rate;
} else {
$key = $key_or_rate;
$rate = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %s", $key ) );
}
$code_string = '';
if ( null !== $rate ) {
$code = array();
$code[] = $rate->tax_rate_country;
$code[] = $rate->tax_rate_state;
$code[] = $rate->tax_rate_name ? $rate->tax_rate_name : 'TAX';
$code[] = absint( $rate->tax_rate_priority );
$code_string = strtoupper( implode( '-', array_filter( $code ) ) );
}
return apply_filters( 'woocommerce_rate_code', $code_string, $key );
}
/**
* Round tax lines and return the sum.
*
* @param array
* @return float
*/
public static function get_tax_total( $taxes ) {
return array_sum( array_map( array( __CLASS__, 'round' ), $taxes ) );
}
}
WC_Tax::init();
|