CartItemSchema.php — WooCommerce 10.9.4

woocommerce / src / StoreApi / Schemas / V1 / CartItemSchema.php

woocommerce / src / StoreApi / Schemas / V1 Last commit date

CartItemSchema.php

199 lines

1	<?php
2	namespace Automattic\WooCommerce\StoreApi\Schemas\V1;
3
4	use Automattic\WooCommerce\StoreApi\Utilities\ProductItemTrait;
5	use Automattic\WooCommerce\StoreApi\Utilities\QuantityLimits;
6
7	/**
8	* CartItemSchema class.
9	*/
10	class CartItemSchema extends ItemSchema {
11	use ProductItemTrait;
12
13	/**
14	* The schema item name.
15	*
16	* @var string
17	*/
18	protected $title = 'cart_item';
19
20	/**
21	* The schema item identifier.
22	*
23	* @var string
24	*/
25	const IDENTIFIER = 'cart-item';
26
27	/**
28	* Convert a WooCommerce cart item to an object suitable for the response.
29	*
30	* @param array $cart_item Cart item array.
31	* @return array
32	*/
33	public function get_item_response( $cart_item ) {
34	$product = $cart_item['data'] ?? false;
35
36	if ( ! $product instanceof \WC_Product ) {
37	return [];
38	}
39
40	/**
41	* Filter the product permalink.
42	*
43	* This is a hook taken from the legacy cart/mini-cart templates that allows the permalink to be changed for a
44	* product. This is specific to the cart endpoint.
45	*
46	* @since 9.9.0
47	*
48	* @param string $product_permalink Product permalink.
49	* @param array $cart_item Cart item array.
50	* @param string $cart_item_key Cart item key.
51	*/
52	$product_permalink = apply_filters( 'woocommerce_cart_item_permalink', $product->get_permalink(), $cart_item, $cart_item['key'] );
53	$price_decimals = wc_get_price_decimals();
54
55	return [
56	'key' => $cart_item['key'],
57	'id' => $product->get_id(),
58	'type' => $product->get_type(),
59	'quantity' => wc_stock_amount( $cart_item['quantity'] ),
60	'quantity_limits' => (object) ( new QuantityLimits() )->get_cart_item_quantity_limits( $cart_item ),
61	'name' => $this->prepare_html_response( $product->get_title() ),
62	'short_description' => $this->prepare_html_response( wc_format_content( wp_kses_post( $product->get_short_description() ) ) ),
63	'description' => $this->prepare_html_response( wc_format_content( wp_kses_post( $product->get_description() ) ) ),
64	'sku' => $this->prepare_html_response( $product->get_sku() ),
65	'low_stock_remaining' => $this->get_low_stock_remaining( $product ),
66	'backorders_allowed' => (bool) $product->backorders_allowed(),
67	'show_backorder_badge' => (bool) $product->backorders_require_notification() && $product->is_on_backorder( $cart_item['quantity'] ),
68	'sold_individually' => $product->is_sold_individually(),
69	'permalink' => $product_permalink,
70	'images' => $this->get_cart_images( $product, $cart_item, $cart_item['key'] ),
71	'variation' => $this->format_variation_data( $cart_item['variation'], $product ),
72	'item_data' => $this->get_item_data( $cart_item ),
73	'prices' => (object) $this->prepare_product_price_response( $product, get_option( 'woocommerce_tax_display_cart' ) ),
74	'totals' => (object) $this->prepare_currency_response(
75	[
76	'line_subtotal' => $this->prepare_money_response( $cart_item['line_subtotal'], $price_decimals ),
77	'line_subtotal_tax' => $this->prepare_money_response( $cart_item['line_subtotal_tax'], $price_decimals ),
78	'line_total' => $this->prepare_money_response( $cart_item['line_total'], $price_decimals ),
79	'line_total_tax' => $this->prepare_money_response( $cart_item['line_tax'], $price_decimals ),
80	]
81	),
82	'catalog_visibility' => $product->get_catalog_visibility(),
83	self::EXTENDING_KEY => $this->get_extended_data( self::IDENTIFIER, $cart_item ),
84	];
85	}
86
87	/**
88	* Get list of product images for the cart item.
89	*
90	* @param \WC_Product $product Product instance.
91	* @param array $cart_item Cart item array.
92	* @param string $cart_item_key Cart item key.
93	* @return array
94	*/
95	protected function get_cart_images( \WC_Product $product, array $cart_item, string $cart_item_key ) {
96	$product_images = $this->get_images( $product );
97
98	/**
99	* Filter the cart product images.
100	*
101	* This hook allows the cart item images to be changed. This is specific to the cart endpoint.
102	*
103	* @param array $product_images Array of image objects, as defined in ImageAttachmentSchema.
104	* @param array $cart_item Cart item array.
105	* @param string $cart_item_key Cart item key.
106	* @since 9.6.0
107	*/
108	$filtered_images = apply_filters( 'woocommerce_store_api_cart_item_images', $product_images, $cart_item, $cart_item_key );
109
110	if ( ! is_array( $filtered_images ) \|\| count( $filtered_images ) === 0 ) {
111	return $product_images;
112	}
113
114	// Return the original images if the filtered image has no ID, or an invalid thumbnail or source URL.
115	$valid_images = array();
116	$logger = wc_get_logger();
117
118	foreach ( $filtered_images as $image ) {
119	// If id is not set then something is wrong with the image, and further logging would break (it uses the ID).
120	if ( ! isset( $image->id ) ) {
121	$logger->warning( 'After passing through woocommerce_cart_item_images filter, one of the images did not have an id property.' );
122	continue;
123	}
124
125	// Check if thumbnail is a valid url.
126	if ( empty( $image->thumbnail ) \|\| ! wp_parse_url( $image->thumbnail, PHP_URL_HOST ) ) {
127	$logger->warning( sprintf( 'After passing through woocommerce_cart_item_images filter, image with id %s did not have a valid thumbnail property.', $image->id ) );
128	continue;
129	}
130
131	// Check if src is a valid url.
132	if ( empty( $image->src ) \|\| ! wp_parse_url( $image->src, PHP_URL_HOST ) ) {
133	$logger->warning( sprintf( 'After passing through woocommerce_cart_item_images filter, image with id %s did not have a valid src property.', $image->id ) );
134	continue;
135	}
136
137	// Image is valid, add to resulting array.
138	$valid_images[] = $image;
139	}
140
141	// If there are no valid images remaining, return original array.
142	if ( count( $valid_images ) === 0 ) {
143	return $product_images;
144	}
145
146	// Return the filtered images.
147	return $valid_images;
148	}
149
150	/**
151	* Format cart item data removing any HTML tag.
152	*
153	* @param array $cart_item Cart item array.
154	* @return array
155	*/
156	protected function get_item_data( $cart_item ) {
157	/**
158	* Filters cart item data.
159	*
160	* Filters the variation option name for custom option slugs.
161	*
162	* @since 4.3.0
163	*
164	* @internal Matches filter name in WooCommerce core.
165	*
166	* @param array $item_data Cart item data. Empty by default.
167	* @param array $cart_item Cart item array.
168	* @return array
169	*/
170	$item_data = apply_filters( 'woocommerce_get_item_data', array(), $cart_item );
171	$clean_item_data = [];
172	foreach ( $item_data as $data ) {
173	// We will check each piece of data in the item data element to ensure it is scalar. Extensions could add arrays
174	// to this, which would cause a fatal in wp_strip_all_tags. If it is not scalar, we will return an empty array,
175	// which will be filtered out in get_item_data (after this function has run).
176	foreach ( $data as $data_value ) {
177	if ( ! is_scalar( $data_value ) ) {
178	continue 2;
179	}
180	}
181	$clean_item_data[] = $this->format_item_data_element( $data );
182	}
183	return $clean_item_data;
184	}
185
186	/**
187	* Remove HTML tags from cart item data and set the `hidden` property to `__experimental_woocommerce_blocks_hidden`.
188	*
189	* @param array $item_data_element Individual element of a cart item data.
190	* @return array
191	*/
192	protected function format_item_data_element( $item_data_element ) {
193	if ( array_key_exists( '__experimental_woocommerce_blocks_hidden', $item_data_element ) ) {
194	$item_data_element['hidden'] = $item_data_element['__experimental_woocommerce_blocks_hidden'];
195	}
196	return array_map( 'wp_kses_post', $item_data_element );
197	}
198	}
199