Completed
Push — master ( 5ce2ab...a77735 )
by Mike
11:53
created

WC_Cart::get_tax_amount()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %
Metric Value
dl 0
loc 3
rs 10
cc 2
eloc 2
nc 2
nop 1
1
<?php
1 ignored issue
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 19 and the first side effect is on line 4.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
3
if ( ! defined( 'ABSPATH' ) ) {
4
	exit; // Exit if accessed directly
5
}
6
7
/**
8
 * WooCommerce cart
9
 *
10
 * The WooCommerce cart class stores cart data and active coupons as well as handling customer sessions and some cart related urls.
11
 * The cart class also has a price calculation function which calls upon other classes to calculate totals.
12
 *
13
 * @class 		WC_Cart
14
 * @version		2.1.0
15
 * @package		WooCommerce/Classes
16
 * @category	Class
17
 * @author 		WooThemes
18
 */
19
class WC_Cart {
20
21
	/** @var array Contains an array of cart items. */
22
	public $cart_contents = array();
23
24
	/** @var array Contains an array of removed cart items. */
25
	public $removed_cart_contents = array();
26
27
	/** @var array Contains an array of coupon codes applied to the cart. */
28
	public $applied_coupons = array();
29
30
	/** @var array Contains an array of coupon code discounts after they have been applied. */
31
	public $coupon_discount_amounts = array();
32
33
	/** @var array Contains an array of coupon code discount taxes. Used for tax incl pricing. */
34
	public $coupon_discount_tax_amounts = array();
35
36
	/** @var array Contains an array of coupon usage counts after they have been applied. */
37
	public $coupon_applied_count = array();
38
39
	/** @var array Array of coupons */
40
	public $coupons = array();
41
42
	/** @var float The total cost of the cart items. */
43
	public $cart_contents_total;
44
45
	/** @var float Cart grand total. */
46
	public $total;
47
48
	/** @var float Cart subtotal. */
49
	public $subtotal;
50
51
	/** @var float Cart subtotal without tax. */
52
	public $subtotal_ex_tax;
53
54
	/** @var float Total cart tax. */
55
	public $tax_total;
56
57
	/** @var array An array of taxes/tax rates for the cart. */
58
	public $taxes;
59
60
	/** @var array An array of taxes/tax rates for the shipping. */
61
	public $shipping_taxes;
62
63
	/** @var float Discount amount before tax */
64
	public $discount_cart;
65
66
	/** @var float Discounted tax amount. Used predominantly for displaying tax inclusive prices correctly */
67
	public $discount_cart_tax;
68
69
	/** @var float Total for additional fees. */
70
	public $fee_total;
71
72
	/** @var float Shipping cost. */
73
	public $shipping_total;
74
75
	/** @var float Shipping tax. */
76
	public $shipping_tax_total;
77
78
	/** @var array cart_session_data. Array of data the cart calculates and stores in the session with defaults */
79
	public $cart_session_data = array(
80
		'cart_contents_total'         => 0,
81
		'total'                       => 0,
82
		'subtotal'                    => 0,
83
		'subtotal_ex_tax'             => 0,
84
		'tax_total'                   => 0,
85
		'taxes'                       => array(),
86
		'shipping_taxes'              => array(),
87
		'discount_cart'               => 0,
88
		'discount_cart_tax'           => 0,
89
		'shipping_total'              => 0,
90
		'shipping_tax_total'          => 0,
91
		'coupon_discount_amounts'     => array(),
92
		'coupon_discount_tax_amounts' => array(),
93
		'fee_total'                   => 0,
94
		'fees'                        => array()
95
	);
96
97
	/**
98
	 * An array of fees.
99
	 *
100
	 * @var array
101
	 */
102
	public $fees = array();
103
104
	/**
105
	 * Constructor for the cart class. Loads options and hooks in the init method.
106
	 */
107
	public function __construct() {
108
		add_action( 'wp_loaded', array( $this, 'init' ) ); // Get cart after WP and plugins are loaded.
109
		add_action( 'wp', array( $this, 'maybe_set_cart_cookies' ), 99 ); // Set cookies
110
		add_action( 'shutdown', array( $this, 'maybe_set_cart_cookies' ), 0 ); // Set cookies before shutdown and ob flushing
111
		add_action( 'woocommerce_add_to_cart', array( $this, 'calculate_totals' ), 20, 0 );
112
		add_action( 'woocommerce_applied_coupon', array( $this, 'calculate_totals' ), 20, 0 );
113
	}
114
115
	/**
116
	 * Auto-load in-accessible properties on demand.
117
	 *
118
	 * @param mixed $key
119
	 * @return mixed
120
	 */
121
	public function __get( $key ) {
122
		switch ( $key ) {
123
			case 'prices_include_tax' :
124
				return wc_prices_include_tax();
125
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
126
			case 'round_at_subtotal' :
127
				return 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' );
128
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
129
			case 'tax_display_cart' :
130
				return get_option( 'woocommerce_tax_display_cart' );
131
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
132
			case 'dp' :
133
				return wc_get_price_decimals();
134
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
135
			case 'display_totals_ex_tax' :
136
			case 'display_cart_ex_tax' :
137
				return $this->tax_display_cart === 'excl';
138
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
139
			case 'cart_contents_weight' :
140
				return $this->get_cart_contents_weight();
141
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
142
			case 'cart_contents_count' :
143
				return $this->get_cart_contents_count();
144
			break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
145
			case 'tax' :
146
				_deprecated_argument( 'WC_Cart->tax', '2.3', 'Use WC_Tax:: directly' );
147
				$this->tax = new WC_Tax();
148
			return $this->tax;
149
			case 'discount_total':
150
				_deprecated_argument( 'WC_Cart->discount_total', '2.3', 'After tax coupons are no longer supported. For more information see: https://woocommerce.wordpress.com/2014/12/upcoming-coupon-changes-in-woocommerce-2-3/' );
151
			return 0;
152
		}
153
	}
154
155
	/**
156
	 * Loads the cart data from the PHP session during WordPress init and hooks in other methods.
157
	 */
158
	public function init() {
159
		$this->get_cart_from_session();
160
161
		add_action( 'woocommerce_check_cart_items', array( $this, 'check_cart_items' ), 1 );
162
		add_action( 'woocommerce_check_cart_items', array( $this, 'check_cart_coupons' ), 1 );
163
		add_action( 'woocommerce_after_checkout_validation', array( $this, 'check_customer_coupons' ), 1 );
164
	}
165
166
	/**
167
	 * Will set cart cookies if needed, once, during WP hook.
168
	 */
169
	public function maybe_set_cart_cookies() {
170
		if ( ! headers_sent() && did_action( 'wp_loaded' ) ) {
171
			if ( ! $this->is_empty() ) {
172
				$this->set_cart_cookies( true );
173
			} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) {
174
				$this->set_cart_cookies( false );
175
			}
176
		}
177
	}
178
179
	/**
180
	 * Set cart hash cookie and items in cart.
181
	 *
182
	 * @access private
183
	 * @param bool $set (default: true)
184
	 */
185
	private function set_cart_cookies( $set = true ) {
186
		if ( $set ) {
187
			wc_setcookie( 'woocommerce_items_in_cart', 1 );
188
			wc_setcookie( 'woocommerce_cart_hash', md5( json_encode( $this->get_cart_for_session() ) ) );
189
		} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) {
190
			wc_setcookie( 'woocommerce_items_in_cart', 0, time() - HOUR_IN_SECONDS );
191
			wc_setcookie( 'woocommerce_cart_hash', '', time() - HOUR_IN_SECONDS );
192
		}
193
		do_action( 'woocommerce_set_cart_cookies', $set );
194
	}
195
196
	/*-----------------------------------------------------------------------------------*/
197
	/* Cart Session Handling */
198
	/*-----------------------------------------------------------------------------------*/
199
200
		/**
201
		 * Get the cart data from the PHP session and store it in class variables.
202
		 */
203
		public function get_cart_from_session() {
204
			// Load cart session data from session
205
			foreach ( $this->cart_session_data as $key => $default ) {
206
				$this->$key = WC()->session->get( $key, $default );
207
			}
208
209
			$update_cart_session         = false;
210
			$this->removed_cart_contents = array_filter( WC()->session->get( 'removed_cart_contents', array() ) );
211
			$this->applied_coupons       = array_filter( WC()->session->get( 'applied_coupons', array() ) );
212
213
			/**
214
			 * Load the cart object. This defaults to the persistent cart if null.
215
			 */
216
			$cart = WC()->session->get( 'cart', null );
217
218
			if ( is_null( $cart ) && ( $saved_cart = get_user_meta( get_current_user_id(), '_woocommerce_persistent_cart', true ) ) ) {
219
				$cart                = $saved_cart['cart'];
220
				$update_cart_session = true;
221
			} elseif ( is_null( $cart ) ) {
222
				$cart = array();
223
			}
224
225
			if ( is_array( $cart ) ) {
226
				// Prime meta cache to reduce future queries
227
				update_meta_cache( 'post', wp_list_pluck( $cart, 'product_id' ) );
228
229
				foreach ( $cart as $key => $values ) {
230
					$_product = wc_get_product( $values['variation_id'] ? $values['variation_id'] : $values['product_id'] );
231
232
					if ( ! empty( $_product ) && $_product->exists() && $values['quantity'] > 0 ) {
233
234
						if ( ! $_product->is_purchasable() ) {
235
236
							// Flag to indicate the stored cart should be update
237
							$update_cart_session = true;
238
							wc_add_notice( sprintf( __( '%s has been removed from your cart because it can no longer be purchased. Please contact us if you need assistance.', 'woocommerce' ), $_product->get_title() ), 'error' );
239
							do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
240
241
						} else {
242
243
							// Put session data into array. Run through filter so other plugins can load their own session data
244
							$session_data = array_merge( $values, array( 'data' => $_product ) );
245
							$this->cart_contents[ $key ] = apply_filters( 'woocommerce_get_cart_item_from_session', $session_data, $values, $key );
246
247
						}
248
					}
249
				}
250
			}
251
252
			// Trigger action
253
			do_action( 'woocommerce_cart_loaded_from_session', $this );
254
255
			if ( $update_cart_session ) {
256
				WC()->session->cart = $this->get_cart_for_session();
257
			}
258
259
			// Queue re-calc if subtotal is not set
260
			if ( ( ! $this->subtotal && ! $this->is_empty() ) || $update_cart_session ) {
261
				$this->calculate_totals();
262
			}
263
		}
264
265
		/**
266
		 * Sets the php session data for the cart and coupons.
267
		 */
268
		public function set_session() {
269
			// Set cart and coupon session data
270
			$cart_session = $this->get_cart_for_session();
271
272
			WC()->session->set( 'cart', $cart_session );
273
			WC()->session->set( 'applied_coupons', $this->applied_coupons );
274
			WC()->session->set( 'coupon_discount_amounts', $this->coupon_discount_amounts );
275
			WC()->session->set( 'coupon_discount_tax_amounts', $this->coupon_discount_tax_amounts );
276
			WC()->session->set( 'removed_cart_contents', $this->removed_cart_contents );
277
278
			foreach ( $this->cart_session_data as $key => $default ) {
279
				WC()->session->set( $key, $this->$key );
280
			}
281
282
			if ( get_current_user_id() ) {
283
				$this->persistent_cart_update();
284
			}
285
286
			do_action( 'woocommerce_cart_updated' );
287
		}
288
289
		/**
290
		 * Empties the cart and optionally the persistent cart too.
291
		 *
292
		 * @param bool $clear_persistent_cart (default: true)
293
		 */
294
		public function empty_cart( $clear_persistent_cart = true ) {
295
			$this->cart_contents = array();
296
			$this->reset( true );
297
298
			unset( WC()->session->order_awaiting_payment, WC()->session->applied_coupons, WC()->session->coupon_discount_amounts, WC()->session->coupon_discount_tax_amounts, WC()->session->cart );
299
300
			if ( $clear_persistent_cart && get_current_user_id() ) {
301
				$this->persistent_cart_destroy();
302
			}
303
304
			do_action( 'woocommerce_cart_emptied' );
305
		}
306
307
	/*-----------------------------------------------------------------------------------*/
308
	/* Persistent cart handling */
309
	/*-----------------------------------------------------------------------------------*/
310
311
		/**
312
		 * Save the persistent cart when the cart is updated.
313
		 */
314
		public function persistent_cart_update() {
315
			update_user_meta( get_current_user_id(), '_woocommerce_persistent_cart', array(
316
				'cart' => WC()->session->get( 'cart' )
317
			) );
318
		}
319
320
		/**
321
		 * Delete the persistent cart permanently.
322
		 */
323
		public function persistent_cart_destroy() {
324
			delete_user_meta( get_current_user_id(), '_woocommerce_persistent_cart' );
325
		}
326
327
	/*-----------------------------------------------------------------------------------*/
328
	/* Cart Data Functions */
329
	/*-----------------------------------------------------------------------------------*/
330
331
		/**
332
		 * Coupons enabled function. Filterable.
333
		 *
334
		 * @deprecated 2.5.0 in favor to wc_coupons_enabled()
335
		 *
336
		 * @return bool
337
		 */
338
		public function coupons_enabled() {
339
			return wc_coupons_enabled();
340
		}
341
342
		/**
343
		 * Get number of items in the cart.
344
		 * @return int
345
		 */
346
		public function get_cart_contents_count() {
347
			return apply_filters( 'woocommerce_cart_contents_count', array_sum( wp_list_pluck( $this->get_cart(), 'quantity' ) ) );
348
		}
349
350
		/**
351
		 * Get weight of items in the cart.
352
		 * @since 2.5.0
353
		 * @return int
354
		 */
355
		public function get_cart_contents_weight() {
356
			$weight = 0;
357
358
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
359
				$weight += $values['data']->get_weight() * $values['quantity'];
360
			}
361
362
			return apply_filters( 'woocommerce_cart_contents_weight', $weight );
363
		}
364
365
		/**
366
		* Checks if the cart is empty.
367
		*
368
		* @return bool
369
		*/
370
		public function is_empty() {
371
			return 0 === sizeof( $this->get_cart() );
372
		}
373
374
		/**
375
		 * Check all cart items for errors.
376
		 */
377
		public function check_cart_items() {
378
379
			// Result
380
			$return = true;
381
382
			// Check cart item validity
383
			$result = $this->check_cart_item_validity();
384
385
			if ( is_wp_error( $result ) ) {
386
				wc_add_notice( $result->get_error_message(), 'error' );
387
				$return = false;
388
			}
389
390
			// Check item stock
391
			$result = $this->check_cart_item_stock();
392
393
			if ( is_wp_error( $result ) ) {
394
				wc_add_notice( $result->get_error_message(), 'error' );
395
				$return = false;
396
			}
397
398
			return $return;
399
400
		}
401
402
		/**
403
		 * Check cart coupons for errors.
404
		 */
405
		public function check_cart_coupons() {
406
			foreach ( $this->applied_coupons as $code ) {
407
				$coupon = new WC_Coupon( $code );
408
409 View Code Duplication
				if ( ! $coupon->is_valid() ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
410
					// Error message
411
					$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_INVALID_REMOVED );
412
413
					// Remove the coupon
414
					$this->remove_coupon( $code );
415
416
					// Flag totals for refresh
417
					WC()->session->set( 'refresh_totals', true );
418
				}
419
			}
420
		}
421
422
		/**
423
		 * Get cart items quantities - merged so we can do accurate stock checks on items across multiple lines.
424
		 *
425
		 * @return array
426
		 */
427
		public function get_cart_item_quantities() {
428
			$quantities = array();
429
430
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
431
				$_product = $values['data'];
432
433
				if ( $_product->is_type( 'variation' ) && true === $_product->managing_stock() ) {
434
					// Variation has stock levels defined so its handled individually
435
					$quantities[ $values['variation_id'] ] = isset( $quantities[ $values['variation_id'] ] ) ? $quantities[ $values['variation_id'] ] + $values['quantity'] : $values['quantity'];
436
				} else {
437
					$quantities[ $values['product_id'] ] = isset( $quantities[ $values['product_id'] ] ) ? $quantities[ $values['product_id'] ] + $values['quantity'] : $values['quantity'];
438
				}
439
			}
440
441
			return $quantities;
442
		}
443
444
		/**
445
		 * Looks through cart items and checks the posts are not trashed or deleted.
446
		 *
447
		 * @return bool|WP_Error
448
		 */
449
		public function check_cart_item_validity() {
450
			$return = true;
451
452
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
453
				$_product = $values['data'];
454
455
				if ( ! $_product || ! $_product->exists() || 'trash' === $_product->post->post_status ) {
456
					$this->set_quantity( $cart_item_key, 0 );
457
					$return = new WP_Error( 'invalid', __( 'An item which is no longer available was removed from your cart.', 'woocommerce' ) );
458
				}
459
			}
460
461
			return $return;
462
		}
463
464
		/**
465
		 * Looks through the cart to check each item is in stock. If not, add an error.
466
		 *
467
		 * @return bool|WP_Error
468
		 */
469
		public function check_cart_item_stock() {
470
			global $wpdb;
471
472
			$error               = new WP_Error();
473
			$product_qty_in_cart = $this->get_cart_item_quantities();
474
475
			// First stock check loop
476
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
477
				$_product = $values['data'];
478
479
				/**
480
				 * Check stock based on stock-status.
481
				 */
482
				if ( ! $_product->is_in_stock() ) {
483
					$error->add( 'out-of-stock', sprintf(__( 'Sorry, "%s" is not in stock. Please edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title() ) );
484
					return $error;
485
				}
486
487
				if ( ! $_product->managing_stock() ) {
488
					continue;
489
				}
490
491
				$check_qty = $_product->is_type( 'variation' ) && true === $_product->managing_stock() ? $product_qty_in_cart[ $values['variation_id'] ] : $product_qty_in_cart[ $values['product_id'] ];
492
493
				/**
494
				 * Check stock based on all items in the cart.
495
				 */
496
				if ( ! $_product->has_enough_stock( $check_qty ) ) {
497
					$error->add( 'out-of-stock', sprintf(__( 'Sorry, we do not have enough "%s" in stock to fulfill your order (%s in stock). Please edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title(), $_product->get_stock_quantity() ) );
498
					return $error;
499
				}
500
501
				/**
502
				 * Finally consider any held stock, from pending orders.
503
				 */
504
				if ( get_option( 'woocommerce_hold_stock_minutes' ) > 0 && ! $_product->backorders_allowed() ) {
505
					$order_id   = isset( WC()->session->order_awaiting_payment ) ? absint( WC()->session->order_awaiting_payment ) : 0;
506
					$held_stock = $wpdb->get_var(
507
						$wpdb->prepare( "
508
							SELECT SUM( order_item_meta.meta_value ) AS held_qty
509
							FROM {$wpdb->posts} AS posts
510
							LEFT JOIN {$wpdb->prefix}woocommerce_order_items as order_items ON posts.ID = order_items.order_id
511
							LEFT JOIN {$wpdb->prefix}woocommerce_order_itemmeta as order_item_meta ON order_items.order_item_id = order_item_meta.order_item_id
512
							LEFT JOIN {$wpdb->prefix}woocommerce_order_itemmeta as order_item_meta2 ON order_items.order_item_id = order_item_meta2.order_item_id
513
							WHERE 	order_item_meta.meta_key   = '_qty'
514
							AND 	order_item_meta2.meta_key  = %s AND order_item_meta2.meta_value  = %d
515
							AND 	posts.post_type            IN ( '" . implode( "','", wc_get_order_types() ) . "' )
516
							AND 	posts.post_status          = 'wc-pending'
517
							AND		posts.ID                   != %d;",
518
							$_product->is_type( 'variation' ) && true === $_product->managing_stock() ? '_variation_id' : '_product_id',
519
							$_product->is_type( 'variation' ) && true === $_product->managing_stock() ? $values['variation_id'] : $values['product_id'],
520
							$order_id
521
						)
522
					);
523
524
					$not_enough_stock = false;
525
526
					if ( $_product->is_type( 'variation' ) && 'parent' === $_product->managing_stock() && $_product->parent->get_stock_quantity() < ( $held_stock + $check_qty ) ) {
527
						$not_enough_stock = true;
528
					} elseif ( $_product->get_stock_quantity() < ( $held_stock + $check_qty ) ) {
529
						$not_enough_stock = true;
530
					}
531
					if ( $not_enough_stock ) {
532
						$error->add( 'out-of-stock', sprintf(__( 'Sorry, we do not have enough "%s" in stock to fulfill your order right now. Please try again in %d minutes or edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title(), get_option( 'woocommerce_hold_stock_minutes' ) ) );
533
						return $error;
534
					}
535
				}
536
			}
537
538
			return true;
539
		}
540
541
		/**
542
		 * Gets and formats a list of cart item data + variations for display on the frontend.
543
		 *
544
		 * @param array $cart_item
545
		 * @param bool $flat (default: false)
546
		 * @return string
547
		 */
548
		public function get_item_data( $cart_item, $flat = false ) {
549
			$item_data = array();
550
551
			// Variation data
552
			if ( ! empty( $cart_item['data']->variation_id ) && is_array( $cart_item['variation'] ) ) {
553
554
				foreach ( $cart_item['variation'] as $name => $value ) {
555
556
					if ( '' === $value )
557
						continue;
558
559
					$taxonomy = wc_attribute_taxonomy_name( str_replace( 'attribute_pa_', '', urldecode( $name ) ) );
560
561
					// If this is a term slug, get the term's nice name
562
					if ( taxonomy_exists( $taxonomy ) ) {
563
						$term = get_term_by( 'slug', $value, $taxonomy );
564
						if ( ! is_wp_error( $term ) && $term && $term->name ) {
565
							$value = $term->name;
566
						}
567
						$label = wc_attribute_label( $taxonomy );
568
569
					// If this is a custom option slug, get the options name
570
					} else {
571
						$value              = apply_filters( 'woocommerce_variation_option_name', $value );
572
						$product_attributes = $cart_item['data']->get_attributes();
573
						if ( isset( $product_attributes[ str_replace( 'attribute_', '', $name ) ] ) ) {
574
							$label = wc_attribute_label( $product_attributes[ str_replace( 'attribute_', '', $name ) ]['name'] );
575
						} else {
576
							$label = $name;
577
						}
578
					}
579
580
					$item_data[] = array(
581
						'key'   => $label,
582
						'value' => $value
583
					);
584
				}
585
			}
586
587
			// Filter item data to allow 3rd parties to add more to the array
588
			$item_data = apply_filters( 'woocommerce_get_item_data', $item_data, $cart_item );
589
590
			// Format item data ready to display
591
			foreach ( $item_data as $key => $data ) {
592
				// Set hidden to true to not display meta on cart.
593
				if ( ! empty( $data['hidden'] ) ) {
594
					unset( $item_data[ $key ] );
595
					continue;
596
				}
597
				$item_data[ $key ]['key']     = ! empty( $data['key'] ) ? $data['key'] : $data['name'];
598
				$item_data[ $key ]['display'] = ! empty( $data['display'] ) ? $data['display'] : $data['value'];
599
			}
600
601
			// Output flat or in list format
602
			if ( sizeof( $item_data ) > 0 ) {
603
				ob_start();
604
605
				if ( $flat ) {
606
					foreach ( $item_data as $data ) {
607
						echo esc_html( $data['key'] ) . ': ' . wp_kses_post( $data['display'] ) . "\n";
608
					}
609
				} else {
610
					wc_get_template( 'cart/cart-item-data.php', array( 'item_data' => $item_data ) );
611
				}
612
613
				return ob_get_clean();
614
			}
615
616
			return '';
617
		}
618
619
		/**
620
		 * Gets cross sells based on the items in the cart.
621
		 *
622
		 * @return array cross_sells (item ids)
623
		 */
624
		public function get_cross_sells() {
625
			$cross_sells = array();
626
			$in_cart = array();
627
			if ( ! $this->is_empty() ) {
628
				foreach ( $this->get_cart() as $cart_item_key => $values ) {
629
					if ( $values['quantity'] > 0 ) {
630
						$cross_sells = array_merge( $values['data']->get_cross_sells(), $cross_sells );
631
						$in_cart[] = $values['product_id'];
632
					}
633
				}
634
			}
635
			$cross_sells = array_diff( $cross_sells, $in_cart );
636
			return $cross_sells;
637
		}
638
639
		/**
640
		 * Gets the url to the cart page.
641
		 *
642
		 * @deprecated 2.5.0 in favor to wc_get_cart_url()
643
		 *
644
		 * @return string url to page
645
		 */
646
		public function get_cart_url() {
647
			return wc_get_cart_url();
648
		}
649
650
		/**
651
		 * Gets the url to the checkout page.
652
		 *
653
		 * @deprecated 2.5.0 in favor to wc_get_checkout_url()
654
		 *
655
		 * @return string url to page
656
		 */
657
		public function get_checkout_url() {
658
			return wc_get_checkout_url();
659
		}
660
661
		/**
662
		 * Gets the url to remove an item from the cart.
663
		 *
664
		 * @param string $cart_item_key contains the id of the cart item
665
		 * @return string url to page
666
		 */
667
		public function get_remove_url( $cart_item_key ) {
668
			$cart_page_url = wc_get_page_permalink( 'cart' );
669
			return apply_filters( 'woocommerce_get_remove_url', $cart_page_url ? wp_nonce_url( add_query_arg( 'remove_item', $cart_item_key, $cart_page_url ), 'woocommerce-cart' ) : '' );
670
		}
671
672
		/**
673
		 * Gets the url to re-add an item into the cart.
674
		 *
675
		 * @param  string $cart_item_key
676
		 * @return string url to page
677
		 */
678
		public function get_undo_url( $cart_item_key ) {
679
			$cart_page_url = wc_get_page_permalink( 'cart' );
680
681
			$query_args = array(
682
				'undo_item' => $cart_item_key,
683
			);
684
685
			return apply_filters( 'woocommerce_get_undo_url', $cart_page_url ? wp_nonce_url( add_query_arg( $query_args, $cart_page_url ), 'woocommerce-cart' ) : '' );
686
		}
687
688
		/**
689
		 * Returns the contents of the cart in an array.
690
		 *
691
		 * @return array contents of the cart
692
		 */
693
		public function get_cart() {
694
			if ( ! did_action( 'wp_loaded' ) ) {
695
				_doing_it_wrong( __FUNCTION__, __( 'Get cart should not be called before the wp_loaded action.', 'woocommerce' ), '2.3' );
696
			}
697
			if ( ! did_action( 'woocommerce_cart_loaded_from_session' ) ) {
698
				$this->get_cart_from_session();
699
			}
700
			return array_filter( (array) $this->cart_contents );
701
		}
702
703
		/**
704
		 * Returns the contents of the cart in an array without the 'data' element.
705
		 *
706
		 * @return array contents of the cart
707
		 */
708
		public function get_cart_for_session() {
709
			$cart_session = array();
710
711
			if ( $this->get_cart() ) {
712
				foreach ( $this->get_cart() as $key => $values ) {
713
					$cart_session[ $key ] = $values;
714
					unset( $cart_session[ $key ]['data'] ); // Unset product object
715
				}
716
			}
717
718
			return $cart_session;
719
		}
720
721
		/**
722
		 * Returns a specific item in the cart.
723
		 *
724
		 * @param string $item_key Cart item key.
725
		 * @return array Item data
726
		 */
727
		public function get_cart_item( $item_key ) {
728
			if ( isset( $this->cart_contents[ $item_key ] ) ) {
729
				return $this->cart_contents[ $item_key ];
730
			}
731
732
			return array();
733
		}
734
735
		/**
736
		 * Returns the cart and shipping taxes, merged.
737
		 *
738
		 * @return array merged taxes
739
		 */
740
		public function get_taxes() {
741
			$taxes = array();
742
743
			// Merge
744
			foreach ( array_keys( $this->taxes + $this->shipping_taxes ) as $key ) {
745
				$taxes[ $key ] = ( isset( $this->shipping_taxes[ $key ] ) ? $this->shipping_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
746
			}
747
748
			return apply_filters( 'woocommerce_cart_get_taxes', $taxes, $this );
749
		}
750
751
		/**
752
		 * Get taxes, merged by code, formatted ready for output.
753
		 *
754
		 * @return array
755
		 */
756
		public function get_tax_totals() {
757
			$taxes      = $this->get_taxes();
758
			$tax_totals = array();
759
760
			foreach ( $taxes as $key => $tax ) {
761
				$code = WC_Tax::get_rate_code( $key );
762
763
				if ( $code || $key === apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) ) {
764 View Code Duplication
					if ( ! isset( $tax_totals[ $code ] ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
765
						$tax_totals[ $code ] = new stdClass();
766
						$tax_totals[ $code ]->amount = 0;
767
					}
768
					$tax_totals[ $code ]->tax_rate_id       = $key;
769
					$tax_totals[ $code ]->is_compound       = WC_Tax::is_compound( $key );
770
					$tax_totals[ $code ]->label             = WC_Tax::get_rate_label( $key );
771
					$tax_totals[ $code ]->amount           += wc_round_tax_total( $tax );
772
					$tax_totals[ $code ]->formatted_amount  = wc_price( wc_round_tax_total( $tax_totals[ $code ]->amount ) );
773
				}
774
			}
775
776
			return apply_filters( 'woocommerce_cart_tax_totals', $tax_totals, $this );
777
		}
778
779
		/**
780
		 * Get all tax classes for items in the cart.
781
		 * @return array
782
		 */
783
		public function get_cart_item_tax_classes() {
784
			$found_tax_classes = array();
785
786
			foreach ( WC()->cart->get_cart() as $item ) {
787
				$found_tax_classes[] = $item['data']->get_tax_class();
788
			}
789
790
			return array_unique( $found_tax_classes );
791
		}
792
793
		/**
794
		 * Determines the value that the customer spent and the subtotal
795
		 * displayed, used for things like coupon validation.
796
		 *
797
		 * Since the coupon lines are displayed based on the TAX DISPLAY value
798
		 * of cart, this is used to determine the spend.
799
		 *
800
		 * If cart totals are shown including tax, use the subtotal.
801
		 * If cart totals are shown excluding tax, use the subtotal ex tax
802
		 * (tax is shown after coupons).
803
		 *
804
		 * @since 2.6.0
805
		 * @return string
806
		 */
807
		public function get_displayed_subtotal() {
808
			if ( 'incl' === $this->tax_display_cart ) {
809
				return wc_format_decimal( $this->subtotal );
810
			} elseif ( 'excl' === $this->tax_display_cart ) {
811
				return wc_format_decimal( $this->subtotal_ex_tax );
812
			}
813
		}
814
815
	/*-----------------------------------------------------------------------------------*/
816
	/* Add to cart handling */
817
	/*-----------------------------------------------------------------------------------*/
818
819
		/**
820
		 * Check if product is in the cart and return cart item key.
821
		 *
822
		 * Cart item key will be unique based on the item and its properties, such as variations.
823
		 *
824
		 * @param mixed id of product to find in the cart
825
		 * @return string cart item key
826
		 */
827
		public function find_product_in_cart( $cart_id = false ) {
828
			if ( $cart_id !== false ) {
829
				if ( is_array( $this->cart_contents ) ) {
830
					foreach ( $this->cart_contents as $cart_item_key => $cart_item ) {
831
						if ( $cart_item_key == $cart_id ) {
832
							return $cart_item_key;
833
						}
834
					}
835
				}
836
			}
837
			return '';
838
		}
839
840
		/**
841
		 * Generate a unique ID for the cart item being added.
842
		 *
843
		 * @param int $product_id - id of the product the key is being generated for
844
		 * @param int $variation_id of the product the key is being generated for
845
		 * @param array $variation data for the cart item
846
		 * @param array $cart_item_data other cart item data passed which affects this items uniqueness in the cart
847
		 * @return string cart item key
848
		 */
849
		public function generate_cart_id( $product_id, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
850
			$id_parts = array( $product_id );
851
852
			if ( $variation_id && 0 != $variation_id ) {
853
				$id_parts[] = $variation_id;
854
			}
855
856
			if ( is_array( $variation ) && ! empty( $variation ) ) {
857
				$variation_key = '';
858
				foreach ( $variation as $key => $value ) {
859
					$variation_key .= trim( $key ) . trim( $value );
860
				}
861
				$id_parts[] = $variation_key;
862
			}
863
864
			if ( is_array( $cart_item_data ) && ! empty( $cart_item_data ) ) {
865
				$cart_item_data_key = '';
866
				foreach ( $cart_item_data as $key => $value ) {
867
868
					if ( is_array( $value ) ) {
869
						$value = http_build_query( $value );
870
					}
871
					$cart_item_data_key .= trim( $key ) . trim( $value );
872
873
				}
874
				$id_parts[] = $cart_item_data_key;
875
			}
876
877
			return md5( implode( '_', $id_parts ) );
878
		}
879
880
		/**
881
		 * Add a product to the cart.
882
		 *
883
		 * @param int $product_id contains the id of the product to add to the cart
884
		 * @param int $quantity contains the quantity of the item to add
885
		 * @param int $variation_id
886
		 * @param array $variation attribute values
887
		 * @param array $cart_item_data extra cart item data we want to pass into the item
888
		 * @return string $cart_item_key
889
		 */
890
		public function add_to_cart( $product_id = 0, $quantity = 1, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
891
			// Wrap in try catch so plugins can throw an exception to prevent adding to cart
892
			try {
893
				$product_id   = absint( $product_id );
894
				$variation_id = absint( $variation_id );
895
896
				// Ensure we don't add a variation to the cart directly by variation ID
897
				if ( 'product_variation' == get_post_type( $product_id ) ) {
898
					$variation_id = $product_id;
899
					$product_id   = wp_get_post_parent_id( $variation_id );
900
				}
901
902
				// Get the product
903
				$product_data = wc_get_product( $variation_id ? $variation_id : $product_id );
904
905
				// Sanitity check
906
				if ( $quantity <= 0 || ! $product_data || 'trash' === $product_data->post->post_status  ) {
907
					throw new Exception();
908
				}
909
910
				// Load cart item data - may be added by other plugins
911
				$cart_item_data = (array) apply_filters( 'woocommerce_add_cart_item_data', $cart_item_data, $product_id, $variation_id );
912
913
				// Generate a ID based on product ID, variation ID, variation data, and other cart item data
914
				$cart_id        = $this->generate_cart_id( $product_id, $variation_id, $variation, $cart_item_data );
915
916
				// Find the cart item key in the existing cart
917
				$cart_item_key  = $this->find_product_in_cart( $cart_id );
0 ignored issues
show
Documentation introduced by
$cart_id is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
918
919
				// Force quantity to 1 if sold individually and check for existing item in cart
920
				if ( $product_data->is_sold_individually() ) {
921
					$quantity         = apply_filters( 'woocommerce_add_to_cart_sold_individually_quantity', 1, $quantity, $product_id, $variation_id, $cart_item_data );
922
					$in_cart_quantity = $cart_item_key ? $this->cart_contents[ $cart_item_key ]['quantity'] : 0;
923
924
					if ( $in_cart_quantity > 0 ) {
925
						throw new Exception( sprintf( '<a href="%s" class="button wc-forward">%s</a> %s', wc_get_cart_url(), __( 'View Cart', 'woocommerce' ), sprintf( __( 'You cannot add another &quot;%s&quot; to your cart.', 'woocommerce' ), $product_data->get_title() ) ) );
926
					}
927
				}
928
929
				// Check product is_purchasable
930
				if ( ! $product_data->is_purchasable() ) {
931
					throw new Exception( __( 'Sorry, this product cannot be purchased.', 'woocommerce' ) );
932
				}
933
934
				// Stock check - only check if we're managing stock and backorders are not allowed
935
				if ( ! $product_data->is_in_stock() ) {
936
					throw new Exception( sprintf( __( 'You cannot add &quot;%s&quot; to the cart because the product is out of stock.', 'woocommerce' ), $product_data->get_title() ) );
937
				}
938
939
				if ( ! $product_data->has_enough_stock( $quantity ) ) {
940
					throw new Exception( sprintf(__( 'You cannot add that amount of &quot;%s&quot; to the cart because there is not enough stock (%s remaining).', 'woocommerce' ), $product_data->get_title(), $product_data->get_stock_quantity() ) );
941
				}
942
943
				// Stock check - this time accounting for whats already in-cart
944
				if ( $managing_stock = $product_data->managing_stock() ) {
945
					$products_qty_in_cart = $this->get_cart_item_quantities();
946
947
					if ( $product_data->is_type( 'variation' ) && true === $managing_stock ) {
948
						$check_qty = isset( $products_qty_in_cart[ $variation_id ] ) ? $products_qty_in_cart[ $variation_id ] : 0;
949
					} else {
950
						$check_qty = isset( $products_qty_in_cart[ $product_id ] ) ? $products_qty_in_cart[ $product_id ] : 0;
951
					}
952
953
					/**
954
					 * Check stock based on all items in the cart.
955
					 */
956
					if ( ! $product_data->has_enough_stock( $check_qty + $quantity ) ) {
957
						throw new Exception( sprintf(
958
							'<a href="%s" class="button wc-forward">%s</a> %s',
959
							wc_get_cart_url(),
960
							__( 'View Cart', 'woocommerce' ),
961
							sprintf( __( 'You cannot add that amount to the cart &mdash; we have %s in stock and you already have %s in your cart.', 'woocommerce' ), $product_data->get_stock_quantity(), $check_qty )
962
						) );
963
					}
964
				}
965
966
				// If cart_item_key is set, the item is already in the cart
967
				if ( $cart_item_key ) {
968
					$new_quantity = $quantity + $this->cart_contents[ $cart_item_key ]['quantity'];
969
					$this->set_quantity( $cart_item_key, $new_quantity, false );
970
				} else {
971
					$cart_item_key = $cart_id;
972
973
					// Add item after merging with $cart_item_data - hook to allow plugins to modify cart item
974
					$this->cart_contents[ $cart_item_key ] = apply_filters( 'woocommerce_add_cart_item', array_merge( $cart_item_data, array(
975
						'product_id'	=> $product_id,
976
						'variation_id'	=> $variation_id,
977
						'variation' 	=> $variation,
978
						'quantity' 		=> $quantity,
979
						'data'			=> $product_data
980
					) ), $cart_item_key );
981
				}
982
983
				if ( did_action( 'wp' ) ) {
984
					$this->set_cart_cookies( ! $this->is_empty() );
985
				}
986
987
				do_action( 'woocommerce_add_to_cart', $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data );
988
989
				return $cart_item_key;
990
991
			} catch ( Exception $e ) {
992
				if ( $e->getMessage() ) {
993
					wc_add_notice( $e->getMessage(), 'error' );
994
				}
995
				return false;
996
			}
997
		}
998
999
		/**
1000
		 * Remove a cart item.
1001
		 *
1002
		 * @since  2.3.0
1003
		 * @param  string $cart_item_key
1004
		 * @return bool
1005
		 */
1006
		public function remove_cart_item( $cart_item_key ) {
1007
			if ( isset( $this->cart_contents[ $cart_item_key ] ) ) {
1008
				$this->removed_cart_contents[ $cart_item_key ] = $this->cart_contents[ $cart_item_key ];
1009
				unset( $this->removed_cart_contents[ $cart_item_key ]['data'] );
1010
1011
				do_action( 'woocommerce_remove_cart_item', $cart_item_key, $this );
1012
1013
				unset( $this->cart_contents[ $cart_item_key ] );
1014
1015
				do_action( 'woocommerce_cart_item_removed', $cart_item_key, $this );
1016
1017
				$this->calculate_totals();
1018
1019
				return true;
1020
			}
1021
1022
			return false;
1023
		}
1024
1025
		/**
1026
		 * Restore a cart item.
1027
		 *
1028
		 * @param  string $cart_item_key
1029
		 * @return bool
1030
		 */
1031
		public function restore_cart_item( $cart_item_key ) {
1032
			if ( isset( $this->removed_cart_contents[ $cart_item_key ] ) ) {
1033
				$this->cart_contents[ $cart_item_key ] = $this->removed_cart_contents[ $cart_item_key ];
1034
				$this->cart_contents[ $cart_item_key ]['data'] = wc_get_product( $this->cart_contents[ $cart_item_key ]['variation_id'] ? $this->cart_contents[ $cart_item_key ]['variation_id'] : $this->cart_contents[ $cart_item_key ]['product_id'] );
1035
1036
				do_action( 'woocommerce_restore_cart_item', $cart_item_key, $this );
1037
1038
				unset( $this->removed_cart_contents[ $cart_item_key ] );
1039
1040
				do_action( 'woocommerce_cart_item_restored', $cart_item_key, $this );
1041
1042
				$this->calculate_totals();
1043
1044
				return true;
1045
			}
1046
1047
			return false;
1048
		}
1049
1050
		/**
1051
		 * Set the quantity for an item in the cart.
1052
		 *
1053
		 * @param string	$cart_item_key	contains the id of the cart item
1054
		 * @param int		$quantity		contains the quantity of the item
1055
		 * @param bool      $refresh_totals	whether or not to calculate totals after setting the new qty
1056
		 *
1057
		 * @return bool
1058
		 */
1059
		public function set_quantity( $cart_item_key, $quantity = 1, $refresh_totals = true ) {
1060
			if ( $quantity == 0 || $quantity < 0 ) {
1061
				do_action( 'woocommerce_before_cart_item_quantity_zero', $cart_item_key );
1062
				unset( $this->cart_contents[ $cart_item_key ] );
1063
			} else {
1064
				$old_quantity = $this->cart_contents[ $cart_item_key ]['quantity'];
1065
				$this->cart_contents[ $cart_item_key ]['quantity'] = $quantity;
1066
				do_action( 'woocommerce_after_cart_item_quantity_update', $cart_item_key, $quantity, $old_quantity );
1067
			}
1068
1069
			if ( $refresh_totals ) {
1070
				$this->calculate_totals();
1071
			}
1072
1073
			return true;
1074
		}
1075
1076
	/*-----------------------------------------------------------------------------------*/
1077
	/* Cart Calculation Functions */
1078
	/*-----------------------------------------------------------------------------------*/
1079
1080
		/**
1081
		 * Reset cart totals to the defaults. Useful before running calculations.
1082
		 *
1083
		 * @param  bool  	$unset_session If true, the session data will be forced unset.
1084
		 * @access private
1085
		 */
1086
		private function reset( $unset_session = false ) {
1087
			foreach ( $this->cart_session_data as $key => $default ) {
1088
				$this->$key = $default;
1089
				if ( $unset_session ) {
1090
					unset( WC()->session->$key );
1091
				}
1092
			}
1093
			do_action( 'woocommerce_cart_reset', $this, $unset_session );
1094
		}
1095
1096
		/**
1097
		 * Sort by subtotal.
1098
		 * @param  array $a
1099
		 * @param  array $b
1100
		 * @return int
1101
		 */
1102
		private function sort_by_subtotal( $a, $b ) {
1103
			$first_item_subtotal  = isset( $a['line_subtotal'] ) ? $a['line_subtotal'] : 0;
1104
			$second_item_subtotal = isset( $b['line_subtotal'] ) ? $b['line_subtotal'] : 0;
1105
			if ( $first_item_subtotal === $second_item_subtotal ) {
1106
				return 0;
1107
			}
1108
			return ( $first_item_subtotal < $second_item_subtotal ) ? 1 : -1;
1109
		}
1110
1111
		/**
1112
		 * Calculate totals for the items in the cart.
1113
		 */
1114
		public function calculate_totals() {
1115
			$this->reset();
1116
			$this->coupons = $this->get_coupons();
1117
1118
			do_action( 'woocommerce_before_calculate_totals', $this );
1119
1120
			if ( $this->is_empty() ) {
1121
				$this->set_session();
1122
				return;
1123
			}
1124
1125
			$tax_rates      = array();
1126
			$shop_tax_rates = array();
1127
			$cart           = $this->get_cart();
1128
1129
			/**
1130
			 * Calculate subtotals for items. This is done first so that discount logic can use the values.
1131
			 */
1132
			foreach ( $cart as $cart_item_key => $values ) {
1133
				$_product          = $values['data'];
1134
				$line_price        = $_product->get_price() * $values['quantity'];
1135
				$line_subtotal     = 0;
1136
				$line_subtotal_tax = 0;
1137
1138
				/**
1139
				 * No tax to calculate.
1140
				 */
1141
				if ( ! $_product->is_taxable() ) {
1142
1143
					// Subtotal is the undiscounted price
1144
					$this->subtotal += $line_price;
1145
					$this->subtotal_ex_tax += $line_price;
1146
1147
				/**
1148
				 * Prices include tax.
1149
				 *
1150
				 * To prevent rounding issues we need to work with the inclusive price where possible.
1151
				 * otherwise we'll see errors such as when working with a 9.99 inc price, 20% VAT which would.
1152
				 * be 8.325 leading to totals being 1p off.
1153
				 *
1154
				 * Pre tax coupons come off the price the customer thinks they are paying - tax is calculated.
1155
				 * afterwards.
1156
				 *
1157
				 * e.g. $100 bike with $10 coupon = customer pays $90 and tax worked backwards from that.
1158
				 */
1159
				} elseif ( $this->prices_include_tax ) {
1160
1161
					// Get base tax rates
1162
					if ( empty( $shop_tax_rates[ $_product->tax_class ] ) ) {
1163
						$shop_tax_rates[ $_product->tax_class ] = WC_Tax::get_base_tax_rates( $_product->tax_class );
1164
					}
1165
1166
					// Get item tax rates
1167
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1168
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1169
					}
1170
1171
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1172
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1173
1174
					/**
1175
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1176
					 *
1177
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1178
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1179
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1180
 					 */
1181
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1182
1183
						// Work out a new base price without the shop's base tax
1184
						$taxes                 = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1185
1186
						// Now we have a new item price (excluding TAX)
1187
						$line_subtotal         = $line_price - array_sum( $taxes );
1188
1189
						// Now add modified taxes
1190
						$tax_result            = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1191
						$line_subtotal_tax     = array_sum( $tax_result );
1192
1193
					/**
1194
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1195
					 */
1196
					} else {
1197
1198
						// Calc tax normally
1199
						$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1200
						$line_subtotal_tax     = array_sum( $taxes );
1201
						$line_subtotal         = $line_price - array_sum( $taxes );
1202
					}
1203
1204
				/**
1205
				 * Prices exclude tax.
1206
				 *
1207
				 * This calculation is simpler - work with the base, untaxed price.
1208
				 */
1209
				} else {
1210
1211
					// Get item tax rates
1212
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1213
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1214
					}
1215
1216
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1217
1218
					// Base tax for line before discount - we will store this in the order data
1219
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1220
					$line_subtotal_tax     = array_sum( $taxes );
1221
1222
					$line_subtotal         = $line_price;
1223
				}
1224
1225
				// Add to main subtotal
1226
				$this->subtotal        += $line_subtotal + $line_subtotal_tax;
1227
				$this->subtotal_ex_tax += $line_subtotal;
1228
			}
1229
1230
			// Order cart items by price so coupon logic is 'fair' for customers and not based on order added to cart.
1231
			uasort( $cart, array( $this, 'sort_by_subtotal' ) );
1232
1233
			/**
1234
			 * Calculate totals for items.
1235
			 */
1236
			foreach ( $cart as $cart_item_key => $values ) {
1237
1238
				$_product = $values['data'];
1239
1240
				// Prices
1241
				$base_price = $_product->get_price();
1242
				$line_price = $_product->get_price() * $values['quantity'];
1243
1244
				// Tax data
1245
				$taxes = array();
1246
				$discounted_taxes = array();
1247
1248
				/**
1249
				 * No tax to calculate.
1250
				 */
1251
				if ( ! $_product->is_taxable() ) {
1252
1253
					// Discounted Price (price with any pre-tax discounts applied)
1254
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1255
					$line_subtotal_tax     = 0;
1256
					$line_subtotal         = $line_price;
1257
					$line_tax              = 0;
1258
					$line_total            = WC_Tax::round( $discounted_price * $values['quantity'] );
1259
1260
				/**
1261
				 * Prices include tax.
1262
				 */
1263
				} elseif ( $this->prices_include_tax ) {
1264
1265
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1266
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1267
1268
					/**
1269
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1270
					 *
1271
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1272
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1273
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1274
 					 */
1275
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1276
1277
						// Work out a new base price without the shop's base tax
1278
						$taxes             = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1279
1280
						// Now we have a new item price (excluding TAX)
1281
						$line_subtotal     = round( $line_price - array_sum( $taxes ), WC_ROUNDING_PRECISION );
1282
						$taxes             = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1283
						$line_subtotal_tax = array_sum( $taxes );
1284
1285
						// Adjusted price (this is the price including the new tax rate)
1286
						$adjusted_price    = ( $line_subtotal + $line_subtotal_tax ) / $values['quantity'];
1287
1288
						// Apply discounts
1289
						$discounted_price  = $this->get_discounted_price( $values, $adjusted_price, true );
1290
						$discounted_taxes  = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates, true );
1291
						$line_tax          = array_sum( $discounted_taxes );
1292
						$line_total        = ( $discounted_price * $values['quantity'] ) - $line_tax;
1293
1294
					/**
1295
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1296
					 */
1297
					} else {
1298
1299
						// Work out a new base price without the item tax
1300
						$taxes             = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1301
1302
						// Now we have a new item price (excluding TAX)
1303
						$line_subtotal     = $line_price - array_sum( $taxes );
1304
						$line_subtotal_tax = array_sum( $taxes );
1305
1306
						// Calc prices and tax (discounted)
1307
						$discounted_price = $this->get_discounted_price( $values, $base_price, true );
1308
						$discounted_taxes = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates, true );
1309
						$line_tax         = array_sum( $discounted_taxes );
1310
						$line_total       = ( $discounted_price * $values['quantity'] ) - $line_tax;
1311
					}
1312
1313
					// Tax rows - merge the totals we just got
1314 View Code Duplication
					foreach ( array_keys( $this->taxes + $discounted_taxes ) as $key ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1315
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1316
					}
1317
1318
				/**
1319
				 * Prices exclude tax.
1320
				 */
1321
				} else {
1322
1323
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1324
1325
					// Work out a new base price without the shop's base tax
1326
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1327
1328
					// Now we have the item price (excluding TAX)
1329
					$line_subtotal         = $line_price;
1330
					$line_subtotal_tax     = array_sum( $taxes );
1331
1332
					// Now calc product rates
1333
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1334
					$discounted_taxes      = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates );
1335
					$discounted_tax_amount = array_sum( $discounted_taxes );
1336
					$line_tax              = $discounted_tax_amount;
1337
					$line_total            = $discounted_price * $values['quantity'];
1338
1339
					// Tax rows - merge the totals we just got
1340 View Code Duplication
					foreach ( array_keys( $this->taxes + $discounted_taxes ) as $key ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1341
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1342
					}
1343
				}
1344
1345
				// Cart contents total is based on discounted prices and is used for the final total calculation
1346
				$this->cart_contents_total += $line_total;
1347
1348
				// Store costs + taxes for lines
1349
				$this->cart_contents[ $cart_item_key ]['line_total']        = $line_total;
1350
				$this->cart_contents[ $cart_item_key ]['line_tax']          = $line_tax;
1351
				$this->cart_contents[ $cart_item_key ]['line_subtotal']     = $line_subtotal;
1352
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $line_subtotal_tax;
1353
1354
				// Store rates ID and costs - Since 2.2
1355
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => $discounted_taxes, 'subtotal' => $taxes );
1356
			}
1357
1358
			// Only calculate the grand total + shipping if on the cart/checkout
1359
			if ( is_checkout() || is_cart() || defined('WOOCOMMERCE_CHECKOUT') || defined('WOOCOMMERCE_CART') ) {
1360
1361
				// Calculate the Shipping
1362
				$this->calculate_shipping();
1363
1364
				// Trigger the fees API where developers can add fees to the cart
1365
				$this->calculate_fees();
1366
1367
				// Total up/round taxes and shipping taxes
1368
				if ( $this->round_at_subtotal ) {
1369
					$this->tax_total          = WC_Tax::get_tax_total( $this->taxes );
0 ignored issues
show
Documentation Bug introduced by
It seems like \WC_Tax::get_tax_total($this->taxes) can also be of type integer. However, the property $tax_total is declared as type double. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1370
					$this->shipping_tax_total = WC_Tax::get_tax_total( $this->shipping_taxes );
0 ignored issues
show
Documentation Bug introduced by
It seems like \WC_Tax::get_tax_total($this->shipping_taxes) can also be of type integer. However, the property $shipping_tax_total is declared as type double. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1371
					$this->taxes              = array_map( array( 'WC_Tax', 'round' ), $this->taxes );
1372
					$this->shipping_taxes     = array_map( array( 'WC_Tax', 'round' ), $this->shipping_taxes );
1373
				} else {
1374
					$this->tax_total          = array_sum( $this->taxes );
0 ignored issues
show
Documentation Bug introduced by
It seems like array_sum($this->taxes) can also be of type integer. However, the property $tax_total is declared as type double. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1375
					$this->shipping_tax_total = array_sum( $this->shipping_taxes );
0 ignored issues
show
Documentation Bug introduced by
It seems like array_sum($this->shipping_taxes) can also be of type integer. However, the property $shipping_tax_total is declared as type double. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1376
				}
1377
1378
				// VAT exemption done at this point - so all totals are correct before exemption
1379
				if ( WC()->customer->is_vat_exempt() ) {
1380
					$this->remove_taxes();
1381
				}
1382
1383
				// Allow plugins to hook and alter totals before final total is calculated
1384
				do_action( 'woocommerce_calculate_totals', $this );
1385
1386
				// Grand Total - Discounted product prices, discounted tax, shipping cost + tax
1387
				$this->total = max( 0, apply_filters( 'woocommerce_calculated_total', round( $this->cart_contents_total + $this->tax_total + $this->shipping_tax_total + $this->shipping_total + $this->fee_total, $this->dp ), $this ) );
1388
1389
			} else {
1390
1391
				// Set tax total to sum of all tax rows
1392
				$this->tax_total = WC_Tax::get_tax_total( $this->taxes );
1393
1394
				// VAT exemption done at this point - so all totals are correct before exemption
1395
				if ( WC()->customer->is_vat_exempt() ) {
1396
					$this->remove_taxes();
1397
				}
1398
			}
1399
1400
			do_action( 'woocommerce_after_calculate_totals', $this );
1401
1402
			$this->set_session();
1403
		}
1404
1405
		/**
1406
		 * Remove taxes.
1407
		 */
1408
		public function remove_taxes() {
1409
			$this->shipping_tax_total = $this->tax_total = 0;
0 ignored issues
show
Documentation Bug introduced by
The property $tax_total was declared of type double, but 0 is of type integer. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
Documentation Bug introduced by
The property $shipping_tax_total was declared of type double, but $this->tax_total = 0 is of type integer. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1410
			$this->subtotal           = $this->subtotal_ex_tax;
1411
1412
			foreach ( $this->cart_contents as $cart_item_key => $item ) {
1413
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $this->cart_contents[ $cart_item_key ]['line_tax'] = 0;
1414
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => array(), 'subtotal' => array() );
1415
			}
1416
1417
			// If true, zero rate is applied so '0' tax is displayed on the frontend rather than nothing.
1418
			if ( apply_filters( 'woocommerce_cart_remove_taxes_apply_zero_rate', true ) ) {
1419
				$this->taxes = $this->shipping_taxes = array( apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) => 0 );
1420
			} else {
1421
				$this->taxes = $this->shipping_taxes = array();
1422
			}
1423
		}
1424
1425
		/**
1426
		 * Looks at the totals to see if payment is actually required.
1427
		 *
1428
		 * @return bool
1429
		 */
1430
		public function needs_payment() {
1431
			return apply_filters( 'woocommerce_cart_needs_payment', $this->total > 0, $this );
1432
		}
1433
1434
	/*-----------------------------------------------------------------------------------*/
1435
	/* Shipping related functions */
1436
	/*-----------------------------------------------------------------------------------*/
1437
1438
		/**
1439
		 * Uses the shipping class to calculate shipping then gets the totals when its finished.
1440
		 */
1441
		public function calculate_shipping() {
1442
			if ( $this->needs_shipping() && $this->show_shipping() ) {
1443
				WC()->shipping->calculate_shipping( $this->get_shipping_packages() );
1444
			} else {
1445
				WC()->shipping->reset_shipping();
1446
			}
1447
1448
			// Get totals for the chosen shipping method
1449
			$this->shipping_total 		= WC()->shipping->shipping_total;	// Shipping Total
1450
			$this->shipping_taxes		= WC()->shipping->shipping_taxes;	// Shipping Taxes
1451
		}
1452
1453
		/**
1454
		 * Get packages to calculate shipping for.
1455
		 *
1456
		 * This lets us calculate costs for carts that are shipped to multiple locations.
1457
		 *
1458
		 * Shipping methods are responsible for looping through these packages.
1459
		 *
1460
		 * By default we pass the cart itself as a package - plugins can change this.
1461
		 * through the filter and break it up.
1462
		 *
1463
		 * @since 1.5.4
1464
		 * @return array of cart items
1465
		 */
1466
		public function get_shipping_packages() {
1467
			// Packages array for storing 'carts'
1468
			$packages = array();
1469
1470
			$packages[0]['contents']                 = $this->get_cart();		// Items in the package
1471
			$packages[0]['contents_cost']            = 0;						// Cost of items in the package, set below
1472
			$packages[0]['applied_coupons']          = $this->applied_coupons;
1473
			$packages[0]['user']['ID']               = get_current_user_id();
1474
			$packages[0]['destination']['country']   = WC()->customer->get_shipping_country();
1475
			$packages[0]['destination']['state']     = WC()->customer->get_shipping_state();
1476
			$packages[0]['destination']['postcode']  = WC()->customer->get_shipping_postcode();
1477
			$packages[0]['destination']['city']      = WC()->customer->get_shipping_city();
1478
			$packages[0]['destination']['address']   = WC()->customer->get_shipping_address();
1479
			$packages[0]['destination']['address_2'] = WC()->customer->get_shipping_address_2();
1480
1481
			foreach ( $this->get_cart() as $item ) {
1482
				if ( $item['data']->needs_shipping() ) {
1483
					if ( isset( $item['line_total'] ) ) {
1484
						$packages[0]['contents_cost'] += $item['line_total'];
1485
					}
1486
				}
1487
			}
1488
1489
			return apply_filters( 'woocommerce_cart_shipping_packages', $packages );
1490
		}
1491
1492
		/**
1493
		 * Looks through the cart to see if shipping is actually required.
1494
		 *
1495
		 * @return bool whether or not the cart needs shipping
1496
		 */
1497
		public function needs_shipping() {
1498
			if ( ! wc_shipping_enabled() ) {
1499
				return false;
1500
			}
1501
1502
			$needs_shipping = false;
1503
1504
			if ( $this->cart_contents ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->cart_contents of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1505
				foreach ( $this->cart_contents as $cart_item_key => $values ) {
1506
					$_product = $values['data'];
1507
					if ( $_product->needs_shipping() ) {
1508
						$needs_shipping = true;
1509
					}
1510
				}
1511
			}
1512
1513
			return apply_filters( 'woocommerce_cart_needs_shipping', $needs_shipping );
1514
		}
1515
1516
		/**
1517
		 * Should the shipping address form be shown.
1518
		 *
1519
		 * @return bool
1520
		 */
1521
		function needs_shipping_address() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1522
1523
			$needs_shipping_address = false;
1524
1525
			if ( $this->needs_shipping() === true && ! wc_ship_to_billing_address_only() ) {
1526
				$needs_shipping_address = true;
1527
			}
1528
1529
			return apply_filters( 'woocommerce_cart_needs_shipping_address', $needs_shipping_address );
1530
		}
1531
1532
		/**
1533
		 * Sees if the customer has entered enough data to calc the shipping yet.
1534
		 *
1535
		 * @return bool
1536
		 */
1537
		public function show_shipping() {
1538
			if ( ! wc_shipping_enabled() || ! is_array( $this->cart_contents ) )
1539
				return false;
1540
1541
			if ( 'yes' === get_option( 'woocommerce_shipping_cost_requires_address' ) ) {
1542
				if ( ! WC()->customer->has_calculated_shipping() ) {
1543
					if ( ! WC()->customer->get_shipping_country() || ( ! WC()->customer->get_shipping_state() && ! WC()->customer->get_shipping_postcode() ) ) {
1544
						return false;
1545
					}
1546
				}
1547
			}
1548
1549
			$show_shipping = true;
1550
1551
			return apply_filters( 'woocommerce_cart_ready_to_calc_shipping', $show_shipping );
1552
1553
		}
1554
1555
		/**
1556
		 * Sees if we need a shipping address.
1557
		 *
1558
		 * @deprecated 2.5.0 in favor to wc_ship_to_billing_address_only()
1559
		 *
1560
		 * @return bool
1561
		 */
1562
		public function ship_to_billing_address_only() {
1563
			return wc_ship_to_billing_address_only();
1564
		}
1565
1566
		/**
1567
		 * Gets the shipping total (after calculation).
1568
		 *
1569
		 * @return string price or string for the shipping total
1570
		 */
1571
		public function get_cart_shipping_total() {
1572
			if ( isset( $this->shipping_total ) ) {
1573
				if ( $this->shipping_total > 0 ) {
1574
1575
					// Display varies depending on settings
1576
					if ( $this->tax_display_cart == 'excl' ) {
1577
1578
						$return = wc_price( $this->shipping_total );
1579
1580
						if ( $this->shipping_tax_total > 0 && $this->prices_include_tax ) {
1581
							$return .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
1582
						}
1583
1584
						return $return;
1585
1586
					} else {
1587
1588
						$return = wc_price( $this->shipping_total + $this->shipping_tax_total );
1589
1590
						if ( $this->shipping_tax_total > 0 && ! $this->prices_include_tax ) {
1591
							$return .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
1592
						}
1593
1594
						return $return;
1595
1596
					}
1597
1598
				} else {
1599
					return __( 'Free!', 'woocommerce' );
1600
				}
1601
			}
1602
1603
			return '';
1604
		}
1605
1606
	/*-----------------------------------------------------------------------------------*/
1607
	/* Coupons/Discount related functions */
1608
	/*-----------------------------------------------------------------------------------*/
1609
1610
		/**
1611
		 * Check for user coupons (now that we have billing email). If a coupon is invalid, add an error.
1612
		 *
1613
		 * Checks two types of coupons:
1614
		 *  1. Where a list of customer emails are set (limits coupon usage to those defined).
1615
		 *  2. Where a usage_limit_per_user is set (limits coupon usage to a number based on user ID and email).
1616
		 *
1617
		 * @param array $posted
1618
		 */
1619
		public function check_customer_coupons( $posted ) {
1620
			if ( ! empty( $this->applied_coupons ) ) {
1621
				foreach ( $this->applied_coupons as $code ) {
1622
					$coupon = new WC_Coupon( $code );
1623
1624
					if ( $coupon->is_valid() ) {
1625
1626
						// Limit to defined email addresses
1627
						if ( is_array( $coupon->customer_email ) && sizeof( $coupon->customer_email ) > 0 ) {
1628
							$check_emails           = array();
1629
							$coupon->customer_email = array_map( 'sanitize_email', $coupon->customer_email );
1630
1631
							if ( is_user_logged_in() ) {
1632
								$current_user   = wp_get_current_user();
1633
								$check_emails[] = $current_user->user_email;
1634
							}
1635
							$check_emails[] = $posted['billing_email'];
1636
							$check_emails   = array_map( 'sanitize_email', array_map( 'strtolower', $check_emails ) );
1637
1638
							if ( 0 == sizeof( array_intersect( $check_emails, $coupon->customer_email ) ) ) {
1639
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_NOT_YOURS_REMOVED );
1640
1641
								// Remove the coupon
1642
								$this->remove_coupon( $code );
1643
1644
								// Flag totals for refresh
1645
								WC()->session->set( 'refresh_totals', true );
1646
							}
1647
						}
1648
1649
						// Usage limits per user - check against billing and user email and user ID
1650
						if ( $coupon->usage_limit_per_user > 0 ) {
1651
							$check_emails = array();
1652
							$used_by      = $coupon->get_used_by();
1653
1654
							if ( is_user_logged_in() ) {
1655
								$current_user   = wp_get_current_user();
1656
								$check_emails[] = sanitize_email( $current_user->user_email );
1657
								$usage_count    = sizeof( array_keys( $used_by, get_current_user_id() ) );
1658
							} else {
1659
								$check_emails[] = sanitize_email( $posted['billing_email'] );
1660
								$user           = get_user_by( 'email', $posted['billing_email'] );
1661
								if ( $user ) {
1662
									$usage_count = sizeof( array_keys( $used_by, $user->ID ) );
1663
								} else {
1664
									$usage_count = 0;
1665
								}
1666
							}
1667
1668
							foreach ( $check_emails as $check_email ) {
1669
								$usage_count = $usage_count + sizeof( array_keys( $used_by, $check_email ) );
1670
							}
1671
1672 View Code Duplication
							if ( $usage_count >= $coupon->usage_limit_per_user ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1673
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_USAGE_LIMIT_REACHED );
1674
1675
								// Remove the coupon
1676
								$this->remove_coupon( $code );
1677
1678
								// Flag totals for refresh
1679
								WC()->session->set( 'refresh_totals', true );
1680
							}
1681
						}
1682
					}
1683
				}
1684
			}
1685
		}
1686
1687
		/**
1688
		 * Returns whether or not a discount has been applied.
1689
		 * @param string $coupon_code
1690
		 * @return bool
1691
		 */
1692
		public function has_discount( $coupon_code = '' ) {
1693
			return $coupon_code ? in_array( apply_filters( 'woocommerce_coupon_code', $coupon_code ), $this->applied_coupons ) : sizeof( $this->applied_coupons ) > 0;
1694
		}
1695
1696
		/**
1697
		 * Applies a coupon code passed to the method.
1698
		 *
1699
		 * @param string $coupon_code - The code to apply
1700
		 * @return bool	True if the coupon is applied, false if it does not exist or cannot be applied
1701
		 */
1702
		public function add_discount( $coupon_code ) {
1703
			// Coupons are globally disabled
1704
			if ( ! wc_coupons_enabled() ) {
1705
				return false;
1706
			}
1707
1708
			// Sanitize coupon code
1709
			$coupon_code = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1710
1711
			// Get the coupon
1712
			$the_coupon = new WC_Coupon( $coupon_code );
1713
1714
			// Check it can be used with cart
1715
			if ( ! $the_coupon->is_valid() ) {
1716
				wc_add_notice( $the_coupon->get_error_message(), 'error' );
1717
				return false;
1718
			}
1719
1720
			// Check if applied
1721
			if ( $this->has_discount( $coupon_code ) ) {
1722
				$the_coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED );
1723
				return false;
1724
			}
1725
1726
			// If its individual use then remove other coupons
1727
			if ( $the_coupon->individual_use == 'yes' ) {
1728
				$this->applied_coupons = apply_filters( 'woocommerce_apply_individual_use_coupon', array(), $the_coupon, $this->applied_coupons );
1729
			}
1730
1731
			if ( $this->applied_coupons ) {
1732
				foreach ( $this->applied_coupons as $code ) {
1733
					$coupon = new WC_Coupon( $code );
1734
1735
					if ( $coupon->individual_use == 'yes' && false === apply_filters( 'woocommerce_apply_with_individual_use_coupon', false, $the_coupon, $coupon, $this->applied_coupons ) ) {
1736
1737
						// Reject new coupon
1738
						$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED_INDIV_USE_ONLY );
1739
1740
						return false;
1741
					}
1742
				}
1743
			}
1744
1745
			$this->applied_coupons[] = $coupon_code;
1746
1747
			// Choose free shipping
1748
			if ( $the_coupon->enable_free_shipping() ) {
1749
				$packages = WC()->shipping->get_packages();
1750
				$chosen_shipping_methods = WC()->session->get( 'chosen_shipping_methods' );
1751
1752
				foreach ( $packages as $i => $package ) {
1753
					$chosen_shipping_methods[ $i ] = 'free_shipping';
1754
				}
1755
1756
				WC()->session->set( 'chosen_shipping_methods', $chosen_shipping_methods );
1757
			}
1758
1759
			$the_coupon->add_coupon_message( WC_Coupon::WC_COUPON_SUCCESS );
1760
1761
			do_action( 'woocommerce_applied_coupon', $coupon_code );
1762
1763
			return true;
1764
		}
1765
1766
		/**
1767
		 * Get array of applied coupon objects and codes.
1768
		 * @return array of applied coupons
1769
		 */
1770
		public function get_coupons( $deprecated = null ) {
1771
			$coupons = array();
1772
1773
			if ( 'order' === $deprecated ) {
1774
				return $coupons;
1775
			}
1776
1777
			foreach ( $this->get_applied_coupons() as $code ) {
1778
				$coupon = new WC_Coupon( $code );
1779
				$coupons[ $code ] = $coupon;
1780
			}
1781
1782
			return $coupons;
1783
		}
1784
1785
		/**
1786
		 * Gets the array of applied coupon codes.
1787
		 *
1788
		 * @return array of applied coupons
1789
		 */
1790
		public function get_applied_coupons() {
1791
			return $this->applied_coupons;
1792
		}
1793
1794
		/**
1795
		 * Get the discount amount for a used coupon.
1796
		 * @param  string $code coupon code
1797
		 * @param  bool $ex_tax inc or ex tax
1798
		 * @return float discount amount
1799
		 */
1800
		public function get_coupon_discount_amount( $code, $ex_tax = true ) {
1801
			$discount_amount = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] : 0;
1802
1803
			if ( ! $ex_tax ) {
1804
				$discount_amount += $this->get_coupon_discount_tax_amount( $code );
1805
			}
1806
1807
			return wc_cart_round_discount( $discount_amount, $this->dp );
1808
		}
1809
1810
		/**
1811
		 * Get the discount tax amount for a used coupon (for tax inclusive prices).
1812
		 * @param  string $code coupon code
1813
		 * @param  bool inc or ex tax
1814
		 * @return float discount amount
1815
		 */
1816
		public function get_coupon_discount_tax_amount( $code ) {
1817
			return wc_cart_round_discount( isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] : 0, $this->dp );
1818
		}
1819
1820
		/**
1821
		 * Remove coupons from the cart of a defined type. Type 1 is before tax, type 2 is after tax.
1822
		 */
1823
		public function remove_coupons( $deprecated = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $deprecated is not used and could be removed.

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

Loading history...
1824
			$this->applied_coupons = $this->coupon_discount_amounts = $this->coupon_discount_tax_amounts = $this->coupon_applied_count = array();
1825
			WC()->session->set( 'applied_coupons', array() );
1826
			WC()->session->set( 'coupon_discount_amounts', array() );
1827
			WC()->session->set( 'coupon_discount_tax_amounts', array() );
1828
		}
1829
1830
		/**
1831
		 * Remove a single coupon by code.
1832
		 * @param  string $coupon_code Code of the coupon to remove
1833
		 * @return bool
1834
		 */
1835
		public function remove_coupon( $coupon_code ) {
1836
			// Coupons are globally disabled
1837
			if ( ! wc_coupons_enabled() ) {
1838
				return false;
1839
			}
1840
1841
			// Get the coupon
1842
			$coupon_code  = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1843
			$position     = array_search( $coupon_code, $this->applied_coupons );
1844
1845
			if ( $position !== false ) {
1846
				unset( $this->applied_coupons[ $position ] );
1847
			}
1848
1849
			WC()->session->set( 'applied_coupons', $this->applied_coupons );
1850
1851
			do_action( 'woocommerce_removed_coupon', $coupon_code );
1852
1853
			return true;
1854
		}
1855
1856
		/**
1857
		 * Function to apply discounts to a product and get the discounted price (before tax is applied).
1858
		 *
1859
		 * @param mixed $values
1860
		 * @param mixed $price
1861
		 * @param bool $add_totals (default: false)
1862
		 * @return float price
1863
		 */
1864
		public function get_discounted_price( $values, $price, $add_totals = false ) {
1865
			if ( ! $price ) {
1866
				return $price;
1867
			}
1868
1869
			$undiscounted_price = $price;
1870
1871
			if ( ! empty( $this->coupons ) ) {
1872
				$product = $values['data'];
1873
1874
				foreach ( $this->coupons as $code => $coupon ) {
1875
					if ( $coupon->is_valid() && ( $coupon->is_valid_for_product( $product, $values ) || $coupon->is_valid_for_cart() ) ) {
1876
						$discount_amount = $coupon->get_discount_amount( 'yes' === get_option( 'woocommerce_calc_discounts_sequentially', 'no' ) ? $price : $undiscounted_price, $values, true );
1877
						$discount_amount = min( $price, $discount_amount );
1878
						$price           = max( $price - $discount_amount, 0 );
1879
1880
						// Store the totals for DISPLAY in the cart
1881
						if ( $add_totals ) {
1882
							$total_discount     = $discount_amount * $values['quantity'];
1883
							$total_discount_tax = 0;
1884
1885
							if ( wc_tax_enabled() ) {
1886
								$tax_rates          = WC_Tax::get_rates( $product->get_tax_class() );
1887
								$taxes              = WC_Tax::calc_tax( $discount_amount, $tax_rates, $this->prices_include_tax );
1888
								$total_discount_tax = WC_Tax::get_tax_total( $taxes ) * $values['quantity'];
1889
								$total_discount     = $this->prices_include_tax ? $total_discount - $total_discount_tax : $total_discount;
1890
								$this->discount_cart_tax += $total_discount_tax;
1891
							}
1892
1893
							$this->discount_cart     += $total_discount;
1894
							$this->increase_coupon_discount_amount( $code, $total_discount, $total_discount_tax );
1895
							$this->increase_coupon_applied_count( $code, $values['quantity'] );
1896
						}
1897
					}
1898
1899
					// If the price is 0, we can stop going through coupons because there is nothing more to discount for this product.
1900
					if ( 0 >= $price ) {
1901
						break;
1902
					}
1903
				}
1904
			}
1905
1906
			return apply_filters( 'woocommerce_get_discounted_price', $price, $values, $this );
1907
		}
1908
1909
		/**
1910
		 * Store how much discount each coupon grants.
1911
		 *
1912
		 * @access private
1913
		 * @param string $code
1914
		 * @param double $amount
1915
		 * @param double $tax
1916
		 */
1917
		private function increase_coupon_discount_amount( $code, $amount, $tax ) {
1918
			$this->coupon_discount_amounts[ $code ]     = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] + $amount : $amount;
1919
			$this->coupon_discount_tax_amounts[ $code ] = isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] + $tax : $tax;
1920
		}
1921
1922
		/**
1923
		 * Store how many times each coupon is applied to cart/items.
1924
		 *
1925
		 * @access private
1926
		 * @param string $code
1927
		 * @param int    $count
1928
		 */
1929
		private function increase_coupon_applied_count( $code, $count = 1 ) {
1930
			if ( empty( $this->coupon_applied_count[ $code ] ) ) {
1931
				$this->coupon_applied_count[ $code ] = 0;
1932
			}
1933
			$this->coupon_applied_count[ $code ] += $count;
1934
		}
1935
1936
	/*-----------------------------------------------------------------------------------*/
1937
	/* Fees API to add additional costs to orders */
1938
	/*-----------------------------------------------------------------------------------*/
1939
1940
		/**
1941
		 * Add additional fee to the cart.
1942
		 *
1943
		 * @param string $name Unique name for the fee. Multiple fees of the same name cannot be added.
1944
		 * @param float $amount Fee amount.
1945
		 * @param bool $taxable (default: false) Is the fee taxable?
1946
		 * @param string $tax_class (default: '') The tax class for the fee if taxable. A blank string is standard tax class.
1947
		 */
1948
		public function add_fee( $name, $amount, $taxable = false, $tax_class = '' ) {
1949
1950
			$new_fee_id = sanitize_title( $name );
1951
1952
			// Only add each fee once
1953
			foreach ( $this->fees as $fee ) {
1954
				if ( $fee->id == $new_fee_id ) {
1955
					return;
1956
				}
1957
			}
1958
1959
			$new_fee            = new stdClass();
1960
			$new_fee->id        = $new_fee_id;
1961
			$new_fee->name      = esc_attr( $name );
1962
			$new_fee->amount    = (float) esc_attr( $amount );
1963
			$new_fee->tax_class = $tax_class;
1964
			$new_fee->taxable   = $taxable ? true : false;
1965
			$new_fee->tax       = 0;
1966
			$new_fee->tax_data  = array();
1967
			$this->fees[]       = $new_fee;
1968
		}
1969
1970
		/**
1971
		 * Get fees.
1972
		 *
1973
		 * @return array
1974
		 */
1975
		public function get_fees() {
1976
			return array_filter( (array) $this->fees );
1977
		}
1978
1979
		/**
1980
		 * Calculate fees.
1981
		 */
1982
		public function calculate_fees() {
1983
			// Reset fees before calculation
1984
			$this->fee_total = 0;
0 ignored issues
show
Documentation Bug introduced by
The property $fee_total was declared of type double, but 0 is of type integer. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1985
			$this->fees      = array();
1986
1987
			// Fire an action where developers can add their fees
1988
			do_action( 'woocommerce_cart_calculate_fees', $this );
1989
1990
			// If fees were added, total them and calculate tax
1991
			if ( ! empty( $this->fees ) ) {
1992
				foreach ( $this->fees as $fee_key => $fee ) {
1993
					$this->fee_total += $fee->amount;
1994
1995
					if ( $fee->taxable ) {
1996
						// Get tax rates
1997
						$tax_rates = WC_Tax::get_rates( $fee->tax_class );
1998
						$fee_taxes = WC_Tax::calc_tax( $fee->amount, $tax_rates, false );
1999
2000
						if ( ! empty( $fee_taxes ) ) {
2001
							// Set the tax total for this fee
2002
							$this->fees[ $fee_key ]->tax = array_sum( $fee_taxes );
2003
2004
							// Set tax data - Since 2.2
2005
							$this->fees[ $fee_key ]->tax_data = $fee_taxes;
2006
2007
							// Tax rows - merge the totals we just got
2008 View Code Duplication
							foreach ( array_keys( $this->taxes + $fee_taxes ) as $key ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2009
								$this->taxes[ $key ] = ( isset( $fee_taxes[ $key ] ) ? $fee_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
2010
							}
2011
						}
2012
					}
2013
				}
2014
			}
2015
		}
2016
2017
	/*-----------------------------------------------------------------------------------*/
2018
	/* Get Formatted Totals */
2019
	/*-----------------------------------------------------------------------------------*/
2020
2021
		/**
2022
		 * Gets the order total (after calculation).
2023
		 *
2024
		 * @return string formatted price
2025
		 */
2026
		public function get_total() {
2027
			return apply_filters( 'woocommerce_cart_total', wc_price( $this->total ) );
2028
		}
2029
2030
		/**
2031
		 * Gets the total excluding taxes.
2032
		 *
2033
		 * @return string formatted price
2034
		 */
2035
		public function get_total_ex_tax() {
2036
			$total = $this->total - $this->tax_total - $this->shipping_tax_total;
2037
			if ( $total < 0 ) {
2038
				$total = 0;
2039
			}
2040
			return apply_filters( 'woocommerce_cart_total_ex_tax', wc_price( $total ) );
2041
		}
2042
2043
		/**
2044
		 * Gets the cart contents total (after calculation).
2045
		 *
2046
		 * @return string formatted price
2047
		 */
2048
		public function get_cart_total() {
2049
			if ( ! $this->prices_include_tax ) {
2050
				$cart_contents_total = wc_price( $this->cart_contents_total );
2051
			} else {
2052
				$cart_contents_total = wc_price( $this->cart_contents_total + $this->tax_total );
2053
			}
2054
2055
			return apply_filters( 'woocommerce_cart_contents_total', $cart_contents_total );
2056
		}
2057
2058
		/**
2059
		 * Gets the sub total (after calculation).
2060
		 *
2061
		 * @param bool $compound whether to include compound taxes
2062
		 * @return string formatted price
2063
		 */
2064
		public function get_cart_subtotal( $compound = false ) {
2065
2066
			// If the cart has compound tax, we want to show the subtotal as
2067
			// cart + shipping + non-compound taxes (after discount)
2068
			if ( $compound ) {
2069
2070
				$cart_subtotal = wc_price( $this->cart_contents_total + $this->shipping_total + $this->get_taxes_total( false, false ) );
2071
2072
			// Otherwise we show cart items totals only (before discount)
2073
			} else {
2074
2075
				// Display varies depending on settings
2076
				if ( $this->tax_display_cart == 'excl' ) {
2077
2078
					$cart_subtotal = wc_price( $this->subtotal_ex_tax );
2079
2080
					if ( $this->tax_total > 0 && $this->prices_include_tax ) {
2081
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2082
					}
2083
2084
				} else {
2085
2086
					$cart_subtotal = wc_price( $this->subtotal );
2087
2088
					if ( $this->tax_total > 0 && !$this->prices_include_tax ) {
2089
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2090
					}
2091
2092
				}
2093
			}
2094
2095
			return apply_filters( 'woocommerce_cart_subtotal', $cart_subtotal, $compound, $this );
2096
		}
2097
2098
		/**
2099
		 * Get the product row price per item.
2100
		 *
2101
		 * @param WC_Product $_product
2102
		 * @return string formatted price
2103
		 */
2104
		public function get_product_price( $_product ) {
2105
			if ( $this->tax_display_cart == 'excl' ) {
2106
				$product_price = $_product->get_price_excluding_tax();
2107
			} else {
2108
				$product_price = $_product->get_price_including_tax();
2109
			}
2110
2111
			return apply_filters( 'woocommerce_cart_product_price', wc_price( $product_price ), $_product );
2112
		}
2113
2114
		/**
2115
		 * Get the product row subtotal.
2116
		 *
2117
		 * Gets the tax etc to avoid rounding issues.
2118
		 *
2119
		 * When on the checkout (review order), this will get the subtotal based on the customer's tax rate rather than the base rate.
2120
		 *
2121
		 * @param WC_Product $_product
2122
		 * @param int $quantity
2123
		 * @return string formatted price
2124
		 */
2125
		public function get_product_subtotal( $_product, $quantity ) {
2126
2127
			$price 			= $_product->get_price();
2128
			$taxable 		= $_product->is_taxable();
2129
2130
			// Taxable
2131
			if ( $taxable ) {
2132
2133
				if ( $this->tax_display_cart == 'excl' ) {
2134
2135
					$row_price        = $_product->get_price_excluding_tax( $quantity );
2136
					$product_subtotal = wc_price( $row_price );
2137
2138
					if ( $this->prices_include_tax && $this->tax_total > 0 ) {
2139
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2140
					}
2141
2142
				} else {
2143
2144
					$row_price        = $_product->get_price_including_tax( $quantity );
2145
					$product_subtotal = wc_price( $row_price );
2146
2147
					if ( ! $this->prices_include_tax && $this->tax_total > 0 ) {
2148
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2149
					}
2150
2151
				}
2152
2153
			// Non-taxable
2154
			} else {
2155
2156
				$row_price        = $price * $quantity;
2157
				$product_subtotal = wc_price( $row_price );
2158
2159
			}
2160
2161
			return apply_filters( 'woocommerce_cart_product_subtotal', $product_subtotal, $_product, $quantity, $this );
2162
		}
2163
2164
		/**
2165
		 * Gets the cart tax (after calculation).
2166
		 *
2167
		 * @return string formatted price
2168
		 */
2169
		public function get_cart_tax() {
2170
			$cart_total_tax = wc_round_tax_total( $this->tax_total + $this->shipping_tax_total );
2171
2172
			return apply_filters( 'woocommerce_get_cart_tax', $cart_total_tax ? wc_price( $cart_total_tax ) : '' );
2173
		}
2174
2175
		/**
2176
		 * Get a tax amount.
2177
		 * @param  string $tax_rate_id
2178
		 * @return float amount
2179
		 */
2180
		public function get_tax_amount( $tax_rate_id ) {
2181
			return isset( $this->taxes[ $tax_rate_id ] ) ? $this->taxes[ $tax_rate_id ] : 0;
2182
		}
2183
2184
		/**
2185
		 * Get a tax amount.
2186
		 * @param  string $tax_rate_id
2187
		 * @return float amount
2188
		 */
2189
		public function get_shipping_tax_amount( $tax_rate_id ) {
2190
			return isset( $this->shipping_taxes[ $tax_rate_id ] ) ? $this->shipping_taxes[ $tax_rate_id ] : 0;
2191
		}
2192
2193
		/**
2194
		 * Get tax row amounts with or without compound taxes includes.
2195
		 *
2196
		 * @param  bool $compound True if getting compound taxes
2197
		 * @param  bool $display  True if getting total to display
2198
		 * @return float price
2199
		 */
2200
		public function get_taxes_total( $compound = true, $display = true ) {
2201
			$total = 0;
2202 View Code Duplication
			foreach ( $this->taxes as $key => $tax ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2203
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2204
				$total += $tax;
2205
			}
2206 View Code Duplication
			foreach ( $this->shipping_taxes as $key => $tax ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2207
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2208
				$total += $tax;
2209
			}
2210
			if ( $display ) {
2211
				$total = wc_round_tax_total( $total );
2212
			}
2213
			return apply_filters( 'woocommerce_cart_taxes_total', $total, $compound, $display, $this );
2214
		}
2215
2216
		/**
2217
		 * Get the total of all cart discounts.
2218
		 *
2219
		 * @return float
2220
		 */
2221
		public function get_cart_discount_total() {
2222
			return wc_cart_round_discount( $this->discount_cart, $this->dp );
2223
		}
2224
2225
		/**
2226
		 * Get the total of all cart tax discounts (used for discounts on tax inclusive prices).
2227
		 *
2228
		 * @return float
2229
		 */
2230
		public function get_cart_discount_tax_total() {
2231
			return wc_cart_round_discount( $this->discount_cart_tax, $this->dp );
2232
		}
2233
2234
		/**
2235
		 * Gets the total discount amount - both kinds.
2236
		 *
2237
		 * @return mixed formatted price or false if there are none
2238
		 */
2239
		public function get_total_discount() {
2240
			if ( $this->get_cart_discount_total() ) {
2241
				$total_discount = wc_price( $this->get_cart_discount_total() );
2242
			} else {
2243
				$total_discount = false;
2244
			}
2245
			return apply_filters( 'woocommerce_cart_total_discount', $total_discount, $this );
2246
		}
2247
2248
		/**
2249
		 * Gets the total (product) discount amount - these are applied before tax.
2250
		 *
2251
		 * @deprecated Order discounts (after tax) removed in 2.3 so multiple methods for discounts are no longer required.
2252
		 * @return mixed formatted price or false if there are none
2253
		 */
2254
		public function get_discounts_before_tax() {
2255
			_deprecated_function( 'get_discounts_before_tax', '2.3', 'get_total_discount' );
2256
			if ( $this->get_cart_discount_total() ) {
2257
				$discounts_before_tax = wc_price( $this->get_cart_discount_total() );
2258
			} else {
2259
				$discounts_before_tax = false;
2260
			}
2261
			return apply_filters( 'woocommerce_cart_discounts_before_tax', $discounts_before_tax, $this );
2262
		}
2263
2264
		/**
2265
		 * Get the total of all order discounts (after tax discounts).
2266
		 *
2267
		 * @deprecated Order discounts (after tax) removed in 2.3
2268
		 * @return int
2269
		 */
2270
		public function get_order_discount_total() {
2271
			_deprecated_function( 'get_order_discount_total', '2.3' );
2272
			return 0;
2273
		}
2274
2275
		/**
2276
		 * Function to apply cart discounts after tax.
2277
 		 * @deprecated Coupons can not be applied after tax
2278
		 */
2279
		public function apply_cart_discounts_after_tax( $values, $price ) {
0 ignored issues
show
Unused Code introduced by
The parameter $values is not used and could be removed.

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

Loading history...
Unused Code introduced by
The parameter $price is not used and could be removed.

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

Loading history...
2280
			_deprecated_function( 'apply_cart_discounts_after_tax', '2.3' );
2281
		}
2282
2283
		/**
2284
		 * Function to apply product discounts after tax.
2285
		 * @deprecated Coupons can not be applied after tax
2286
		 */
2287
		public function apply_product_discounts_after_tax( $values, $price ) {
0 ignored issues
show
Unused Code introduced by
The parameter $values is not used and could be removed.

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

Loading history...
Unused Code introduced by
The parameter $price is not used and could be removed.

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

Loading history...
2288
			_deprecated_function( 'apply_product_discounts_after_tax', '2.3' );
2289
		}
2290
2291
		/**
2292
		 * Gets the order discount amount - these are applied after tax.
2293
		 * @deprecated Coupons can not be applied after tax
2294
		 */
2295
		public function get_discounts_after_tax() {
2296
			_deprecated_function( 'get_discounts_after_tax', '2.3' );
2297
		}
2298
}
2299