Exceptions
2 years ago
Formatters
1 year ago
Payments
2 years ago
Routes
10 months ago
Schemas
10 months ago
Utilities
7 months ago
Authentication.php
11 months ago
Formatters.php
2 years ago
Legacy.php
1 year ago
RoutesController.php
1 year ago
SchemaController.php
1 year ago
SessionHandler.php
9 months ago
StoreApi.php
1 year ago
deprecated.php
2 years ago
functions.php
2 years ago
SchemaController.php
82 lines
| 1 | <?php |
| 2 | namespace Automattic\WooCommerce\StoreApi; |
| 3 | |
| 4 | use Automattic\WooCommerce\StoreApi\Schemas\ExtendSchema; |
| 5 | |
| 6 | /** |
| 7 | * SchemaController class. |
| 8 | */ |
| 9 | class SchemaController { |
| 10 | |
| 11 | /** |
| 12 | * Stores schema class instances. |
| 13 | * |
| 14 | * @var Schemas\V1\AbstractSchema[] |
| 15 | */ |
| 16 | protected $schemas = []; |
| 17 | |
| 18 | /** |
| 19 | * Stores Rest Extending instance |
| 20 | * |
| 21 | * @var ExtendSchema |
| 22 | */ |
| 23 | private $extend; |
| 24 | |
| 25 | /** |
| 26 | * Constructor. |
| 27 | * |
| 28 | * @param ExtendSchema $extend Rest Extending instance. |
| 29 | */ |
| 30 | public function __construct( ExtendSchema $extend ) { |
| 31 | $this->extend = $extend; |
| 32 | $this->schemas = [ |
| 33 | 'v1' => [ |
| 34 | Schemas\V1\BatchSchema::IDENTIFIER => Schemas\V1\BatchSchema::class, |
| 35 | Schemas\V1\ErrorSchema::IDENTIFIER => Schemas\V1\ErrorSchema::class, |
| 36 | Schemas\V1\ImageAttachmentSchema::IDENTIFIER => Schemas\V1\ImageAttachmentSchema::class, |
| 37 | Schemas\V1\TermSchema::IDENTIFIER => Schemas\V1\TermSchema::class, |
| 38 | Schemas\V1\BillingAddressSchema::IDENTIFIER => Schemas\V1\BillingAddressSchema::class, |
| 39 | Schemas\V1\ShippingAddressSchema::IDENTIFIER => Schemas\V1\ShippingAddressSchema::class, |
| 40 | Schemas\V1\CartShippingRateSchema::IDENTIFIER => Schemas\V1\CartShippingRateSchema::class, |
| 41 | Schemas\V1\CartCouponSchema::IDENTIFIER => Schemas\V1\CartCouponSchema::class, |
| 42 | Schemas\V1\CartFeeSchema::IDENTIFIER => Schemas\V1\CartFeeSchema::class, |
| 43 | Schemas\V1\CartItemSchema::IDENTIFIER => Schemas\V1\CartItemSchema::class, |
| 44 | Schemas\V1\CartSchema::IDENTIFIER => Schemas\V1\CartSchema::class, |
| 45 | Schemas\V1\CartExtensionsSchema::IDENTIFIER => Schemas\V1\CartExtensionsSchema::class, |
| 46 | Schemas\V1\CheckoutOrderSchema::IDENTIFIER => Schemas\V1\CheckoutOrderSchema::class, |
| 47 | Schemas\V1\CheckoutSchema::IDENTIFIER => Schemas\V1\CheckoutSchema::class, |
| 48 | Schemas\V1\OrderItemSchema::IDENTIFIER => Schemas\V1\OrderItemSchema::class, |
| 49 | Schemas\V1\OrderCouponSchema::IDENTIFIER => Schemas\V1\OrderCouponSchema::class, |
| 50 | Schemas\V1\OrderFeeSchema::IDENTIFIER => Schemas\V1\OrderFeeSchema::class, |
| 51 | Schemas\V1\OrderSchema::IDENTIFIER => Schemas\V1\OrderSchema::class, |
| 52 | Schemas\V1\ProductSchema::IDENTIFIER => Schemas\V1\ProductSchema::class, |
| 53 | Schemas\V1\ProductAttributeSchema::IDENTIFIER => Schemas\V1\ProductAttributeSchema::class, |
| 54 | Schemas\V1\ProductCategorySchema::IDENTIFIER => Schemas\V1\ProductCategorySchema::class, |
| 55 | Schemas\V1\ProductBrandSchema::IDENTIFIER => Schemas\V1\ProductBrandSchema::class, |
| 56 | Schemas\V1\ProductCollectionDataSchema::IDENTIFIER => Schemas\V1\ProductCollectionDataSchema::class, |
| 57 | Schemas\V1\ProductReviewSchema::IDENTIFIER => Schemas\V1\ProductReviewSchema::class, |
| 58 | Schemas\V1\PatternsSchema::IDENTIFIER => Schemas\V1\PatternsSchema::class, |
| 59 | ], |
| 60 | ]; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Get a schema class instance. |
| 65 | * |
| 66 | * @throws \Exception If the schema does not exist. |
| 67 | * |
| 68 | * @param string $name Name of schema. |
| 69 | * @param int $version API Version being requested. |
| 70 | * @return Schemas\V1\AbstractSchema A new instance of the requested schema. |
| 71 | */ |
| 72 | public function get( $name, $version = 1 ) { |
| 73 | $schema = $this->schemas[ "v{$version}" ][ $name ] ?? false; |
| 74 | |
| 75 | if ( ! $schema ) { |
| 76 | throw new \Exception( "{$name} v{$version} schema does not exist" ); |
| 77 | } |
| 78 | |
| 79 | return new $schema( $this->extend, $this ); |
| 80 | } |
| 81 | } |
| 82 |