Jetpack_Search_Helpers::get_widget_option_name() - Code Metrics - Inspection of "Search: Add helpers and unit tests for building wi..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/tracks-for-search ( 7901da...1c1db3 )

unknown

created 2018-01-23 21:12 UTC

Jetpack_Search_Helpers::get_widget_option_name() A

↳ Parent: Jetpack_Search_Helpers

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

class Jetpack_Search_Helpers {
	const FILTER_WIDGET_BASE = 'jetpack-search-filters';

	static function get_search_url() {
		$query_args = $_GET;

		// Handle the case where a permastruct is being used, such as /search/{$query}
		if ( ! isset( $query_args['s'] ) ) {
			$query_args['s'] = get_search_query();
		}

		if ( isset( $query_args['paged'] ) ) {
			unset( $query_args['paged'] );
		}

		$query = http_build_query( $query_args );
		return home_url( "?{$query}" );
	}

	static function add_query_arg( $key, $value = false ) {
		if ( is_array( $key ) ) {
			return add_query_arg( $key, self::get_search_url() );
		}

		return add_query_arg( $key, $value, self::get_search_url() );
	}

	static function remove_query_arg( $key ) {
		return remove_query_arg( $key, self::get_search_url() );
	}

	static function get_widget_option_name() {
		return sprintf( 'widget_%s', self::FILTER_WIDGET_BASE );
	}

	static function get_widgets_from_option() {
		$widget_options = get_option( self::get_widget_option_name(), array() );

		// We don't need this
		if ( ! empty( $widget_options ) && isset( $widget_options['_multiwidget'] ) ) {
			unset( $widget_options['_multiwidget'] );
		}

		return $widget_options;
	}

	static function build_widget_id( $number ) {
		return sprintf( '%s-%d', self::FILTER_WIDGET_BASE, $number );
	}

	static function is_active_widget( $widget_id ) {
		return (bool) is_active_widget( false, $widget_id, self::FILTER_WIDGET_BASE );
	}

	static function get_filters_from_widgets() {
		$filters = array();

		$widget_options = self::get_widgets_from_option();
		if ( empty( $widget_options ) ) {
			return $filters;
		}

		foreach ( (array) $widget_options as $number => $settings ) {
			$widget_id = self::build_widget_id( $number );
			if ( ! self::is_active_widget( $widget_id ) || empty( $settings['filters'] ) ) {
				continue;
			}

			if ( empty( $settings['use_filters'] ) ) {
				continue;
			}

			foreach ( (array) $settings['filters'] as $widget_filter ) {
				$widget_filter['widget_id'] = $widget_id;
				$key = sprintf( '%s_%d', $widget_filter['type'], count( $filters ) );
				$filters[ $key ] = $widget_filter;
			}
		}

		return $filters;
	}

	/**
	 * Whether we should rerun a search in the customizer preview or not.
	 *
	 * @since 5.8.0
	 *
	 * @return bool
	 */
	static function should_rerun_search_in_customizer_preview() {
		// Only update when in a customizer preview and data is being posted.
		// Check for $_POST removes an extra update when the customizer loads.
		//
		// Note: We use $GLOBALS['wp_customize'] here instead of is_customize_preview() to support unit tests.
		if ( ! isset( $GLOBALS['wp_customize'] ) || ! $GLOBALS['wp_customize']->is_preview() || empty( $_POST ) ) {
			return false;
		}

		return true;
	}

	/**
	 * Since PHP's built-in array_diff() works by comparing the values that are in array 1 to the other arrays,
	 * if there are less values in array 1, it's possible to get an empty diff where one might be expected.
	 *
	 * @since 5.8.0
	 *
	 * @param array $array_1
	 * @param array $array_2
	 *
	 * @return array
	 */
	static function array_diff( $array_1, $array_2 ) {
		// If the array counts are the same, then the order doesn't matter. If the count of
		// $array_1 is higher than $array_2, that's also fine. If the count of $array_2 is higher,
		// we need to swap the array order though.
		if ( count( $array_1 ) != count( $array_2 ) && count( $array_2 ) > count( $array_1 ) ) {
			$temp = $array_1;
			$array_1 = $array_2;
			$array_2 = $temp;
		}

		// Disregard keys
		return array_values( array_diff( $array_1, $array_2 ) );
	}

	/**
	 * Given the widget instance, will return true when selected post types differ from searchable post types.
	 *
	 * @since 5.8.0
	 *
	 * @param array $instance
	 * @return bool
	 */
	static function post_types_differ_searchable( $instance ) {
		if ( empty( $instance['post_types'] ) ) {
			return false;
		}

		$searchable_post_types = get_post_types( array( 'exclude_from_search' => false ) );
		$diff_of_searchable = self::array_diff( $searchable_post_types, (array) $instance['post_types'] );

		return ! empty( $diff_of_searchable );
	}

	/**
	 * Given the widget instance, will return true when selected post types differ from the post type filters
	 * applied to the search.
	 *
	 * @since 5.8.0
	 *
	 * @param array $instance
	 * @return bool
	 */
	static function post_types_differ_query( $instance ) {
		if ( empty( $instance['post_types'] ) ) {
			return false;
		}

		if ( empty( $_GET['post_type'] ) ) {
			$post_types_from_query = array();
		} else if ( is_array( $_GET['post_type'] ) ) {
			$post_types_from_query = $_GET['post_type'];
		} else {
			$post_types_from_query = (array) explode( ',',  $_GET['post_type'] );
		}

		$post_types_from_query = array_map( 'trim', $post_types_from_query );

		$diff_query = self::array_diff( (array) $instance['post_types'], $post_types_from_query );
		return ! empty( $diff_query );
	}

	static function get_widget_tracks_value( $old_value, $new_value ) {
		$old_value = (array) $old_value;
		if ( isset( $old_value['_multiwidget'] ) ) {
			unset( $old_value['_multiwidget'] );
		}

		$new_value = (array) $new_value;
		if ( isset( $new_value['_multiwidget'] ) ) {
			unset( $new_value['_multiwidget'] );
		}

		$action = '';
		$old_keys = array_keys( $old_value );
		$new_keys = array_keys( $new_value );

		if ( count( $new_keys ) > count( $old_keys ) ) { // This is the case for a widget being added
			$diff = self::array_diff( $new_keys, $old_keys );
			$action = 'widget_added';
			$widget = empty( $diff ) || ! isset( $new_value[ $diff[0] ] )
				? false
				: $new_value[ $diff[0] ];
		} else if ( count( $old_keys ) > count( $new_keys ) ) { // This is the case for a widget being deleted
			$diff = self::array_diff( $old_keys, $new_keys );

			$action = 'widget_deleted';
			$widget = empty( $diff ) || ! isset( $old_value[ $diff[0] ] )
				? false
				: $old_value[ $diff[0] ];
		}

		if ( empty( $action ) || empty( $diff ) || empty( $widget ) ) {
			return false;
		}

		return array(
			'action' => $action,
			'widget' => self::get_widget_properties_for_tracks( $widget ),
		);
	}

	static function get_widget_properties_for_tracks( $widget ) {
		$sanitized = array();

		foreach ( (array) $widget as $key => $value ) {
			if ( '_multiwidget' == $key ) {
				continue;
			}
			if ( is_scalar( $value ) ) {
				$key = str_replace( '-', '_', sanitize_key( $key ) );
				$key = "widget_{$key}";
				$sanitized[ $key ] = $value;
			}
		}

		$filters_properties = ! empty( $widget['filters'] )
			? self::get_filter_properties_for_tracks( $widget['filters'] )
			: array();

		return array_merge( $sanitized, $filters_properties );
	}

	static function get_filter_properties_for_tracks( $filters ) {
		if ( empty( $filters ) ) {
			return $filters;
		}

		$filters_properties = array(
			'widget_filter_count' => count( $filters ),
		);

		foreach ( $filters as $filter ) {
			if ( empty( $filter['type'] ) ) {
				continue;
			}

			$key = sprintf( 'widget_filter_type_%s', $filter['type'] );
			if ( isset( $filters_properties[ $key ] ) ) {
				$filters_properties[ $key ]++;
			} else {
				$filters_properties[ $key ] = 1;
			}
		}

		return $filters_properties;
	}
}


1			<?php
2
3			class Jetpack_Search_Helpers {
4			const FILTER_WIDGET_BASE = 'jetpack-search-filters';
5
6			static function get_search_url() {
7			$query_args = $_GET;
8
9			// Handle the case where a permastruct is being used, such as /search/{$query}
10			if ( ! isset( $query_args['s'] ) ) {
11			$query_args['s'] = get_search_query();
12			}
13
14			if ( isset( $query_args['paged'] ) ) {
15			unset( $query_args['paged'] );
16			}
17
18			$query = http_build_query( $query_args );
19			return home_url( "?{$query}" );
20			}
21
22			static function add_query_arg( $key, $value = false ) {
23			if ( is_array( $key ) ) {
24			return add_query_arg( $key, self::get_search_url() );
25			}
26
27			return add_query_arg( $key, $value, self::get_search_url() );
28			}
29
30			static function remove_query_arg( $key ) {
31			return remove_query_arg( $key, self::get_search_url() );
32			}
33
34			static function get_widget_option_name() {
35			return sprintf( 'widget_%s', self::FILTER_WIDGET_BASE );
36			}
37
38			static function get_widgets_from_option() {
39			$widget_options = get_option( self::get_widget_option_name(), array() );
40
41			// We don't need this
42			if ( ! empty( $widget_options ) && isset( $widget_options['_multiwidget'] ) ) {
43			unset( $widget_options['_multiwidget'] );
44			}
45
46			return $widget_options;
47			}
48
49			static function build_widget_id( $number ) {
50			return sprintf( '%s-%d', self::FILTER_WIDGET_BASE, $number );
51			}
52
53			static function is_active_widget( $widget_id ) {
54			return (bool) is_active_widget( false, $widget_id, self::FILTER_WIDGET_BASE );
55			}
56
57			static function get_filters_from_widgets() {
58			$filters = array();
59
60			$widget_options = self::get_widgets_from_option();
61			if ( empty( $widget_options ) ) {
62			return $filters;
63			}
64
65			foreach ( (array) $widget_options as $number => $settings ) {
66			$widget_id = self::build_widget_id( $number );
67			if ( ! self::is_active_widget( $widget_id ) \|\| empty( $settings['filters'] ) ) {
68			continue;
69			}
70
71			if ( empty( $settings['use_filters'] ) ) {
72			continue;
73			}
74
75			foreach ( (array) $settings['filters'] as $widget_filter ) {
76			$widget_filter['widget_id'] = $widget_id;
77			$key = sprintf( '%s_%d', $widget_filter['type'], count( $filters ) );
78			$filters[ $key ] = $widget_filter;
79			}
80			}
81
82			return $filters;
83			}
84
85			/**
86			* Whether we should rerun a search in the customizer preview or not.
87			*
88			* @since 5.8.0
89			*
90			* @return bool
91			*/
92			static function should_rerun_search_in_customizer_preview() {
93			// Only update when in a customizer preview and data is being posted.
94			// Check for $_POST removes an extra update when the customizer loads.
95			//
96			// Note: We use $GLOBALS['wp_customize'] here instead of is_customize_preview() to support unit tests.
97			if ( ! isset( $GLOBALS['wp_customize'] ) \|\| ! $GLOBALS['wp_customize']->is_preview() \|\| empty( $_POST ) ) {
98			return false;
99			}
100
101			return true;
102			}
103
104			/**
105			* Since PHP's built-in array_diff() works by comparing the values that are in array 1 to the other arrays,
106			* if there are less values in array 1, it's possible to get an empty diff where one might be expected.
107			*
108			* @since 5.8.0
109			*
110			* @param array $array_1
111			* @param array $array_2
112			*
113			* @return array
114			*/
115			static function array_diff( $array_1, $array_2 ) {
116			// If the array counts are the same, then the order doesn't matter. If the count of
117			// $array_1 is higher than $array_2, that's also fine. If the count of $array_2 is higher,
118			// we need to swap the array order though.
119			if ( count( $array_1 ) != count( $array_2 ) && count( $array_2 ) > count( $array_1 ) ) {
120			$temp = $array_1;
121			$array_1 = $array_2;
122			$array_2 = $temp;
123			}
124
125			// Disregard keys
126			return array_values( array_diff( $array_1, $array_2 ) );
127			}
128
129			/**
130			* Given the widget instance, will return true when selected post types differ from searchable post types.
131			*
132			* @since 5.8.0
133			*
134			* @param array $instance
135			* @return bool
136			*/
137			static function post_types_differ_searchable( $instance ) {
138			if ( empty( $instance['post_types'] ) ) {
139			return false;
140			}
141
142			$searchable_post_types = get_post_types( array( 'exclude_from_search' => false ) );
143			$diff_of_searchable = self::array_diff( $searchable_post_types, (array) $instance['post_types'] );
144
145			return ! empty( $diff_of_searchable );
146			}
147
148			/**
149			* Given the widget instance, will return true when selected post types differ from the post type filters
150			* applied to the search.
151			*
152			* @since 5.8.0
153			*
154			* @param array $instance
155			* @return bool
156			*/
157			static function post_types_differ_query( $instance ) {
158			if ( empty( $instance['post_types'] ) ) {
159			return false;
160			}
161
162			if ( empty( $_GET['post_type'] ) ) {
163			$post_types_from_query = array();
164			} else if ( is_array( $_GET['post_type'] ) ) {
165			$post_types_from_query = $_GET['post_type'];
166			} else {
167			$post_types_from_query = (array) explode( ',', $_GET['post_type'] );
168			}
169
170			$post_types_from_query = array_map( 'trim', $post_types_from_query );
171
172			$diff_query = self::array_diff( (array) $instance['post_types'], $post_types_from_query );
173			return ! empty( $diff_query );
174			}
175
176			static function get_widget_tracks_value( $old_value, $new_value ) {
177			$old_value = (array) $old_value;
178			if ( isset( $old_value['_multiwidget'] ) ) {
179			unset( $old_value['_multiwidget'] );
180			}
181
182			$new_value = (array) $new_value;
183			if ( isset( $new_value['_multiwidget'] ) ) {
184			unset( $new_value['_multiwidget'] );
185			}
186
187			$action = '';
188			$old_keys = array_keys( $old_value );
189			$new_keys = array_keys( $new_value );
190
191			if ( count( $new_keys ) > count( $old_keys ) ) { // This is the case for a widget being added
192			$diff = self::array_diff( $new_keys, $old_keys );
193			$action = 'widget_added';
194			$widget = empty( $diff ) \|\| ! isset( $new_value[ $diff[0] ] )
195			? false
196			: $new_value[ $diff[0] ];
197			} else if ( count( $old_keys ) > count( $new_keys ) ) { // This is the case for a widget being deleted
198			$diff = self::array_diff( $old_keys, $new_keys );
199
200			$action = 'widget_deleted';
201			$widget = empty( $diff ) \|\| ! isset( $old_value[ $diff[0] ] )
202			? false
203			: $old_value[ $diff[0] ];
204			}
205
206			if ( empty( $action ) \|\| empty( $diff ) \|\| empty( $widget ) ) {
207			return false;
208			}
209
210			return array(
211			'action' => $action,
212			'widget' => self::get_widget_properties_for_tracks( $widget ),
213			);
214			}
215
216			static function get_widget_properties_for_tracks( $widget ) {
217			$sanitized = array();
218
219			foreach ( (array) $widget as $key => $value ) {
220			if ( '_multiwidget' == $key ) {
221			continue;
222			}
223			if ( is_scalar( $value ) ) {
224			$key = str_replace( '-', '_', sanitize_key( $key ) );
225			$key = "widget_{$key}";
226			$sanitized[ $key ] = $value;
227			}
228			}
229
230			$filters_properties = ! empty( $widget['filters'] )
231			? self::get_filter_properties_for_tracks( $widget['filters'] )
232			: array();
233
234			return array_merge( $sanitized, $filters_properties );
235			}
236
237			static function get_filter_properties_for_tracks( $filters ) {
238			if ( empty( $filters ) ) {
239			return $filters;
240			}
241
242			$filters_properties = array(
243			'widget_filter_count' => count( $filters ),
244			);
245
246			foreach ( $filters as $filter ) {
247			if ( empty( $filter['type'] ) ) {
248			continue;
249			}
250
251			$key = sprintf( 'widget_filter_type_%s', $filter['type'] );
252			if ( isset( $filters_properties[ $key ] ) ) {
253			$filters_properties[ $key ]++;
254			} else {
255			$filters_properties[ $key ] = 1;
256			}
257			}
258
259			return $filters_properties;
260			}
261			}
262

Automattic / jetpack

Push — add/tracks-for-search ( 7901da...1c1db3 )

Jetpack_Search_Helpers::get_widget_option_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like