ProductsById.php — WooCommerce 10.9.4

woocommerce / src / StoreApi / Routes / V1 / ProductsById.php

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

ProductsById.php

93 lines

1	<?php // phpcs:ignore Generic.PHP.RequireStrictTypes.MissingDeclaration
2	namespace Automattic\WooCommerce\StoreApi\Routes\V1;
3
4	use Automattic\WooCommerce\Enums\ProductStatus;
5	use Automattic\WooCommerce\StoreApi\Exceptions\RouteException;
6	use Automattic\WooCommerce\StoreApi\Utilities\ProductLinksTrait;
7
8	/**
9	* ProductsById class.
10	*/
11	class ProductsById extends AbstractRoute {
12	use ProductLinksTrait;
13
14	/**
15	* The route identifier.
16	*
17	* @var string
18	*/
19	const IDENTIFIER = 'products-by-id';
20
21	/**
22	* The routes schema.
23	*
24	* @var string
25	*/
26	const SCHEMA_TYPE = 'product';
27
28	/**
29	* Get the path of this REST route.
30	*
31	* @return string
32	*/
33	public function get_path() {
34	return self::get_path_regex();
35	}
36
37	/**
38	* Get the path of this rest route.
39	*
40	* @return string
41	*/
42	public static function get_path_regex() {
43	return '/products/(?P<id>[\d]+)';
44	}
45
46	/**
47	* Get method arguments for this REST route.
48	*
49	* @return array An array of endpoints.
50	*/
51	public function get_args() {
52	return [
53	'args' => array(
54	'id' => array(
55	'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
56	'type' => 'integer',
57	),
58	),
59	[
60	'methods' => \WP_REST_Server::READABLE,
61	'callback' => [ $this, 'get_response' ],
62	'permission_callback' => '__return_true',
63	'args' => array(
64	'context' => $this->get_context_param(
65	array(
66	'default' => 'view',
67	)
68	),
69	),
70	'allow_batch' => [ 'v1' => true ],
71	],
72	'schema' => [ $this->schema, 'get_public_item_schema' ],
73	];
74	}
75
76	/**
77	* Get a single item.
78	*
79	* @throws RouteException On error.
80	* @param \WP_REST_Request $request Request object.
81	* @return \WP_REST_Response
82	*/
83	protected function get_route_response( \WP_REST_Request $request ) {
84	$object = wc_get_product( (int) $request['id'] );
85
86	if ( ! $object \|\| 0 === $object->get_id() \|\| ProductStatus::PUBLISH !== $object->get_status() ) {
87	throw new RouteException( 'woocommerce_rest_product_invalid_id', __( 'Invalid product ID.', 'woocommerce' ), 404 );
88	}
89
90	return $this->prepare_item_for_response( $object, $request );
91	}
92	}
93