Completed
Pull Request — master (#10315)
by Mike
08:27
created

WC_Cart::get_cross_sells()   A

Complexity

Conditions 4
Paths 2

Size

Total Lines 14
Code Lines 10

Duplication

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
410
					// Error message
411
					$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_INVALID_REMOVED );
412
413
					// Remove the coupon
414
					$this->remove_coupon( $code );
415
416
					// Flag totals for refresh
417
					WC()->session->set( 'refresh_totals', true );
418
				}
419
			}
420
		}
421
422
		/**
423
		 * Get cart items quantities - merged so we can do accurate stock checks on items across multiple lines.
424
		 *
425
		 * @return array
426
		 */
427
		public function get_cart_item_quantities() {
428
			$quantities = array();
429
430
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
431
				$_product = $values['data'];
432
433
				if ( $_product->is_type( 'variation' ) && true === $_product->managing_stock() ) {
434
					// Variation has stock levels defined so its handled individually
435
					$quantities[ $values['variation_id'] ] = isset( $quantities[ $values['variation_id'] ] ) ? $quantities[ $values['variation_id'] ] + $values['quantity'] : $values['quantity'];
436
				} else {
437
					$quantities[ $values['product_id'] ] = isset( $quantities[ $values['product_id'] ] ) ? $quantities[ $values['product_id'] ] + $values['quantity'] : $values['quantity'];
438
				}
439
			}
440
441
			return $quantities;
442
		}
443
444
		/**
445
		 * Looks through cart items and checks the posts are not trashed or deleted.
446
		 *
447
		 * @return bool|WP_Error
448
		 */
449
		public function check_cart_item_validity() {
450
			$return = true;
451
452
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
453
				$_product = $values['data'];
454
455
				if ( ! $_product || ! $_product->exists() || 'trash' === $_product->post->post_status ) {
456
					$this->set_quantity( $cart_item_key, 0 );
457
					$return = new WP_Error( 'invalid', __( 'An item which is no longer available was removed from your cart.', 'woocommerce' ) );
458
				}
459
			}
460
461
			return $return;
462
		}
463
464
		/**
465
		 * Looks through the cart to check each item is in stock. If not, add an error.
466
		 *
467
		 * @return bool|WP_Error
468
		 */
469
		public function check_cart_item_stock() {
470
			global $wpdb;
471
472
			$error               = new WP_Error();
473
			$product_qty_in_cart = $this->get_cart_item_quantities();
474
475
			// First stock check loop
476
			foreach ( $this->get_cart() as $cart_item_key => $values ) {
477
				$_product = $values['data'];
478
479
				/**
480
				 * Check stock based on stock-status.
481
				 */
482
				if ( ! $_product->is_in_stock() ) {
483
					$error->add( 'out-of-stock', sprintf(__( 'Sorry, "%s" is not in stock. Please edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title() ) );
484
					return $error;
485
				}
486
487
				if ( ! $_product->managing_stock() ) {
488
					continue;
489
				}
490
491
				$check_qty = $_product->is_type( 'variation' ) && true === $_product->managing_stock() ? $product_qty_in_cart[ $values['variation_id'] ] : $product_qty_in_cart[ $values['product_id'] ];
492
493
				/**
494
				 * Check stock based on all items in the cart.
495
				 */
496
				if ( ! $_product->has_enough_stock( $check_qty ) ) {
497
					$error->add( 'out-of-stock', sprintf(__( 'Sorry, we do not have enough "%s" in stock to fulfill your order (%s in stock). Please edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title(), $_product->get_stock_quantity() ) );
498
					return $error;
499
				}
500
501
				/**
502
				 * Finally consider any held stock, from pending orders.
503
				 */
504
				if ( get_option( 'woocommerce_hold_stock_minutes' ) > 0 && ! $_product->backorders_allowed() ) {
505
					$order_id   = isset( WC()->session->order_awaiting_payment ) ? absint( WC()->session->order_awaiting_payment ) : 0;
506
					$held_stock = $wpdb->get_var(
507
						$wpdb->prepare( "
508
							SELECT SUM( order_item_meta.meta_value ) AS held_qty
509
							FROM {$wpdb->posts} AS posts
510
							LEFT JOIN {$wpdb->prefix}woocommerce_order_items as order_items ON posts.ID = order_items.order_id
511
							LEFT JOIN {$wpdb->prefix}woocommerce_order_itemmeta as order_item_meta ON order_items.order_item_id = order_item_meta.order_item_id
512
							LEFT JOIN {$wpdb->prefix}woocommerce_order_itemmeta as order_item_meta2 ON order_items.order_item_id = order_item_meta2.order_item_id
513
							WHERE 	order_item_meta.meta_key   = '_qty'
514
							AND 	order_item_meta2.meta_key  = %s AND order_item_meta2.meta_value  = %d
515
							AND 	posts.post_type            IN ( '" . implode( "','", wc_get_order_types() ) . "' )
516
							AND 	posts.post_status          = 'wc-pending'
517
							AND		posts.ID                   != %d;",
518
							$_product->is_type( 'variation' ) && true === $_product->managing_stock() ? '_variation_id' : '_product_id',
519
							$_product->is_type( 'variation' ) && true === $_product->managing_stock() ? $values['variation_id'] : $values['product_id'],
520
							$order_id
521
						)
522
					);
523
524
					$not_enough_stock = false;
525
526
					if ( $_product->is_type( 'variation' ) && 'parent' === $_product->managing_stock() && $_product->parent->get_stock_quantity() < ( $held_stock + $check_qty ) ) {
527
						$not_enough_stock = true;
528
					} elseif ( $_product->get_stock_quantity() < ( $held_stock + $check_qty ) ) {
529
						$not_enough_stock = true;
530
					}
531
					if ( $not_enough_stock ) {
532
						$error->add( 'out-of-stock', sprintf(__( 'Sorry, we do not have enough "%s" in stock to fulfill your order right now. Please try again in %d minutes or edit your cart and try again. We apologise for any inconvenience caused.', 'woocommerce' ), $_product->get_title(), get_option( 'woocommerce_hold_stock_minutes' ) ) );
533
						return $error;
534
					}
535
				}
536
			}
537
538
			return true;
539
		}
540
541
		/**
542
		 * Gets and formats a list of cart item data + variations for display on the frontend.
543
		 *
544
		 * @param array $cart_item
545
		 * @param bool $flat (default: false)
546
		 * @return string
547
		 */
548
		public function get_item_data( $cart_item, $flat = false ) {
549
			$item_data = array();
550
551
			// Variation data
552
			if ( ! empty( $cart_item['data']->variation_id ) && is_array( $cart_item['variation'] ) ) {
553
554
				foreach ( $cart_item['variation'] as $name => $value ) {
555
556
					if ( '' === $value )
557
						continue;
558
559
					$taxonomy = wc_attribute_taxonomy_name( str_replace( 'attribute_pa_', '', urldecode( $name ) ) );
560
561
					// If this is a term slug, get the term's nice name
562
					if ( taxonomy_exists( $taxonomy ) ) {
563
						$term = get_term_by( 'slug', $value, $taxonomy );
564
						if ( ! is_wp_error( $term ) && $term && $term->name ) {
565
							$value = $term->name;
566
						}
567
						$label = wc_attribute_label( $taxonomy );
568
569
					// If this is a custom option slug, get the options name
570
					} else {
571
						$value              = apply_filters( 'woocommerce_variation_option_name', $value );
572
						$product_attributes = $cart_item['data']->get_attributes();
573
						if ( isset( $product_attributes[ str_replace( 'attribute_', '', $name ) ] ) ) {
574
							$label = wc_attribute_label( $product_attributes[ str_replace( 'attribute_', '', $name ) ]['name'] );
575
						} else {
576
							$label = $name;
577
						}
578
					}
579
580
					$item_data[] = array(
581
						'key'   => $label,
582
						'value' => $value
583
					);
584
				}
585
			}
586
587
			// Filter item data to allow 3rd parties to add more to the array
588
			$item_data = apply_filters( 'woocommerce_get_item_data', $item_data, $cart_item );
589
590
			// Format item data ready to display
591
			foreach ( $item_data as $key => $data ) {
592
				// Set hidden to true to not display meta on cart.
593
				if ( ! empty( $data['hidden'] ) ) {
594
					unset( $item_data[ $key ] );
595
					continue;
596
				}
597
				$item_data[ $key ]['key']     = ! empty( $data['key'] ) ? $data['key'] : $data['name'];
598
				$item_data[ $key ]['display'] = ! empty( $data['display'] ) ? $data['display'] : $data['value'];
599
			}
600
601
			// Output flat or in list format
602
			if ( sizeof( $item_data ) > 0 ) {
603
				ob_start();
604
605
				if ( $flat ) {
606
					foreach ( $item_data as $data ) {
607
						echo esc_html( $data['key'] ) . ': ' . wp_kses_post( $data['display'] ) . "\n";
608
					}
609
				} else {
610
					wc_get_template( 'cart/cart-item-data.php', array( 'item_data' => $item_data ) );
611
				}
612
613
				return ob_get_clean();
614
			}
615
616
			return '';
617
		}
618
619
		/**
620
		 * Gets cross sells based on the items in the cart.
621
		 *
622
		 * @return array cross_sells (item ids)
623
		 */
624
		public function get_cross_sells() {
625
			$cross_sells = array();
626
			$in_cart = array();
627
			if ( ! $this->is_empty() ) {
628
				foreach ( $this->get_cart() as $cart_item_key => $values ) {
629
					if ( $values['quantity'] > 0 ) {
630
						$cross_sells = array_merge( $values['data']->get_cross_sells(), $cross_sells );
631
						$in_cart[] = $values['product_id'];
632
					}
633
				}
634
			}
635
			$cross_sells = array_diff( $cross_sells, $in_cart );
636
			return $cross_sells;
637
		}
638
639
		/**
640
		 * Gets the url to the cart page.
641
		 *
642
		 * @deprecated 2.5.0 in favor to wc_get_cart_url()
643
		 *
644
		 * @return string url to page
645
		 */
646
		public function get_cart_url() {
647
			return wc_get_cart_url();
648
		}
649
650
		/**
651
		 * Gets the url to the checkout page.
652
		 *
653
		 * @deprecated 2.5.0 in favor to wc_get_checkout_url()
654
		 *
655
		 * @return string url to page
656
		 */
657
		public function get_checkout_url() {
658
			return wc_get_checkout_url();
659
		}
660
661
		/**
662
		 * Gets the url to remove an item from the cart.
663
		 *
664
		 * @param string cart_item_key contains the id of the cart item
665
		 * @return string url to page
666
		 */
667
		public function get_remove_url( $cart_item_key ) {
668
			$cart_page_url = wc_get_page_permalink( 'cart' );
669
			return apply_filters( 'woocommerce_get_remove_url', $cart_page_url ? wp_nonce_url( add_query_arg( 'remove_item', $cart_item_key, $cart_page_url ), 'woocommerce-cart' ) : '' );
670
		}
671
672
		/**
673
		 * Gets the url to re-add an item into the cart.
674
		 *
675
		 * @param  string $cart_item_key
676
		 * @return string url to page
677
		 */
678
		public function get_undo_url( $cart_item_key ) {
679
			$cart_page_url = wc_get_page_permalink( 'cart' );
680
681
			$query_args = array(
682
				'undo_item' => $cart_item_key,
683
			);
684
685
			return apply_filters( 'woocommerce_get_undo_url', $cart_page_url ? wp_nonce_url( add_query_arg( $query_args, $cart_page_url ), 'woocommerce-cart' ) : '' );
686
		}
687
688
		/**
689
		 * Returns the contents of the cart in an array.
690
		 *
691
		 * @return array contents of the cart
692
		 */
693
		public function get_cart() {
694
			if ( ! did_action( 'wp_loaded' ) ) {
695
				_doing_it_wrong( __FUNCTION__, __( 'Get cart should not be called before the wp_loaded action.', 'woocommerce' ), '2.3' );
696
			}
697
			if ( ! did_action( 'woocommerce_cart_loaded_from_session' ) ) {
698
				$this->get_cart_from_session();
699
			}
700
			return array_filter( (array) $this->cart_contents );
701
		}
702
703
		/**
704
		 * Returns the contents of the cart in an array without the 'data' element.
705
		 *
706
		 * @return array contents of the cart
707
		 */
708
		public function get_cart_for_session() {
709
			$cart_session = array();
710
711
			if ( $this->get_cart() ) {
712
				foreach ( $this->get_cart() as $key => $values ) {
713
					$cart_session[ $key ] = $values;
714
					unset( $cart_session[ $key ]['data'] ); // Unset product object
715
				}
716
			}
717
718
			return $cart_session;
719
		}
720
721
		/**
722
		 * Returns a specific item in the cart.
723
		 *
724
		 * @return array item data
725
		 */
726
		public function get_cart_item( $item_key ) {
727
			if ( isset( $this->cart_contents[ $item_key ] ) ) {
728
				return $this->cart_contents[ $item_key ];
729
			}
730
731
			return array();
732
		}
733
734
		/**
735
		 * Returns the cart and shipping taxes, merged.
736
		 *
737
		 * @return array merged taxes
738
		 */
739
		public function get_taxes() {
740
			$taxes = array();
741
742
			// Merge
743
			foreach ( array_keys( $this->taxes + $this->shipping_taxes ) as $key ) {
744
				$taxes[ $key ] = ( isset( $this->shipping_taxes[ $key ] ) ? $this->shipping_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
745
			}
746
747
			return apply_filters( 'woocommerce_cart_get_taxes', $taxes, $this );
748
		}
749
750
		/**
751
		 * Get taxes, merged by code, formatted ready for output.
752
		 *
753
		 * @return array
754
		 */
755
		public function get_tax_totals() {
756
			$taxes      = $this->get_taxes();
757
			$tax_totals = array();
758
759
			foreach ( $taxes as $key => $tax ) {
760
				$code = WC_Tax::get_rate_code( $key );
761
762
				if ( $code || $key === apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) ) {
763 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...
764
						$tax_totals[ $code ] = new stdClass();
765
						$tax_totals[ $code ]->amount = 0;
766
					}
767
					$tax_totals[ $code ]->tax_rate_id       = $key;
768
					$tax_totals[ $code ]->is_compound       = WC_Tax::is_compound( $key );
769
					$tax_totals[ $code ]->label             = WC_Tax::get_rate_label( $key );
770
					$tax_totals[ $code ]->amount           += wc_round_tax_total( $tax );
771
					$tax_totals[ $code ]->formatted_amount  = wc_price( wc_round_tax_total( $tax_totals[ $code ]->amount ) );
772
				}
773
			}
774
775
			return apply_filters( 'woocommerce_cart_tax_totals', $tax_totals, $this );
776
		}
777
778
		/**
779
		 * Get all tax classes for items in the cart.
780
		 * @return array
781
		 */
782
		public function get_cart_item_tax_classes() {
783
			$found_tax_classes = array();
784
785
			foreach ( WC()->cart->get_cart() as $item ) {
786
				$found_tax_classes[] = $item['data']->get_tax_class();
787
			}
788
789
			return array_unique( $found_tax_classes );
790
		}
791
792
	/*-----------------------------------------------------------------------------------*/
793
	/* Add to cart handling */
794
	/*-----------------------------------------------------------------------------------*/
795
796
		/**
797
		 * Check if product is in the cart and return cart item key.
798
		 *
799
		 * Cart item key will be unique based on the item and its properties, such as variations.
800
		 *
801
		 * @param mixed id of product to find in the cart
802
		 * @return string cart item key
803
		 */
804
		public function find_product_in_cart( $cart_id = false ) {
805
			if ( $cart_id !== false ) {
806
				if ( is_array( $this->cart_contents ) ) {
807
					foreach ( $this->cart_contents as $cart_item_key => $cart_item ) {
808
						if ( $cart_item_key == $cart_id ) {
809
							return $cart_item_key;
810
						}
811
					}
812
				}
813
			}
814
			return '';
815
		}
816
817
		/**
818
		 * Generate a unique ID for the cart item being added.
819
		 *
820
		 * @param int $product_id - id of the product the key is being generated for
821
		 * @param int $variation_id of the product the key is being generated for
822
		 * @param array $variation data for the cart item
823
		 * @param array $cart_item_data other cart item data passed which affects this items uniqueness in the cart
824
		 * @return string cart item key
825
		 */
826
		public function generate_cart_id( $product_id, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
827
			$id_parts = array( $product_id );
828
829
			if ( $variation_id && 0 != $variation_id ) {
830
				$id_parts[] = $variation_id;
831
			}
832
833
			if ( is_array( $variation ) && ! empty( $variation ) ) {
834
				$variation_key = '';
835
				foreach ( $variation as $key => $value ) {
836
					$variation_key .= trim( $key ) . trim( $value );
837
				}
838
				$id_parts[] = $variation_key;
839
			}
840
841
			if ( is_array( $cart_item_data ) && ! empty( $cart_item_data ) ) {
842
				$cart_item_data_key = '';
843
				foreach ( $cart_item_data as $key => $value ) {
844
845
					if ( is_array( $value ) ) {
846
						$value = http_build_query( $value );
847
					}
848
					$cart_item_data_key .= trim( $key ) . trim( $value );
849
850
				}
851
				$id_parts[] = $cart_item_data_key;
852
			}
853
854
			return md5( implode( '_', $id_parts ) );
855
		}
856
857
		/**
858
		 * Add a product to the cart.
859
		 *
860
		 * @param int $product_id contains the id of the product to add to the cart
861
		 * @param int $quantity contains the quantity of the item to add
862
		 * @param int $variation_id
863
		 * @param array $variation attribute values
864
		 * @param array $cart_item_data extra cart item data we want to pass into the item
865
		 * @return string $cart_item_key
866
		 */
867
		public function add_to_cart( $product_id = 0, $quantity = 1, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
868
			// Wrap in try catch so plugins can throw an exception to prevent adding to cart
869
			try {
870
				$product_id   = absint( $product_id );
871
				$variation_id = absint( $variation_id );
872
873
				// Ensure we don't add a variation to the cart directly by variation ID
874
				if ( 'product_variation' == get_post_type( $product_id ) ) {
875
					$variation_id = $product_id;
876
					$product_id   = wp_get_post_parent_id( $variation_id );
877
				}
878
879
				// Get the product
880
				$product_data = wc_get_product( $variation_id ? $variation_id : $product_id );
881
882
				// Sanitity check
883
				if ( $quantity <= 0 || ! $product_data || 'trash' === $product_data->post->post_status  ) {
884
					throw new Exception();
885
				}
886
887
				// Load cart item data - may be added by other plugins
888
				$cart_item_data = (array) apply_filters( 'woocommerce_add_cart_item_data', $cart_item_data, $product_id, $variation_id );
889
890
				// Generate a ID based on product ID, variation ID, variation data, and other cart item data
891
				$cart_id        = $this->generate_cart_id( $product_id, $variation_id, $variation, $cart_item_data );
892
893
				// Find the cart item key in the existing cart
894
				$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...
895
896
				// Force quantity to 1 if sold individually and check for exisitng item in cart
897
				if ( $product_data->is_sold_individually() ) {
898
					$quantity         = apply_filters( 'woocommerce_add_to_cart_sold_individually_quantity', 1, $quantity, $product_id, $variation_id, $cart_item_data );
899
					$in_cart_quantity = $cart_item_key ? $this->cart_contents[ $cart_item_key ]['quantity'] : 0;
900
901
					if ( $in_cart_quantity > 0 ) {
902
						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() ) ) );
903
					}
904
				}
905
906
				// Check product is_purchasable
907
				if ( ! $product_data->is_purchasable() ) {
908
					throw new Exception( __( 'Sorry, this product cannot be purchased.', 'woocommerce' ) );
909
				}
910
911
				// Stock check - only check if we're managing stock and backorders are not allowed
912
				if ( ! $product_data->is_in_stock() ) {
913
					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() ) );
914
				}
915
916
				if ( ! $product_data->has_enough_stock( $quantity ) ) {
917
					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() ) );
918
				}
919
920
				// Stock check - this time accounting for whats already in-cart
921
				if ( $managing_stock = $product_data->managing_stock() ) {
922
					$products_qty_in_cart = $this->get_cart_item_quantities();
923
924
					if ( $product_data->is_type( 'variation' ) && true === $managing_stock ) {
925
						$check_qty = isset( $products_qty_in_cart[ $variation_id ] ) ? $products_qty_in_cart[ $variation_id ] : 0;
926
					} else {
927
						$check_qty = isset( $products_qty_in_cart[ $product_id ] ) ? $products_qty_in_cart[ $product_id ] : 0;
928
					}
929
930
					/**
931
					 * Check stock based on all items in the cart.
932
					 */
933
					if ( ! $product_data->has_enough_stock( $check_qty + $quantity ) ) {
934
						throw new Exception( sprintf(
935
							'<a href="%s" class="button wc-forward">%s</a> %s',
936
							wc_get_cart_url(),
937
							__( 'View Cart', 'woocommerce' ),
938
							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 )
939
						) );
940
					}
941
				}
942
943
				// If cart_item_key is set, the item is already in the cart
944
				if ( $cart_item_key ) {
945
					$new_quantity = $quantity + $this->cart_contents[ $cart_item_key ]['quantity'];
946
					$this->set_quantity( $cart_item_key, $new_quantity, false );
947
				} else {
948
					$cart_item_key = $cart_id;
949
950
					// Add item after merging with $cart_item_data - hook to allow plugins to modify cart item
951
					$this->cart_contents[ $cart_item_key ] = apply_filters( 'woocommerce_add_cart_item', array_merge( $cart_item_data, array(
952
						'product_id'	=> $product_id,
953
						'variation_id'	=> $variation_id,
954
						'variation' 	=> $variation,
955
						'quantity' 		=> $quantity,
956
						'data'			=> $product_data
957
					) ), $cart_item_key );
958
				}
959
960
				if ( did_action( 'wp' ) ) {
961
					$this->set_cart_cookies( ! $this->is_empty() );
962
				}
963
964
				do_action( 'woocommerce_add_to_cart', $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data );
965
966
				return $cart_item_key;
967
968
			} catch ( Exception $e ) {
969
				if ( $e->getMessage() ) {
970
					wc_add_notice( $e->getMessage(), 'error' );
971
				}
972
				return false;
973
			}
974
		}
975
976
		/**
977
		 * Remove a cart item.
978
		 *
979
		 * @since  2.3.0
980
		 * @param  string $cart_item_key
981
		 * @return bool
982
		 */
983
		public function remove_cart_item( $cart_item_key ) {
984
			if ( isset( $this->cart_contents[ $cart_item_key ] ) ) {
985
				$this->removed_cart_contents[ $cart_item_key ] = $this->cart_contents[ $cart_item_key ];
986
				unset( $this->removed_cart_contents[ $cart_item_key ]['data'] );
987
988
				do_action( 'woocommerce_remove_cart_item', $cart_item_key, $this );
989
990
				unset( $this->cart_contents[ $cart_item_key ] );
991
992
				do_action( 'woocommerce_cart_item_removed', $cart_item_key, $this );
993
994
				$this->calculate_totals();
995
996
				return true;
997
			}
998
999
			return false;
1000
		}
1001
1002
		/**
1003
		 * Restore a cart item.
1004
		 *
1005
		 * @param  string $cart_item_key
1006
		 * @return bool
1007
		 */
1008
		public function restore_cart_item( $cart_item_key ) {
1009
			if ( isset( $this->removed_cart_contents[ $cart_item_key ] ) ) {
1010
				$this->cart_contents[ $cart_item_key ] = $this->removed_cart_contents[ $cart_item_key ];
1011
				$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'] );
1012
1013
				do_action( 'woocommerce_restore_cart_item', $cart_item_key, $this );
1014
1015
				unset( $this->removed_cart_contents[ $cart_item_key ] );
1016
1017
				do_action( 'woocommerce_cart_item_restored', $cart_item_key, $this );
1018
1019
				$this->calculate_totals();
1020
1021
				return true;
1022
			}
1023
1024
			return false;
1025
		}
1026
1027
		/**
1028
		 * Set the quantity for an item in the cart.
1029
		 *
1030
		 * @param string	$cart_item_key	contains the id of the cart item
1031
		 * @param string	$quantity		contains the quantity of the item
1032
		 * @param bool      $refresh_totals	whether or not to calculate totals after setting the new qty
1033
		 *
1034
		 * @return bool
1035
		 */
1036
		public function set_quantity( $cart_item_key, $quantity = 1, $refresh_totals = true ) {
1037
			if ( $quantity == 0 || $quantity < 0 ) {
1038
				do_action( 'woocommerce_before_cart_item_quantity_zero', $cart_item_key );
1039
				unset( $this->cart_contents[ $cart_item_key ] );
1040
			} else {
1041
				$old_quantity = $this->cart_contents[ $cart_item_key ]['quantity'];
1042
				$this->cart_contents[ $cart_item_key ]['quantity'] = $quantity;
1043
				do_action( 'woocommerce_after_cart_item_quantity_update', $cart_item_key, $quantity, $old_quantity );
1044
			}
1045
1046
			if ( $refresh_totals ) {
1047
				$this->calculate_totals();
1048
			}
1049
1050
			return true;
1051
		}
1052
1053
	/*-----------------------------------------------------------------------------------*/
1054
	/* Cart Calculation Functions */
1055
	/*-----------------------------------------------------------------------------------*/
1056
1057
		/**
1058
		 * Reset cart totals to the defaults. Useful before running calculations.
1059
		 *
1060
		 * @param  bool  	$unset_session If true, the session data will be forced unset.
1061
		 * @access private
1062
		 */
1063
		private function reset( $unset_session = false ) {
1064
			foreach ( $this->cart_session_data as $key => $default ) {
1065
				$this->$key = $default;
1066
				if ( $unset_session ) {
1067
					unset( WC()->session->$key );
1068
				}
1069
			}
1070
			do_action( 'woocommerce_cart_reset', $this, $unset_session );
1071
		}
1072
1073
		/**
1074
		 * Sort by subtotal.
1075
		 * @param  array $a
1076
		 * @param  array $b
1077
		 * @return int
1078
		 */
1079
		private function sort_by_subtotal( $a, $b ) {
1080
			$first_item_subtotal  = isset( $a['line_subtotal'] ) ? $a['line_subtotal'] : 0;
1081
			$second_item_subtotal = isset( $b['line_subtotal'] ) ? $b['line_subtotal'] : 0;
1082
			if ( $first_item_subtotal === $second_item_subtotal ) {
1083
				return 0;
1084
			}
1085
			return ( $first_item_subtotal < $second_item_subtotal ) ? 1 : -1;
1086
		}
1087
1088
		/**
1089
		 * Calculate totals for the items in the cart.
1090
		 */
1091
		public function calculate_totals() {
1092
			$this->reset();
1093
			$this->coupons = $this->get_coupons();
1094
1095
			do_action( 'woocommerce_before_calculate_totals', $this );
1096
1097
			if ( $this->is_empty() ) {
1098
				$this->set_session();
1099
				return;
1100
			}
1101
1102
			$tax_rates      = array();
1103
			$shop_tax_rates = array();
1104
			$cart           = $this->get_cart();
1105
1106
			/**
1107
			 * Calculate subtotals for items. This is done first so that discount logic can use the values.
1108
			 */
1109
			foreach ( $cart as $cart_item_key => $values ) {
1110
				$_product          = $values['data'];
1111
				$line_price        = $_product->get_price() * $values['quantity'];
1112
				$line_subtotal     = 0;
1113
				$line_subtotal_tax = 0;
1114
1115
				/**
1116
				 * No tax to calculate.
1117
				 */
1118
				if ( ! $_product->is_taxable() ) {
1119
1120
					// Subtotal is the undiscounted price
1121
					$this->subtotal += $line_price;
1122
					$this->subtotal_ex_tax += $line_price;
1123
1124
				/**
1125
				 * Prices include tax.
1126
				 *
1127
				 * To prevent rounding issues we need to work with the inclusive price where possible.
1128
				 * otherwise we'll see errors such as when working with a 9.99 inc price, 20% VAT which would.
1129
				 * be 8.325 leading to totals being 1p off.
1130
				 *
1131
				 * Pre tax coupons come off the price the customer thinks they are paying - tax is calculated.
1132
				 * afterwards.
1133
				 *
1134
				 * e.g. $100 bike with $10 coupon = customer pays $90 and tax worked backwards from that.
1135
				 */
1136
				} elseif ( $this->prices_include_tax ) {
1137
1138
					// Get base tax rates
1139
					if ( empty( $shop_tax_rates[ $_product->tax_class ] ) ) {
1140
						$shop_tax_rates[ $_product->tax_class ] = WC_Tax::get_base_tax_rates( $_product->tax_class );
1141
					}
1142
1143
					// Get item tax rates
1144
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1145
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1146
					}
1147
1148
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1149
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1150
1151
					/**
1152
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1153
					 *
1154
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1155
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1156
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1157
 					 */
1158
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1159
1160
						// Work out a new base price without the shop's base tax
1161
						$taxes                 = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1162
1163
						// Now we have a new item price (excluding TAX)
1164
						$line_subtotal         = $line_price - array_sum( $taxes );
1165
1166
						// Now add modified taxes
1167
						$tax_result            = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1168
						$line_subtotal_tax     = array_sum( $tax_result );
1169
1170
					/**
1171
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1172
					 */
1173
					} else {
1174
1175
						// Calc tax normally
1176
						$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1177
						$line_subtotal_tax     = array_sum( $taxes );
1178
						$line_subtotal         = $line_price - array_sum( $taxes );
1179
					}
1180
1181
				/**
1182
				 * Prices exclude tax.
1183
				 *
1184
				 * This calculation is simpler - work with the base, untaxed price.
1185
				 */
1186
				} else {
1187
1188
					// Get item tax rates
1189
					if ( empty( $tax_rates[ $_product->get_tax_class() ] ) ) {
1190
						$tax_rates[ $_product->get_tax_class() ] = WC_Tax::get_rates( $_product->get_tax_class() );
1191
					}
1192
1193
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1194
1195
					// Base tax for line before discount - we will store this in the order data
1196
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1197
					$line_subtotal_tax     = array_sum( $taxes );
1198
1199
					$line_subtotal         = $line_price;
1200
				}
1201
1202
				// Add to main subtotal
1203
				$this->subtotal        += $line_subtotal + $line_subtotal_tax;
1204
				$this->subtotal_ex_tax += $line_subtotal;
1205
			}
1206
1207
			// Order cart items by price so coupon logic is 'fair' for customers and not based on order added to cart.
1208
			uasort( $cart, array( $this, 'sort_by_subtotal' ) );
1209
1210
			/**
1211
			 * Calculate totals for items.
1212
			 */
1213
			foreach ( $cart as $cart_item_key => $values ) {
1214
1215
				$_product = $values['data'];
1216
1217
				// Prices
1218
				$base_price = $_product->get_price();
1219
				$line_price = $_product->get_price() * $values['quantity'];
1220
1221
				// Tax data
1222
				$taxes = array();
1223
				$discounted_taxes = array();
1224
1225
				/**
1226
				 * No tax to calculate.
1227
				 */
1228
				if ( ! $_product->is_taxable() ) {
1229
1230
					// Discounted Price (price with any pre-tax discounts applied)
1231
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1232
					$line_subtotal_tax     = 0;
1233
					$line_subtotal         = $line_price;
1234
					$line_tax              = 0;
1235
					$line_total            = WC_Tax::round( $discounted_price * $values['quantity'] );
1236
1237
				/**
1238
				 * Prices include tax.
1239
				 */
1240
				} elseif ( $this->prices_include_tax ) {
1241
1242
					$base_tax_rates = $shop_tax_rates[ $_product->tax_class ];
1243
					$item_tax_rates = $tax_rates[ $_product->get_tax_class() ];
1244
1245
					/**
1246
					 * ADJUST TAX - Calculations when base tax is not equal to the item tax.
1247
					 *
1248
 					 * The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing with out of base locations.
1249
 					 * e.g. If a product costs 10 including tax, all users will pay 10 regardless of location and taxes.
1250
 					 * This feature is experimental @since 2.4.7 and may change in the future. Use at your risk.
1251
 					 */
1252
					if ( $item_tax_rates !== $base_tax_rates && apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
1253
1254
						// Work out a new base price without the shop's base tax
1255
						$taxes             = WC_Tax::calc_tax( $line_price, $base_tax_rates, true, true );
1256
1257
						// Now we have a new item price (excluding TAX)
1258
						$line_subtotal     = round( $line_price - array_sum( $taxes ), WC_ROUNDING_PRECISION );
1259
						$taxes             = WC_Tax::calc_tax( $line_subtotal, $item_tax_rates );
1260
						$line_subtotal_tax = array_sum( $taxes );
1261
1262
						// Adjusted price (this is the price including the new tax rate)
1263
						$adjusted_price    = ( $line_subtotal + $line_subtotal_tax ) / $values['quantity'];
1264
1265
						// Apply discounts
1266
						$discounted_price  = $this->get_discounted_price( $values, $adjusted_price, true );
1267
						$discounted_taxes  = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates, true );
1268
						$line_tax          = array_sum( $discounted_taxes );
1269
						$line_total        = ( $discounted_price * $values['quantity'] ) - $line_tax;
1270
1271
					/**
1272
					 * Regular tax calculation (customer inside base and the tax class is unmodified.
1273
					 */
1274
					} else {
1275
1276
						// Work out a new base price without the item tax
1277
						$taxes             = WC_Tax::calc_tax( $line_price, $item_tax_rates, true );
1278
1279
						// Now we have a new item price (excluding TAX)
1280
						$line_subtotal     = $line_price - array_sum( $taxes );
1281
						$line_subtotal_tax = array_sum( $taxes );
1282
1283
						// Calc prices and tax (discounted)
1284
						$discounted_price = $this->get_discounted_price( $values, $base_price, true );
1285
						$discounted_taxes = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates, true );
1286
						$line_tax         = array_sum( $discounted_taxes );
1287
						$line_total       = ( $discounted_price * $values['quantity'] ) - $line_tax;
1288
					}
1289
1290
					// Tax rows - merge the totals we just got
1291 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...
1292
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1293
					}
1294
1295
				/**
1296
				 * Prices exclude tax.
1297
				 */
1298
				} else {
1299
1300
					$item_tax_rates        = $tax_rates[ $_product->get_tax_class() ];
1301
1302
					// Work out a new base price without the shop's base tax
1303
					$taxes                 = WC_Tax::calc_tax( $line_price, $item_tax_rates );
1304
1305
					// Now we have the item price (excluding TAX)
1306
					$line_subtotal         = $line_price;
1307
					$line_subtotal_tax     = array_sum( $taxes );
1308
1309
					// Now calc product rates
1310
					$discounted_price      = $this->get_discounted_price( $values, $base_price, true );
1311
					$discounted_taxes      = WC_Tax::calc_tax( $discounted_price * $values['quantity'], $item_tax_rates );
1312
					$discounted_tax_amount = array_sum( $discounted_taxes );
1313
					$line_tax              = $discounted_tax_amount;
1314
					$line_total            = $discounted_price * $values['quantity'];
1315
1316
					// Tax rows - merge the totals we just got
1317 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...
1318
						$this->taxes[ $key ] = ( isset( $discounted_taxes[ $key ] ) ? $discounted_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1319
					}
1320
				}
1321
1322
				// Cart contents total is based on discounted prices and is used for the final total calculation
1323
				$this->cart_contents_total += $line_total;
1324
1325
				// Store costs + taxes for lines
1326
				$this->cart_contents[ $cart_item_key ]['line_total']        = $line_total;
1327
				$this->cart_contents[ $cart_item_key ]['line_tax']          = $line_tax;
1328
				$this->cart_contents[ $cart_item_key ]['line_subtotal']     = $line_subtotal;
1329
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $line_subtotal_tax;
1330
1331
				// Store rates ID and costs - Since 2.2
1332
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => $discounted_taxes, 'subtotal' => $taxes );
1333
			}
1334
1335
			// Only calculate the grand total + shipping if on the cart/checkout
1336
			if ( is_checkout() || is_cart() || defined('WOOCOMMERCE_CHECKOUT') || defined('WOOCOMMERCE_CART') ) {
1337
1338
				// Calculate the Shipping
1339
				$this->calculate_shipping();
1340
1341
				// Trigger the fees API where developers can add fees to the cart
1342
				$this->calculate_fees();
1343
1344
				// Total up/round taxes and shipping taxes
1345
				if ( $this->round_at_subtotal ) {
1346
					$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...
1347
					$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...
1348
					$this->taxes              = array_map( array( 'WC_Tax', 'round' ), $this->taxes );
1349
					$this->shipping_taxes     = array_map( array( 'WC_Tax', 'round' ), $this->shipping_taxes );
1350
				} else {
1351
					$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...
1352
					$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...
1353
				}
1354
1355
				// VAT exemption done at this point - so all totals are correct before exemption
1356
				if ( WC()->customer->is_vat_exempt() ) {
1357
					$this->remove_taxes();
1358
				}
1359
1360
				// Allow plugins to hook and alter totals before final total is calculated
1361
				do_action( 'woocommerce_calculate_totals', $this );
1362
1363
				// Grand Total - Discounted product prices, discounted tax, shipping cost + tax
1364
				$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 ) );
1365
1366
			} else {
1367
1368
				// Set tax total to sum of all tax rows
1369
				$this->tax_total = WC_Tax::get_tax_total( $this->taxes );
1370
1371
				// VAT exemption done at this point - so all totals are correct before exemption
1372
				if ( WC()->customer->is_vat_exempt() ) {
1373
					$this->remove_taxes();
1374
				}
1375
			}
1376
1377
			do_action( 'woocommerce_after_calculate_totals', $this );
1378
1379
			$this->set_session();
1380
		}
1381
1382
		/**
1383
		 * Remove taxes.
1384
		 */
1385
		public function remove_taxes() {
1386
			$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...
1387
			$this->subtotal           = $this->subtotal_ex_tax;
1388
1389
			foreach ( $this->cart_contents as $cart_item_key => $item ) {
1390
				$this->cart_contents[ $cart_item_key ]['line_subtotal_tax'] = $this->cart_contents[ $cart_item_key ]['line_tax'] = 0;
1391
				$this->cart_contents[ $cart_item_key ]['line_tax_data']     = array( 'total' => array(), 'subtotal' => array() );
1392
			}
1393
1394
			// If true, zero rate is applied so '0' tax is displayed on the frontend rather than nothing.
1395
			if ( apply_filters( 'woocommerce_cart_remove_taxes_apply_zero_rate', true ) ) {
1396
				$this->taxes = $this->shipping_taxes = array( apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) => 0 );
1397
			} else {
1398
				$this->taxes = $this->shipping_taxes = array();
1399
			}
1400
		}
1401
1402
		/**
1403
		 * Looks at the totals to see if payment is actually required.
1404
		 *
1405
		 * @return bool
1406
		 */
1407
		public function needs_payment() {
1408
			return apply_filters( 'woocommerce_cart_needs_payment', $this->total > 0, $this );
1409
		}
1410
1411
	/*-----------------------------------------------------------------------------------*/
1412
	/* Shipping related functions */
1413
	/*-----------------------------------------------------------------------------------*/
1414
1415
		/**
1416
		 * Uses the shipping class to calculate shipping then gets the totals when its finished.
1417
		 */
1418
		public function calculate_shipping() {
1419
			if ( $this->needs_shipping() && $this->show_shipping() ) {
1420
				WC()->shipping->calculate_shipping( $this->get_shipping_packages() );
1421
			} else {
1422
				WC()->shipping->reset_shipping();
1423
			}
1424
1425
			// Get totals for the chosen shipping method
1426
			$this->shipping_total 		= WC()->shipping->shipping_total;	// Shipping Total
1427
			$this->shipping_taxes		= WC()->shipping->shipping_taxes;	// Shipping Taxes
1428
		}
1429
1430
		/**
1431
		 * Get packages to calculate shipping for.
1432
		 *
1433
		 * This lets us calculate costs for carts that are shipped to multiple locations.
1434
		 *
1435
		 * Shipping methods are responsible for looping through these packages.
1436
		 *
1437
		 * By default we pass the cart itself as a package - plugins can change this.
1438
		 * through the filter and break it up.
1439
		 *
1440
		 * @since 1.5.4
1441
		 * @return array of cart items
1442
		 */
1443
		public function get_shipping_packages() {
1444
			// Packages array for storing 'carts'
1445
			$packages = array();
1446
1447
			$packages[0]['contents']                 = $this->get_cart();		// Items in the package
1448
			$packages[0]['contents_cost']            = 0;						// Cost of items in the package, set below
1449
			$packages[0]['applied_coupons']          = $this->applied_coupons;
1450
			$packages[0]['user']['ID']               = get_current_user_id();
1451
			$packages[0]['destination']['country']   = WC()->customer->get_shipping_country();
1452
			$packages[0]['destination']['state']     = WC()->customer->get_shipping_state();
1453
			$packages[0]['destination']['postcode']  = WC()->customer->get_shipping_postcode();
1454
			$packages[0]['destination']['city']      = WC()->customer->get_shipping_city();
1455
			$packages[0]['destination']['address']   = WC()->customer->get_shipping_address();
1456
			$packages[0]['destination']['address_2'] = WC()->customer->get_shipping_address_2();
1457
1458
			foreach ( $this->get_cart() as $item ) {
1459
				if ( $item['data']->needs_shipping() ) {
1460
					if ( isset( $item['line_total'] ) ) {
1461
						$packages[0]['contents_cost'] += $item['line_total'];
1462
					}
1463
				}
1464
			}
1465
1466
			return apply_filters( 'woocommerce_cart_shipping_packages', $packages );
1467
		}
1468
1469
		/**
1470
		 * Looks through the cart to see if shipping is actually required.
1471
		 *
1472
		 * @return bool whether or not the cart needs shipping
1473
		 */
1474
		public function needs_shipping() {
1475
			if ( ! wc_shipping_enabled() ) {
1476
				return false;
1477
			}
1478
1479
			$needs_shipping = false;
1480
1481
			if ( $this->cart_contents ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->cart_contents of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

Loading history...
1482
				foreach ( $this->cart_contents as $cart_item_key => $values ) {
1483
					$_product = $values['data'];
1484
					if ( $_product->needs_shipping() ) {
1485
						$needs_shipping = true;
1486
					}
1487
				}
1488
			}
1489
1490
			return apply_filters( 'woocommerce_cart_needs_shipping', $needs_shipping );
1491
		}
1492
1493
		/**
1494
		 * Should the shipping address form be shown.
1495
		 *
1496
		 * @return bool
1497
		 */
1498
		function needs_shipping_address() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

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

Loading history...
1499
1500
			$needs_shipping_address = false;
1501
1502
			if ( $this->needs_shipping() === true && ! wc_ship_to_billing_address_only() ) {
1503
				$needs_shipping_address = true;
1504
			}
1505
1506
			return apply_filters( 'woocommerce_cart_needs_shipping_address', $needs_shipping_address );
1507
		}
1508
1509
		/**
1510
		 * Sees if the customer has entered enough data to calc the shipping yet.
1511
		 *
1512
		 * @return bool
1513
		 */
1514
		public function show_shipping() {
1515
			if ( ! wc_shipping_enabled() || ! is_array( $this->cart_contents ) )
1516
				return false;
1517
1518
			if ( get_option( 'woocommerce_shipping_cost_requires_address' ) == 'yes' ) {
1519
				if ( ! WC()->customer->has_calculated_shipping() ) {
1520
					if ( ! WC()->customer->get_shipping_country() || ( ! WC()->customer->get_shipping_state() && ! WC()->customer->get_shipping_postcode() ) )
1521
						return false;
1522
				}
1523
			}
1524
1525
			$show_shipping = true;
1526
1527
			return apply_filters( 'woocommerce_cart_ready_to_calc_shipping', $show_shipping );
1528
1529
		}
1530
1531
		/**
1532
		 * Sees if we need a shipping address.
1533
		 *
1534
		 * @deprecated 2.5.0 in favor to wc_ship_to_billing_address_only()
1535
		 *
1536
		 * @return bool
1537
		 */
1538
		public function ship_to_billing_address_only() {
1539
			return wc_ship_to_billing_address_only();
1540
		}
1541
1542
		/**
1543
		 * Gets the shipping total (after calculation).
1544
		 *
1545
		 * @return string price or string for the shipping total
1546
		 */
1547
		public function get_cart_shipping_total() {
1548
			if ( isset( $this->shipping_total ) ) {
1549
				if ( $this->shipping_total > 0 ) {
1550
1551
					// Display varies depending on settings
1552
					if ( $this->tax_display_cart == 'excl' ) {
1553
1554
						$return = wc_price( $this->shipping_total );
1555
1556
						if ( $this->shipping_tax_total > 0 && $this->prices_include_tax ) {
1557
							$return .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
1558
						}
1559
1560
						return $return;
1561
1562
					} else {
1563
1564
						$return = wc_price( $this->shipping_total + $this->shipping_tax_total );
1565
1566
						if ( $this->shipping_tax_total > 0 && ! $this->prices_include_tax ) {
1567
							$return .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
1568
						}
1569
1570
						return $return;
1571
1572
					}
1573
1574
				} else {
1575
					return __( 'Free!', 'woocommerce' );
1576
				}
1577
			}
1578
1579
			return '';
1580
		}
1581
1582
	/*-----------------------------------------------------------------------------------*/
1583
	/* Coupons/Discount related functions */
1584
	/*-----------------------------------------------------------------------------------*/
1585
1586
		/**
1587
		 * Check for user coupons (now that we have billing email). If a coupon is invalid, add an error.
1588
		 *
1589
		 * Checks two types of coupons:
1590
		 *  1. Where a list of customer emails are set (limits coupon usage to those defined).
1591
		 *  2. Where a usage_limit_per_user is set (limits coupon usage to a number based on user ID and email).
1592
		 *
1593
		 * @param array $posted
1594
		 */
1595
		public function check_customer_coupons( $posted ) {
1596
			if ( ! empty( $this->applied_coupons ) ) {
1597
				foreach ( $this->applied_coupons as $code ) {
1598
					$coupon = new WC_Coupon( $code );
1599
1600
					if ( $coupon->is_valid() ) {
1601
1602
						// Limit to defined email addresses
1603
						if ( is_array( $coupon->customer_email ) && sizeof( $coupon->customer_email ) > 0 ) {
1604
							$check_emails           = array();
1605
							$coupon->customer_email = array_map( 'sanitize_email', $coupon->customer_email );
1606
1607
							if ( is_user_logged_in() ) {
1608
								$current_user   = wp_get_current_user();
1609
								$check_emails[] = $current_user->user_email;
1610
							}
1611
							$check_emails[] = $posted['billing_email'];
1612
							$check_emails   = array_map( 'sanitize_email', array_map( 'strtolower', $check_emails ) );
1613
1614
							if ( 0 == sizeof( array_intersect( $check_emails, $coupon->customer_email ) ) ) {
1615
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_NOT_YOURS_REMOVED );
1616
1617
								// Remove the coupon
1618
								$this->remove_coupon( $code );
1619
1620
								// Flag totals for refresh
1621
								WC()->session->set( 'refresh_totals', true );
1622
							}
1623
						}
1624
1625
						// Usage limits per user - check against billing and user email and user ID
1626
						if ( $coupon->usage_limit_per_user > 0 ) {
1627
							$check_emails = array();
1628
							$used_by      = $coupon->get_used_by();
1629
1630
							if ( is_user_logged_in() ) {
1631
								$current_user   = wp_get_current_user();
1632
								$check_emails[] = sanitize_email( $current_user->user_email );
1633
								$usage_count    = sizeof( array_keys( $used_by, get_current_user_id() ) );
1634
							} else {
1635
								$check_emails[] = sanitize_email( $posted['billing_email'] );
1636
								$user           = get_user_by( 'email', $posted['billing_email'] );
1637
								if ( $user ) {
1638
									$usage_count = sizeof( array_keys( $used_by, $user->ID ) );
1639
								} else {
1640
									$usage_count = 0;
1641
								}
1642
							}
1643
1644
							foreach ( $check_emails as $check_email ) {
1645
								$usage_count = $usage_count + sizeof( array_keys( $used_by, $check_email ) );
1646
							}
1647
1648 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...
1649
								$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_USAGE_LIMIT_REACHED );
1650
1651
								// Remove the coupon
1652
								$this->remove_coupon( $code );
1653
1654
								// Flag totals for refresh
1655
								WC()->session->set( 'refresh_totals', true );
1656
							}
1657
						}
1658
					}
1659
				}
1660
			}
1661
		}
1662
1663
		/**
1664
		 * Returns whether or not a discount has been applied.
1665
		 * @param string $coupon_code
1666
		 * @return bool
1667
		 */
1668
		public function has_discount( $coupon_code = '' ) {
1669
			return $coupon_code ? in_array( apply_filters( 'woocommerce_coupon_code', $coupon_code ), $this->applied_coupons ) : sizeof( $this->applied_coupons ) > 0;
1670
		}
1671
1672
		/**
1673
		 * Applies a coupon code passed to the method.
1674
		 *
1675
		 * @param string $coupon_code - The code to apply
1676
		 * @return bool	True if the coupon is applied, false if it does not exist or cannot be applied
1677
		 */
1678
		public function add_discount( $coupon_code ) {
1679
			// Coupons are globally disabled
1680
			if ( ! wc_coupons_enabled() ) {
1681
				return false;
1682
			}
1683
1684
			// Sanitize coupon code
1685
			$coupon_code = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1686
1687
			// Get the coupon
1688
			$the_coupon = new WC_Coupon( $coupon_code );
1689
1690
			// Check it can be used with cart
1691
			if ( ! $the_coupon->is_valid() ) {
1692
				wc_add_notice( $the_coupon->get_error_message(), 'error' );
1693
				return false;
1694
			}
1695
1696
			// Check if applied
1697
			if ( $this->has_discount( $coupon_code ) ) {
1698
				$the_coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED );
1699
				return false;
1700
			}
1701
1702
			// If its individual use then remove other coupons
1703
			if ( $the_coupon->individual_use == 'yes' ) {
1704
				$this->applied_coupons = apply_filters( 'woocommerce_apply_individual_use_coupon', array(), $the_coupon, $this->applied_coupons );
1705
			}
1706
1707
			if ( $this->applied_coupons ) {
1708
				foreach ( $this->applied_coupons as $code ) {
1709
					$coupon = new WC_Coupon( $code );
1710
1711
					if ( $coupon->individual_use == 'yes' && false === apply_filters( 'woocommerce_apply_with_individual_use_coupon', false, $the_coupon, $coupon, $this->applied_coupons ) ) {
1712
1713
						// Reject new coupon
1714
						$coupon->add_coupon_message( WC_Coupon::E_WC_COUPON_ALREADY_APPLIED_INDIV_USE_ONLY );
1715
1716
						return false;
1717
					}
1718
				}
1719
			}
1720
1721
			$this->applied_coupons[] = $coupon_code;
1722
1723
			// Choose free shipping
1724
			if ( $the_coupon->enable_free_shipping() ) {
1725
				$packages = WC()->shipping->get_packages();
1726
				$chosen_shipping_methods = WC()->session->get( 'chosen_shipping_methods' );
1727
1728
				foreach ( $packages as $i => $package ) {
1729
					$chosen_shipping_methods[ $i ] = 'free_shipping';
1730
				}
1731
1732
				WC()->session->set( 'chosen_shipping_methods', $chosen_shipping_methods );
1733
			}
1734
1735
			$the_coupon->add_coupon_message( WC_Coupon::WC_COUPON_SUCCESS );
1736
1737
			do_action( 'woocommerce_applied_coupon', $coupon_code );
1738
1739
			return true;
1740
		}
1741
1742
		/**
1743
		 * Get array of applied coupon objects and codes.
1744
		 * @return array of applied coupons
1745
		 */
1746
		public function get_coupons( $deprecated = null ) {
1747
			$coupons = array();
1748
1749
			if ( 'order' === $deprecated ) {
1750
				return $coupons;
1751
			}
1752
1753
			foreach ( $this->get_applied_coupons() as $code ) {
1754
				$coupon = new WC_Coupon( $code );
1755
				$coupons[ $code ] = $coupon;
1756
			}
1757
1758
			return $coupons;
1759
		}
1760
1761
		/**
1762
		 * Gets the array of applied coupon codes.
1763
		 *
1764
		 * @return array of applied coupons
1765
		 */
1766
		public function get_applied_coupons() {
1767
			return $this->applied_coupons;
1768
		}
1769
1770
		/**
1771
		 * Get the discount amount for a used coupon.
1772
		 * @param  string $code coupon code
1773
		 * @param  bool inc or ex tax
1774
		 * @return float discount amount
1775
		 */
1776
		public function get_coupon_discount_amount( $code, $ex_tax = true ) {
1777
			$discount_amount = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] : 0;
1778
1779
			if ( ! $ex_tax ) {
1780
				$discount_amount += $this->get_coupon_discount_tax_amount( $code );
1781
			}
1782
1783
			return wc_cart_round_discount( $discount_amount, $this->dp );
1784
		}
1785
1786
		/**
1787
		 * Get the discount tax amount for a used coupon (for tax inclusive prices).
1788
		 * @param  string $code coupon code
1789
		 * @param  bool inc or ex tax
1790
		 * @return float discount amount
1791
		 */
1792
		public function get_coupon_discount_tax_amount( $code ) {
1793
			return wc_cart_round_discount( isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] : 0, $this->dp );
1794
		}
1795
1796
		/**
1797
		 * Remove coupons from the cart of a defined type. Type 1 is before tax, type 2 is after tax.
1798
		 */
1799
		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...
1800
			$this->applied_coupons = $this->coupon_discount_amounts = $this->coupon_discount_tax_amounts = $this->coupon_applied_count = array();
1801
			WC()->session->set( 'applied_coupons', array() );
1802
			WC()->session->set( 'coupon_discount_amounts', array() );
1803
			WC()->session->set( 'coupon_discount_tax_amounts', array() );
1804
		}
1805
1806
		/**
1807
		 * Remove a single coupon by code.
1808
		 * @param  string $coupon_code Code of the coupon to remove
1809
		 * @return bool
1810
		 */
1811
		public function remove_coupon( $coupon_code ) {
1812
			// Coupons are globally disabled
1813
			if ( ! wc_coupons_enabled() ) {
1814
				return false;
1815
			}
1816
1817
			// Get the coupon
1818
			$coupon_code  = apply_filters( 'woocommerce_coupon_code', $coupon_code );
1819
			$position     = array_search( $coupon_code, $this->applied_coupons );
1820
1821
			if ( $position !== false ) {
1822
				unset( $this->applied_coupons[ $position ] );
1823
			}
1824
1825
			WC()->session->set( 'applied_coupons', $this->applied_coupons );
1826
1827
			do_action( 'woocommerce_removed_coupon', $coupon_code );
1828
1829
			return true;
1830
		}
1831
1832
		/**
1833
		 * Function to apply discounts to a product and get the discounted price (before tax is applied).
1834
		 *
1835
		 * @param mixed $values
1836
		 * @param mixed $price
1837
		 * @param bool $add_totals (default: false)
1838
		 * @return float price
1839
		 */
1840
		public function get_discounted_price( $values, $price, $add_totals = false ) {
1841
			if ( ! $price ) {
1842
				return $price;
1843
			}
1844
1845
			$undiscounted_price = $price;
1846
1847
			if ( ! empty( $this->coupons ) ) {
1848
				$product = $values['data'];
1849
1850
				foreach ( $this->coupons as $code => $coupon ) {
1851
					if ( $coupon->is_valid() && ( $coupon->is_valid_for_product( $product, $values ) || $coupon->is_valid_for_cart() ) ) {
1852
						$discount_amount = $coupon->get_discount_amount( 'yes' === get_option( 'woocommerce_calc_discounts_sequentially', 'no' ) ? $price : $undiscounted_price, $values, true );
1853
						$discount_amount = min( $price, $discount_amount );
1854
						$price           = max( $price - $discount_amount, 0 );
1855
1856
						// Store the totals for DISPLAY in the cart
1857
						if ( $add_totals ) {
1858
							$total_discount     = $discount_amount * $values['quantity'];
1859
							$total_discount_tax = 0;
1860
1861
							if ( wc_tax_enabled() ) {
1862
								$tax_rates          = WC_Tax::get_rates( $product->get_tax_class() );
1863
								$taxes              = WC_Tax::calc_tax( $discount_amount, $tax_rates, $this->prices_include_tax );
1864
								$total_discount_tax = WC_Tax::get_tax_total( $taxes ) * $values['quantity'];
1865
								$total_discount     = $this->prices_include_tax ? $total_discount - $total_discount_tax : $total_discount;
1866
								$this->discount_cart_tax += $total_discount_tax;
1867
							}
1868
1869
							$this->discount_cart     += $total_discount;
1870
							$this->increase_coupon_discount_amount( $code, $total_discount, $total_discount_tax );
1871
							$this->increase_coupon_applied_count( $code, $values['quantity'] );
1872
						}
1873
					}
1874
1875
					// If the price is 0, we can stop going through coupons because there is nothing more to discount for this product.
1876
					if ( 0 >= $price ) {
1877
						break;
1878
					}
1879
				}
1880
			}
1881
1882
			return apply_filters( 'woocommerce_get_discounted_price', $price, $values, $this );
1883
		}
1884
1885
		/**
1886
		 * Store how much discount each coupon grants.
1887
		 *
1888
		 * @access private
1889
		 * @param string $code
1890
		 * @param double $amount
1891
		 * @param double $tax
1892
		 */
1893
		private function increase_coupon_discount_amount( $code, $amount, $tax ) {
1894
			$this->coupon_discount_amounts[ $code ]     = isset( $this->coupon_discount_amounts[ $code ] ) ? $this->coupon_discount_amounts[ $code ] + $amount : $amount;
1895
			$this->coupon_discount_tax_amounts[ $code ] = isset( $this->coupon_discount_tax_amounts[ $code ] ) ? $this->coupon_discount_tax_amounts[ $code ] + $tax : $tax;
1896
		}
1897
1898
		/**
1899
		 * Store how many times each coupon is applied to cart/items.
1900
		 *
1901
		 * @access private
1902
		 * @param string $code
1903
		 * @param int    $count
1904
		 */
1905
		private function increase_coupon_applied_count( $code, $count = 1 ) {
1906
			if ( empty( $this->coupon_applied_count[ $code ] ) ) {
1907
				$this->coupon_applied_count[ $code ] = 0;
1908
			}
1909
			$this->coupon_applied_count[ $code ] += $count;
1910
		}
1911
1912
	/*-----------------------------------------------------------------------------------*/
1913
	/* Fees API to add additional costs to orders */
1914
	/*-----------------------------------------------------------------------------------*/
1915
1916
		/**
1917
		 * Add additional fee to the cart.
1918
		 *
1919
		 * @param string $name Unique name for the fee. Multiple fees of the same name cannot be added.
1920
		 * @param float $amount Fee amount.
1921
		 * @param bool $taxable (default: false) Is the fee taxable?
1922
		 * @param string $tax_class (default: '') The tax class for the fee if taxable. A blank string is standard tax class.
1923
		 */
1924
		public function add_fee( $name, $amount, $taxable = false, $tax_class = '' ) {
1925
1926
			$new_fee_id = sanitize_title( $name );
1927
1928
			// Only add each fee once
1929
			foreach ( $this->fees as $fee ) {
1930
				if ( $fee->id == $new_fee_id ) {
1931
					return;
1932
				}
1933
			}
1934
1935
			$new_fee            = new stdClass();
1936
			$new_fee->id        = $new_fee_id;
1937
			$new_fee->name      = esc_attr( $name );
1938
			$new_fee->amount    = (float) esc_attr( $amount );
1939
			$new_fee->tax_class = $tax_class;
1940
			$new_fee->taxable   = $taxable ? true : false;
1941
			$new_fee->tax       = 0;
1942
			$new_fee->tax_data  = array();
1943
			$this->fees[]       = $new_fee;
1944
		}
1945
1946
		/**
1947
		 * Get fees.
1948
		 *
1949
		 * @return array
1950
		 */
1951
		public function get_fees() {
1952
			return array_filter( (array) $this->fees );
1953
		}
1954
1955
		/**
1956
		 * Calculate fees.
1957
		 */
1958
		public function calculate_fees() {
1959
			// Reset fees before calculation
1960
			$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...
1961
			$this->fees      = array();
1962
1963
			// Fire an action where developers can add their fees
1964
			do_action( 'woocommerce_cart_calculate_fees', $this );
1965
1966
			// If fees were added, total them and calculate tax
1967
			if ( ! empty( $this->fees ) ) {
1968
				foreach ( $this->fees as $fee_key => $fee ) {
1969
					$this->fee_total += $fee->amount;
1970
1971
					if ( $fee->taxable ) {
1972
						// Get tax rates
1973
						$tax_rates = WC_Tax::get_rates( $fee->tax_class );
1974
						$fee_taxes = WC_Tax::calc_tax( $fee->amount, $tax_rates, false );
1975
1976
						if ( ! empty( $fee_taxes ) ) {
1977
							// Set the tax total for this fee
1978
							$this->fees[ $fee_key ]->tax = array_sum( $fee_taxes );
1979
1980
							// Set tax data - Since 2.2
1981
							$this->fees[ $fee_key ]->tax_data = $fee_taxes;
1982
1983
							// Tax rows - merge the totals we just got
1984 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...
1985
								$this->taxes[ $key ] = ( isset( $fee_taxes[ $key ] ) ? $fee_taxes[ $key ] : 0 ) + ( isset( $this->taxes[ $key ] ) ? $this->taxes[ $key ] : 0 );
1986
							}
1987
						}
1988
					}
1989
				}
1990
			}
1991
		}
1992
1993
	/*-----------------------------------------------------------------------------------*/
1994
	/* Get Formatted Totals */
1995
	/*-----------------------------------------------------------------------------------*/
1996
1997
		/**
1998
		 * Gets the order total (after calculation).
1999
		 *
2000
		 * @return string formatted price
2001
		 */
2002
		public function get_total() {
2003
			return apply_filters( 'woocommerce_cart_total', wc_price( $this->total ) );
2004
		}
2005
2006
		/**
2007
		 * Gets the total excluding taxes.
2008
		 *
2009
		 * @return string formatted price
2010
		 */
2011
		public function get_total_ex_tax() {
2012
			$total = $this->total - $this->tax_total - $this->shipping_tax_total;
2013
			if ( $total < 0 ) {
2014
				$total = 0;
2015
			}
2016
			return apply_filters( 'woocommerce_cart_total_ex_tax', wc_price( $total ) );
2017
		}
2018
2019
		/**
2020
		 * Gets the cart contents total (after calculation).
2021
		 *
2022
		 * @return string formatted price
2023
		 */
2024
		public function get_cart_total() {
2025
			if ( ! $this->prices_include_tax ) {
2026
				$cart_contents_total = wc_price( $this->cart_contents_total );
2027
			} else {
2028
				$cart_contents_total = wc_price( $this->cart_contents_total + $this->tax_total );
2029
			}
2030
2031
			return apply_filters( 'woocommerce_cart_contents_total', $cart_contents_total );
2032
		}
2033
2034
		/**
2035
		 * Gets the sub total (after calculation).
2036
		 *
2037
		 * @params bool whether to include compound taxes
2038
		 * @return string formatted price
2039
		 */
2040
		public function get_cart_subtotal( $compound = false ) {
2041
2042
			// If the cart has compound tax, we want to show the subtotal as
2043
			// cart + shipping + non-compound taxes (after discount)
2044
			if ( $compound ) {
2045
2046
				$cart_subtotal = wc_price( $this->cart_contents_total + $this->shipping_total + $this->get_taxes_total( false, false ) );
2047
2048
			// Otherwise we show cart items totals only (before discount)
2049
			} else {
2050
2051
				// Display varies depending on settings
2052
				if ( $this->tax_display_cart == 'excl' ) {
2053
2054
					$cart_subtotal = wc_price( $this->subtotal_ex_tax );
2055
2056
					if ( $this->tax_total > 0 && $this->prices_include_tax ) {
2057
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2058
					}
2059
2060
				} else {
2061
2062
					$cart_subtotal = wc_price( $this->subtotal );
2063
2064
					if ( $this->tax_total > 0 && !$this->prices_include_tax ) {
2065
						$cart_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2066
					}
2067
2068
				}
2069
			}
2070
2071
			return apply_filters( 'woocommerce_cart_subtotal', $cart_subtotal, $compound, $this );
2072
		}
2073
2074
		/**
2075
		 * Get the product row price per item.
2076
		 *
2077
		 * @param WC_Product $_product
2078
		 * @return string formatted price
2079
		 */
2080
		public function get_product_price( $_product ) {
2081
			if ( $this->tax_display_cart == 'excl' ) {
2082
				$product_price = $_product->get_price_excluding_tax();
2083
			} else {
2084
				$product_price = $_product->get_price_including_tax();
2085
			}
2086
2087
			return apply_filters( 'woocommerce_cart_product_price', wc_price( $product_price ), $_product );
2088
		}
2089
2090
		/**
2091
		 * Get the product row subtotal.
2092
		 *
2093
		 * Gets the tax etc to avoid rounding issues.
2094
		 *
2095
		 * When on the checkout (review order), this will get the subtotal based on the customer's tax rate rather than the base rate.
2096
		 *
2097
		 * @param WC_Product $_product
2098
		 * @param int quantity
2099
		 * @return string formatted price
2100
		 */
2101
		public function get_product_subtotal( $_product, $quantity ) {
2102
2103
			$price 			= $_product->get_price();
2104
			$taxable 		= $_product->is_taxable();
2105
2106
			// Taxable
2107
			if ( $taxable ) {
2108
2109
				if ( $this->tax_display_cart == 'excl' ) {
2110
2111
					$row_price        = $_product->get_price_excluding_tax( $quantity );
2112
					$product_subtotal = wc_price( $row_price );
2113
2114
					if ( $this->prices_include_tax && $this->tax_total > 0 ) {
2115
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
2116
					}
2117
2118
				} else {
2119
2120
					$row_price        = $_product->get_price_including_tax( $quantity );
2121
					$product_subtotal = wc_price( $row_price );
2122
2123
					if ( ! $this->prices_include_tax && $this->tax_total > 0 ) {
2124
						$product_subtotal .= ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>';
2125
					}
2126
2127
				}
2128
2129
			// Non-taxable
2130
			} else {
2131
2132
				$row_price        = $price * $quantity;
2133
				$product_subtotal = wc_price( $row_price );
2134
2135
			}
2136
2137
			return apply_filters( 'woocommerce_cart_product_subtotal', $product_subtotal, $_product, $quantity, $this );
2138
		}
2139
2140
		/**
2141
		 * Gets the cart tax (after calculation).
2142
		 *
2143
		 * @return string formatted price
2144
		 */
2145
		public function get_cart_tax() {
2146
			$cart_total_tax = wc_round_tax_total( $this->tax_total + $this->shipping_tax_total );
2147
2148
			return apply_filters( 'woocommerce_get_cart_tax', $cart_total_tax ? wc_price( $cart_total_tax ) : '' );
2149
		}
2150
2151
		/**
2152
		 * Get a tax amount.
2153
		 * @param  string $tax_rate_id
2154
		 * @return float amount
2155
		 */
2156
		public function get_tax_amount( $tax_rate_id ) {
2157
			return isset( $this->taxes[ $tax_rate_id ] ) ? $this->taxes[ $tax_rate_id ] : 0;
2158
		}
2159
2160
		/**
2161
		 * Get a tax amount.
2162
		 * @param  string $tax_rate_id
2163
		 * @return float amount
2164
		 */
2165
		public function get_shipping_tax_amount( $tax_rate_id ) {
2166
			return isset( $this->shipping_taxes[ $tax_rate_id ] ) ? $this->shipping_taxes[ $tax_rate_id ] : 0;
2167
		}
2168
2169
		/**
2170
		 * Get tax row amounts with or without compound taxes includes.
2171
		 *
2172
		 * @param  bool $compound True if getting compound taxes
2173
		 * @param  bool $display  True if getting total to display
2174
		 * @return float price
2175
		 */
2176
		public function get_taxes_total( $compound = true, $display = true ) {
2177
			$total = 0;
2178 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...
2179
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2180
				$total += $tax;
2181
			}
2182 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...
2183
				if ( ! $compound && WC_Tax::is_compound( $key ) ) continue;
2184
				$total += $tax;
2185
			}
2186
			if ( $display ) {
2187
				$total = wc_round_tax_total( $total );
2188
			}
2189
			return apply_filters( 'woocommerce_cart_taxes_total', $total, $compound, $display, $this );
2190
		}
2191
2192
		/**
2193
		 * Get the total of all cart discounts.
2194
		 *
2195
		 * @return float
2196
		 */
2197
		public function get_cart_discount_total() {
2198
			return wc_cart_round_discount( $this->discount_cart, $this->dp );
2199
		}
2200
2201
		/**
2202
		 * Get the total of all cart tax discounts (used for discounts on tax inclusive prices).
2203
		 *
2204
		 * @return float
2205
		 */
2206
		public function get_cart_discount_tax_total() {
2207
			return wc_cart_round_discount( $this->discount_cart_tax, $this->dp );
2208
		}
2209
2210
		/**
2211
		 * Gets the total discount amount - both kinds.
2212
		 *
2213
		 * @return mixed formatted price or false if there are none
2214
		 */
2215
		public function get_total_discount() {
2216
			if ( $this->get_cart_discount_total() ) {
2217
				$total_discount = wc_price( $this->get_cart_discount_total() );
2218
			} else {
2219
				$total_discount = false;
2220
			}
2221
			return apply_filters( 'woocommerce_cart_total_discount', $total_discount, $this );
2222
		}
2223
2224
		/**
2225
		 * Gets the total (product) discount amount - these are applied before tax.
2226
		 *
2227
		 * @deprecated Order discounts (after tax) removed in 2.3 so multiple methods for discounts are no longer required.
2228
		 * @return mixed formatted price or false if there are none
2229
		 */
2230
		public function get_discounts_before_tax() {
2231
			_deprecated_function( 'get_discounts_before_tax', '2.3', 'get_total_discount' );
2232
			if ( $this->get_cart_discount_total() ) {
2233
				$discounts_before_tax = wc_price( $this->get_cart_discount_total() );
2234
			} else {
2235
				$discounts_before_tax = false;
2236
			}
2237
			return apply_filters( 'woocommerce_cart_discounts_before_tax', $discounts_before_tax, $this );
2238
		}
2239
2240
		/**
2241
		 * Get the total of all order discounts (after tax discounts).
2242
		 *
2243
		 * @deprecated Order discounts (after tax) removed in 2.3
2244
		 * @return int
2245
		 */
2246
		public function get_order_discount_total() {
2247
			_deprecated_function( 'get_order_discount_total', '2.3' );
2248
			return 0;
2249
		}
2250
2251
		/**
2252
		 * Function to apply cart discounts after tax.
2253
 		 * @deprecated Coupons can not be applied after tax
2254
		 */
2255
		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...
2256
			_deprecated_function( 'apply_cart_discounts_after_tax', '2.3' );
2257
		}
2258
2259
		/**
2260
		 * Function to apply product discounts after tax.
2261
		 * @deprecated Coupons can not be applied after tax
2262
		 */
2263
		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...
2264
			_deprecated_function( 'apply_product_discounts_after_tax', '2.3' );
2265
		}
2266
2267
		/**
2268
		 * Gets the order discount amount - these are applied after tax.
2269
		 * @deprecated Coupons can not be applied after tax
2270
		 */
2271
		public function get_discounts_after_tax() {
2272
			_deprecated_function( 'get_discounts_after_tax', '2.3' );
2273
		}
2274
}
2275