ProductBrands.php — WooCommerce 10.9.2

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

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

ProductBrands.php

70 lines

1	<?php
2	declare(strict_types=1);
3
4	namespace Automattic\WooCommerce\StoreApi\Routes\V1;
5
6	/**
7	* ProductBrands class.
8	*/
9	class ProductBrands extends AbstractTermsRoute {
10	/**
11	* The route identifier.
12	*
13	* @var string
14	*/
15	const IDENTIFIER = 'product-brands';
16
17	/**
18	* The routes schema.
19	*
20	* @var string
21	*/
22	const SCHEMA_TYPE = 'product-brand';
23
24	/**
25	* Get the path of this REST route.
26	*
27	* @return string
28	*/
29	public function get_path() {
30	return self::get_path_regex();
31	}
32
33	/**
34	* Get the path of this rest route.
35	*
36	* @return string
37	*/
38	public static function get_path_regex() {
39	return '/products/brands';
40	}
41
42	/**
43	* Get method arguments for this REST route.
44	*
45	* @return array An array of endpoints.
46	*/
47	public function get_args() {
48	return [
49	[
50	'methods' => \WP_REST_Server::READABLE,
51	'callback' => [ $this, 'get_response' ],
52	'permission_callback' => '__return_true',
53	'args' => $this->get_collection_params(),
54	'allow_batch' => [ 'v1' => true ],
55	],
56	'schema' => [ $this->schema, 'get_public_item_schema' ],
57	];
58	}
59
60	/**
61	* Get a collection of terms.
62	*
63	* @param \WP_REST_Request $request Request object.
64	* @return \WP_REST_Response
65	*/
66	protected function get_route_response( \WP_REST_Request $request ) {
67	return $this->get_terms_response( 'product_brand', $request );
68	}
69	}
70