elasticpress / includes / classes / REST / SearchOrdering.php

SearchOrdering.php in ElasticPress 5.3.5, at includes/classes/REST/SearchOrdering.php

145 lines 3.0 KB

Raw Download Zip

1	<?php
2	/**
3	* Custom Results REST API Controller
4	*
5	* @since 5.0.0
6	* @package elasticpress
7	*/
8
9	namespace ElasticPress\REST;
10
11	use ElasticPress\Features;
12	use ElasticPress\Utils;
13
14	/**
15	* Custom Results API controller class.
16	*
17	* @since 5.0.0
18	* @package elasticpress
19	*/
20	class SearchOrdering {
21
22	/**
23	* Register routes.
24	*
25	* @return void
26	*/
27	public function register_routes() {
28	register_rest_route(
29	'elasticpress/v1',
30	'pointer_search',
31	[
32	'args' => $this->get_args(),
33	'callback' => [ $this, 'get_posts' ],
34	'methods' => 'GET',
35	'permission_callback' => [ $this, 'check_permission' ],
36	]
37	);
38
39	register_rest_route(
40	'elasticpress/v1',
41	'pointer_preview',
42	[
43	'args' => $this->get_args(),
44	'callback' => [ $this, 'get_preview' ],
45	'methods' => 'GET',
46	'permission_callback' => [ $this, 'check_permission' ],
47	]
48	);
49	}
50
51
52	/**
53	* Get args schema.
54	*
55	* @return array
56	*/
57	public function get_args() {
58	return [
59	's' => [
60	'description' => __( 'Search query.', 'elasticpress' ),
61	'required' => true,
62	'type' => 'string',
63	'validate_callback' => fn( $param ) => ! empty( $param ),
64	],
65	];
66	}
67
68	/**
69	* Check that the request has permission to sync.
70	*
71	* @return boolean
72	*/
73	public function check_permission() {
74	$capability = Utils\get_capability( 'search-ordering' );
75
76	return current_user_can( $capability );
77	}
78
79	/**
80	* Handles the search for posts from the admin interface for the post
81	* type.
82	*
83	* @param \WP_REST_Request $request Full details about the request.
84	* @return array
85	*/
86	public function get_posts( \WP_REST_Request $request ) {
87	$search = $request->get_param( 's' );
88
89	/** Features Class @var Features $features */
90	$features = Features::factory();
91
92	/** Search Feature @var Feature\Search\Search $search */
93	$search_feature = $features->get_registered_feature( 'search' );
94
95	$post_types = $search_feature->get_searchable_post_types();
96
97	$query = new \WP_Query(
98	[
99	'post_type' => $post_types,
100	'post_status' => 'publish',
101	's' => $search,
102	]
103	);
104
105	return $query->posts;
106	}
107
108	/**
109	* Handles the search preview on the pointer edit screen.
110	*
111	* @param \WP_REST_Request $request Full details about the request.
112	* @return array
113	*/
114	public function get_preview( $request ) {
115	$search = $request->get_param( 's' );
116
117	add_filter( 'ep_autosuggest_contexts', [ $this, 'add_rest_api_context' ] );
118
119	$query = new \WP_Query(
120	[
121	's' => $search,
122	'exclude_pointers' => true,
123	]
124	);
125
126	remove_filter( 'ep_autosuggest_contexts', [ $this, 'add_rest_api_context' ] );
127
128	return $query->posts;
129	}
130
131	/**
132	* Add the rest context to the autosuggest contexts.
133	*
134	* This makes sure the search results preview matches the search results on the frontend.
135	*
136	* @since 5.3.0
137	* @param array $contexts The contexts.
138	* @return array The contexts.
139	*/
140	public function add_rest_api_context( $contexts ) {
141	$contexts[] = 'rest';
142	return $contexts;
143	}
144	}
145