Completed
Pull Request — master (#11218)
by
unknown
08:57
created

WC_Cart::is_product_in_cart()   B

Complexity

Conditions 5
Paths 4

Size

Total Lines 12
Code Lines 7

Duplication

Lines 9
Ratio 75 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 5
eloc 7
nc 4
nop 1
dl 9
loc 12
rs 8.8571
c 1
b 0
f 0
1
<?php
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' ) : '', $cart_item_key );
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 View Code Duplication
			if ( apply_filters( 'woocommerce_cart_hide_zero_taxes', true ) ) {
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...
777
				$amounts    = array_filter( wp_list_pluck( $tax_totals, 'amount' ) );
778
				$tax_totals = array_intersect_key( $tax_totals, $amounts );
779
			}
780
781
			return apply_filters( 'woocommerce_cart_tax_totals', $tax_totals, $this );
782
		}
783
784
		/**
785
		 * Get all tax classes for items in the cart.
786
		 * @return array
787
		 */
788
		public function get_cart_item_tax_classes() {
789
			$found_tax_classes = array();
790
791
			foreach ( WC()->cart->get_cart() as $item ) {
792
				$found_tax_classes[] = $item['data']->get_tax_class();
793
			}
794
795
			return array_unique( $found_tax_classes );
796
		}
797
798
		/**
799
		 * Determines the value that the customer spent and the subtotal
800
		 * displayed, used for things like coupon validation.
801
		 *
802
		 * Since the coupon lines are displayed based on the TAX DISPLAY value
803
		 * of cart, this is used to determine the spend.
804
		 *
805
		 * If cart totals are shown including tax, use the subtotal.
806
		 * If cart totals are shown excluding tax, use the subtotal ex tax
807
		 * (tax is shown after coupons).
808
		 *
809
		 * @since 2.6.0
810
		 * @return string
811
		 */
812
		public function get_displayed_subtotal() {
813
			if ( 'incl' === $this->tax_display_cart ) {
814
				return wc_format_decimal( $this->subtotal );
815
			} elseif ( 'excl' === $this->tax_display_cart ) {
816
				return wc_format_decimal( $this->subtotal_ex_tax );
817
			}
818
		}
819
820
	/*-----------------------------------------------------------------------------------*/
821
	/* Add to cart handling */
822
	/*-----------------------------------------------------------------------------------*/
823
824
		/**
825
		 * Check if product is in the cart and return cart item key.
826
		 *
827
		 * Cart item key will be unique based on the item and its properties, such as variations.
828
		 *
829
		 * @param mixed id of product to find in the cart
830
		 * @return string cart item key
831
		 */
832
		public function find_product_in_cart( $cart_id = false ) {
833
			if ( $cart_id !== false ) {
834 View Code Duplication
				if ( is_array( $this->cart_contents ) ) {
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...
835
					foreach ( $this->cart_contents as $cart_item_key => $cart_item ) {
836
						if ( $cart_item_key == $cart_id ) {
837
							return $cart_item_key;
838
						}
839
					}
840
				}
841
			}
842
			return '';
843
		}
844
845
		/**
846
		 * Check if product is in the cart based on product ID.
847
		 *
848
		 * @param mixed $product_id - id of product to find in the cart
849
		 * @return bool
850
		 */
851
		public function is_product_in_cart( $product_id = false ) {
852 View Code Duplication
			if ( $product_id !== false ) {
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...
853
				if ( is_array( $this->cart_contents ) ) {
854
					foreach ( $this->cart_contents as $cart_item_key => $cart_item ) {
855
						if ( $product_id === $cart_item['product_id'] ) {
856
							return true;
857
						}
858
					}
859
				}
860
			}
861
			return false;
862
		}
863
864
		/**
865
		 * Generate a unique ID for the cart item being added.
866
		 *
867
		 * @param int $product_id - id of the product the key is being generated for
868
		 * @param int $variation_id of the product the key is being generated for
869
		 * @param array $variation data for the cart item
870
		 * @param array $cart_item_data other cart item data passed which affects this items uniqueness in the cart
871
		 * @return string cart item key
872
		 */
873
		public function generate_cart_id( $product_id, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
874
			$id_parts = array( $product_id );
875
876
			if ( $variation_id && 0 != $variation_id ) {
877
				$id_parts[] = $variation_id;
878
			}
879
880
			if ( is_array( $variation ) && ! empty( $variation ) ) {
881
				$variation_key = '';
882
				foreach ( $variation as $key => $value ) {
883
					$variation_key .= trim( $key ) . trim( $value );
884
				}
885
				$id_parts[] = $variation_key;
886
			}
887
888
			if ( is_array( $cart_item_data ) && ! empty( $cart_item_data ) ) {
889
				$cart_item_data_key = '';
890
				foreach ( $cart_item_data as $key => $value ) {
891
892
					if ( is_array( $value ) ) {
893
						$value = http_build_query( $value );
894
					}
895
					$cart_item_data_key .= trim( $key ) . trim( $value );
896
897
				}
898
				$id_parts[] = $cart_item_data_key;
899
			}
900
901
			return md5( implode( '_', $id_parts ) );
902
		}
903
904
		/**
905
		 * Add a product to the cart.
906
		 *
907
		 * @param int $product_id contains the id of the product to add to the cart
908
		 * @param int $quantity contains the quantity of the item to add
909
		 * @param int $variation_id
910
		 * @param array $variation attribute values
911
		 * @param array $cart_item_data extra cart item data we want to pass into the item
912
		 * @return string|bool $cart_item_key
913
		 */
914
		public function add_to_cart( $product_id = 0, $quantity = 1, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
915
			// Wrap in try catch so plugins can throw an exception to prevent adding to cart
916
			try {
917
				$product_id   = absint( $product_id );
918
				$variation_id = absint( $variation_id );
919
920
				// Ensure we don't add a variation to the cart directly by variation ID
921
				if ( 'product_variation' == get_post_type( $product_id ) ) {
922
					$variation_id = $product_id;
923
					$product_id   = wp_get_post_parent_id( $variation_id );
924
				}
925
926
				// Get the product
927
				$product_data = wc_get_product( $variation_id ? $variation_id : $product_id );
928
929
				// Sanity check
930
				if ( $quantity <= 0 || ! $product_data || 'trash' === $product_data->post->post_status  ) {
931
					throw new Exception();
932
				}
933
934
				// Load cart item data - may be added by other plugins
935
				$cart_item_data = (array) apply_filters( 'woocommerce_add_cart_item_data', $cart_item_data, $product_id, $variation_id );
936
937
				// Generate a ID based on product ID, variation ID, variation data, and other cart item data
938
				$cart_id        = $this->generate_cart_id( $product_id, $variation_id, $variation, $cart_item_data );
939
940
				// Find the cart item key in the existing cart
941
				$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...
942
943
				// Force quantity to 1 if sold individually and check for existing item in cart
944
				if ( $product_data->is_sold_individually() ) {
945
					$quantity         = apply_filters( 'woocommerce_add_to_cart_sold_individually_quantity', 1, $quantity, $product_id, $variation_id, $cart_item_data );
946
					$in_cart_quantity = $cart_item_key ? $this->cart_contents[ $cart_item_key ]['quantity'] : 0;
947
948
					if ( $in_cart_quantity > 0 ) {
949
						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() ) ) );
950
					}
951
				}
952
953
				// Check product is_purchasable
954
				if ( ! $product_data->is_purchasable() ) {
955
					throw new Exception( __( 'Sorry, this product cannot be purchased.', 'woocommerce' ) );
956
				}
957
958
				// Stock check - only check if we're managing stock and backorders are not allowed
959
				if ( ! $product_data->is_in_stock() ) {
960
					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() ) );
961
				}
962
963
				if ( ! $product_data->has_enough_stock( $quantity ) ) {
964
					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() ) );
965
				}
966
967
				// Stock check - this time accounting for whats already in-cart
968
				if ( $managing_stock = $product_data->managing_stock() ) {
969
					$products_qty_in_cart = $this->get_cart_item_quantities();
970
971
					if ( $product_data->is_type( 'variation' ) && true === $managing_stock ) {
972
						$check_qty = isset( $products_qty_in_cart[ $variation_id ] ) ? $products_qty_in_cart[ $variation_id ] : 0;
973
					} else {
974
						$check_qty = isset( $products_qty_in_cart[ $product_id ] ) ? $products_qty_in_cart[ $product_id ] : 0;
975
					}
976
977
					/**
978
					 * Check stock based on all items in the cart.
979
					 */
980
					if ( ! $product_data->has_enough_stock( $check_qty + $quantity ) ) {
981
						throw new Exception( sprintf(
982
							'<a href="%s" class="button wc-forward">%s</a> %s',
983
							wc_get_cart_url(),
984
							__( 'View Cart', 'woocommerce' ),
985
							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 )
986
						) );
987
					}
988
				}
989
990
				// If cart_item_key is set, the item is already in the cart
991
				if ( $cart_item_key ) {
992
					$new_quantity = $quantity + $this->cart_contents[ $cart_item_key ]['quantity'];
993
					$this->set_quantity( $cart_item_key, $new_quantity, false );
994
				} else {
995
					$cart_item_key = $cart_id;
996
997
					// Add item after merging with $cart_item_data - hook to allow plugins to modify cart item
998
					$this->cart_contents[ $cart_item_key ] = apply_filters( 'woocommerce_add_cart_item', array_merge( $cart_item_data, array(
999
						'product_id'	=> $product_id,
1000
						'variation_id'	=> $variation_id,
1001
						'variation' 	=> $variation,
1002
						'quantity' 		=> $quantity,
1003
						'data'			=> $product_data
1004
					) ), $cart_item_key );
1005
				}
1006
1007
				if ( did_action( 'wp' ) ) {
1008
					$this->set_cart_cookies( ! $this->is_empty() );
1009
				}
1010
1011
				do_action( 'woocommerce_add_to_cart', $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data );
1012
1013
				return $cart_item_key;
1014
1015
			} catch ( Exception $e ) {
1016
				if ( $e->getMessage() ) {
1017
					wc_add_notice( $e->getMessage(), 'error' );
1018
				}
1019
				return false;
1020
			}
1021
		}
1022
1023
		/**
1024
		 * Remove a cart item.
1025
		 *
1026
		 * @since  2.3.0
1027
		 * @param  string $cart_item_key
1028
		 * @return bool
1029
		 */
1030
		public function remove_cart_item( $cart_item_key ) {
1031
			if ( isset( $this->cart_contents[ $cart_item_key ] ) ) {
1032
				$this->removed_cart_contents[ $cart_item_key ] = $this->cart_contents[ $cart_item_key ];
1033
				unset( $this->removed_cart_contents[ $cart_item_key ]['data'] );
1034
1035
				do_action( 'woocommerce_remove_cart_item', $cart_item_key, $this );
1036
1037
				unset( $this->cart_contents[ $cart_item_key ] );
1038
1039
				do_action( 'woocommerce_cart_item_removed', $cart_item_key, $this );
1040
1041
				$this->calculate_totals();
1042
1043
				return true;
1044
			}
1045
1046
			return false;
1047
		}
1048
1049
		/**
1050
		 * Restore a cart item.
1051
		 *
1052
		 * @param  string $cart_item_key
1053
		 * @return bool
1054
		 */
1055
		public function restore_cart_item( $cart_item_key ) {
1056
			if ( isset( $this->removed_cart_contents[ $cart_item_key ] ) ) {
1057
				$this->cart_contents[ $cart_item_key ] = $this->removed_cart_contents[ $cart_item_key ];
1058
				$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'] );
1059
1060
				do_action( 'woocommerce_restore_cart_item', $cart_item_key, $this );
1061
1062
				unset( $this->removed_cart_contents[ $cart_item_key ] );
1063
1064
				do_action( 'woocommerce_cart_item_restored', $cart_item_key, $this );
1065
1066
				$this->calculate_totals();
1067
1068
				return true;
1069
			}
1070
1071
			return false;
1072
		}
1073
1074
		/**
1075
		 * Set the quantity for an item in the cart.
1076
		 *
1077
		 * @param string	$cart_item_key	contains the id of the cart item
1078
		 * @param int		$quantity		contains the quantity of the item
1079
		 * @param bool      $refresh_totals	whether or not to calculate totals after setting the new qty
1080
		 *
1081
		 * @return bool
1082
		 */
1083
		public function set_quantity( $cart_item_key, $quantity = 1, $refresh_totals = true ) {
1084
			if ( $quantity == 0 || $quantity < 0 ) {
1085
				do_action( 'woocommerce_before_cart_item_quantity_zero', $cart_item_key );
1086
				unset( $this->cart_contents[ $cart_item_key ] );
1087
			} else {
1088
				$old_quantity = $this->cart_contents[ $cart_item_key ]['quantity'];
1089
				$this->cart_contents[ $cart_item_key ]['quantity'] = $quantity;
1090
				do_action( 'woocommerce_after_cart_item_quantity_update', $cart_item_key, $quantity, $old_quantity );
1091
			}
1092
1093
			if ( $refresh_totals ) {
1094
				$this->calculate_totals();
1095
			}
1096
1097
			return true;
1098
		}
1099
1100
	/*-----------------------------------------------------------------------------------*/
1101
	/* Cart Calculation Functions */
1102
	/*-----------------------------------------------------------------------------------*/
1103
1104
		/**
1105
		 * Reset cart totals to the defaults. Useful before running calculations.
1106
		 *
1107
		 * @param  bool  	$unset_session If true, the session data will be forced unset.
1108
		 * @access private
1109
		 */
1110
		private function reset( $unset_session = false ) {
1111
			foreach ( $this->cart_session_data as $key => $default ) {
1112
				$this->$key = $default;
1113
				if ( $unset_session ) {
1114
					unset( WC()->session->$key );
1115
				}
1116
			}
1117
			do_action( 'woocommerce_cart_reset', $this, $unset_session );
1118
		}
1119
1120
		/**
1121
		 * Sort by subtotal.
1122
		 * @param  array $a
1123
		 * @param  array $b
1124
		 * @return int
1125
		 */
1126
		private function sort_by_subtotal( $a, $b ) {
1127
			$first_item_subtotal  = isset( $a['line_subtotal'] ) ? $a['line_subtotal'] : 0;
1128
			$second_item_subtotal = isset( $b['line_subtotal'] ) ? $b['line_subtotal'] : 0;
1129
			if ( $first_item_subtotal === $second_item_subtotal ) {
1130
				return 0;
1131
			}
1132
			return ( $first_item_subtotal < $second_item_subtotal ) ? 1 : -1;
1133
		}
1134
1135
		/**
1136
		 * Calculate totals for the items in the cart.
1137
		 */
1138
		public function calculate_totals() {
1139
			$this->reset();
1140
			$this->coupons = $this->get_coupons();
1141
1142
			do_action( 'woocommerce_before_calculate_totals', $this );
1143
1144
			if ( $this->is_empty() ) {
1145
				$this->set_session();
1146
				return;
1147
			}
1148
1149
			$tax_rates      = array();
1150
			$shop_tax_rates = array();
1151
			$cart           = $this->get_cart();
1152
1153
			/**
1154
			 * Calculate subtotals for items. This is done first so that discount logic can use the values.
1155
			 */
1156
			foreach ( $cart as $cart_item_key => $values ) {
1157
				$_product          = $values['data'];
1158
				$line_price        = $_product->get_price() * $values['quantity'];
1159
				$line_subtotal     = 0;
1160
				$line_subtotal_tax = 0;
1161
1162
				/**
1163
				 * No tax to calculate.
1164
				 */
1165
				if ( ! $_product->is_taxable() ) {
1166
1167
					// Subtotal is the undiscounted price
1168
					$this->subtotal += $line_price;
1169
					$this->subtotal_ex_tax += $line_price;
1170
1171
				/**
1172
				 * Prices include tax.
1173
				 *
1174
				 * To prevent rounding issues we need to work with the inclusive price where possible.
1175
				 * otherwise we'll see errors such as when working with a 9.99 inc price, 20% VAT which would.
1176
				 * be 8.325 leading to totals being 1p off.
1177
				 *
1178
				 * Pre tax coupons come off the price the customer thinks they are paying - tax is calculated.
1179
				 * afterwards.
1180
				 *
1181
				 * e.g. $100 bike with $10 coupon = customer pays $90 and tax worked backwards from that.
1182
				 */
1183
				} elseif ( $this->prices_include_tax ) {
1184
1185
					// Get base tax rates
1186
					if ( empty( $shop_tax_rates[ $_product->tax_class ] ) ) {
1187
						$shop_tax_rates[ $_product->tax_class ] = WC_Tax::get_base_tax_rates( $_product->tax_class );
1188
					}
1189
1190
					// Get item tax rates
1191
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1192
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1193
					}
1194
1195
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1196
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1197
1198
					/**
1199
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1200
					 *
1201
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1202
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1203
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1204
 					 */
1205
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1206
1207
						// Work out a new base price without the shop's base tax
1208
						$taxes                 = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1209
1210
						// Now we have a new item price (excluding TAX)
1211
						$line_subtotal         = $line_price - array_sum( $taxes );
1212
1213
						// Now add modified taxes
1214
						$tax_result            = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1215
						$line_subtotal_tax     = array_sum( $tax_result );
1216
1217
					/**
1218
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1219
					 */
1220
					} else {
1221
1222
						// Calc tax normally
1223
						$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1224
						$line_subtotal_tax     = array_sum( $taxes );
1225
						$line_subtotal         = $line_price - array_sum( $taxes );
1226
					}
1227
1228
				/**
1229
				 * Prices exclude tax.
1230
				 *
1231
				 * This calculation is simpler - work with the base, untaxed price.
1232
				 */
1233
				} else {
1234
1235
					// Get item tax rates
1236
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1237
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1238
					}
1239
1240
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1241
1242
					// Base tax for line before discount - we will store this in the order data
1243
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1244
					$line_subtotal_tax     = array_sum( $taxes );
1245
1246
					$line_subtotal         = $line_price;
1247
				}
1248
1249
				// Add to main subtotal
1250
				$this->subtotal        += $line_subtotal + $line_subtotal_tax;
1251
				$this->subtotal_ex_tax += $line_subtotal;
1252
			}
1253
1254
			// Order cart items by price so coupon logic is 'fair' for customers and not based on order added to cart.
1255
			uasort( $cart, array( $this, 'sort_by_subtotal' ) );
1256
1257
			/**
1258
			 * Calculate totals for items.
1259
			 */
1260
			foreach ( $cart as $cart_item_key => $values ) {
1261
1262
				$_product = $values['data'];
1263
1264
				// Prices
1265
				$base_price = $_product->get_price();
1266
				$line_price = $_product->get_price() * $values['quantity'];
1267
1268
				// Tax data
1269
				$taxes = array();
1270
				$discounted_taxes = array();
1271
1272
				/**
1273
				 * No tax to calculate.
1274
				 */
1275
				if ( ! $_product->is_taxable() ) {
1276
1277
					// Discounted Price (price with any pre-tax discounts applied)
1278
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1279
					$line_subtotal_tax     = 0;
1280
					$line_subtotal         = $line_price;
1281
					$line_tax              = 0;
1282
					$line_total            = round( $discounted_price * $values['quantity'], WC_ROUNDING_PRECISION );
1283
1284
				/**
1285
				 * Prices include tax.
1286
				 */
1287
				} elseif ( $this->prices_include_tax ) {
1288
1289
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1290
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1291
1292
					/**
1293
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1294
					 *
1295
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1296
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1297
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1298
 					 */
1299
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1300
1301
						// Work out a new base price without the shop's base tax
1302
						$taxes             = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1303
1304
						// Now we have a new item price (excluding TAX)
1305
						$line_subtotal     = round( $line_price - array_sum( $taxes ), WC_ROUNDING_PRECISION );
1306
						$taxes             = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1307
						$line_subtotal_tax = array_sum( $taxes );
1308
1309
						// Adjusted price (this is the price including the new tax rate)
1310
						$adjusted_price    = ( $line_subtotal + $line_subtotal_tax ) / $values['quantity'];
1311
1312
						// Apply discounts and get the discounted price FOR A SINGLE ITEM
1313
						$discounted_price  = $this->get_discounted_price( $values, $adjusted_price, true );
1314
1315
						// Convert back to line price and round nicely
1316
						$discounted_line_price = round( $discounted_price * $values['quantity'], $this->dp );
1317
1318
						// Now use rounded line price to get taxes.
1319
						$discounted_taxes  = WC_Tax::calc_tax( $discounted_line_price, $item_tax_rates, true );
1320
						$line_tax          = array_sum( $discounted_taxes );
1321
						$line_total        = $discounted_line_price - $line_tax;
1322
1323
					/**
1324
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1325
					 */
1326
					} else {
1327
1328
						// Work out a new base price without the item tax
1329
						$taxes             = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1330
1331
						// Now we have a new item price (excluding TAX)
1332
						$line_subtotal     = $line_price - array_sum( $taxes );
1333
						$line_subtotal_tax = array_sum( $taxes );
1334
1335
						// Calc prices and tax (discounted)
1336
						$discounted_price = $this->get_discounted_price( $values, $base_price, true );
1337
1338
						// Convert back to line price and round nicely
1339
						$discounted_line_price = round( $discounted_price * $values['quantity'], $this->dp );
1340
1341
						// Now use rounded line price to get taxes.
1342
						$discounted_taxes  = WC_Tax::calc_tax( $discounted_line_price, $item_tax_rates, true );
1343
						$line_tax          = array_sum( $discounted_taxes );
1344
						$line_total        = $discounted_line_price - $line_tax;
1345
					}
1346
1347
					// Tax rows - merge the totals we just got
1348 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...
1349
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1350
					}
1351
1352
				/**
1353
				 * Prices exclude tax.
1354
				 */
1355
				} else {
1356
1357
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1358
1359
					// Work out a new base price without the shop's base tax
1360
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1361
1362
					// Now we have the item price (excluding TAX)
1363
					$line_subtotal         = $line_price;
1364
					$line_subtotal_tax     = array_sum( $taxes );
1365
1366
					// Now calc product rates
1367
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1368
					$discounted_taxes      = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates );
1369
					$discounted_tax_amount = array_sum( $discounted_taxes );
1370
					$line_tax              = $discounted_tax_amount;
1371
					$line_total            = $discounted_price * $values['quantity'];
1372
1373
					// Tax rows - merge the totals we just got
1374 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...
1375
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1376
					}
1377
				}
1378
1379
				// Cart contents total is based on discounted prices and is used for the final total calculation
1380
				$this->cart_contents_total += $line_total;
1381
1382
				// Store costs + taxes for lines
1383
				$this->cart_contents[ $cart_item_key ]['line_total']        = $line_total;
1384
				$this->cart_contents[ $cart_item_key ]['line_tax']          = $line_tax;
1385
				$this->cart_contents[ $cart_item_key ]['line_subtotal']     = $line_subtotal;
1386
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $line_subtotal_tax;
1387
1388
				// Store rates ID and costs - Since 2.2
1389
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => $discounted_taxes, 'subtotal' => $taxes );
1390
			}
1391
1392
			// Only calculate the grand total + shipping if on the cart/checkout
1393
			if ( is_checkout() || is_cart() || defined('WOOCOMMERCE_CHECKOUT') || defined('WOOCOMMERCE_CART') ) {
1394
1395
				// Calculate the Shipping
1396
				$this->calculate_shipping();
1397
1398
				// Trigger the fees API where developers can add fees to the cart
1399
				$this->calculate_fees();
1400
1401
				// Total up/round taxes and shipping taxes
1402
				if ( $this->round_at_subtotal ) {
1403
					$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...
1404
					$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...
1405
					$this->taxes              = array_map( array( 'WC_Tax', 'round' ), $this->taxes );
1406
					$this->shipping_taxes     = array_map( array( 'WC_Tax', 'round' ), $this->shipping_taxes );
1407
				} else {
1408
					$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...
1409
					$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...
1410
				}
1411
1412
				// VAT exemption done at this point - so all totals are correct before exemption
1413
				if ( WC()->customer->is_vat_exempt() ) {
1414
					$this->remove_taxes();
1415
				}
1416
1417
				// Allow plugins to hook and alter totals before final total is calculated
1418
				do_action( 'woocommerce_calculate_totals', $this );
1419
1420
				// Grand Total - Discounted product prices, discounted tax, shipping cost + tax
1421
				$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 ) );
1422
1423
			} else {
1424
1425
				// Set tax total to sum of all tax rows
1426
				$this->tax_total = WC_Tax::get_tax_total( $this->taxes );
1427
1428
				// VAT exemption done at this point - so all totals are correct before exemption
1429
				if ( WC()->customer->is_vat_exempt() ) {
1430
					$this->remove_taxes();
1431
				}
1432
			}
1433
1434
			do_action( 'woocommerce_after_calculate_totals', $this );
1435
1436
			$this->set_session();
1437
		}
1438
1439
		/**
1440
		 * Remove taxes.
1441
		 */
1442
		public function remove_taxes() {
1443
			$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...
1444
			$this->subtotal           = $this->subtotal_ex_tax;
1445
1446
			foreach ( $this->cart_contents as $cart_item_key => $item ) {
1447
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $this->cart_contents[ $cart_item_key ]['line_tax'] = 0;
1448
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => array(), 'subtotal' => array() );
1449
			}
1450
1451
			// If true, zero rate is applied so '0' tax is displayed on the frontend rather than nothing.
1452
			if ( apply_filters( 'woocommerce_cart_remove_taxes_apply_zero_rate', true ) ) {
1453
				$this->taxes = $this->shipping_taxes = array( apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) => 0 );
1454
			} else {
1455
				$this->taxes = $this->shipping_taxes = array();
1456
			}
1457
		}
1458
1459
		/**
1460
		 * Looks at the totals to see if payment is actually required.
1461
		 *
1462
		 * @return bool
1463
		 */
1464
		public function needs_payment() {
1465
			return apply_filters( 'woocommerce_cart_needs_payment', $this->total > 0, $this );
1466
		}
1467
1468
	/*-----------------------------------------------------------------------------------*/
1469
	/* Shipping related functions */
1470
	/*-----------------------------------------------------------------------------------*/
1471
1472
		/**
1473
		 * Uses the shipping class to calculate shipping then gets the totals when its finished.
1474
		 */
1475
		public function calculate_shipping() {
1476
			if ( $this->needs_shipping() && $this->show_shipping() ) {
1477
				WC()->shipping->calculate_shipping( $this->get_shipping_packages() );
1478
			} else {
1479
				WC()->shipping->reset_shipping();
1480
			}
1481
1482
			// Get totals for the chosen shipping method
1483
			$this->shipping_total 		= WC()->shipping->shipping_total;	// Shipping Total
1484
			$this->shipping_taxes		= WC()->shipping->shipping_taxes;	// Shipping Taxes
1485
		}
1486
1487
		/**
1488
		 * Get packages to calculate shipping for.
1489
		 *
1490
		 * This lets us calculate costs for carts that are shipped to multiple locations.
1491
		 *
1492
		 * Shipping methods are responsible for looping through these packages.
1493
		 *
1494
		 * By default we pass the cart itself as a package - plugins can change this.
1495
		 * through the filter and break it up.
1496
		 *
1497
		 * @since 1.5.4
1498
		 * @return array of cart items
1499
		 */
1500
		public function get_shipping_packages() {
1501
			// Packages array for storing 'carts'
1502
			$packages = array();
1503
1504
			$packages[0]['contents']                 = $this->get_cart();		// Items in the package
1505
			$packages[0]['contents_cost']            = 0;						// Cost of items in the package, set below
1506
			$packages[0]['applied_coupons']          = $this->applied_coupons;
1507
			$packages[0]['user']['ID']               = get_current_user_id();
1508
			$packages[0]['destination']['country']   = WC()->customer->get_shipping_country();
1509
			$packages[0]['destination']['state']     = WC()->customer->get_shipping_state();
1510
			$packages[0]['destination']['postcode']  = WC()->customer->get_shipping_postcode();
1511
			$packages[0]['destination']['city']      = WC()->customer->get_shipping_city();
1512
			$packages[0]['destination']['address']   = WC()->customer->get_shipping_address();
1513
			$packages[0]['destination']['address_2'] = WC()->customer->get_shipping_address_2();
1514
1515
			foreach ( $this->get_cart() as $item ) {
1516
				if ( $item['data']->needs_shipping() ) {
1517
					if ( isset( $item['line_total'] ) ) {
1518
						$packages[0]['contents_cost'] += $item['line_total'];
1519
					}
1520
				}
1521
			}
1522
1523
			return apply_filters( 'woocommerce_cart_shipping_packages', $packages );
1524
		}
1525
1526
		/**
1527
		 * Looks through the cart to see if shipping is actually required.
1528
		 *
1529
		 * @return bool whether or not the cart needs shipping
1530
		 */
1531
		public function needs_shipping() {
1532
			// If shipping is disabled or not yet configured, we can skip this.
1533
			if ( ! wc_shipping_enabled() || 0 === wc_get_shipping_method_count( true ) ) {
1534
				return false;
1535
			}
1536
1537
			$needs_shipping = false;
1538
1539
			if ( ! empty( $this->cart_contents ) ) {
1540
				foreach ( $this->cart_contents as $cart_item_key => $values ) {
1541
					$_product = $values['data'];
1542
					if ( $_product->needs_shipping() ) {
1543
						$needs_shipping = true;
1544
					}
1545
				}
1546
			}
1547
1548
			return apply_filters( 'woocommerce_cart_needs_shipping', $needs_shipping );
1549
		}
1550
1551
		/**
1552
		 * Should the shipping address form be shown.
1553
		 *
1554
		 * @return bool
1555
		 */
1556
		public function needs_shipping_address() {
1557
1558
			$needs_shipping_address = false;
1559
1560
			if ( $this->needs_shipping() === true && ! wc_ship_to_billing_address_only() ) {
1561
				$needs_shipping_address = true;
1562
			}
1563
1564
			return apply_filters( 'woocommerce_cart_needs_shipping_address', $needs_shipping_address );
1565
		}
1566
1567
		/**
1568
		 * Sees if the customer has entered enough data to calc the shipping yet.
1569
		 *
1570
		 * @return bool
1571
		 */
1572
		public function show_shipping() {
1573
			if ( ! wc_shipping_enabled() || ! is_array( $this->cart_contents ) )
1574
				return false;
1575
1576
			if ( 'yes' === get_option( 'woocommerce_shipping_cost_requires_address' ) ) {
1577
				if ( ! WC()->customer->has_calculated_shipping() ) {
1578
					if ( ! WC()->customer->get_shipping_country() || ( ! WC()->customer->get_shipping_state() && ! WC()->customer->get_shipping_postcode() ) ) {
1579
						return false;
1580
					}
1581
				}
1582
			}
1583
1584
			return apply_filters( 'woocommerce_cart_ready_to_calc_shipping', true );
1585
		}
1586
1587
		/**
1588
		 * Sees if we need a shipping address.
1589
		 *
1590
		 * @deprecated 2.5.0 in favor to wc_ship_to_billing_address_only()
1591
		 *
1592
		 * @return bool
1593
		 */
1594
		public function ship_to_billing_address_only() {
1595
			return wc_ship_to_billing_address_only();
1596
		}
1597
1598
		/**
1599
		 * Gets the shipping total (after calculation).
1600
		 *
1601
		 * @return string price or string for the shipping total
1602
		 */
1603
		public function get_cart_shipping_total() {
1604
			if ( isset( $this->shipping_total ) ) {
1605
				if ( $this->shipping_total > 0 ) {
1606
1607
					// Display varies depending on settings
1608
					if ( $this->tax_display_cart == 'excl' ) {
1609
1610
						$return = wc_price( $this->shipping_total );
1611
1612
						if ( $this->shipping_tax_total > 0 && $this->prices_include_tax ) {
1613
							$return .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
1614
						}
1615
1616
						return $return;
1617
1618
					} else {
1619
1620
						$return = wc_price( $this->shipping_total + $this->shipping_tax_total );
1621
1622
						if ( $this->shipping_tax_total > 0 && ! $this->prices_include_tax ) {
1623
							$return .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
1624
						}
1625
1626
						return $return;
1627
1628
					}
1629
1630
				} else {
1631
					return __( 'Free!', 'woocommerce' );
1632
				}
1633
			}
1634
1635
			return '';
1636
		}
1637
1638
	/*-----------------------------------------------------------------------------------*/
1639
	/* Coupons/Discount related functions */
1640
	/*-----------------------------------------------------------------------------------*/
1641
1642
		/**
1643
		 * Check for user coupons (now that we have billing email). If a coupon is invalid, add an error.
1644
		 *
1645
		 * Checks two types of coupons:
1646
		 *  1. Where a list of customer emails are set (limits coupon usage to those defined).
1647
		 *  2. Where a usage_limit_per_user is set (limits coupon usage to a number based on user ID and email).
1648
		 *
1649
		 * @param array $posted
1650
		 */
1651
		public function check_customer_coupons( $posted ) {
1652
			if ( ! empty( $this->applied_coupons ) ) {
1653
				foreach ( $this->applied_coupons as $code ) {
1654
					$coupon = new WC_Coupon( $code );
1655
1656
					if ( $coupon->is_valid() ) {
1657
1658
						// Limit to defined email addresses
1659
						if ( is_array( $coupon->customer_email ) && sizeof( $coupon->customer_email ) > 0 ) {
1660
							$check_emails           = array();
1661
							$coupon->customer_email = array_map( 'sanitize_email', $coupon->customer_email );
1662
1663
							if ( is_user_logged_in() ) {
1664
								$current_user   = wp_get_current_user();
1665
								$check_emails[] = $current_user->user_email;
1666
							}
1667
							$check_emails[] = $posted['billing_email'];
1668
							$check_emails   = array_map( 'sanitize_email', array_map( 'strtolower', $check_emails ) );
1669
1670
							if ( 0 == sizeof( array_intersect( $check_emails, $coupon->customer_email ) ) ) {
1671
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_NOT_YOURS_REMOVED );
1672
1673
								// Remove the coupon
1674
								$this->remove_coupon( $code );
1675
1676
								// Flag totals for refresh
1677
								WC()->session->set( 'refresh_totals', true );
1678
							}
1679
						}
1680
1681
						// Usage limits per user - check against billing and user email and user ID
1682
						if ( $coupon->usage_limit_per_user > 0 ) {
1683
							$check_emails = array();
1684
							$used_by      = $coupon->get_used_by();
1685
1686
							if ( is_user_logged_in() ) {
1687
								$current_user   = wp_get_current_user();
1688
								$check_emails[] = sanitize_email( $current_user->user_email );
1689
								$usage_count    = sizeof( array_keys( $used_by, get_current_user_id() ) );
1690
							} else {
1691
								$check_emails[] = sanitize_email( $posted['billing_email'] );
1692
								$user           = get_user_by( 'email', $posted['billing_email'] );
1693
								if ( $user ) {
1694
									$usage_count = sizeof( array_keys( $used_by, $user->ID ) );
1695
								} else {
1696
									$usage_count = 0;
1697
								}
1698
							}
1699
1700
							foreach ( $check_emails as $check_email ) {
1701
								$usage_count = $usage_count + sizeof( array_keys( $used_by, $check_email ) );
1702
							}
1703
1704 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...
1705
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_USAGE_LIMIT_REACHED );
1706
1707
								// Remove the coupon
1708
								$this->remove_coupon( $code );
1709
1710
								// Flag totals for refresh
1711
								WC()->session->set( 'refresh_totals', true );
1712
							}
1713
						}
1714
					}
1715
				}
1716
			}
1717
		}
1718
1719
		/**
1720
		 * Returns whether or not a discount has been applied.
1721
		 * @param string $coupon_code
1722
		 * @return bool
1723
		 */
1724
		public function has_discount( $coupon_code = '' ) {
1725
			return $coupon_code ? in_array( apply_filters( 'woocommerce_coupon_code', $coupon_code ), $this->applied_coupons ) : sizeof( $this->applied_coupons ) > 0;
1726
		}
1727
1728
		/**
1729
		 * Applies a coupon code passed to the method.
1730
		 *
1731
		 * @param string $coupon_code - The code to apply
1732
		 * @return bool	True if the coupon is applied, false if it does not exist or cannot be applied
1733
		 */
1734
		public function add_discount( $coupon_code ) {
1735
			// Coupons are globally disabled
1736
			if ( ! wc_coupons_enabled() ) {
1737
				return false;
1738
			}
1739
1740
			// Sanitize coupon code
1741
			$coupon_code = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1742
1743
			// Get the coupon
1744
			$the_coupon = new WC_Coupon( $coupon_code );
1745
1746
			// Check it can be used with cart
1747
			if ( ! $the_coupon->is_valid() ) {
1748
				wc_add_notice( $the_coupon->get_error_message(), 'error' );
1749
				return false;
1750
			}
1751
1752
			// Check if applied
1753
			if ( $this->has_discount( $coupon_code ) ) {
1754
				$the_coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED );
1755
				return false;
1756
			}
1757
1758
			// If its individual use then remove other coupons
1759
			if ( $the_coupon->individual_use == 'yes' ) {
1760
				$this->applied_coupons = apply_filters( 'woocommerce_apply_individual_use_coupon', array(), $the_coupon, $this->applied_coupons );
1761
			}
1762
1763
			if ( $this->applied_coupons ) {
1764
				foreach ( $this->applied_coupons as $code ) {
1765
					$coupon = new WC_Coupon( $code );
1766
1767
					if ( $coupon->individual_use == 'yes' && false === apply_filters( 'woocommerce_apply_with_individual_use_coupon', false, $the_coupon, $coupon, $this->applied_coupons ) ) {
1768
1769
						// Reject new coupon
1770
						$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED_INDIV_USE_ONLY );
1771
1772
						return false;
1773
					}
1774
				}
1775
			}
1776
1777
			$this->applied_coupons[] = $coupon_code;
1778
1779
			// Choose free shipping
1780
			if ( $the_coupon->enable_free_shipping() ) {
1781
				$packages = WC()->shipping->get_packages();
1782
				$chosen_shipping_methods = WC()->session->get( 'chosen_shipping_methods' );
1783
1784
				foreach ( $packages as $i => $package ) {
1785
					$chosen_shipping_methods[ $i ] = 'free_shipping';
1786
				}
1787
1788
				WC()->session->set( 'chosen_shipping_methods', $chosen_shipping_methods );
1789
			}
1790
1791
			$the_coupon->add_coupon_message( WC_Coupon::WC_COUPON_SUCCESS );
1792
1793
			do_action( 'woocommerce_applied_coupon', $coupon_code );
1794
1795
			return true;
1796
		}
1797
1798
		/**
1799
		 * Get array of applied coupon objects and codes.
1800
		 * @return array of applied coupons
1801
		 */
1802
		public function get_coupons( $deprecated = null ) {
1803
			$coupons = array();
1804
1805
			if ( 'order' === $deprecated ) {
1806
				return $coupons;
1807
			}
1808
1809
			foreach ( $this->get_applied_coupons() as $code ) {
1810
				$coupon = new WC_Coupon( $code );
1811
				$coupons[ $code ] = $coupon;
1812
			}
1813
1814
			return $coupons;
1815
		}
1816
1817
		/**
1818
		 * Gets the array of applied coupon codes.
1819
		 *
1820
		 * @return array of applied coupons
1821
		 */
1822
		public function get_applied_coupons() {
1823
			return $this->applied_coupons;
1824
		}
1825
1826
		/**
1827
		 * Get the discount amount for a used coupon.
1828
		 * @param  string $code coupon code
1829
		 * @param  bool $ex_tax inc or ex tax
1830
		 * @return float discount amount
1831
		 */
1832
		public function get_coupon_discount_amount( $code, $ex_tax = true ) {
1833
			$discount_amount = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] : 0;
1834
1835
			if ( ! $ex_tax ) {
1836
				$discount_amount += $this->get_coupon_discount_tax_amount( $code );
1837
			}
1838
1839
			return wc_cart_round_discount( $discount_amount, $this->dp );
1840
		}
1841
1842
		/**
1843
		 * Get the discount tax amount for a used coupon (for tax inclusive prices).
1844
		 * @param  string $code coupon code
1845
		 * @param  bool inc or ex tax
1846
		 * @return float discount amount
1847
		 */
1848
		public function get_coupon_discount_tax_amount( $code ) {
1849
			return wc_cart_round_discount( isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] : 0, $this->dp );
1850
		}
1851
1852
		/**
1853
		 * Remove coupons from the cart of a defined type. Type 1 is before tax, type 2 is after tax.
1854
		 */
1855
		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...
1856
			$this->applied_coupons = $this->coupon_discount_amounts = $this->coupon_discount_tax_amounts = $this->coupon_applied_count = array();
1857
			WC()->session->set( 'applied_coupons', array() );
1858
			WC()->session->set( 'coupon_discount_amounts', array() );
1859
			WC()->session->set( 'coupon_discount_tax_amounts', array() );
1860
		}
1861
1862
		/**
1863
		 * Remove a single coupon by code.
1864
		 * @param  string $coupon_code Code of the coupon to remove
1865
		 * @return bool
1866
		 */
1867
		public function remove_coupon( $coupon_code ) {
1868
			// Coupons are globally disabled
1869
			if ( ! wc_coupons_enabled() ) {
1870
				return false;
1871
			}
1872
1873
			// Get the coupon
1874
			$coupon_code  = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1875
			$position     = array_search( $coupon_code, $this->applied_coupons );
1876
1877
			if ( $position !== false ) {
1878
				unset( $this->applied_coupons[ $position ] );
1879
			}
1880
1881
			WC()->session->set( 'applied_coupons', $this->applied_coupons );
1882
1883
			do_action( 'woocommerce_removed_coupon', $coupon_code );
1884
1885
			return true;
1886
		}
1887
1888
		/**
1889
		 * Function to apply discounts to a product and get the discounted price (before tax is applied).
1890
		 *
1891
		 * @param mixed $values
1892
		 * @param mixed $price
1893
		 * @param bool $add_totals (default: false)
1894
		 * @return float price
1895
		 */
1896
		public function get_discounted_price( $values, $price, $add_totals = false ) {
1897
			if ( ! $price ) {
1898
				return $price;
1899
			}
1900
1901
			$undiscounted_price = $price;
1902
1903
			if ( ! empty( $this->coupons ) ) {
1904
				$product = $values['data'];
1905
1906
				foreach ( $this->coupons as $code => $coupon ) {
1907
					if ( $coupon->is_valid() && ( $coupon->is_valid_for_product( $product, $values ) || $coupon->is_valid_for_cart() ) ) {
1908
						$discount_amount = $coupon->get_discount_amount( 'yes' === get_option( 'woocommerce_calc_discounts_sequentially', 'no' ) ? $price : $undiscounted_price, $values, true );
1909
						$discount_amount = min( $price, $discount_amount );
1910
						$price           = max( $price - $discount_amount, 0 );
1911
1912
						// Store the totals for DISPLAY in the cart
1913
						if ( $add_totals ) {
1914
							$total_discount     = $discount_amount * $values['quantity'];
1915
							$total_discount_tax = 0;
1916
1917
							if ( wc_tax_enabled() ) {
1918
								$tax_rates          = WC_Tax::get_rates( $product->get_tax_class() );
1919
								$taxes              = WC_Tax::calc_tax( $discount_amount, $tax_rates, $this->prices_include_tax );
1920
								$total_discount_tax = WC_Tax::get_tax_total( $taxes ) * $values['quantity'];
1921
								$total_discount     = $this->prices_include_tax ? $total_discount - $total_discount_tax : $total_discount;
1922
								$this->discount_cart_tax += $total_discount_tax;
1923
							}
1924
1925
							$this->discount_cart     += $total_discount;
1926
							$this->increase_coupon_discount_amount( $code, $total_discount, $total_discount_tax );
1927
							$this->increase_coupon_applied_count( $code, $values['quantity'] );
1928
						}
1929
					}
1930
1931
					// If the price is 0, we can stop going through coupons because there is nothing more to discount for this product.
1932
					if ( 0 >= $price ) {
1933
						break;
1934
					}
1935
				}
1936
			}
1937
1938
			return apply_filters( 'woocommerce_get_discounted_price', $price, $values, $this );
1939
		}
1940
1941
		/**
1942
		 * Store how much discount each coupon grants.
1943
		 *
1944
		 * @access private
1945
		 * @param string $code
1946
		 * @param double $amount
1947
		 * @param double $tax
1948
		 */
1949
		private function increase_coupon_discount_amount( $code, $amount, $tax ) {
1950
			$this->coupon_discount_amounts[ $code ]     = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] + $amount : $amount;
1951
			$this->coupon_discount_tax_amounts[ $code ] = isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] + $tax : $tax;
1952
		}
1953
1954
		/**
1955
		 * Store how many times each coupon is applied to cart/items.
1956
		 *
1957
		 * @access private
1958
		 * @param string $code
1959
		 * @param int    $count
1960
		 */
1961
		private function increase_coupon_applied_count( $code, $count = 1 ) {
1962
			if ( empty( $this->coupon_applied_count[ $code ] ) ) {
1963
				$this->coupon_applied_count[ $code ] = 0;
1964
			}
1965
			$this->coupon_applied_count[ $code ] += $count;
1966
		}
1967
1968
	/*-----------------------------------------------------------------------------------*/
1969
	/* Fees API to add additional costs to orders */
1970
	/*-----------------------------------------------------------------------------------*/
1971
1972
		/**
1973
		 * Add additional fee to the cart.
1974
		 *
1975
		 * @param string $name Unique name for the fee. Multiple fees of the same name cannot be added.
1976
		 * @param float $amount Fee amount.
1977
		 * @param bool $taxable (default: false) Is the fee taxable?
1978
		 * @param string $tax_class (default: '') The tax class for the fee if taxable. A blank string is standard tax class.
1979
		 */
1980
		public function add_fee( $name, $amount, $taxable = false, $tax_class = '' ) {
1981
1982
			$new_fee_id = sanitize_title( $name );
1983
1984
			// Only add each fee once
1985
			foreach ( $this->fees as $fee ) {
1986
				if ( $fee->id == $new_fee_id ) {
1987
					return;
1988
				}
1989
			}
1990
1991
			$new_fee            = new stdClass();
1992
			$new_fee->id        = $new_fee_id;
1993
			$new_fee->name      = esc_attr( $name );
1994
			$new_fee->amount    = (float) esc_attr( $amount );
1995
			$new_fee->tax_class = $tax_class;
1996
			$new_fee->taxable   = $taxable ? true : false;
1997
			$new_fee->tax       = 0;
1998
			$new_fee->tax_data  = array();
1999
			$this->fees[]       = $new_fee;
2000
		}
2001
2002
		/**
2003
		 * Get fees.
2004
		 *
2005
		 * @return array
2006
		 */
2007
		public function get_fees() {
2008
			return array_filter( (array) $this->fees );
2009
		}
2010
2011
		/**
2012
		 * Calculate fees.
2013
		 */
2014
		public function calculate_fees() {
2015
			// Reset fees before calculation
2016
			$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...
2017
			$this->fees      = array();
2018
2019
			// Fire an action where developers can add their fees
2020
			do_action( 'woocommerce_cart_calculate_fees', $this );
2021
2022
			// If fees were added, total them and calculate tax
2023
			if ( ! empty( $this->fees ) ) {
2024
				foreach ( $this->fees as $fee_key => $fee ) {
2025
					$this->fee_total += $fee->amount;
2026
2027
					if ( $fee->taxable ) {
2028
						// Get tax rates
2029
						$tax_rates = WC_Tax::get_rates( $fee->tax_class );
2030
						$fee_taxes = WC_Tax::calc_tax( $fee->amount, $tax_rates, false );
2031
2032
						if ( ! empty( $fee_taxes ) ) {
2033
							// Set the tax total for this fee
2034
							$this->fees[ $fee_key ]->tax = array_sum( $fee_taxes );
2035
2036
							// Set tax data - Since 2.2
2037
							$this->fees[ $fee_key ]->tax_data = $fee_taxes;
2038
2039
							// Tax rows - merge the totals we just got
2040 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...
2041
								$this->taxes[ $key ] = ( isset( $fee_taxes[ $key ] ) ? $fee_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
2042
							}
2043
						}
2044
					}
2045
				}
2046
			}
2047
		}
2048
2049
	/*-----------------------------------------------------------------------------------*/
2050
	/* Get Formatted Totals */
2051
	/*-----------------------------------------------------------------------------------*/
2052
2053
		/**
2054
		 * Gets the order total (after calculation).
2055
		 *
2056
		 * @return string formatted price
2057
		 */
2058
		public function get_total() {
2059
			return apply_filters( 'woocommerce_cart_total', wc_price( $this->total ) );
2060
		}
2061
2062
		/**
2063
		 * Gets the total excluding taxes.
2064
		 *
2065
		 * @return string formatted price
2066
		 */
2067
		public function get_total_ex_tax() {
2068
			$total = $this->total - $this->tax_total - $this->shipping_tax_total;
2069
			if ( $total < 0 ) {
2070
				$total = 0;
2071
			}
2072
			return apply_filters( 'woocommerce_cart_total_ex_tax', wc_price( $total ) );
2073
		}
2074
2075
		/**
2076
		 * Gets the cart contents total (after calculation).
2077
		 *
2078
		 * @return string formatted price
2079
		 */
2080
		public function get_cart_total() {
2081
			if ( ! $this->prices_include_tax ) {
2082
				$cart_contents_total = wc_price( $this->cart_contents_total );
2083
			} else {
2084
				$cart_contents_total = wc_price( $this->cart_contents_total + $this->tax_total );
2085
			}
2086
2087
			return apply_filters( 'woocommerce_cart_contents_total', $cart_contents_total );
2088
		}
2089
2090
		/**
2091
		 * Gets the sub total (after calculation).
2092
		 *
2093
		 * @param bool $compound whether to include compound taxes
2094
		 * @return string formatted price
2095
		 */
2096
		public function get_cart_subtotal( $compound = false ) {
2097
2098
			// If the cart has compound tax, we want to show the subtotal as
2099
			// cart + shipping + non-compound taxes (after discount)
2100
			if ( $compound ) {
2101
2102
				$cart_subtotal = wc_price( $this->cart_contents_total + $this->shipping_total + $this->get_taxes_total( false, false ) );
2103
2104
			// Otherwise we show cart items totals only (before discount)
2105
			} else {
2106
2107
				// Display varies depending on settings
2108
				if ( $this->tax_display_cart == 'excl' ) {
2109
2110
					$cart_subtotal = wc_price( $this->subtotal_ex_tax );
2111
2112
					if ( $this->tax_total > 0 && $this->prices_include_tax ) {
2113
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2114
					}
2115
2116
				} else {
2117
2118
					$cart_subtotal = wc_price( $this->subtotal );
2119
2120
					if ( $this->tax_total > 0 && !$this->prices_include_tax ) {
2121
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2122
					}
2123
2124
				}
2125
			}
2126
2127
			return apply_filters( 'woocommerce_cart_subtotal', $cart_subtotal, $compound, $this );
2128
		}
2129
2130
		/**
2131
		 * Get the product row price per item.
2132
		 *
2133
		 * @param WC_Product $_product
2134
		 * @return string formatted price
2135
		 */
2136
		public function get_product_price( $_product ) {
2137
			if ( $this->tax_display_cart == 'excl' ) {
2138
				$product_price = $_product->get_price_excluding_tax();
2139
			} else {
2140
				$product_price = $_product->get_price_including_tax();
2141
			}
2142
2143
			return apply_filters( 'woocommerce_cart_product_price', wc_price( $product_price ), $_product );
2144
		}
2145
2146
		/**
2147
		 * Get the product row subtotal.
2148
		 *
2149
		 * Gets the tax etc to avoid rounding issues.
2150
		 *
2151
		 * When on the checkout (review order), this will get the subtotal based on the customer's tax rate rather than the base rate.
2152
		 *
2153
		 * @param WC_Product $_product
2154
		 * @param int $quantity
2155
		 * @return string formatted price
2156
		 */
2157
		public function get_product_subtotal( $_product, $quantity ) {
2158
2159
			$price 			= $_product->get_price();
2160
			$taxable 		= $_product->is_taxable();
2161
2162
			// Taxable
2163
			if ( $taxable ) {
2164
2165
				if ( $this->tax_display_cart == 'excl' ) {
2166
2167
					$row_price        = $_product->get_price_excluding_tax( $quantity );
2168
					$product_subtotal = wc_price( $row_price );
2169
2170
					if ( $this->prices_include_tax && $this->tax_total > 0 ) {
2171
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2172
					}
2173
2174
				} else {
2175
2176
					$row_price        = $_product->get_price_including_tax( $quantity );
2177
					$product_subtotal = wc_price( $row_price );
2178
2179
					if ( ! $this->prices_include_tax && $this->tax_total > 0 ) {
2180
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2181
					}
2182
2183
				}
2184
2185
			// Non-taxable
2186
			} else {
2187
2188
				$row_price        = $price * $quantity;
2189
				$product_subtotal = wc_price( $row_price );
2190
2191
			}
2192
2193
			return apply_filters( 'woocommerce_cart_product_subtotal', $product_subtotal, $_product, $quantity, $this );
2194
		}
2195
2196
		/**
2197
		 * Gets the cart tax (after calculation).
2198
		 *
2199
		 * @return string formatted price
2200
		 */
2201
		public function get_cart_tax() {
2202
			$cart_total_tax = wc_round_tax_total( $this->tax_total + $this->shipping_tax_total );
2203
2204
			return apply_filters( 'woocommerce_get_cart_tax', $cart_total_tax ? wc_price( $cart_total_tax ) : '' );
2205
		}
2206
2207
		/**
2208
		 * Get a tax amount.
2209
		 * @param  string $tax_rate_id
2210
		 * @return float amount
2211
		 */
2212
		public function get_tax_amount( $tax_rate_id ) {
2213
			return isset( $this->taxes[ $tax_rate_id ] ) ? $this->taxes[ $tax_rate_id ] : 0;
2214
		}
2215
2216
		/**
2217
		 * Get a tax amount.
2218
		 * @param  string $tax_rate_id
2219
		 * @return float amount
2220
		 */
2221
		public function get_shipping_tax_amount( $tax_rate_id ) {
2222
			return isset( $this->shipping_taxes[ $tax_rate_id ] ) ? $this->shipping_taxes[ $tax_rate_id ] : 0;
2223
		}
2224
2225
		/**
2226
		 * Get tax row amounts with or without compound taxes includes.
2227
		 *
2228
		 * @param  bool $compound True if getting compound taxes
2229
		 * @param  bool $display  True if getting total to display
2230
		 * @return float price
2231
		 */
2232
		public function get_taxes_total( $compound = true, $display = true ) {
2233
			$total = 0;
2234 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...
2235
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2236
				$total += $tax;
2237
			}
2238 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...
2239
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2240
				$total += $tax;
2241
			}
2242
			if ( $display ) {
2243
				$total = wc_round_tax_total( $total );
2244
			}
2245
			return apply_filters( 'woocommerce_cart_taxes_total', $total, $compound, $display, $this );
2246
		}
2247
2248
		/**
2249
		 * Get the total of all cart discounts.
2250
		 *
2251
		 * @return float
2252
		 */
2253
		public function get_cart_discount_total() {
2254
			return wc_cart_round_discount( $this->discount_cart, $this->dp );
2255
		}
2256
2257
		/**
2258
		 * Get the total of all cart tax discounts (used for discounts on tax inclusive prices).
2259
		 *
2260
		 * @return float
2261
		 */
2262
		public function get_cart_discount_tax_total() {
2263
			return wc_cart_round_discount( $this->discount_cart_tax, $this->dp );
2264
		}
2265
2266
		/**
2267
		 * Gets the total discount amount - both kinds.
2268
		 *
2269
		 * @return mixed formatted price or false if there are none
2270
		 */
2271
		public function get_total_discount() {
2272
			if ( $this->get_cart_discount_total() ) {
2273
				$total_discount = wc_price( $this->get_cart_discount_total() );
2274
			} else {
2275
				$total_discount = false;
2276
			}
2277
			return apply_filters( 'woocommerce_cart_total_discount', $total_discount, $this );
2278
		}
2279
2280
		/**
2281
		 * Gets the total (product) discount amount - these are applied before tax.
2282
		 *
2283
		 * @deprecated Order discounts (after tax) removed in 2.3 so multiple methods for discounts are no longer required.
2284
		 * @return mixed formatted price or false if there are none
2285
		 */
2286
		public function get_discounts_before_tax() {
2287
			_deprecated_function( 'get_discounts_before_tax', '2.3', 'get_total_discount' );
2288
			if ( $this->get_cart_discount_total() ) {
2289
				$discounts_before_tax = wc_price( $this->get_cart_discount_total() );
2290
			} else {
2291
				$discounts_before_tax = false;
2292
			}
2293
			return apply_filters( 'woocommerce_cart_discounts_before_tax', $discounts_before_tax, $this );
2294
		}
2295
2296
		/**
2297
		 * Get the total of all order discounts (after tax discounts).
2298
		 *
2299
		 * @deprecated Order discounts (after tax) removed in 2.3
2300
		 * @return int
2301
		 */
2302
		public function get_order_discount_total() {
2303
			_deprecated_function( 'get_order_discount_total', '2.3' );
2304
			return 0;
2305
		}
2306
2307
		/**
2308
		 * Function to apply cart discounts after tax.
2309
 		 * @deprecated Coupons can not be applied after tax
2310
		 */
2311
		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...
2312
			_deprecated_function( 'apply_cart_discounts_after_tax', '2.3' );
2313
		}
2314
2315
		/**
2316
		 * Function to apply product discounts after tax.
2317
		 * @deprecated Coupons can not be applied after tax
2318
		 */
2319
		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...
2320
			_deprecated_function( 'apply_product_discounts_after_tax', '2.3' );
2321
		}
2322
2323
		/**
2324
		 * Gets the order discount amount - these are applied after tax.
2325
		 * @deprecated Coupons can not be applied after tax
2326
		 */
2327
		public function get_discounts_after_tax() {
2328
			_deprecated_function( 'get_discounts_after_tax', '2.3' );
2329
		}
2330
}
2331