Exceptions
2 years ago
Formatters
2 years ago
Payments
2 years ago
Routes
2 years ago
Schemas
2 years ago
Utilities
2 years ago
Authentication.php
2 years ago
Formatters.php
2 years ago
Legacy.php
2 years ago
RoutesController.php
2 years ago
SchemaController.php
2 years ago
SessionHandler.php
2 years ago
StoreApi.php
2 years ago
deprecated.php
2 years ago
functions.php
2 years ago
RoutesController.php
130 lines
| 1 | <?php |
| 2 | namespace Automattic\WooCommerce\StoreApi; |
| 3 | |
| 4 | use Automattic\WooCommerce\StoreApi\Routes\V1\AbstractRoute; |
| 5 | |
| 6 | /** |
| 7 | * RoutesController class. |
| 8 | */ |
| 9 | class RoutesController { |
| 10 | /** |
| 11 | * Stores schema_controller. |
| 12 | * |
| 13 | * @var SchemaController |
| 14 | */ |
| 15 | protected $schema_controller; |
| 16 | |
| 17 | /** |
| 18 | * Stores routes. |
| 19 | * |
| 20 | * @var array |
| 21 | */ |
| 22 | protected $routes = []; |
| 23 | |
| 24 | /** |
| 25 | * Constructor. |
| 26 | * |
| 27 | * @param SchemaController $schema_controller Schema controller class passed to each route. |
| 28 | */ |
| 29 | public function __construct( SchemaController $schema_controller ) { |
| 30 | $this->schema_controller = $schema_controller; |
| 31 | $this->routes = [ |
| 32 | 'v1' => [ |
| 33 | Routes\V1\Batch::IDENTIFIER => Routes\V1\Batch::class, |
| 34 | Routes\V1\Cart::IDENTIFIER => Routes\V1\Cart::class, |
| 35 | Routes\V1\CartAddItem::IDENTIFIER => Routes\V1\CartAddItem::class, |
| 36 | Routes\V1\CartApplyCoupon::IDENTIFIER => Routes\V1\CartApplyCoupon::class, |
| 37 | Routes\V1\CartCoupons::IDENTIFIER => Routes\V1\CartCoupons::class, |
| 38 | Routes\V1\CartCouponsByCode::IDENTIFIER => Routes\V1\CartCouponsByCode::class, |
| 39 | Routes\V1\CartExtensions::IDENTIFIER => Routes\V1\CartExtensions::class, |
| 40 | Routes\V1\CartItems::IDENTIFIER => Routes\V1\CartItems::class, |
| 41 | Routes\V1\CartItemsByKey::IDENTIFIER => Routes\V1\CartItemsByKey::class, |
| 42 | Routes\V1\CartRemoveCoupon::IDENTIFIER => Routes\V1\CartRemoveCoupon::class, |
| 43 | Routes\V1\CartRemoveItem::IDENTIFIER => Routes\V1\CartRemoveItem::class, |
| 44 | Routes\V1\CartSelectShippingRate::IDENTIFIER => Routes\V1\CartSelectShippingRate::class, |
| 45 | Routes\V1\CartUpdateItem::IDENTIFIER => Routes\V1\CartUpdateItem::class, |
| 46 | Routes\V1\CartUpdateCustomer::IDENTIFIER => Routes\V1\CartUpdateCustomer::class, |
| 47 | Routes\V1\Checkout::IDENTIFIER => Routes\V1\Checkout::class, |
| 48 | Routes\V1\CheckoutOrder::IDENTIFIER => Routes\V1\CheckoutOrder::class, |
| 49 | Routes\V1\Order::IDENTIFIER => Routes\V1\Order::class, |
| 50 | Routes\V1\ProductAttributes::IDENTIFIER => Routes\V1\ProductAttributes::class, |
| 51 | Routes\V1\ProductAttributesById::IDENTIFIER => Routes\V1\ProductAttributesById::class, |
| 52 | Routes\V1\ProductAttributeTerms::IDENTIFIER => Routes\V1\ProductAttributeTerms::class, |
| 53 | Routes\V1\ProductCategories::IDENTIFIER => Routes\V1\ProductCategories::class, |
| 54 | Routes\V1\ProductCategoriesById::IDENTIFIER => Routes\V1\ProductCategoriesById::class, |
| 55 | Routes\V1\ProductCollectionData::IDENTIFIER => Routes\V1\ProductCollectionData::class, |
| 56 | Routes\V1\ProductReviews::IDENTIFIER => Routes\V1\ProductReviews::class, |
| 57 | Routes\V1\ProductTags::IDENTIFIER => Routes\V1\ProductTags::class, |
| 58 | Routes\V1\Products::IDENTIFIER => Routes\V1\Products::class, |
| 59 | Routes\V1\ProductsById::IDENTIFIER => Routes\V1\ProductsById::class, |
| 60 | Routes\V1\ProductsBySlug::IDENTIFIER => Routes\V1\ProductsBySlug::class, |
| 61 | ], |
| 62 | // @todo Migrate internal AI routes to WooCommerce Core codebase. |
| 63 | 'private' => [ |
| 64 | Routes\V1\AI\StoreTitle::IDENTIFIER => Routes\V1\AI\StoreTitle::class, |
| 65 | Routes\V1\AI\Images::IDENTIFIER => Routes\V1\AI\Images::class, |
| 66 | Routes\V1\AI\Patterns::IDENTIFIER => Routes\V1\AI\Patterns::class, |
| 67 | Routes\V1\AI\Product::IDENTIFIER => Routes\V1\AI\Product::class, |
| 68 | Routes\V1\AI\Products::IDENTIFIER => Routes\V1\AI\Products::class, |
| 69 | Routes\V1\AI\BusinessDescription::IDENTIFIER => Routes\V1\AI\BusinessDescription::class, |
| 70 | Routes\V1\AI\StoreInfo::IDENTIFIER => Routes\V1\AI\StoreInfo::class, |
| 71 | ], |
| 72 | ]; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Register all Store API routes. This includes routes under specific version namespaces. |
| 77 | */ |
| 78 | public function register_all_routes() { |
| 79 | $this->register_routes( 'v1', 'wc/store' ); |
| 80 | $this->register_routes( 'v1', 'wc/store/v1' ); |
| 81 | $this->register_routes( 'private', 'wc/private' ); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Get a route class instance. |
| 86 | * |
| 87 | * Each route class is instantized with the SchemaController instance, and its main Schema Type. |
| 88 | * |
| 89 | * @throws \Exception If the schema does not exist. |
| 90 | * @param string $name Name of schema. |
| 91 | * @param string $version API Version being requested. |
| 92 | * @return AbstractRoute |
| 93 | */ |
| 94 | public function get( $name, $version = 'v1' ) { |
| 95 | $route = $this->routes[ $version ][ $name ] ?? false; |
| 96 | |
| 97 | if ( ! $route ) { |
| 98 | throw new \Exception( "{$name} {$version} route does not exist" ); |
| 99 | } |
| 100 | |
| 101 | return new $route( |
| 102 | $this->schema_controller, |
| 103 | $this->schema_controller->get( $route::SCHEMA_TYPE, $route::SCHEMA_VERSION ) |
| 104 | ); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Register defined list of routes with WordPress. |
| 109 | * |
| 110 | * @param string $version API Version being registered.. |
| 111 | * @param string $namespace Overrides the default route namespace. |
| 112 | */ |
| 113 | protected function register_routes( $version = 'v1', $namespace = 'wc/store/v1' ) { |
| 114 | if ( ! isset( $this->routes[ $version ] ) ) { |
| 115 | return; |
| 116 | } |
| 117 | $route_identifiers = array_keys( $this->routes[ $version ] ); |
| 118 | foreach ( $route_identifiers as $route ) { |
| 119 | $route_instance = $this->get( $route, $version ); |
| 120 | $route_instance->set_namespace( $namespace ); |
| 121 | |
| 122 | register_rest_route( |
| 123 | $route_instance->get_namespace(), |
| 124 | $route_instance->get_path(), |
| 125 | $route_instance->get_args() |
| 126 | ); |
| 127 | } |
| 128 | } |
| 129 | } |
| 130 |