ProductCollectionDataSchema.php — WooCommerce 10.9.4

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

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

ProductCollectionDataSchema.php

168 lines

1	<?php
2	namespace Automattic\WooCommerce\StoreApi\Schemas\V1;
3
4	/**
5	* ProductCollectionDataSchema class.
6	*/
7	class ProductCollectionDataSchema extends AbstractSchema {
8	/**
9	* The schema item name.
10	*
11	* @var string
12	*/
13	protected $title = 'product-collection-data';
14
15	/**
16	* The schema item identifier.
17	*
18	* @var string
19	*/
20	const IDENTIFIER = 'product-collection-data';
21
22	/**
23	* Product collection data schema properties.
24	*
25	* @return array
26	*/
27	public function get_properties() {
28	return [
29	'price_range' => [
30	'description' => __( 'Min and max prices found in collection of products, provided using the smallest unit of the currency.', 'woocommerce' ),
31	'type' => [ 'object', 'null' ],
32	'context' => [ 'view', 'edit' ],
33	'readonly' => true,
34	'properties' => array_merge(
35	$this->get_store_currency_properties(),
36	[
37	'min_price' => [
38	'description' => __( 'Min price found in collection of products.', 'woocommerce' ),
39	'type' => 'string',
40	'context' => [ 'view', 'edit' ],
41	'readonly' => true,
42	],
43	'max_price' => [
44	'description' => __( 'Max price found in collection of products.', 'woocommerce' ),
45	'type' => 'string',
46	'context' => [ 'view', 'edit' ],
47	'readonly' => true,
48	],
49	]
50	),
51	],
52	'attribute_counts' => [
53	'description' => __( 'Returns number of products within attribute terms.', 'woocommerce' ),
54	'type' => [ 'array', 'null' ],
55	'context' => [ 'view', 'edit' ],
56	'readonly' => true,
57	'items' => [
58	'type' => 'object',
59	'properties' => [
60	'term' => [
61	'description' => __( 'Term ID', 'woocommerce' ),
62	'type' => 'integer',
63	'context' => [ 'view', 'edit' ],
64	'readonly' => true,
65	],
66	'count' => [
67	'description' => __( 'Number of products.', 'woocommerce' ),
68	'type' => 'integer',
69	'context' => [ 'view', 'edit' ],
70	'readonly' => true,
71	],
72	],
73	],
74	],
75	'rating_counts' => [
76	'description' => __( 'Returns number of products with each average rating.', 'woocommerce' ),
77	'type' => [ 'array', 'null' ],
78	'context' => [ 'view', 'edit' ],
79	'readonly' => true,
80	'items' => [
81	'type' => 'object',
82	'properties' => [
83	'rating' => [
84	'description' => __( 'Average rating', 'woocommerce' ),
85	'type' => 'integer',
86	'context' => [ 'view', 'edit' ],
87	'readonly' => true,
88	],
89	'count' => [
90	'description' => __( 'Number of products.', 'woocommerce' ),
91	'type' => 'integer',
92	'context' => [ 'view', 'edit' ],
93	'readonly' => true,
94	],
95	],
96	],
97	],
98	'stock_status_counts' => [
99	'description' => __( 'Returns number of products with each stock status.', 'woocommerce' ),
100	'type' => [ 'array', 'null' ],
101	'context' => [ 'view', 'edit' ],
102	'readonly' => true,
103	'items' => [
104	'type' => 'object',
105	'properties' => [
106	'status' => [
107	'description' => __( 'Status', 'woocommerce' ),
108	'type' => 'string',
109	'context' => [ 'view', 'edit' ],
110	'readonly' => true,
111	],
112	'count' => [
113	'description' => __( 'Number of products.', 'woocommerce' ),
114	'type' => 'integer',
115	'context' => [ 'view', 'edit' ],
116	'readonly' => true,
117	],
118	],
119	],
120	],
121	'taxonomy_counts' => [
122	'description' => __( 'Returns number of products within taxonomy terms.', 'woocommerce' ),
123	'type' => [ 'array', 'null' ],
124	'context' => [ 'view', 'edit' ],
125	'readonly' => true,
126	'items' => [
127	'type' => 'object',
128	'properties' => [
129	'term' => [
130	'description' => __( 'Term ID', 'woocommerce' ),
131	'type' => 'integer',
132	'context' => [ 'view', 'edit' ],
133	'readonly' => true,
134	],
135	'count' => [
136	'description' => __( 'Number of products.', 'woocommerce' ),
137	'type' => 'integer',
138	'context' => [ 'view', 'edit' ],
139	'readonly' => true,
140	],
141	],
142	],
143	],
144	];
145	}
146
147	/**
148	* Format data.
149	*
150	* @param array $data Collection data to format and return.
151	* @return array
152	*/
153	public function get_item_response( $data ) {
154	return [
155	'price_range' => ! is_null( $data['min_price'] ) && ! is_null( $data['max_price'] ) ? (object) $this->prepare_currency_response(
156	[
157	'min_price' => $this->prepare_money_response( $data['min_price'], wc_get_price_decimals() ),
158	'max_price' => $this->prepare_money_response( $data['max_price'], wc_get_price_decimals() ),
159	]
160	) : null,
161	'attribute_counts' => $data['attribute_counts'],
162	'rating_counts' => $data['rating_counts'],
163	'stock_status_counts' => $data['stock_status_counts'],
164	'taxonomy_counts' => $data['taxonomy_counts'],
165	];
166	}
167	}
168