RoutesController.php — WooCommerce 10.9.1

woocommerce / src / StoreApi / RoutesController.php

woocommerce / src / StoreApi Last commit date

Exceptions 2 years ago Formatters 1 year ago Payments 4 months ago Routes 4 weeks ago Schemas 4 weeks ago Utilities 4 weeks ago Authentication.php 4 months ago Formatters.php 2 years ago Legacy.php 1 year ago RoutesController.php 4 weeks ago SchemaController.php 4 weeks ago SessionHandler.php 3 months ago StoreApi.php 4 months ago deprecated.php 2 years ago functions.php 2 years ago

RoutesController.php

187 lines

1	<?php
2	declare( strict_types = 1 );
3
4	namespace Automattic\WooCommerce\StoreApi;
5
6	use Automattic\WooCommerce\Internal\ShopperLists\ShopperListsController;
7	use Automattic\WooCommerce\StoreApi\Routes\V1\AbstractRoute;
8	use Automattic\WooCommerce\Utilities\FeaturesUtil;
9
10	/**
11	* RoutesController class.
12	*/
13	class RoutesController {
14	/**
15	* Stores schema_controller.
16	*
17	* @var SchemaController
18	*/
19	protected $schema_controller;
20
21	/**
22	* Stores routes.
23	*
24	* @var array
25	*/
26	protected $routes = [];
27
28	/**
29	* Namespace for the API.
30	*
31	* @var string
32	*/
33	private static $api_namespace = 'wc/store';
34
35	/**
36	* Constructor.
37	*
38	* @param SchemaController $schema_controller Schema controller class passed to each route.
39	*/
40	public function __construct( SchemaController $schema_controller ) {
41	$this->schema_controller = $schema_controller;
42	$this->routes = [
43	'v1' => [
44	Routes\V1\Batch::IDENTIFIER => Routes\V1\Batch::class,
45	Routes\V1\Cart::IDENTIFIER => Routes\V1\Cart::class,
46	Routes\V1\CartAddItem::IDENTIFIER => Routes\V1\CartAddItem::class,
47	Routes\V1\CartApplyCoupon::IDENTIFIER => Routes\V1\CartApplyCoupon::class,
48	Routes\V1\CartCoupons::IDENTIFIER => Routes\V1\CartCoupons::class,
49	Routes\V1\CartCouponsByCode::IDENTIFIER => Routes\V1\CartCouponsByCode::class,
50	Routes\V1\CartExtensions::IDENTIFIER => Routes\V1\CartExtensions::class,
51	Routes\V1\CartItems::IDENTIFIER => Routes\V1\CartItems::class,
52	Routes\V1\CartItemsByKey::IDENTIFIER => Routes\V1\CartItemsByKey::class,
53	Routes\V1\CartRemoveCoupon::IDENTIFIER => Routes\V1\CartRemoveCoupon::class,
54	Routes\V1\CartRemoveItem::IDENTIFIER => Routes\V1\CartRemoveItem::class,
55	Routes\V1\CartSelectShippingRate::IDENTIFIER => Routes\V1\CartSelectShippingRate::class,
56	Routes\V1\CartUpdateItem::IDENTIFIER => Routes\V1\CartUpdateItem::class,
57	Routes\V1\CartUpdateCustomer::IDENTIFIER => Routes\V1\CartUpdateCustomer::class,
58	Routes\V1\Checkout::IDENTIFIER => Routes\V1\Checkout::class,
59	Routes\V1\CheckoutOrder::IDENTIFIER => Routes\V1\CheckoutOrder::class,
60	Routes\V1\Order::IDENTIFIER => Routes\V1\Order::class,
61	Routes\V1\ProductAttributes::IDENTIFIER => Routes\V1\ProductAttributes::class,
62	Routes\V1\ProductAttributesById::IDENTIFIER => Routes\V1\ProductAttributesById::class,
63	Routes\V1\ProductAttributeTerms::IDENTIFIER => Routes\V1\ProductAttributeTerms::class,
64	Routes\V1\ProductCategories::IDENTIFIER => Routes\V1\ProductCategories::class,
65	Routes\V1\ProductCategoriesById::IDENTIFIER => Routes\V1\ProductCategoriesById::class,
66	Routes\V1\ProductBrands::IDENTIFIER => Routes\V1\ProductBrands::class,
67	Routes\V1\ProductBrandsById::IDENTIFIER => Routes\V1\ProductBrandsById::class,
68	Routes\V1\ProductCollectionData::IDENTIFIER => Routes\V1\ProductCollectionData::class,
69	Routes\V1\ProductReviews::IDENTIFIER => Routes\V1\ProductReviews::class,
70	Routes\V1\ProductTags::IDENTIFIER => Routes\V1\ProductTags::class,
71	Routes\V1\Products::IDENTIFIER => Routes\V1\Products::class,
72	Routes\V1\ProductsById::IDENTIFIER => Routes\V1\ProductsById::class,
73	Routes\V1\ProductsBySlug::IDENTIFIER => Routes\V1\ProductsBySlug::class,
74	],
75	'private' => [
76	// This route should be moved outside of the Store API namespace.
77	Routes\V1\Patterns::IDENTIFIER => Routes\V1\Patterns::class,
78	],
79	'shopper_lists' => [
80	// Gated by ShopperListsController — registered only when at least one shopper-list feature is enabled.
81	Routes\V1\ShopperLists::IDENTIFIER => Routes\V1\ShopperLists::class,
82	Routes\V1\ShopperListsBySlug::IDENTIFIER => Routes\V1\ShopperListsBySlug::class,
83	Routes\V1\ShopperListItems::IDENTIFIER => Routes\V1\ShopperListItems::class,
84	Routes\V1\ShopperListItemsByKey::IDENTIFIER => Routes\V1\ShopperListItemsByKey::class,
85	],
86	'agentic' => [
87	// Agentic Commerce Protocol endpoints.
88	Routes\V1\Agentic\CheckoutSessions::IDENTIFIER => Routes\V1\Agentic\CheckoutSessions::class,
89	Routes\V1\Agentic\CheckoutSessionsUpdate::IDENTIFIER => Routes\V1\Agentic\CheckoutSessionsUpdate::class,
90	Routes\V1\Agentic\CheckoutSessionsComplete::IDENTIFIER => Routes\V1\Agentic\CheckoutSessionsComplete::class,
91	],
92	];
93	}
94
95	/**
96	* Register all Store API routes. This includes routes under specific version namespaces.
97	*/
98	public function register_all_routes() {
99	$this->register_routes( 'v1', self::$api_namespace );
100	$this->register_routes( 'v1', self::$api_namespace . '/v1' );
101	$this->register_routes( 'private', 'wc/private' );
102
103	if ( wc_get_container()->get( ShopperListsController::class )->is_enabled() ) {
104	$this->register_routes( 'shopper_lists', self::$api_namespace . '/v1' );
105	}
106
107	if ( FeaturesUtil::feature_is_enabled( 'agentic_checkout' ) ) {
108	$this->register_routes( 'agentic', 'wc/agentic/v1' );
109	}
110	}
111
112	/**
113	* Get a route class instance.
114	*
115	* Each route class is instantized with the SchemaController instance, and its main Schema Type.
116	*
117	* @throws \Exception If the schema does not exist.
118	* @param string $name Name of schema.
119	* @param string $version API Version being requested.
120	* @return AbstractRoute
121	*/
122	public function get( $name, $version = 'v1' ) {
123	$route = $this->routes[ $version ][ $name ] ?? false;
124
125	if ( ! $route ) {
126	throw new \Exception( "{$name} {$version} route does not exist" );
127	}
128
129	return new $route(
130	$this->schema_controller,
131	$this->schema_controller->get( $route::SCHEMA_TYPE, $route::SCHEMA_VERSION )
132	);
133	}
134
135	/**
136	* Get a route path without instantiating the corresponding RoutesController object.
137	*
138	* @throws \Exception If the schema does not exist.
139	*
140	* @param string $version API Version being requested.
141	* @param string $controller Whether to return controller name. If false, returns empty array. Note:
142	* When $controller param is true, the output should not be used directly in front-end code, to prevent class names from leaking. It's not a security issue necessarily, but it's not a good practice.
143	* When $controller param is false, it currently returns and empty array. But it can be modified in future to return include more details about the route info that can be used in frontend.
144	*
145	* @return string[] List of route paths.
146	*/
147	public function get_all_routes( $version = 'v1', $controller = false ) {
148	$routes = array();
149
150	foreach ( $this->routes[ $version ] as $key => $route_class ) {
151
152	if ( ! method_exists( $route_class, 'get_path_regex' ) ) {
153	throw new \Exception( esc_html( "{$route_class} route does not have a get_path_regex method" ) );
154	}
155
156	$route_path = '/' . trailingslashit( self::$api_namespace ) . $version . $route_class::get_path_regex();
157
158	$routes[ $route_path ] = $controller ? $route_class : array();
159	}
160
161	return $routes;
162	}
163
164	/**
165	* Register defined list of routes with WordPress.
166	*
167	* @param string $version API Version being registered..
168	* @param string $namespace Overrides the default route namespace.
169	*/
170	protected function register_routes( $version = 'v1', $namespace = 'wc/store/v1' ) {
171	if ( ! isset( $this->routes[ $version ] ) ) {
172	return;
173	}
174	$route_identifiers = array_keys( $this->routes[ $version ] );
175	foreach ( $route_identifiers as $route ) {
176	$route_instance = $this->get( $route, $version );
177	$route_instance->set_namespace( $namespace );
178
179	register_rest_route(
180	$route_instance->get_namespace(),
181	$route_instance->get_path(),
182	$route_instance->get_args()
183	);
184	}
185	}
186	}
187