class-wc-cart-session.php — WooCommerce 3.3.0

woocommerce / includes / class-wc-cart-session.php

woocommerce / includes Last commit date

class-wc-cart-session.php

220 lines

1	<?php
2	/**
3	* Cart session handling class.
4	*
5	* @author Automattic
6	* @package WooCommerce/Classes
7	*/
8
9	if ( ! defined( 'ABSPATH' ) ) {
10	exit;
11	}
12
13	/**
14	* WC_Cart_Session class.
15	*
16	* @since 3.2.0
17	*/
18	final class WC_Cart_Session {
19
20	/**
21	* Reference to cart object.
22	*
23	* @since 3.2.0
24	* @var WC_Cart
25	*/
26	protected $cart;
27
28	/**
29	* Sets up the items provided, and calculate totals.
30	*
31	* @since 3.2.0
32	* @throws Exception If missing WC_Cart object.
33	* @param WC_Cart $cart Cart object to calculate totals for.
34	*/
35	public function __construct( &$cart ) {
36	if ( ! is_a( $cart, 'WC_Cart' ) ) {
37	throw new Exception( 'A valid WC_Cart object is required' );
38	}
39
40	$this->cart = $cart;
41	}
42
43	/**
44	* Register methods for this object on the appropriate WordPress hooks.
45	*/
46	public function init() {
47	add_action( 'wp_loaded', array( $this, 'get_cart_from_session' ) );
48	add_action( 'woocommerce_cart_emptied', array( $this, 'destroy_cart_session' ) );
49	add_action( 'wp', array( $this, 'maybe_set_cart_cookies' ), 99 );
50	add_action( 'shutdown', array( $this, 'maybe_set_cart_cookies' ), 0 );
51	add_action( 'woocommerce_add_to_cart', array( $this, 'maybe_set_cart_cookies' ) );
52	add_action( 'woocommerce_after_calculate_totals', array( $this, 'set_session' ) );
53	add_action( 'woocommerce_cart_loaded_from_session', array( $this, 'set_session' ) );
54	add_action( 'woocommerce_removed_coupon', array( $this, 'set_session' ) );
55	add_action( 'woocommerce_cart_updated', array( $this, 'persistent_cart_update' ) );
56	}
57
58	/**
59	* Get the cart data from the PHP session and store it in class variables.
60	*
61	* @since 3.2.0
62	*/
63	public function get_cart_from_session() {
64	$update_cart_session = false;
65	$totals = WC()->session->get( 'cart_totals', null );
66	$cart = WC()->session->get( 'cart', null );
67
68	$this->cart->set_totals( $totals );
69	$this->cart->set_applied_coupons( WC()->session->get( 'applied_coupons', array() ) );
70	$this->cart->set_coupon_discount_totals( WC()->session->get( 'coupon_discount_totals', array() ) );
71	$this->cart->set_coupon_discount_tax_totals( WC()->session->get( 'coupon_discount_tax_totals', array() ) );
72	$this->cart->set_removed_cart_contents( WC()->session->get( 'removed_cart_contents', array() ) );
73
74	if ( is_null( $cart ) && ( $saved_cart = get_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id(), true ) ) ) { // @codingStandardsIgnoreLine
75	$cart = $saved_cart['cart'];
76	$update_cart_session = true;
77	} elseif ( is_null( $cart ) ) {
78	$cart = array();
79	} elseif ( is_array( $cart ) && ( $saved_cart = get_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id(), true ) ) ) { // @codingStandardsIgnoreLine
80	$cart = array_merge( $saved_cart['cart'], $cart );
81	$update_cart_session = true;
82	}
83
84	if ( is_array( $cart ) ) {
85	$cart_contents = array();
86
87	update_meta_cache( 'post', wp_list_pluck( $cart, 'product_id' ) ); // Prime meta cache to reduce future queries.
88	update_object_term_cache( wp_list_pluck( $cart, 'product_id' ), 'product' );
89
90	foreach ( $cart as $key => $values ) {
91	$product = wc_get_product( $values['variation_id'] ? $values['variation_id'] : $values['product_id'] );
92
93	if ( ! empty( $product ) && $product->exists() && $values['quantity'] > 0 ) {
94
95	if ( ! $product->is_purchasable() ) {
96	$update_cart_session = true; // Flag to indicate the stored cart should be updated.
97	/* translators: %s: product name */
98	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_name() ), 'error' );
99	do_action( 'woocommerce_remove_cart_item_from_session', $key, $values );
100
101	} else {
102	// Put session data into array. Run through filter so other plugins can load their own session data.
103	$session_data = array_merge( $values, array(
104	'data' => $product,
105	) );
106	$cart_contents[ $key ] = apply_filters( 'woocommerce_get_cart_item_from_session', $session_data, $values, $key );
107
108	// Add to cart right away so the product is visible in woocommerce_get_cart_item_from_session hook.
109	$this->cart->set_cart_contents( $cart_contents );
110	}
111	}
112	}
113	}
114
115	do_action( 'woocommerce_cart_loaded_from_session', $this->cart );
116
117	if ( $update_cart_session \|\| is_null( WC()->session->get( 'cart_totals', null ) ) ) {
118	WC()->session->set( 'cart', $this->get_cart_for_session() );
119	$this->cart->calculate_totals();
120	}
121	}
122
123	/**
124	* Destroy cart session data.
125	*
126	* @since 3.2.0
127	*/
128	public function destroy_cart_session() {
129	WC()->session->set( 'cart', null );
130	WC()->session->set( 'cart_totals', null );
131	WC()->session->set( 'applied_coupons', null );
132	WC()->session->set( 'coupon_discount_totals', null );
133	WC()->session->set( 'coupon_discount_tax_totals', null );
134	WC()->session->set( 'removed_cart_contents', null );
135	WC()->session->set( 'order_awaiting_payment', null );
136	}
137
138	/**
139	* Will set cart cookies if needed and when possible.
140	*
141	* @since 3.2.0
142	*/
143	public function maybe_set_cart_cookies() {
144	if ( ! headers_sent() && did_action( 'wp_loaded' ) ) {
145	if ( ! $this->cart->is_empty() ) {
146	$this->set_cart_cookies( true );
147	} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) {
148	$this->set_cart_cookies( false );
149	}
150	}
151	}
152
153	/**
154	* Sets the php session data for the cart and coupons.
155	*/
156	public function set_session() {
157	WC()->session->set( 'cart', $this->get_cart_for_session() );
158	WC()->session->set( 'cart_totals', $this->cart->get_totals() );
159	WC()->session->set( 'applied_coupons', $this->cart->get_applied_coupons() );
160	WC()->session->set( 'coupon_discount_totals', $this->cart->get_coupon_discount_totals() );
161	WC()->session->set( 'coupon_discount_tax_totals', $this->cart->get_coupon_discount_tax_totals() );
162	WC()->session->set( 'removed_cart_contents', $this->cart->get_removed_cart_contents() );
163
164	do_action( 'woocommerce_cart_updated' );
165	}
166
167	/**
168	* Returns the contents of the cart in an array without the 'data' element.
169	*
170	* @return array contents of the cart
171	*/
172	public function get_cart_for_session() {
173	$cart_session = array();
174
175	foreach ( $this->cart->get_cart() as $key => $values ) {
176	$cart_session[ $key ] = $values;
177	unset( $cart_session[ $key ]['data'] ); // Unset product object.
178	}
179
180	return $cart_session;
181	}
182
183	/**
184	* Save the persistent cart when the cart is updated.
185	*/
186	public function persistent_cart_update() {
187	if ( get_current_user_id() ) {
188	update_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id(), array(
189	'cart' => $this->get_cart_for_session(),
190	) );
191	}
192	}
193
194	/**
195	* Delete the persistent cart permanently.
196	*/
197	public function persistent_cart_destroy() {
198	if ( get_current_user_id() ) {
199	delete_user_meta( get_current_user_id(), '_woocommerce_persistent_cart_' . get_current_blog_id() );
200	}
201	}
202
203	/**
204	* Set cart hash cookie and items in cart.
205	*
206	* @access private
207	* @param bool $set Should cookies be set (true) or unset.
208	*/
209	private function set_cart_cookies( $set = true ) {
210	if ( $set ) {
211	wc_setcookie( 'woocommerce_items_in_cart', 1 );
212	wc_setcookie( 'woocommerce_cart_hash', md5( wp_json_encode( $this->get_cart_for_session() ) ) );
213	} elseif ( isset( $_COOKIE['woocommerce_items_in_cart'] ) ) {
214	wc_setcookie( 'woocommerce_items_in_cart', 0, time() - HOUR_IN_SECONDS );
215	wc_setcookie( 'woocommerce_cart_hash', '', time() - HOUR_IN_SECONDS );
216	}
217	do_action( 'woocommerce_set_cart_cookies', $set );
218	}
219	}
220