Jetpack_Instant_Search::action__parse_query() - Code Metrics - Inspection of "Instant Search: refactor search php for the differ..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — instant-search-master ( 6806c6...584d61 )

unknown

created 2020-01-09 00:01 UTC

Jetpack_Instant_Search::action__parse_query() A

↳ Parent: Jetpack_Instant_Search

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	25
rs	9.52
c	0
b	0
f	0

<?php
/**
 * Jetpack Search: Instant Front-End Search and Filtering
 *
 * @since 8.3.0
 * @package jetpack
 */

use Automattic\Jetpack\Connection\Client;
use Automattic\Jetpack\Constants;

class Jetpack_Instant_Search extends Jetpack_Search {

	/**
	 * Loads the php for this version of search
	 *
	 * @since 8.3.0
	 */
	public function load_php() {
		require_once dirname( __FILE__ ) . '/class.jetpack-search-template-tags.php';
		require_once JETPACK__PLUGIN_DIR . 'modules/widgets/search.php';

		if ( class_exists( 'WP_Customize_Manager' ) ) {
			require_once dirname( __FILE__ ) . '/class-jetpack-search-customize.php';
			new Jetpack_Search_Customize();
		}
	}

	/**
	 * Setup the various hooks needed for the plugin to take over search duties.
	 *
	 * @since 5.0.0
	 */
	public function init_hooks() {
		if ( ! is_admin() ) {
			add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
			add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );

			add_action( 'init', array( $this, 'set_filters_from_widgets' ) );

			add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
			add_action( 'wp_footer', array( $this, 'print_instant_search_sidebar' ) );
		} else {
			add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
		}

		add_action( 'widgets_init', array( $this, 'register_jetpack_instant_sidebar' ) );
		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
	}

	/**
	 * Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
	 */
	public function load_assets() {
		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
		$style_relative_path  = '_inc/build/instant-search/instant-search.min.css';
		if ( ! file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) || ! file_exists( JETPACK__PLUGIN_DIR . $style_relative_path ) ) {
			return;
		}

		$script_version = self::get_asset_version( $script_relative_path );
		$script_path    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
		wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
		$this->load_and_initialize_tracks();
		$this->inject_javascript_options();

		$style_version = self::get_asset_version( $style_relative_path );
		$style_path    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
		wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
	}

	/**
	 * Passes all options to the JS app.
	 */
	protected function inject_javascript_options() {
		$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
		if ( is_array( $widget_options ) ) {
			$widget_options = end( $widget_options );
		}

		$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
		$widgets = array();
		foreach ( $filters as $key => $filter ) {
			if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
				$widgets[ $filter['widget_id'] ]['filters']   = array();
				$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
			}
			$new_filter                                   = $filter;
			$new_filter['filter_id']                      = $key;
			$widgets[ $filter['widget_id'] ]['filters'][] = $new_filter;
		}

		$post_type_objs   = get_post_types( array(), 'objects' );
		$post_type_labels = array();
		foreach ( $post_type_objs as $key => $obj ) {
			$post_type_labels[ $key ] = array(
				'singular_name' => $obj->labels->singular_name,
				'name'          => $obj->labels->name,
			);
		}

		$prefix  = Jetpack_Search_Options::OPTION_PREFIX;
		$options = array(
			// overlay options.
			'closeColor'      => (bool) get_option( $prefix . 'close_color', '#BD3854' ),
			'colorTheme'      => (bool) get_option( $prefix . 'color_theme', 'light' ),
			'enableInfScroll' => (bool) get_option( $prefix . 'inf_scroll', true ),
			'highlightColor'  => (bool) get_option( $prefix . 'highlight_color', '#FFC' ),
			'opacity'         => (bool) get_option( $prefix . 'opacity', 97 ),
			'showLogo'        => (bool) get_option( $prefix . 'show_logo', true ),
			'showPoweredBy'   => (bool) get_option( $prefix . 'show_powered_by', true ),

			// core config.
			'homeUrl'         => home_url(),
			'locale'          => str_replace( '_', '-', get_locale() ),
			'postsPerPage'    => get_option( 'posts_per_page' ),
			'siteId'          => Jetpack::get_option( 'id' ),

			// filtering.
			'postTypeFilters' => $widget_options['post_types'],
			'postTypes'       => $post_type_labels,
			'sort'            => $widget_options['sort'],
			'widgets'         => array_values( $widgets ),
		);

		/**
		 * Customize Instant Search Options.
		 *
		 * @module search
		 *
		 * @since 7.7.0
		 *
		 * @param array $options Array of parameters used in Instant Search queries.
		 */
		$options = apply_filters( 'jetpack_instant_search_options', $options );

		wp_localize_script(
			'jetpack-instant-search',
			'JetpackInstantSearchOptions',
			$options
		);
	}

	/**
	 * Registers a widget sidebar for Instant Search.
	 */
	public function register_jetpack_instant_sidebar() {
		$args = array(
			'name'          => 'Jetpack Search Sidebar',
			'id'            => 'jetpack-instant-search-sidebar',
			'description'   => 'Customize the sidebar inside the Jetpack Search overlay',
			'class'         => '',
			'before_widget' => '<div id="%1$s" class="widget %2$s">',
			'after_widget'  => '</div>',
			'before_title'  => '<h2 class="widgettitle">',
			'after_title'   => '</h2>',
		);
		register_sidebar( $args );
	}

	/**
	 * Prints Instant Search sidebar.
	 */
	public function print_instant_search_sidebar() {
		?>
		<div class="jetpack-instant-search__widget-area" style="display: none">
			<?php if ( is_active_sidebar( 'jetpack-instant-search-sidebar' ) ) { ?>
				<?php dynamic_sidebar( 'jetpack-instant-search-sidebar' ); ?>
			<?php } ?>
		</div>
		<?php
	}

	/**
	 * Loads scripts for Tracks analytics library
	 */
	public function load_and_initialize_tracks() {
		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
	}

	/**
	 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
	 *
	 * @param string $file Path of the file we are looking for.
	 * @return string $script_version Version number.
	 */
	public static function get_asset_version( $file ) {
		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
			? filemtime( JETPACK__PLUGIN_DIR . $file )
			: JETPACK__VERSION;
	}

	/**
	 * Bypass the normal Search query since we will run it with instant search.
	 *
	 * @since 8.3.0
	 *
	 * @param array    $posts Current array of posts (still pre-query).
	 * @param WP_Query $query The WP_Query being filtered.
	 *
	 * @return array Array of matching posts.
	 */
	public function filter__posts_pre_query( $posts, $query ) {
		if ( ! $this->should_handle_query( $query ) ) {
			// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
			return $posts;
		}

		/**
		 * Bypass the main query and return dummy data
		 *  WP Core doesn't call the set_found_posts and its filters when filtering
		 *  posts_pre_query like we do, so need to do these manually.
		 */
		$query->found_posts   = 1;
		$query->max_num_pages = 1;

		return array();
	}

	/**
	 * Run the aggregations API query for any filtering
	 *
	 * @since 8.3.0
	 *
	 * @param WP_Query $query The WP_Query being filtered.
	 */
	public function action__parse_query( $query ) {
		if ( ! empty( $this->search_result ) ) {
			return;
		}

		if ( is_admin() ) {
			return;
		}

		if ( empty( $this->aggregations ) ) {
			return;
		}

		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );

		$builder = new Jetpack_WPES_Query_Builder();
		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
		$this->search_result = $this->instant_api(

			array(
				'aggregations' => $builder->build_aggregation(),
				'size'         => 0,
				'from'         => 0,
			)
		);
	}

	/**
	 * Run an instant search on the WordPress.com public API.
	 *
	 * @since 8.3.0
	 *
	 * @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
	 *
	 * @return object|WP_Error The response from the public API, or a WP_Error.
	 */
	public function instant_api( array $args ) {
		$start_time = microtime( true );

		// Cache locally to avoid remote request slowing the page.
		$transient_name = '_jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
		$cache          = get_transient( $transient_name );
		if ( false !== $cache ) {
			$end_time = microtime( true );
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			return $cache;
		}

		$endpoint     = sprintf( '/sites/%s/search', $this->jetpack_blog_id );
		$query_params = urldecode( http_build_query( $args ) );
		$service_url  = 'https://public-api.wordpress.com/rest/v1.3' . $endpoint . '?' . $query_params;

		$request_args = array(
			'timeout'    => 10,
			'user-agent' => 'jetpack_search',
		);

		$request  = wp_remote_get( $service_url, $request_args );
		$end_time = microtime( true );

		if ( is_wp_error( $request ) ) {
			return $request;
		}

		$response_code = wp_remote_retrieve_response_code( $request );
		$response      = json_decode( wp_remote_retrieve_body( $request ), true );

		if ( ! $response_code || $response_code < 200 || $response_code >= 300 ) {
			/**
			 * Fires after a search query request has failed
			 *
			 * @module search
			 *
			 * @since  5.6.0
			 *
			 * @param array Array containing the response code and response from the failed search query
			 */
			do_action(
				'failed_jetpack_search_query',
				array(
					'response_code' => $response_code,
					'json'          => $response,
				)
			);

			return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );

		}

		$took = is_array( $response ) && ! empty( $response['took'] )
			? $response['took']
			: null;

		$query = array(
			'args'          => $args,
			'response'      => $response,
			'response_code' => $response_code,
			'elapsed_time'  => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
			'es_time'       => $took,
			'url'           => $service_url,
		);

		/**
		 * Fires after a search request has been performed.
		 *
		 * Includes the following info in the $query parameter:
		 *
		 * array args Array of Elasticsearch arguments for the search
		 * array response Raw API response, JSON decoded
		 * int response_code HTTP response code of the request
		 * float elapsed_time Roundtrip time of the search request, in milliseconds
		 * float es_time Amount of time Elasticsearch spent running the request, in milliseconds
		 * string url API url that was queried
		 *
		 * @module search
		 *
		 * @since  5.0.0
		 * @since  5.8.0 This action now fires on all queries instead of just successful queries.
		 *
		 * @param array $query Array of information about the query performed
		 */
		do_action( 'did_jetpack_search_query', $query );

		// Update local cache.
		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );

		return $response;
	}

	/**
	 * Get the raw Aggregation results from the Elasticsearch response.
	 *
	 * @since  8.3.0
	 *
	 * @return array Array of Aggregations performed on the search.
	 */
	public function get_search_aggregations_results() {
		if ( empty( $this->search_result ) || is_wp_error( $this->search_result ) || ! isset( $this->search_result['aggregations'] ) ) {
			return array();
		}

		return $this->search_result['aggregations'];
	}


}


1		<?php
2		/**
3		* Jetpack Search: Instant Front-End Search and Filtering
4		*
5		* @since 8.3.0
6		* @package jetpack
7		*/
8
9		use Automattic\Jetpack\Connection\Client;
10		use Automattic\Jetpack\Constants;
11
12		class Jetpack_Instant_Search extends Jetpack_Search {
13
14		/**
15		* Loads the php for this version of search
16		*
17		* @since 8.3.0
18		*/
19		public function load_php() {
20		require_once dirname( __FILE__ ) . '/class.jetpack-search-template-tags.php';
21		require_once JETPACK__PLUGIN_DIR . 'modules/widgets/search.php';
22
23		if ( class_exists( 'WP_Customize_Manager' ) ) {
24		require_once dirname( __FILE__ ) . '/class-jetpack-search-customize.php';
25		new Jetpack_Search_Customize();
26		}
27		}
28
29		/**
30		* Setup the various hooks needed for the plugin to take over search duties.
31		*
32		* @since 5.0.0
33		*/
34	View Code Duplication	public function init_hooks() {
35		if ( ! is_admin() ) {
36		add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
37		add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );
38
39		add_action( 'init', array( $this, 'set_filters_from_widgets' ) );
40
41		add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
42		add_action( 'wp_footer', array( $this, 'print_instant_search_sidebar' ) );
43		} else {
44		add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
45		}
46
47		add_action( 'widgets_init', array( $this, 'register_jetpack_instant_sidebar' ) );
48		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
49		}
50
51		/**
52		* Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
53		*/
54		public function load_assets() {
55		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
56		$style_relative_path = '_inc/build/instant-search/instant-search.min.css';
57		if ( ! file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) \|\| ! file_exists( JETPACK__PLUGIN_DIR . $style_relative_path ) ) {
58		return;
59		}
60
61		$script_version = self::get_asset_version( $script_relative_path );
62		$script_path = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
63		wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
64		$this->load_and_initialize_tracks();
65		$this->inject_javascript_options();
66
67		$style_version = self::get_asset_version( $style_relative_path );
68		$style_path = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
69		wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
70		}
71
72		/**
73		* Passes all options to the JS app.
74		*/
75		protected function inject_javascript_options() {
76		$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
77		if ( is_array( $widget_options ) ) {
78		$widget_options = end( $widget_options );
79		}
80
81		$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
82		$widgets = array();
83		foreach ( $filters as $key => $filter ) {
84		if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
85		$widgets[ $filter['widget_id'] ]['filters'] = array();
86		$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
87		}
88		$new_filter = $filter;
89		$new_filter['filter_id'] = $key;
90		$widgets[ $filter['widget_id'] ]['filters'][] = $new_filter;
91		}
92
93		$post_type_objs = get_post_types( array(), 'objects' );
94		$post_type_labels = array();
95		foreach ( $post_type_objs as $key => $obj ) {
96		$post_type_labels[ $key ] = array(
97		'singular_name' => $obj->labels->singular_name,
98		'name' => $obj->labels->name,
99		);
100		}
101
102		$prefix = Jetpack_Search_Options::OPTION_PREFIX;
103		$options = array(
104		// overlay options.
105		'closeColor' => (bool) get_option( $prefix . 'close_color', '#BD3854' ),
106		'colorTheme' => (bool) get_option( $prefix . 'color_theme', 'light' ),
107		'enableInfScroll' => (bool) get_option( $prefix . 'inf_scroll', true ),
108		'highlightColor' => (bool) get_option( $prefix . 'highlight_color', '#FFC' ),
109		'opacity' => (bool) get_option( $prefix . 'opacity', 97 ),
110		'showLogo' => (bool) get_option( $prefix . 'show_logo', true ),
111		'showPoweredBy' => (bool) get_option( $prefix . 'show_powered_by', true ),
112
113		// core config.
114		'homeUrl' => home_url(),
115		'locale' => str_replace( '_', '-', get_locale() ),
116		'postsPerPage' => get_option( 'posts_per_page' ),
117		'siteId' => Jetpack::get_option( 'id' ),
118
119		// filtering.
120		'postTypeFilters' => $widget_options['post_types'],
121		'postTypes' => $post_type_labels,
122		'sort' => $widget_options['sort'],
123		'widgets' => array_values( $widgets ),
124		);
125
126		/**
127		* Customize Instant Search Options.
128		*
129		* @module search
130		*
131		* @since 7.7.0
132		*
133		* @param array $options Array of parameters used in Instant Search queries.
134		*/
135		$options = apply_filters( 'jetpack_instant_search_options', $options );
136
137		wp_localize_script(
138		'jetpack-instant-search',
139		'JetpackInstantSearchOptions',
140		$options
141		);
142		}
143
144		/**
145		* Registers a widget sidebar for Instant Search.
146		*/
147		public function register_jetpack_instant_sidebar() {
148		$args = array(
149		'name' => 'Jetpack Search Sidebar',
150		'id' => 'jetpack-instant-search-sidebar',
151		'description' => 'Customize the sidebar inside the Jetpack Search overlay',
152		'class' => '',
153		'before_widget' => '<div id="%1$s" class="widget %2$s">',
154		'after_widget' => '</div>',
155		'before_title' => '<h2 class="widgettitle">',
156		'after_title' => '</h2>',
157		);
158		register_sidebar( $args );
159		}
160
161		/**
162		* Prints Instant Search sidebar.
163		*/
164		public function print_instant_search_sidebar() {
165		?>
166		<div class="jetpack-instant-search__widget-area" style="display: none">
167		<?php if ( is_active_sidebar( 'jetpack-instant-search-sidebar' ) ) { ?>
168		<?php dynamic_sidebar( 'jetpack-instant-search-sidebar' ); ?>
169		<?php } ?>
170		</div>
171		<?php
172		}
173
174		/**
175		* Loads scripts for Tracks analytics library
176		*/
177		public function load_and_initialize_tracks() {
178		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
179		}
180
181		/**
182		* Get the version number to use when loading the file. Allows us to bypass cache when developing.
183		*
184		* @param string $file Path of the file we are looking for.
185		* @return string $script_version Version number.
186		*/
187		public static function get_asset_version( $file ) {
188		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
189		? filemtime( JETPACK__PLUGIN_DIR . $file )
190		: JETPACK__VERSION;
191		}
192
193		/**
194		* Bypass the normal Search query since we will run it with instant search.
195		*
196		* @since 8.3.0
197		*
198		* @param array $posts Current array of posts (still pre-query).
199		* @param WP_Query $query The WP_Query being filtered.
200		*
201		* @return array Array of matching posts.
202		*/
203		public function filter__posts_pre_query( $posts, $query ) {
204		if ( ! $this->should_handle_query( $query ) ) {
205		// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
206		return $posts;
207		}
208
209		/**
210		* Bypass the main query and return dummy data
211		* WP Core doesn't call the set_found_posts and its filters when filtering
212		* posts_pre_query like we do, so need to do these manually.
213		*/
214		$query->found_posts = 1;
215		$query->max_num_pages = 1;
216
217		return array();
218		}
219
220		/**
221		* Run the aggregations API query for any filtering
222		*
223		* @since 8.3.0
224		*
225		* @param WP_Query $query The WP_Query being filtered.
226		*/
227		public function action__parse_query( $query ) {
228		if ( ! empty( $this->search_result ) ) {
229		return;
230		}
231
232		if ( is_admin() ) {
233		return;
234		}
235
236		if ( empty( $this->aggregations ) ) {
237		return;
238		}
239
240		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );
241
242		$builder = new Jetpack_WPES_Query_Builder();
243		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
244		$this->search_result = $this->instant_api(
		0 ignored issues – show Documentation Bug introduced 2019-12-30 18:25 UTC by Report Bug Copy Issue Report It seems like `$this->instant_api(array...ze' => 0, 'from' => 0))` of type `object` is incompatible with the declared type `array` of property `$search_result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
245		array(
246		'aggregations' => $builder->build_aggregation(),
247		'size' => 0,
248		'from' => 0,
249		)
250		);
251		}
252
253		/**
254		* Run an instant search on the WordPress.com public API.
255		*
256		* @since 8.3.0
257		*
258		* @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
259		*
260		* @return object\|WP_Error The response from the public API, or a WP_Error.
261		*/
262		public function instant_api( array $args ) {
263		$start_time = microtime( true );
264
265		// Cache locally to avoid remote request slowing the page.
266		$transient_name = '_jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
267		$cache = get_transient( $transient_name );
268		if ( false !== $cache ) {
269		$end_time = microtime( true );
		0 ignored issues – show Unused Code introduced 2019-12-30 18:25 UTC by Report Bug Copy Issue Report `$end_time` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
270		return $cache;
271		}
272
273		$endpoint = sprintf( '/sites/%s/search', $this->jetpack_blog_id );
274		$query_params = urldecode( http_build_query( $args ) );
275		$service_url = 'https://public-api.wordpress.com/rest/v1.3' . $endpoint . '?' . $query_params;
276
277		$request_args = array(
278		'timeout' => 10,
279		'user-agent' => 'jetpack_search',
280		);
281
282		$request = wp_remote_get( $service_url, $request_args );
283		$end_time = microtime( true );
284
285		if ( is_wp_error( $request ) ) {
286		return $request;
287		}
288
289		$response_code = wp_remote_retrieve_response_code( $request );
290		$response = json_decode( wp_remote_retrieve_body( $request ), true );
291
292	View Code Duplication	if ( ! $response_code \|\| $response_code < 200 \|\| $response_code >= 300 ) {
293		/**
294		* Fires after a search query request has failed
295		*
296		* @module search
297		*
298		* @since 5.6.0
299		*
300		* @param array Array containing the response code and response from the failed search query
301		*/
302		do_action(
303		'failed_jetpack_search_query',
304		array(
305		'response_code' => $response_code,
306		'json' => $response,
307		)
308		);
309
310		return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
		0 ignored issues – show Unused Code introduced 2019-11-08 21:29 UTC by Report Bug Copy Issue Report The call to `WP_Error::__construct()` has too many arguments starting with `'invalid_search_api_response'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
311		}
312
313		$took = is_array( $response ) && ! empty( $response['took'] )
314		? $response['took']
315		: null;
316
317		$query = array(
318		'args' => $args,
319		'response' => $response,
320		'response_code' => $response_code,
321		'elapsed_time' => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
322		'es_time' => $took,
323		'url' => $service_url,
324		);
325
326		/**
327		* Fires after a search request has been performed.
328		*
329		* Includes the following info in the $query parameter:
330		*
331		* array args Array of Elasticsearch arguments for the search
332		* array response Raw API response, JSON decoded
333		* int response_code HTTP response code of the request
334		* float elapsed_time Roundtrip time of the search request, in milliseconds
335		* float es_time Amount of time Elasticsearch spent running the request, in milliseconds
336		* string url API url that was queried
337		*
338		* @module search
339		*
340		* @since 5.0.0
341		* @since 5.8.0 This action now fires on all queries instead of just successful queries.
342		*
343		* @param array $query Array of information about the query performed
344		*/
345		do_action( 'did_jetpack_search_query', $query );
346
347		// Update local cache.
348		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );
349
350		return $response;
351		}
352
353		/**
354		* Get the raw Aggregation results from the Elasticsearch response.
355		*
356		* @since 8.3.0
357		*
358		* @return array Array of Aggregations performed on the search.
359		*/
360		public function get_search_aggregations_results() {
361		if ( empty( $this->search_result ) \|\| is_wp_error( $this->search_result ) \|\| ! isset( $this->search_result['aggregations'] ) ) {
362		return array();
363		}
364
365		return $this->search_result['aggregations'];
366		}
367
368
369		}
370

Automattic / jetpack

Push — instant-search-master ( 6806c6...584d61 )

Jetpack_Instant_Search::action__parse_query() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like