Product.php — WooCommerce 10.9.3

woocommerce / src / Api / Interfaces / Product.php

woocommerce / src / Api / Interfaces Last commit date

ObjectWithId.php 2 months ago Product.php 2 months ago

Product.php

213 lines

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Automattic\WooCommerce\Api\Interfaces;
6
7	use Automattic\WooCommerce\Api\Attributes\ArrayOf;
8	use Automattic\WooCommerce\Api\Attributes\ConnectionOf;
9	use Automattic\WooCommerce\Api\Attributes\Deprecated;
10	use Automattic\WooCommerce\Api\Attributes\Description;
11	use Automattic\WooCommerce\Api\Attributes\Ignore;
12	use Automattic\WooCommerce\Api\Attributes\Name;
13	use Automattic\WooCommerce\Api\Attributes\Parameter;
14	use Automattic\WooCommerce\Api\Attributes\ParameterDescription;
15	use Automattic\WooCommerce\Api\Attributes\ScalarType;
16	use Automattic\WooCommerce\Api\Enums\Products\ProductStatus;
17	use Automattic\WooCommerce\Api\Enums\Products\ProductType;
18	use Automattic\WooCommerce\Api\Enums\Products\StockStatus;
19	use Automattic\WooCommerce\Api\Pagination\Connection;
20	use Automattic\WooCommerce\Api\Scalars\DateTime;
21	use Automattic\WooCommerce\Api\Types\Products\ProductDimensions;
22	use Automattic\WooCommerce\Api\Types\Products\ProductAttribute;
23	use Automattic\WooCommerce\Api\Types\Products\ProductImage;
24	use Automattic\WooCommerce\Api\Types\Products\ProductReview;
25
26	/**
27	* Interface trait for WooCommerce products.
28	*
29	* Defines the common fields shared by all product types.
30	*/
31	#[Name( 'Product' )]
32	#[Description( 'A WooCommerce product.' )]
33	trait Product {
34	use ObjectWithId;
35
36	/**
37	* The product name.
38	*
39	* @var string
40	*/
41	#[Description( 'The product name.' )]
42	public string $name;
43
44	/**
45	* The product slug.
46	*
47	* @var string
48	*/
49	#[Description( 'The product slug.' )]
50	public string $slug;
51
52	/**
53	* The product SKU.
54	*
55	* @var ?string
56	*/
57	#[Description( 'The product SKU.' )]
58	public ?string $sku;
59
60	/**
61	* The full product description.
62	*
63	* @var string
64	*/
65	#[Description( 'The full product description.' )]
66	public string $description;
67
68	/**
69	* The short product description.
70	*
71	* @var string
72	*/
73	#[Deprecated( 'Use description instead.' )]
74	#[Description( 'The short product description.' )]
75	public string $short_description;
76
77	/**
78	* The product status.
79	*
80	* @var ProductStatus
81	*/
82	#[Description( 'The product status.' )]
83	public ProductStatus $status;
84
85	/**
86	* The raw status as stored in WordPress. Useful when status is OTHER.
87	*
88	* @var string
89	*/
90	#[Description( 'The raw status as stored in WordPress. Useful when status is OTHER (e.g. plugin-added post statuses).' )]
91	public string $raw_status;
92
93	/**
94	* The product type.
95	*
96	* @var ProductType
97	*/
98	#[Description( 'The product type.' )]
99	public ProductType $product_type;
100
101	/**
102	* The raw product type as stored in WooCommerce. Useful when product_type is OTHER.
103	*
104	* @var string
105	*/
106	#[Description( 'The raw product type as stored in WooCommerce. Useful when product_type is OTHER (e.g. plugin-added types like subscription, bundle).' )]
107	public string $raw_product_type;
108
109	/**
110	* The regular price of the product. Null when not set.
111	*
112	* @var ?string
113	*/
114	#[Description( 'The regular price of the product. Null when not set.' )]
115	#[Parameter( name: 'formatted', type: 'bool', default: true, description: 'Whether to apply currency formatting.' )]
116	public ?string $regular_price;
117
118	/**
119	* The sale price of the product.
120	*
121	* @var ?string
122	*/
123	#[Description( 'The sale price of the product.' )]
124	#[Parameter( name: 'formatted', type: 'bool', default: true )]
125	#[ParameterDescription( name: 'formatted', description: 'When true, returns price with currency symbol.' )]
126	public ?string $sale_price;
127
128	/**
129	* The stock status of the product.
130	*
131	* @var StockStatus
132	*/
133	#[Description( 'The stock status of the product.' )]
134	public StockStatus $stock_status;
135
136	/**
137	* The raw stock status as stored in WooCommerce. Useful when stock_status is OTHER.
138	*
139	* @var string
140	*/
141	#[Description( 'The raw stock status as stored in WooCommerce. Useful when stock_status is OTHER (e.g. plugin-added statuses).' )]
142	public string $raw_stock_status;
143
144	/**
145	* The number of items in stock.
146	*
147	* @var ?int
148	*/
149	#[Description( 'The number of items in stock.' )]
150	public ?int $stock_quantity;
151
152	/**
153	* The product dimensions.
154	*
155	* @var ?ProductDimensions
156	*/
157	#[Description( 'The product dimensions.' )]
158	public ?ProductDimensions $dimensions;
159
160	/**
161	* The product images.
162	*
163	* @var ProductImage[]
164	*/
165	#[Description( 'The product images.' )]
166	#[ArrayOf( ProductImage::class )]
167	public array $images;
168
169	/**
170	* The product attributes.
171	*
172	* @var ProductAttribute[]
173	*/
174	#[Description( 'The product attributes.' )]
175	#[ArrayOf( ProductAttribute::class )]
176	public array $attributes;
177
178	/**
179	* Customer reviews for this product.
180	*
181	* @var Connection
182	*/
183	#[Description( 'Customer reviews for this product.' )]
184	#[ConnectionOf( ProductReview::class )]
185	public Connection $reviews;
186
187	/**
188	* The date the product was created.
189	*
190	* @var ?string
191	*/
192	#[Description( 'The date the product was created.' )]
193	#[ScalarType( DateTime::class )]
194	public ?string $date_created;
195
196	/**
197	* The date the product was last modified.
198	*
199	* @var ?string
200	*/
201	#[Description( 'The date the product was last modified.' )]
202	#[ScalarType( DateTime::class )]
203	public ?string $date_modified;
204
205	/**
206	* Internal notes (ignored in schema).
207	*
208	* @var ?string
209	*/
210	#[Ignore]
211	public ?string $internal_notes;
212	}
213