Order.php — WooCommerce 10.9.4

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

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

Order.php

96 lines

1	<?php
2	namespace Automattic\WooCommerce\StoreApi\Routes\V1;
3
4	use Automattic\WooCommerce\StoreApi\SchemaController;
5	use Automattic\WooCommerce\StoreApi\Schemas\V1\AbstractSchema;
6	use Automattic\WooCommerce\StoreApi\Utilities\OrderController;
7	use Automattic\WooCommerce\StoreApi\Exceptions\RouteException;
8	use Automattic\WooCommerce\StoreApi\Utilities\OrderAuthorizationTrait;
9
10	/**
11	* Order class.
12	*/
13	class Order extends AbstractRoute {
14	use OrderAuthorizationTrait;
15
16	/**
17	* The route identifier.
18	*
19	* @var string
20	*/
21	const IDENTIFIER = 'order';
22
23	/**
24	* The schema item identifier.
25	*
26	* @var string
27	*/
28	const SCHEMA_TYPE = 'order';
29
30	/**
31	* Order controller class instance.
32	*
33	* @var OrderController
34	*/
35	protected $order_controller;
36
37	/**
38	* Constructor.
39	*
40	* @param SchemaController $schema_controller Schema Controller instance.
41	* @param AbstractSchema $schema Schema class for this route.
42	*/
43	public function __construct( SchemaController $schema_controller, AbstractSchema $schema ) {
44	parent::__construct( $schema_controller, $schema );
45	$this->order_controller = new OrderController();
46	}
47
48	/**
49	* Get the path of this REST route.
50	*
51	* @return string
52	*/
53	public function get_path() {
54	return self::get_path_regex();
55	}
56
57	/**
58	* Get the path of this rest route.
59	*
60	* @return string
61	*/
62	public static function get_path_regex() {
63	return '/order/(?P<id>[\d]+)';
64	}
65
66	/**
67	* Get method arguments for this REST route.
68	*
69	* @return array An array of endpoints.
70	*/
71	public function get_args() {
72	return [
73	[
74	'methods' => \WP_REST_Server::READABLE,
75	'callback' => [ $this, 'get_response' ],
76	'permission_callback' => [ $this, 'is_authorized' ],
77	'args' => [
78	'context' => $this->get_context_param( [ 'default' => 'view' ] ),
79	],
80	],
81	'schema' => [ $this->schema, 'get_public_item_schema' ],
82	];
83	}
84
85	/**
86	* Handle the request and return a valid response for this endpoint.
87	*
88	* @param \WP_REST_Request $request Request object.
89	* @return \WP_REST_Response
90	*/
91	protected function get_route_response( \WP_REST_Request $request ) {
92	$order_id = absint( $request['id'] );
93	return rest_ensure_response( $this->schema->get_item_response( wc_get_order( $order_id ) ) );
94	}
95	}
96