|
1
|
|
|
<?php |
|
|
|
|
|
|
2
|
|
|
/** |
|
3
|
|
|
* The GravityView New Search widget |
|
4
|
|
|
* |
|
5
|
|
|
* @package GravityView-DataTables-Ext |
|
6
|
|
|
* @license GPL2+ |
|
7
|
|
|
* @author Katz Web Services, Inc. |
|
8
|
|
|
* @link http://gravityview.co |
|
9
|
|
|
* @copyright Copyright 2014, Katz Web Services, Inc. |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
if ( ! defined( 'WPINC' ) ) { |
|
13
|
|
|
die; |
|
14
|
|
|
} |
|
15
|
|
|
|
|
16
|
|
|
class GravityView_Widget_Search extends \GV\Widget { |
|
17
|
|
|
|
|
18
|
|
|
public static $file; |
|
19
|
|
|
public static $instance; |
|
20
|
|
|
|
|
21
|
|
|
private $search_filters = array(); |
|
|
|
|
|
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* whether search method is GET or POST ( default: GET ) |
|
25
|
|
|
* @since 1.16.4 |
|
26
|
|
|
* @var string |
|
27
|
|
|
*/ |
|
28
|
|
|
private $search_method = 'get'; |
|
29
|
|
|
|
|
30
|
6 |
|
public function __construct() { |
|
31
|
|
|
|
|
32
|
6 |
|
$this->widget_id = 'search_bar'; |
|
33
|
6 |
|
$this->widget_description = esc_html__( 'Search form for searching entries.', 'gravityview' ); |
|
34
|
|
|
|
|
35
|
6 |
|
self::$instance = &$this; |
|
36
|
|
|
|
|
37
|
6 |
|
self::$file = plugin_dir_path( __FILE__ ); |
|
38
|
|
|
|
|
39
|
6 |
|
$default_values = array( 'header' => 0, 'footer' => 0 ); |
|
40
|
|
|
|
|
41
|
|
|
$settings = array( |
|
42
|
6 |
|
'search_layout' => array( |
|
43
|
6 |
|
'type' => 'radio', |
|
44
|
|
|
'full_width' => true, |
|
45
|
6 |
|
'label' => esc_html__( 'Search Layout', 'gravityview' ), |
|
46
|
6 |
|
'value' => 'horizontal', |
|
47
|
|
|
'options' => array( |
|
48
|
6 |
|
'horizontal' => esc_html__( 'Horizontal', 'gravityview' ), |
|
49
|
6 |
|
'vertical' => esc_html__( 'Vertical', 'gravityview' ), |
|
50
|
|
|
), |
|
51
|
|
|
), |
|
52
|
|
|
'search_clear' => array( |
|
53
|
6 |
|
'type' => 'checkbox', |
|
54
|
6 |
|
'label' => __( 'Show Clear button', 'gravityview' ), |
|
55
|
|
|
'value' => false, |
|
56
|
|
|
), |
|
57
|
|
|
'search_fields' => array( |
|
58
|
|
|
'type' => 'hidden', |
|
59
|
|
|
'label' => '', |
|
60
|
|
|
'class' => 'gv-search-fields-value', |
|
61
|
|
|
'value' => '[{"field":"search_all","input":"input_text"}]', // Default: Search Everything text box |
|
62
|
|
|
), |
|
63
|
|
|
'search_mode' => array( |
|
64
|
6 |
|
'type' => 'radio', |
|
65
|
|
|
'full_width' => true, |
|
66
|
6 |
|
'label' => esc_html__( 'Search Mode', 'gravityview' ), |
|
67
|
6 |
|
'desc' => __('Should search results match all search fields, or any?', 'gravityview'), |
|
|
|
|
|
|
68
|
6 |
|
'value' => 'any', |
|
69
|
6 |
|
'class' => 'hide-if-js', |
|
70
|
|
|
'options' => array( |
|
71
|
6 |
|
'any' => esc_html__( 'Match Any Fields', 'gravityview' ), |
|
72
|
6 |
|
'all' => esc_html__( 'Match All Fields', 'gravityview' ), |
|
73
|
|
|
), |
|
74
|
|
|
), |
|
75
|
|
|
); |
|
76
|
|
|
|
|
77
|
6 |
|
if ( ! $this->is_registered() ) { |
|
78
|
|
|
// frontend - filter entries |
|
79
|
|
|
add_filter( 'gravityview_fe_search_criteria', array( $this, 'filter_entries' ), 10, 3 ); |
|
80
|
|
|
|
|
81
|
|
|
// frontend - add template path |
|
82
|
|
|
add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) ); |
|
83
|
|
|
|
|
84
|
|
|
// Add hidden fields for "Default" permalink structure |
|
85
|
|
|
add_filter( 'gravityview_widget_search_filters', array( $this, 'add_no_permalink_fields' ), 10, 3 ); |
|
86
|
|
|
|
|
87
|
|
|
// admin - add scripts - run at 1100 to make sure GravityView_Admin_Views::add_scripts_and_styles() runs first at 999 |
|
88
|
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'add_scripts_and_styles' ), 1100 ); |
|
89
|
|
|
add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts') ); |
|
|
|
|
|
|
90
|
|
|
add_filter( 'gravityview_noconflict_scripts', array( $this, 'register_no_conflict' ) ); |
|
91
|
|
|
|
|
92
|
|
|
// ajax - get the searchable fields |
|
93
|
|
|
add_action( 'wp_ajax_gv_searchable_fields', array( 'GravityView_Widget_Search', 'get_searchable_fields' ) ); |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
6 |
|
parent::__construct( esc_html__( 'Search Bar', 'gravityview' ), null, $default_values, $settings ); |
|
97
|
|
|
|
|
98
|
|
|
// calculate the search method (POST / GET) |
|
99
|
6 |
|
$this->set_search_method(); |
|
100
|
6 |
|
} |
|
101
|
|
|
|
|
102
|
|
|
/** |
|
103
|
|
|
* @return GravityView_Widget_Search |
|
104
|
|
|
*/ |
|
105
|
2 |
|
public static function getInstance() { |
|
|
|
|
|
|
106
|
2 |
|
if ( empty( self::$instance ) ) { |
|
107
|
|
|
self::$instance = new GravityView_Widget_Search; |
|
108
|
|
|
} |
|
109
|
2 |
|
return self::$instance; |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
/** |
|
113
|
|
|
* Sets the search method to GET (default) or POST |
|
114
|
|
|
* @since 1.16.4 |
|
115
|
|
|
*/ |
|
116
|
6 |
|
private function set_search_method() { |
|
117
|
|
|
/** |
|
118
|
|
|
* @filter `gravityview/search/method` Modify the search form method (GET / POST) |
|
119
|
|
|
* @since 1.16.4 |
|
120
|
|
|
* @param string $search_method Assign an input type according to the form field type. Defaults: `boolean`, `multi`, `select`, `date`, `text` |
|
121
|
|
|
* @param string $field_type Gravity Forms field type (also the `name` parameter of GravityView_Field classes) |
|
122
|
|
|
*/ |
|
123
|
6 |
|
$method = apply_filters( 'gravityview/search/method', $this->search_method ); |
|
124
|
|
|
|
|
125
|
6 |
|
$method = strtolower( $method ); |
|
126
|
|
|
|
|
127
|
6 |
|
$this->search_method = in_array( $method, array( 'get', 'post' ) ) ? $method : 'get'; |
|
128
|
6 |
|
} |
|
129
|
|
|
|
|
130
|
|
|
/** |
|
131
|
|
|
* Returns the search method |
|
132
|
|
|
* @since 1.16.4 |
|
133
|
|
|
* @return string |
|
134
|
|
|
*/ |
|
135
|
2 |
|
public function get_search_method() { |
|
136
|
2 |
|
return $this->search_method; |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* Get the input types available for different field types |
|
141
|
|
|
* |
|
142
|
|
|
* @since 1.17.5 |
|
143
|
|
|
* |
|
144
|
|
|
* @return array [field type name] => (array|string) search bar input types |
|
145
|
|
|
*/ |
|
146
|
|
|
public static function get_input_types_by_field_type() { |
|
147
|
|
|
/** |
|
148
|
|
|
* Input Type groups |
|
149
|
|
|
* @see admin-search-widget.js (getSelectInput) |
|
150
|
|
|
* @var array |
|
151
|
|
|
*/ |
|
152
|
|
|
$input_types = array( |
|
153
|
|
|
'text' => array( 'input_text' ), |
|
154
|
|
|
'address' => array( 'input_text' ), |
|
155
|
|
|
'number' => array( 'input_text' ), |
|
156
|
|
|
'date' => array( 'date', 'date_range' ), |
|
157
|
|
|
'boolean' => array( 'single_checkbox' ), |
|
158
|
|
|
'select' => array( 'select', 'radio', 'link' ), |
|
159
|
|
|
'multi' => array( 'select', 'multiselect', 'radio', 'checkbox', 'link' ), |
|
160
|
|
|
); |
|
161
|
|
|
|
|
162
|
|
|
/** |
|
163
|
|
|
* @filter `gravityview/search/input_types` Change the types of search fields available to a field type |
|
164
|
|
|
* @see GravityView_Widget_Search::get_search_input_labels() for the available input types |
|
165
|
|
|
* @param array $input_types Associative array: key is field `name`, value is array of GravityView input types (note: use `input_text` for `text`) |
|
166
|
|
|
*/ |
|
167
|
|
|
$input_types = apply_filters( 'gravityview/search/input_types', $input_types ); |
|
168
|
|
|
|
|
169
|
|
|
return $input_types; |
|
170
|
|
|
} |
|
171
|
|
|
|
|
172
|
|
|
/** |
|
173
|
|
|
* Get labels for different types of search bar inputs |
|
174
|
|
|
* |
|
175
|
|
|
* @since 1.17.5 |
|
176
|
|
|
* |
|
177
|
|
|
* @return array [input type] => input type label |
|
178
|
|
|
*/ |
|
179
|
|
|
public static function get_search_input_labels() { |
|
180
|
|
|
/** |
|
181
|
|
|
* Input Type labels l10n |
|
182
|
|
|
* @see admin-search-widget.js (getSelectInput) |
|
183
|
|
|
* @var array |
|
184
|
|
|
*/ |
|
185
|
|
|
$input_labels = array( |
|
186
|
|
|
'input_text' => esc_html__( 'Text', 'gravityview' ), |
|
187
|
|
|
'date' => esc_html__( 'Date', 'gravityview' ), |
|
188
|
|
|
'select' => esc_html__( 'Select', 'gravityview' ), |
|
189
|
|
|
'multiselect' => esc_html__( 'Select (multiple values)', 'gravityview' ), |
|
190
|
|
|
'radio' => esc_html__( 'Radio', 'gravityview' ), |
|
191
|
|
|
'checkbox' => esc_html__( 'Checkbox', 'gravityview' ), |
|
192
|
|
|
'single_checkbox' => esc_html__( 'Checkbox', 'gravityview' ), |
|
193
|
|
|
'link' => esc_html__( 'Links', 'gravityview' ), |
|
194
|
|
|
'date_range' => esc_html__( 'Date range', 'gravityview' ), |
|
195
|
|
|
); |
|
196
|
|
|
|
|
197
|
|
|
/** |
|
198
|
|
|
* @filter `gravityview/search/input_types` Change the label of search field input types |
|
199
|
|
|
* @param array $input_types Associative array: key is input type name, value is label |
|
200
|
|
|
*/ |
|
201
|
|
|
$input_labels = apply_filters( 'gravityview/search/input_labels', $input_labels ); |
|
202
|
|
|
|
|
203
|
|
|
return $input_labels; |
|
204
|
|
|
} |
|
205
|
|
|
|
|
206
|
|
|
public static function get_search_input_label( $input_type ) { |
|
207
|
|
|
$labels = self::get_search_input_labels(); |
|
208
|
|
|
|
|
209
|
|
|
return \GV\Utils::get( $labels, $input_type, false ); |
|
210
|
|
|
} |
|
211
|
|
|
|
|
212
|
|
|
/** |
|
213
|
|
|
* Add script to Views edit screen (admin) |
|
214
|
|
|
* @param mixed $hook |
|
215
|
|
|
*/ |
|
216
|
|
|
public function add_scripts_and_styles( $hook ) { |
|
217
|
|
|
global $pagenow; |
|
|
|
|
|
|
218
|
|
|
|
|
219
|
|
|
// Don't process any scripts below here if it's not a GravityView page or the widgets screen |
|
220
|
|
|
if ( ! gravityview_is_admin_page( $hook, 'single' ) && ( 'widgets.php' !== $pagenow ) ) { |
|
|
|
|
|
|
221
|
|
|
return; |
|
222
|
|
|
} |
|
223
|
|
|
|
|
224
|
|
|
$script_min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min'; |
|
225
|
|
|
$script_source = empty( $script_min ) ? '/source' : ''; |
|
226
|
|
|
|
|
227
|
|
|
wp_enqueue_script( 'gravityview_searchwidget_admin', plugins_url( 'assets/js'.$script_source.'/admin-search-widget'.$script_min.'.js', __FILE__ ), array( 'jquery', 'gravityview_views_scripts' ), \GV\Plugin::$version ); |
|
228
|
|
|
|
|
229
|
|
|
wp_localize_script( 'gravityview_searchwidget_admin', 'gvSearchVar', array( |
|
230
|
|
|
'nonce' => wp_create_nonce( 'gravityview_ajaxsearchwidget' ), |
|
231
|
|
|
'label_nofields' => esc_html__( 'No search fields configured yet.', 'gravityview' ), |
|
232
|
|
|
'label_addfield' => esc_html__( 'Add Search Field', 'gravityview' ), |
|
233
|
|
|
'label_label' => esc_html__( 'Label', 'gravityview' ), |
|
234
|
|
|
'label_searchfield' => esc_html__( 'Search Field', 'gravityview' ), |
|
235
|
|
|
'label_inputtype' => esc_html__( 'Input Type', 'gravityview' ), |
|
236
|
|
|
'label_ajaxerror' => esc_html__( 'There was an error loading searchable fields. Save the View or refresh the page to fix this issue.', 'gravityview' ), |
|
237
|
|
|
'input_labels' => json_encode( self::get_search_input_labels() ), |
|
238
|
|
|
'input_types' => json_encode( self::get_input_types_by_field_type() ), |
|
239
|
|
|
) ); |
|
240
|
|
|
|
|
241
|
|
|
} |
|
242
|
|
|
|
|
243
|
|
|
/** |
|
244
|
|
|
* Add admin script to the no-conflict scripts whitelist |
|
245
|
|
|
* @param array $allowed Scripts allowed in no-conflict mode |
|
246
|
|
|
* @return array Scripts allowed in no-conflict mode, plus the search widget script |
|
247
|
|
|
*/ |
|
248
|
|
|
public function register_no_conflict( $allowed ) { |
|
249
|
|
|
$allowed[] = 'gravityview_searchwidget_admin'; |
|
250
|
|
|
return $allowed; |
|
251
|
|
|
} |
|
252
|
|
|
|
|
253
|
|
|
/** |
|
254
|
|
|
* Ajax |
|
255
|
|
|
* Returns the form fields ( only the searchable ones ) |
|
256
|
|
|
* |
|
257
|
|
|
* @access public |
|
258
|
|
|
* @return void |
|
259
|
|
|
*/ |
|
260
|
|
|
public static function get_searchable_fields() { |
|
261
|
|
|
|
|
262
|
|
|
if ( ! isset( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'gravityview_ajaxsearchwidget' ) ) { |
|
|
|
|
|
|
263
|
|
|
exit( '0' ); |
|
|
|
|
|
|
264
|
|
|
} |
|
265
|
|
|
|
|
266
|
|
|
$form = ''; |
|
267
|
|
|
|
|
268
|
|
|
// Fetch the form for the current View |
|
269
|
|
|
if ( ! empty( $_POST['view_id'] ) ) { |
|
270
|
|
|
|
|
271
|
|
|
$form = gravityview_get_form_id( $_POST['view_id'] ); |
|
|
|
|
|
|
272
|
|
|
|
|
273
|
|
|
} elseif ( ! empty( $_POST['formid'] ) ) { |
|
274
|
|
|
|
|
275
|
|
|
$form = (int) $_POST['formid']; |
|
|
|
|
|
|
276
|
|
|
|
|
277
|
|
|
} elseif ( ! empty( $_POST['template_id'] ) && class_exists( 'GravityView_Ajax' ) ) { |
|
278
|
|
|
|
|
279
|
|
|
$form = GravityView_Ajax::pre_get_form_fields( $_POST['template_id'] ); |
|
|
|
|
|
|
280
|
|
|
|
|
281
|
|
|
} |
|
282
|
|
|
|
|
283
|
|
|
// fetch form id assigned to the view |
|
284
|
|
|
$response = self::render_searchable_fields( $form ); |
|
285
|
|
|
|
|
286
|
|
|
exit( $response ); |
|
|
|
|
|
|
287
|
|
|
} |
|
288
|
|
|
|
|
289
|
|
|
/** |
|
290
|
|
|
* Generates html for the available Search Fields dropdown |
|
291
|
|
|
* @param int $form_id |
|
292
|
|
|
* @param string $current (for future use) |
|
293
|
|
|
* @return string |
|
294
|
|
|
*/ |
|
295
|
|
|
public static function render_searchable_fields( $form_id = null, $current = '' ) { |
|
296
|
|
|
|
|
297
|
|
|
if ( is_null( $form_id ) ) { |
|
298
|
|
|
return ''; |
|
299
|
|
|
} |
|
300
|
|
|
|
|
301
|
|
|
// start building output |
|
302
|
|
|
|
|
303
|
|
|
$output = '<select class="gv-search-fields">'; |
|
304
|
|
|
|
|
305
|
|
|
$custom_fields = array( |
|
306
|
|
|
'search_all' => array( |
|
307
|
|
|
'text' => esc_html__( 'Search Everything', 'gravityview' ), |
|
308
|
|
|
'type' => 'text', |
|
309
|
|
|
), |
|
310
|
|
|
'entry_date' => array( |
|
311
|
|
|
'text' => esc_html__( 'Entry Date', 'gravityview' ), |
|
312
|
|
|
'type' => 'date', |
|
313
|
|
|
), |
|
314
|
|
|
'entry_id' => array( |
|
315
|
|
|
'text' => esc_html__( 'Entry ID', 'gravityview' ), |
|
316
|
|
|
'type' => 'text', |
|
317
|
|
|
), |
|
318
|
|
|
'created_by' => array( |
|
319
|
|
|
'text' => esc_html__( 'Entry Creator', 'gravityview' ), |
|
320
|
|
|
'type' => 'select', |
|
321
|
|
|
), |
|
322
|
|
|
'is_starred' => array( |
|
323
|
|
|
'text' => esc_html__( 'Is Starred', 'gravityview' ), |
|
324
|
|
|
'type' => 'boolean', |
|
325
|
|
|
), |
|
326
|
|
|
); |
|
327
|
|
|
|
|
328
|
|
|
foreach( $custom_fields as $custom_field_key => $custom_field ) { |
|
329
|
|
|
$output .= sprintf( '<option value="%s" %s data-inputtypes="%s" data-placeholder="%s">%s</option>', $custom_field_key, selected( $custom_field_key, $current, false ), $custom_field['type'], self::get_field_label( array('field' => $custom_field_key ) ), $custom_field['text'] ); |
|
|
|
|
|
|
330
|
|
|
} |
|
331
|
|
|
|
|
332
|
|
|
// Get fields with sub-inputs and no parent |
|
333
|
|
|
$fields = gravityview_get_form_fields( $form_id, true, true ); |
|
334
|
|
|
|
|
335
|
|
|
/** |
|
336
|
|
|
* @filter `gravityview/search/searchable_fields` Modify the fields that are displayed as searchable in the Search Bar dropdown\n |
|
337
|
|
|
* @since 1.17 |
|
338
|
|
|
* @see gravityview_get_form_fields() Used to fetch the fields |
|
339
|
|
|
* @see GravityView_Widget_Search::get_search_input_types See this method to modify the type of input types allowed for a field |
|
340
|
|
|
* @param array $fields Array of searchable fields, as fetched by gravityview_get_form_fields() |
|
341
|
|
|
* @param int $form_id |
|
342
|
|
|
*/ |
|
343
|
|
|
$fields = apply_filters( 'gravityview/search/searchable_fields', $fields, $form_id ); |
|
344
|
|
|
|
|
345
|
|
|
if ( ! empty( $fields ) ) { |
|
346
|
|
|
|
|
347
|
|
|
$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', array( 'fileupload', 'post_image', 'post_id', 'section' ), null ); |
|
348
|
|
|
|
|
349
|
|
|
foreach ( $fields as $id => $field ) { |
|
350
|
|
|
|
|
351
|
|
|
if ( in_array( $field['type'], $blacklist_field_types ) ) { |
|
352
|
|
|
continue; |
|
353
|
|
|
} |
|
354
|
|
|
|
|
355
|
|
|
$types = self::get_search_input_types( $id, $field['type'] ); |
|
356
|
|
|
|
|
357
|
|
|
$output .= '<option value="'. $id .'" '. selected( $id, $current, false ).'data-inputtypes="'. esc_attr( $types ) .'">'. esc_html( $field['label'] ) .'</option>'; |
|
358
|
|
|
} |
|
359
|
|
|
} |
|
360
|
|
|
|
|
361
|
|
|
$output .= '</select>'; |
|
362
|
|
|
|
|
363
|
|
|
return $output; |
|
364
|
|
|
|
|
365
|
|
|
} |
|
366
|
|
|
|
|
367
|
|
|
/** |
|
368
|
|
|
* Assign an input type according to the form field type |
|
369
|
|
|
* |
|
370
|
|
|
* @see admin-search-widget.js |
|
371
|
|
|
* |
|
372
|
|
|
* @param string|int|float $field_id Gravity Forms field ID |
|
373
|
|
|
* @param string $field_type Gravity Forms field type (also the `name` parameter of GravityView_Field classes) |
|
374
|
|
|
* |
|
375
|
|
|
* @return string GV field search input type ('multi', 'boolean', 'select', 'date', 'text') |
|
376
|
|
|
*/ |
|
377
|
|
|
public static function get_search_input_types( $field_id = '', $field_type = null ) { |
|
378
|
|
|
|
|
379
|
|
|
// @todo - This needs to be improved - many fields have . including products and addresses |
|
380
|
|
|
if ( false !== strpos( (string) $field_id, '.' ) && in_array( $field_type, array( 'checkbox' ) ) || in_array( $field_id, array( 'is_fulfilled' ) ) ) { |
|
381
|
|
|
$input_type = 'boolean'; // on/off checkbox |
|
382
|
|
|
} elseif ( in_array( $field_type, array( 'checkbox', 'post_category', 'multiselect' ) ) ) { |
|
383
|
|
|
$input_type = 'multi'; //multiselect |
|
384
|
|
|
} elseif ( in_array( $field_type, array( 'select', 'radio' ) ) ) { |
|
385
|
|
|
$input_type = 'select'; |
|
386
|
|
|
} elseif ( in_array( $field_type, array( 'date' ) ) || in_array( $field_id, array( 'payment_date' ) ) ) { |
|
387
|
|
|
$input_type = 'date'; |
|
388
|
|
|
} elseif ( in_array( $field_type, array( 'number' ) ) || in_array( $field_id, array( 'payment_amount' ) ) ) { |
|
389
|
|
|
$input_type = 'number'; |
|
390
|
|
|
} else { |
|
391
|
|
|
$input_type = 'text'; |
|
392
|
|
|
} |
|
393
|
|
|
|
|
394
|
|
|
/** |
|
395
|
|
|
* @filter `gravityview/extension/search/input_type` Modify the search form input type based on field type |
|
396
|
|
|
* @since 1.2 |
|
397
|
|
|
* @since 1.19.2 Added $field_id parameter |
|
398
|
|
|
* @param string $input_type Assign an input type according to the form field type. Defaults: `boolean`, `multi`, `select`, `date`, `text` |
|
399
|
|
|
* @param string $field_type Gravity Forms field type (also the `name` parameter of GravityView_Field classes) |
|
400
|
|
|
* @param string|int|float $field_id ID of the field being processed |
|
401
|
|
|
*/ |
|
402
|
|
|
$input_type = apply_filters( 'gravityview/extension/search/input_type', $input_type, $field_type, $field_id ); |
|
403
|
|
|
|
|
404
|
|
|
return $input_type; |
|
405
|
|
|
} |
|
406
|
|
|
|
|
407
|
|
|
/** |
|
408
|
|
|
* Display hidden fields to add support for sites using Default permalink structure |
|
409
|
|
|
* |
|
410
|
|
|
* @since 1.8 |
|
411
|
|
|
* @return array Search fields, modified if not using permalinks |
|
412
|
|
|
*/ |
|
413
|
2 |
|
public function add_no_permalink_fields( $search_fields, $object, $widget_args = array() ) { |
|
414
|
|
|
/** @global WP_Rewrite $wp_rewrite */ |
|
415
|
2 |
|
global $wp_rewrite; |
|
|
|
|
|
|
416
|
|
|
|
|
417
|
|
|
// Support default permalink structure |
|
418
|
2 |
|
if ( false === $wp_rewrite->using_permalinks() ) { |
|
419
|
|
|
|
|
420
|
|
|
// By default, use current post. |
|
421
|
2 |
|
$post_id = 0; |
|
422
|
|
|
|
|
423
|
|
|
// We're in the WordPress Widget context, and an overriding post ID has been set. |
|
424
|
2 |
|
if ( ! empty( $widget_args['post_id'] ) ) { |
|
425
|
|
|
$post_id = absint( $widget_args['post_id'] ); |
|
426
|
|
|
} |
|
427
|
|
|
// We're in the WordPress Widget context, and the base View ID should be used |
|
428
|
2 |
|
else if ( ! empty( $widget_args['view_id'] ) ) { |
|
429
|
|
|
$post_id = absint( $widget_args['view_id'] ); |
|
430
|
|
|
} |
|
431
|
|
|
|
|
432
|
2 |
|
$args = gravityview_get_permalink_query_args( $post_id ); |
|
433
|
|
|
|
|
434
|
|
|
// Add hidden fields to the search form |
|
435
|
2 |
|
foreach ( $args as $key => $value ) { |
|
|
|
|
|
|
436
|
2 |
|
$search_fields[] = array( |
|
437
|
2 |
|
'name' => $key, |
|
438
|
2 |
|
'input' => 'hidden', |
|
439
|
2 |
|
'value' => $value, |
|
440
|
|
|
); |
|
441
|
|
|
} |
|
442
|
|
|
} |
|
443
|
|
|
|
|
444
|
2 |
|
return $search_fields; |
|
445
|
|
|
} |
|
446
|
|
|
|
|
447
|
|
|
/** |
|
448
|
|
|
* Get the fields that are searchable for a View |
|
449
|
|
|
* |
|
450
|
|
|
* @since 2.0 |
|
451
|
|
|
* @since 2.0.8.2 Added $with_full_field parameter |
|
452
|
|
|
* |
|
453
|
|
|
* @param \GV\View|null $view |
|
454
|
|
|
* @param bool $with_full_field Return full field array, or just field ID? Default: false (just field ID) |
|
455
|
|
|
* |
|
456
|
|
|
* TODO: Move to \GV\View, perhaps? And return a Field_Collection |
|
457
|
|
|
* TODO: Use in gravityview()->request->is_search() to calculate whether a valid search |
|
458
|
|
|
* |
|
459
|
3 |
|
* @return array If no View, returns empty array. Otherwise, returns array of fields configured in widgets and Search Bar for a View |
|
460
|
|
|
*/ |
|
461
|
|
|
private function get_view_searchable_fields( $view, $with_full_field = false ) { |
|
462
|
|
|
|
|
463
|
|
|
/** |
|
464
|
3 |
|
* Find all search widgets on the view and get the searchable fields settings. |
|
465
|
|
|
*/ |
|
466
|
3 |
|
$searchable_fields = array(); |
|
467
|
|
|
|
|
468
|
|
|
if ( ! $view ) { |
|
469
|
|
|
return $searchable_fields; |
|
470
|
|
|
} |
|
471
|
|
|
|
|
472
|
|
|
/** |
|
473
|
3 |
|
* Include the sidebar Widgets. |
|
474
|
|
|
*/ |
|
475
|
3 |
|
$widgets = (array) get_option( 'widget_gravityview_search', array() ); |
|
476
|
3 |
|
|
|
477
|
|
|
foreach ( $widgets as $widget ) { |
|
478
|
|
|
if ( ! empty( $widget['view_id'] ) && $widget['view_id'] == $view->ID ) { |
|
479
|
3 |
|
if( $_fields = json_decode( $widget['search_fields'], true ) ) { |
|
480
|
|
|
foreach ( $_fields as $field ) { |
|
481
|
|
|
$searchable_fields [] = $with_full_field ? $field : $field['field']; |
|
482
|
|
|
} |
|
483
|
|
|
} |
|
484
|
|
|
} |
|
485
|
3 |
|
} |
|
486
|
3 |
|
|
|
487
|
3 |
|
foreach ( $view->widgets->by_id( $this->get_widget_id() )->all() as $widget ) { |
|
488
|
3 |
|
if( $_fields = json_decode( $widget->configuration->get( 'search_fields' ), true ) ) { |
|
489
|
|
|
foreach ( $_fields as $field ) { |
|
490
|
|
|
$searchable_fields [] = $with_full_field ? $field : $field['field']; |
|
491
|
|
|
} |
|
492
|
|
|
} |
|
493
|
3 |
|
} |
|
494
|
|
|
|
|
495
|
|
|
return $searchable_fields; |
|
496
|
|
|
} |
|
497
|
|
|
|
|
498
|
|
|
/** --- Frontend --- */ |
|
499
|
|
|
|
|
500
|
|
|
/** |
|
501
|
|
|
* Calculate the search criteria to filter entries |
|
502
|
|
|
* @param array $search_criteria |
|
503
|
26 |
|
* @return array |
|
504
|
|
|
*/ |
|
505
|
26 |
|
public function filter_entries( $search_criteria, $form_id = null, $args = array() ) { |
|
506
|
|
|
|
|
507
|
|
|
if( 'post' === $this->search_method ) { |
|
508
|
26 |
|
$get = $_POST; |
|
|
|
|
|
|
509
|
|
|
} else { |
|
510
|
|
|
$get = $_GET; |
|
|
|
|
|
|
511
|
26 |
|
} |
|
512
|
|
|
|
|
513
|
26 |
|
$view = \GV\View::by_id( \GV\Utils::get( $args, 'id' ) ); |
|
514
|
|
|
|
|
515
|
26 |
|
gravityview()->log->debug( 'Requested $_{method}: ', array( 'method' => $this->search_method, 'data' => $get ) ); |
|
516
|
23 |
|
|
|
517
|
|
|
if ( empty( $get ) || ! is_array( $get ) ) { |
|
518
|
|
|
return $search_criteria; |
|
519
|
4 |
|
} |
|
520
|
|
|
|
|
521
|
4 |
|
$get = stripslashes_deep( $get ); |
|
522
|
|
|
|
|
523
|
|
|
$get = gv_map_deep( $get, 'rawurldecode' ); |
|
524
|
4 |
|
|
|
525
|
|
|
// Make sure array key is set up |
|
526
|
4 |
|
$search_criteria['field_filters'] = \GV\Utils::get( $search_criteria, 'field_filters', array() ); |
|
527
|
|
|
|
|
528
|
|
|
$searchable_fields = $this->get_view_searchable_fields( $view ); |
|
529
|
4 |
|
|
|
530
|
|
|
// add free search |
|
531
|
1 |
|
if ( isset( $get['gv_search'] ) && '' !== $get['gv_search'] && in_array( 'search_all', $searchable_fields ) ) { |
|
532
|
|
|
|
|
533
|
|
|
$search_all_value = trim( $get['gv_search'] ); |
|
534
|
|
|
|
|
535
|
|
|
/** |
|
536
|
|
|
* @filter `gravityview/search-all-split-words` Search for each word separately or the whole phrase? |
|
537
|
|
|
* @since 1.20.2 |
|
538
|
1 |
|
* @param bool $split_words True: split a phrase into words; False: search whole word only [Default: true] |
|
539
|
|
|
*/ |
|
540
|
1 |
|
$split_words = apply_filters( 'gravityview/search-all-split-words', true ); |
|
541
|
|
|
|
|
542
|
|
|
if ( $split_words ) { |
|
543
|
1 |
|
|
|
544
|
|
|
// Search for a piece |
|
545
|
1 |
|
$words = explode( ' ', $search_all_value ); |
|
546
|
|
|
|
|
547
|
|
|
$words = array_filter( $words ); |
|
548
|
|
|
|
|
549
|
|
|
} else { |
|
550
|
1 |
|
|
|
551
|
|
|
// Replace multiple spaces with one space |
|
552
|
1 |
|
$search_all_value = preg_replace( '/\s+/ism', ' ', $search_all_value ); |
|
553
|
|
|
|
|
554
|
|
|
$words = array( $search_all_value ); |
|
555
|
1 |
|
} |
|
556
|
1 |
|
|
|
557
|
1 |
|
foreach ( $words as $word ) { |
|
558
|
1 |
|
$search_criteria['field_filters'][] = array( |
|
559
|
1 |
|
'key' => null, // The field ID to search |
|
560
|
|
|
'value' => $word, // The value to search |
|
561
|
|
|
'operator' => 'contains', // What to search in. Options: `is` or `contains` |
|
562
|
|
|
); |
|
563
|
|
|
} |
|
564
|
|
|
} |
|
565
|
4 |
|
|
|
566
|
3 |
|
// start date & end date |
|
567
|
3 |
|
if ( in_array( 'entry_date', $searchable_fields ) ) { |
|
568
|
|
|
$curr_start = !empty( $get['gv_start'] ) ? $get['gv_start'] : ''; |
|
|
|
|
|
|
569
|
3 |
|
$curr_end = !empty( $get['gv_start'] ) ? $get['gv_end'] : ''; |
|
|
|
|
|
|
570
|
|
|
|
|
571
|
|
|
if ( $view ) { |
|
572
|
|
|
/** |
|
573
|
3 |
|
* Override start and end dates if View is limited to some already. |
|
574
|
1 |
|
*/ |
|
575
|
1 |
|
if ( $start_date =$view->settings->get( 'start_date' ) ) { |
|
|
|
|
|
|
576
|
|
|
if ( $start_timestamp = strtotime( $curr_start ) ) { |
|
577
|
|
|
$curr_start = $start_timestamp < strtotime( $start_date ) ? $start_date : $curr_start; |
|
578
|
3 |
|
} |
|
579
|
|
|
} |
|
580
|
|
|
if ( $end_date =$view->settings->get( 'end_date' ) ) { |
|
|
|
|
|
|
581
|
|
|
if ( $end_timestamp = strtotime( $curr_end ) ) { |
|
582
|
|
|
$curr_end = $end_timestamp > strtotime( $end_date ) ? $end_date : $curr_end; |
|
583
|
|
|
} |
|
584
|
|
|
} |
|
585
|
|
|
} |
|
586
|
|
|
|
|
587
|
|
|
/** |
|
588
|
|
|
* @filter `gravityview_date_created_adjust_timezone` Whether to adjust the timezone for entries. \n |
|
589
|
|
|
* date_created is stored in UTC format. Convert search date into UTC (also used on templates/fields/date_created.php) |
|
590
|
|
|
* @since 1.12 |
|
591
|
|
|
* @param[out,in] boolean $adjust_tz Use timezone-adjusted datetime? If true, adjusts date based on blog's timezone setting. If false, uses UTC setting. Default: true |
|
592
|
3 |
|
* @param[in] string $context Where the filter is being called from. `search` in this case. |
|
593
|
|
|
*/ |
|
594
|
|
|
$adjust_tz = apply_filters( 'gravityview_date_created_adjust_timezone', true, 'search' ); |
|
595
|
|
|
|
|
596
|
|
|
/** |
|
597
|
3 |
|
* Don't set $search_criteria['start_date'] if start_date is empty as it may lead to bad query results (GFAPI::get_entries) |
|
598
|
3 |
|
*/ |
|
599
|
3 |
|
if ( ! empty( $curr_start ) ) { |
|
600
|
|
|
$curr_start = date( 'Y-m-d H:i:s', strtotime( $curr_start ) ); |
|
601
|
|
|
$search_criteria['start_date'] = $adjust_tz ? get_gmt_from_date( $curr_start ) : $curr_start; |
|
602
|
3 |
|
} |
|
603
|
|
|
|
|
604
|
3 |
|
if ( ! empty( $curr_end ) ) { |
|
605
|
3 |
|
// Fast-forward 24 hour on the end time |
|
606
|
3 |
|
$curr_end = date( 'Y-m-d H:i:s', strtotime( $curr_end ) + DAY_IN_SECONDS ); |
|
607
|
3 |
|
$search_criteria['end_date'] = $adjust_tz ? get_gmt_from_date( $curr_end ) : $curr_end; |
|
608
|
|
|
if ( strpos( $search_criteria['end_date'], '00:00:00' ) ) { // See https://github.com/gravityview/GravityView/issues/1056 |
|
609
|
|
|
$search_criteria['end_date'] = date( 'Y-m-d H:i:s', strtotime( $search_criteria['end_date'] ) - 1 ); |
|
610
|
|
|
} |
|
611
|
|
|
} |
|
612
|
|
|
} |
|
613
|
4 |
|
|
|
614
|
2 |
|
// search for a specific entry ID |
|
615
|
2 |
|
if ( ! empty( $get[ 'gv_id' ] ) && in_array( 'entry_id', $searchable_fields ) ) { |
|
|
|
|
|
|
616
|
2 |
|
$search_criteria['field_filters'][] = array( |
|
617
|
2 |
|
'key' => 'id', |
|
618
|
|
|
'value' => absint( $get[ 'gv_id' ] ), |
|
|
|
|
|
|
619
|
|
|
'operator' => '=', |
|
620
|
|
|
); |
|
621
|
|
|
} |
|
622
|
4 |
|
|
|
623
|
2 |
|
// search for a specific Created_by ID |
|
624
|
2 |
|
if ( ! empty( $get[ 'gv_by' ] ) && in_array( 'created_by', $searchable_fields ) ) { |
|
|
|
|
|
|
625
|
2 |
|
$search_criteria['field_filters'][] = array( |
|
626
|
2 |
|
'key' => 'created_by', |
|
627
|
|
|
'value' => absint( $get['gv_by'] ), |
|
628
|
|
|
'operator' => '=', |
|
629
|
|
|
); |
|
630
|
|
|
} |
|
631
|
|
|
|
|
|
|
|
|
|
632
|
4 |
|
|
|
633
|
|
|
// Get search mode passed in URL |
|
634
|
|
|
$mode = isset( $get['mode'] ) && in_array( $get['mode'], array( 'any', 'all' ) ) ? $get['mode'] : 'any'; |
|
635
|
4 |
|
|
|
636
|
|
|
// get the other search filters |
|
637
|
4 |
|
foreach ( $get as $key => $value ) { |
|
638
|
3 |
|
|
|
639
|
|
|
if ( 0 !== strpos( $key, 'filter_' ) || gv_empty( $value, false, false ) || ( is_array( $value ) && count( $value ) === 1 && gv_empty( $value[0], false, false ) ) ) { |
|
|
|
|
|
|
640
|
|
|
continue; |
|
641
|
2 |
|
} |
|
642
|
|
|
|
|
643
|
|
|
$filter_key = $this->convert_request_key_to_filter_key( $key ); |
|
644
|
2 |
|
|
|
645
|
1 |
|
// could return simple filter or multiple filters |
|
646
|
|
|
if ( ! in_array( 'search_all', $searchable_fields ) && ! in_array( $filter_key , $searchable_fields ) ) { |
|
647
|
|
|
continue; |
|
648
|
1 |
|
} |
|
649
|
|
|
|
|
650
|
1 |
|
$filter = $this->prepare_field_filter( $filter_key, $value, $view ); |
|
651
|
|
|
|
|
652
|
|
|
if ( isset( $filter[0]['value'] ) ) { |
|
653
|
|
|
$search_criteria['field_filters'] = array_merge( $search_criteria['field_filters'], $filter ); |
|
654
|
|
|
|
|
655
|
|
|
// if date range type, set search mode to ALL |
|
656
|
|
|
if ( ! empty( $filter[0]['operator'] ) && in_array( $filter[0]['operator'], array( '>=', '<=', '>', '<' ) ) ) { |
|
657
|
1 |
|
$mode = 'all'; |
|
658
|
1 |
|
} |
|
659
|
|
|
} elseif( !empty( $filter ) ) { |
|
|
|
|
|
|
660
|
|
|
$search_criteria['field_filters'][] = $filter; |
|
661
|
|
|
} |
|
662
|
|
|
} |
|
663
|
|
|
|
|
664
|
|
|
/** |
|
665
|
|
|
* @filter `gravityview/search/mode` Set the Search Mode (`all` or `any`) |
|
666
|
|
|
* @since 1.5.1 |
|
667
|
4 |
|
* @param[out,in] string $mode Search mode (`any` vs `all`) |
|
668
|
|
|
*/ |
|
669
|
4 |
|
$search_criteria['field_filters']['mode'] = apply_filters( 'gravityview/search/mode', $mode ); |
|
670
|
|
|
|
|
671
|
4 |
|
gravityview()->log->debug( 'Returned Search Criteria: ', array( 'data' => $search_criteria ) ); |
|
672
|
|
|
|
|
673
|
4 |
|
unset( $get ); |
|
674
|
|
|
|
|
675
|
|
|
return $search_criteria; |
|
676
|
|
|
} |
|
677
|
|
|
|
|
678
|
|
|
/** |
|
679
|
|
|
* Convert $_GET/$_POST key to the field/meta ID |
|
680
|
|
|
* |
|
681
|
|
|
* Examples: |
|
682
|
|
|
* - `filter_is_starred` => `is_starred` |
|
683
|
|
|
* - `filter_1_2` => `1.2` |
|
684
|
|
|
* - `filter_5` => `5` |
|
685
|
|
|
* |
|
686
|
|
|
* @since 2.0 |
|
687
|
|
|
* |
|
688
|
|
|
* @param string $key $_GET/_$_POST search key |
|
689
|
|
|
* |
|
690
|
2 |
|
* @return string |
|
691
|
|
|
*/ |
|
692
|
2 |
|
private function convert_request_key_to_filter_key( $key ) { |
|
693
|
|
|
|
|
694
|
|
|
$field_id = str_replace( 'filter_', '', $key ); |
|
695
|
2 |
|
|
|
696
|
2 |
|
// calculates field_id, removing 'filter_' and for '_' for advanced fields ( like name or checkbox ) |
|
697
|
|
|
if ( preg_match('/^[0-9_]+$/ism', $field_id ) ) { |
|
|
|
|
|
|
698
|
|
|
$field_id = str_replace( '_', '.', $field_id ); |
|
699
|
2 |
|
} |
|
700
|
|
|
|
|
701
|
|
|
return $field_id; |
|
702
|
|
|
} |
|
703
|
|
|
|
|
704
|
|
|
/** |
|
705
|
|
|
* Prepare the field filters to GFAPI |
|
706
|
|
|
* |
|
707
|
|
|
* The type post_category, multiselect and checkbox support multi-select search - each value needs to be separated in an independent filter so we could apply the ANY search mode. |
|
708
|
|
|
* |
|
709
|
|
|
* Format searched values |
|
710
|
|
|
* |
|
711
|
|
|
* @param string $filter_key ID of the field, or entry meta key |
|
712
|
|
|
* @param string $value $_GET/$_POST search value |
|
713
|
|
|
* @param \GV\View $view The view we're looking at |
|
714
|
|
|
* |
|
715
|
1 |
|
* @return array 1 or 2 deph levels |
|
716
|
|
|
*/ |
|
717
|
|
|
public function prepare_field_filter( $filter_key, $value, $view ) { |
|
718
|
1 |
|
|
|
719
|
|
|
// get form field array |
|
720
|
|
|
$form_field = is_numeric( $filter_key ) ? \GV\GF_Field::by_id( $view->form, $filter_key ) : \GV\Internal_Field::by_id( $filter_key ); |
|
721
|
|
|
|
|
722
|
1 |
|
// default filter array |
|
723
|
1 |
|
$filter = array( |
|
724
|
|
|
'key' => $filter_key, |
|
725
|
|
|
'value' => $value, |
|
726
|
1 |
|
); |
|
727
|
|
|
|
|
728
|
1 |
|
switch ( $form_field->type ) { |
|
729
|
1 |
|
|
|
730
|
1 |
|
case 'select': |
|
731
|
1 |
|
case 'radio': |
|
732
|
|
|
$filter['operator'] = 'is'; |
|
733
|
|
|
break; |
|
734
|
|
|
|
|
735
|
|
|
case 'post_category': |
|
736
|
|
|
|
|
737
|
|
|
if ( ! is_array( $value ) ) { |
|
738
|
|
|
$value = array( $value ); |
|
739
|
|
|
} |
|
740
|
|
|
|
|
741
|
|
|
// Reset filter variable |
|
742
|
|
|
$filter = array(); |
|
743
|
|
|
|
|
744
|
|
|
foreach ( $value as $val ) { |
|
745
|
|
|
$cat = get_term( $val, 'category' ); |
|
746
|
|
|
$filter[] = array( |
|
747
|
|
|
'key' => $filter_key, |
|
748
|
|
|
'value' => esc_attr( $cat->name ) . ':' . $val, |
|
749
|
|
|
'operator' => 'is', |
|
750
|
|
|
); |
|
751
|
|
|
} |
|
752
|
|
|
|
|
753
|
|
|
break; |
|
754
|
|
|
|
|
755
|
|
|
case 'multiselect': |
|
756
|
|
|
|
|
757
|
|
|
if ( ! is_array( $value ) ) { |
|
758
|
|
|
break; |
|
759
|
|
|
} |
|
760
|
|
|
|
|
761
|
|
|
// Reset filter variable |
|
762
|
|
|
$filter = array(); |
|
763
|
|
|
|
|
764
|
|
|
foreach ( $value as $val ) { |
|
765
|
|
|
$filter[] = array( 'key' => $filter_key, 'value' => $val ); |
|
766
|
|
|
} |
|
767
|
|
|
|
|
768
|
|
|
break; |
|
769
|
|
|
|
|
770
|
|
|
case 'checkbox': |
|
771
|
|
|
// convert checkbox on/off into the correct search filter |
|
772
|
|
|
if ( false !== strpos( $filter_key, '.' ) && ! empty( $form_field->inputs ) && ! empty( $form_field->choices ) ) { |
|
773
|
|
|
foreach ( $form_field->inputs as $k => $input ) { |
|
774
|
|
|
if ( $input['id'] == $filter_key ) { |
|
775
|
|
|
$filter['value'] = $form_field->choices[ $k ]['value']; |
|
776
|
|
|
$filter['operator'] = 'is'; |
|
777
|
|
|
break; |
|
778
|
|
|
} |
|
779
|
|
|
} |
|
780
|
|
|
} elseif ( is_array( $value ) ) { |
|
781
|
|
|
|
|
782
|
|
|
// Reset filter variable |
|
783
|
|
|
$filter = array(); |
|
784
|
|
|
|
|
785
|
|
|
foreach ( $value as $val ) { |
|
786
|
|
|
$filter[] = array( |
|
787
|
|
|
'key' => $filter_key, |
|
788
|
|
|
'value' => $val, |
|
789
|
|
|
'operator' => 'is', |
|
790
|
|
|
); |
|
791
|
|
|
} |
|
792
|
|
|
} |
|
793
|
|
|
|
|
794
|
|
|
break; |
|
795
|
|
|
|
|
796
|
|
|
case 'name': |
|
797
|
|
|
case 'address': |
|
798
|
|
|
|
|
799
|
|
|
if ( false === strpos( $filter_key, '.' ) ) { |
|
800
|
|
|
|
|
801
|
|
|
$words = explode( ' ', $value ); |
|
802
|
|
|
|
|
803
|
|
|
$filters = array(); |
|
804
|
|
|
foreach ( $words as $word ) { |
|
805
|
|
|
if ( ! empty( $word ) && strlen( $word ) > 1 ) { |
|
806
|
|
|
// Keep the same key for each filter |
|
807
|
|
|
$filter['value'] = $word; |
|
808
|
|
|
// Add a search for the value |
|
809
|
|
|
$filters[] = $filter; |
|
810
|
|
|
} |
|
811
|
|
|
} |
|
812
|
|
|
|
|
813
|
|
|
$filter = $filters; |
|
814
|
|
|
} |
|
815
|
|
|
|
|
816
|
|
|
// State/Province should be exact matches |
|
817
|
|
|
if ( 'address' === $form_field->field->type ) { |
|
818
|
|
|
|
|
819
|
|
|
$searchable_fields = $this->get_view_searchable_fields( $view, true ); |
|
820
|
|
|
|
|
821
|
|
|
foreach ( $searchable_fields as $searchable_field ) { |
|
822
|
|
|
|
|
823
|
|
|
if( $form_field->ID !== $searchable_field['field'] ) { |
|
824
|
|
|
continue; |
|
825
|
|
|
} |
|
826
|
|
|
|
|
827
|
|
|
// Only exact-match dropdowns, not text search |
|
828
|
|
|
if( in_array( $searchable_field['input'], array( 'text', 'search' ), true ) ) { |
|
829
|
|
|
continue; |
|
830
|
|
|
} |
|
831
|
|
|
|
|
832
|
|
|
$input_id = gravityview_get_input_id_from_id( $form_field->ID ); |
|
833
|
|
|
|
|
834
|
|
|
if ( 4 === $input_id ) { |
|
835
|
|
|
$filter['operator'] = 'is'; |
|
836
|
|
|
}; |
|
837
|
|
|
} |
|
838
|
|
|
} |
|
839
|
|
|
|
|
840
|
|
|
break; |
|
841
|
|
|
|
|
842
|
|
|
case 'date': |
|
843
|
|
|
|
|
844
|
|
|
if ( is_array( $value ) ) { |
|
845
|
|
|
|
|
846
|
|
|
// Reset filter variable |
|
847
|
|
|
$filter = array(); |
|
848
|
|
|
|
|
849
|
|
|
foreach ( $value as $k => $date ) { |
|
850
|
|
|
if ( empty( $date ) ) { |
|
851
|
|
|
continue; |
|
852
|
|
|
} |
|
853
|
|
|
$operator = 'start' === $k ? '>=' : '<='; |
|
854
|
1 |
|
|
|
855
|
|
|
/** |
|
856
|
|
|
* @hack |
|
857
|
|
|
* @since 1.16.3 |
|
858
|
|
|
* Safeguard until GF implements '<=' operator |
|
859
|
|
|
*/ |
|
860
|
|
|
if( !GFFormsModel::is_valid_operator( $operator ) && $operator === '<=' ) { |
|
|
|
|
|
|
861
|
|
|
$operator = '<'; |
|
862
|
|
|
$date = date( 'Y-m-d', strtotime( $date . ' +1 day' ) ); |
|
863
|
|
|
} |
|
864
|
|
|
|
|
865
|
|
|
$filter[] = array( |
|
866
|
|
|
'key' => $filter_key, |
|
867
|
|
|
'value' => self::get_formatted_date( $date, 'Y-m-d' ), |
|
868
|
|
|
'operator' => $operator, |
|
869
|
|
|
); |
|
870
|
|
|
} |
|
871
|
|
|
} else { |
|
872
|
|
|
$filter['value'] = self::get_formatted_date( $value, 'Y-m-d' ); |
|
873
|
|
|
} |
|
874
|
|
|
|
|
875
|
|
|
break; |
|
876
|
|
|
|
|
|
|
|
|
|
877
|
|
|
|
|
878
|
|
|
} // switch field type |
|
879
|
|
|
|
|
880
|
|
|
return $filter; |
|
881
|
|
|
} |
|
882
|
|
|
|
|
883
|
|
|
/** |
|
884
|
|
|
* Get the Field Format form GravityForms |
|
885
|
|
|
* |
|
886
|
|
|
* @param GF_Field_Date $field The field object |
|
887
|
|
|
* @since 1.10 |
|
888
|
|
|
* |
|
889
|
|
|
* @return string Format of the date in the database |
|
890
|
|
|
*/ |
|
891
|
|
|
public static function get_date_field_format( GF_Field_Date $field ) { |
|
892
|
|
|
$format = 'm/d/Y'; |
|
893
|
|
|
$datepicker = array( |
|
894
|
|
|
'mdy' => 'm/d/Y', |
|
895
|
|
|
'dmy' => 'd/m/Y', |
|
896
|
|
|
'dmy_dash' => 'd-m-Y', |
|
897
|
|
|
'dmy_dot' => 'm.d.Y', |
|
898
|
|
|
'ymd_slash' => 'Y/m/d', |
|
899
|
|
|
'ymd_dash' => 'Y-m-d', |
|
900
|
|
|
'ymd_dot' => 'Y.m.d', |
|
901
|
|
|
); |
|
902
|
|
|
|
|
903
|
|
|
if ( ! empty( $field->dateFormat ) && isset( $datepicker[ $field->dateFormat ] ) ){ |
|
904
|
|
|
$format = $datepicker[ $field->dateFormat ]; |
|
905
|
24 |
|
} |
|
906
|
|
|
|
|
907
|
|
|
return $format; |
|
908
|
24 |
|
} |
|
909
|
|
|
|
|
910
|
24 |
|
/** |
|
911
|
|
|
* Format a date value |
|
912
|
|
|
* |
|
913
|
|
|
* @param string $value Date value input |
|
914
|
|
|
* @param string $format Wanted formatted date |
|
915
|
|
|
* @return string |
|
916
|
|
|
*/ |
|
917
|
|
|
public static function get_formatted_date( $value = '', $format = 'Y-m-d' ) { |
|
918
|
|
|
$date = date_create( $value ); |
|
919
|
|
|
if ( empty( $date ) ) { |
|
920
|
|
|
gravityview()->log->debug( 'Date format not valid: {value}', array( 'value' => $value ) ); |
|
921
|
|
|
return ''; |
|
922
|
2 |
|
} |
|
923
|
|
|
return $date->format( $format ); |
|
924
|
2 |
|
} |
|
925
|
|
|
|
|
926
|
2 |
|
|
|
927
|
2 |
|
/** |
|
928
|
|
|
* Include this extension templates path |
|
929
|
2 |
|
* @param array $file_paths List of template paths ordered |
|
930
|
|
|
*/ |
|
931
|
|
|
public function add_template_path( $file_paths ) { |
|
932
|
|
|
|
|
933
|
2 |
|
// Index 100 is the default GravityView template path. |
|
934
|
|
|
$file_paths[102] = self::$file . 'templates/'; |
|
935
|
|
|
|
|
936
|
|
|
return $file_paths; |
|
937
|
|
|
} |
|
938
|
|
|
|
|
939
|
|
|
/** |
|
940
|
|
|
* Check whether the configured search fields have a date field |
|
941
|
|
|
* |
|
942
|
|
|
* @since 1.17.5 |
|
943
|
|
|
* |
|
944
|
2 |
|
* @param array $search_fields |
|
945
|
|
|
* |
|
946
|
2 |
|
* @return bool True: has a `date` or `date_range` field |
|
947
|
|
|
*/ |
|
948
|
2 |
|
private function has_date_field( $search_fields ) { |
|
949
|
|
|
|
|
950
|
|
|
$has_date = false; |
|
951
|
|
|
|
|
952
|
|
|
foreach ( $search_fields as $k => $field ) { |
|
953
|
|
|
if ( in_array( $field['input'], array( 'date', 'date_range', 'entry_date' ) ) ) { |
|
954
|
2 |
|
$has_date = true; |
|
955
|
|
|
break; |
|
956
|
2 |
|
} |
|
957
|
|
|
} |
|
958
|
|
|
|
|
959
|
|
|
return $has_date; |
|
960
|
|
|
} |
|
961
|
|
|
|
|
962
|
|
|
/** |
|
963
|
2 |
|
* Renders the Search Widget |
|
964
|
|
|
* @param array $widget_args |
|
965
|
2 |
|
* @param string $content |
|
966
|
|
|
* @param string $context |
|
967
|
2 |
|
* |
|
968
|
|
|
* @return void |
|
969
|
2 |
|
*/ |
|
970
|
|
|
public function render_frontend( $widget_args, $content = '', $context = '' ) { |
|
971
|
2 |
|
/** @var GravityView_View $gravityview_view */ |
|
972
|
2 |
|
$gravityview_view = GravityView_View::getInstance(); |
|
973
|
2 |
|
|
|
974
|
2 |
|
if ( empty( $gravityview_view ) ) { |
|
975
|
2 |
|
gravityview()->log->debug( '$gravityview_view not instantiated yet.' ); |
|
976
|
|
|
return; |
|
977
|
|
|
} |
|
978
|
|
|
|
|
979
|
|
|
// get configured search fields |
|
980
|
|
|
$search_fields = ! empty( $widget_args['search_fields'] ) ? json_decode( $widget_args['search_fields'], true ) : ''; |
|
981
|
|
|
|
|
982
|
|
|
if ( empty( $search_fields ) || ! is_array( $search_fields ) ) { |
|
983
|
|
|
gravityview()->log->debug( 'No search fields configured for widget:', array( 'data' => $widget_args ) ); |
|
984
|
|
|
return; |
|
985
|
|
|
} |
|
986
|
|
|
|
|
|
|
|
|
|
987
|
|
|
|
|
988
|
|
|
// prepare fields |
|
989
|
|
|
foreach ( $search_fields as $k => $field ) { |
|
990
|
|
|
|
|
991
|
|
|
$updated_field = $field; |
|
992
|
|
|
|
|
993
|
|
|
$updated_field = $this->get_search_filter_details( $updated_field ); |
|
994
|
|
|
|
|
995
|
|
|
switch ( $field['field'] ) { |
|
996
|
|
|
|
|
997
|
|
|
case 'search_all': |
|
998
|
|
|
$updated_field['key'] = 'search_all'; |
|
999
|
|
|
$updated_field['input'] = 'search_all'; |
|
1000
|
2 |
|
$updated_field['value'] = $this->rgget_or_rgpost( 'gv_search' ); |
|
1001
|
|
|
break; |
|
1002
|
|
|
|
|
1003
|
2 |
|
case 'entry_date': |
|
1004
|
|
|
$updated_field['key'] = 'entry_date'; |
|
1005
|
|
|
$updated_field['input'] = 'entry_date'; |
|
1006
|
|
|
$updated_field['value'] = array( |
|
1007
|
|
|
'start' => $this->rgget_or_rgpost( 'gv_start' ), |
|
1008
|
|
|
'end' => $this->rgget_or_rgpost( 'gv_end' ), |
|
1009
|
|
|
); |
|
1010
|
|
|
break; |
|
1011
|
|
|
|
|
1012
|
|
|
case 'entry_id': |
|
1013
|
2 |
|
$updated_field['key'] = 'entry_id'; |
|
1014
|
|
|
$updated_field['input'] = 'entry_id'; |
|
1015
|
2 |
|
$updated_field['value'] = $this->rgget_or_rgpost( 'gv_id' ); |
|
1016
|
|
|
break; |
|
1017
|
|
|
|
|
1018
|
2 |
|
case 'created_by': |
|
1019
|
|
|
$updated_field['key'] = 'created_by'; |
|
1020
|
2 |
|
$updated_field['name'] = 'gv_by'; |
|
1021
|
|
|
$updated_field['value'] = $this->rgget_or_rgpost( 'gv_by' ); |
|
1022
|
2 |
|
$updated_field['choices'] = self::get_created_by_choices(); |
|
1023
|
|
|
break; |
|
1024
|
2 |
|
} |
|
1025
|
|
|
|
|
1026
|
2 |
|
$search_fields[ $k ] = $updated_field; |
|
1027
|
|
|
} |
|
1028
|
|
|
|
|
1029
|
|
|
gravityview()->log->debug( 'Calculated Search Fields: ', array( 'data' => $search_fields ) ); |
|
1030
|
|
|
|
|
1031
|
2 |
|
/** |
|
1032
|
|
|
* @filter `gravityview_widget_search_filters` Modify what fields are shown. The order of the fields in the $search_filters array controls the order as displayed in the search bar widget. |
|
1033
|
2 |
|
* @param array $search_fields Array of search filters with `key`, `label`, `value`, `type`, `choices` keys |
|
1034
|
2 |
|
* @param GravityView_Widget_Search $this Current widget object |
|
1035
|
|
|
* @param array $widget_args Args passed to this method. {@since 1.8} |
|
1036
|
|
|
* @param \GV\Template_Context $context {@since 2.0} |
|
1037
|
|
|
* @var array |
|
1038
|
|
|
*/ |
|
1039
|
|
|
$gravityview_view->search_fields = apply_filters( 'gravityview_widget_search_filters', $search_fields, $this, $widget_args, $context ); |
|
|
|
|
|
|
1040
|
|
|
|
|
1041
|
|
|
$gravityview_view->search_layout = ! empty( $widget_args['search_layout'] ) ? $widget_args['search_layout'] : 'horizontal'; |
|
|
|
|
|
|
1042
|
|
|
|
|
1043
|
2 |
|
/** @since 1.14 */ |
|
1044
|
2 |
|
$gravityview_view->search_mode = ! empty( $widget_args['search_mode'] ) ? $widget_args['search_mode'] : 'any'; |
|
|
|
|
|
|
1045
|
|
|
|
|
1046
|
2 |
|
$custom_class = ! empty( $widget_args['custom_class'] ) ? $widget_args['custom_class'] : ''; |
|
1047
|
|
|
|
|
1048
|
2 |
|
$gravityview_view->search_class = self::get_search_class( $custom_class ); |
|
|
|
|
|
|
1049
|
|
|
|
|
1050
|
|
|
$gravityview_view->search_clear = ! empty( $widget_args['search_clear'] ) ? $widget_args['search_clear'] : false; |
|
|
|
|
|
|
1051
|
|
|
|
|
1052
|
|
|
if ( $this->has_date_field( $search_fields ) ) { |
|
1053
|
|
|
// enqueue datepicker stuff only if needed! |
|
1054
|
|
|
$this->enqueue_datepicker(); |
|
1055
|
|
|
} |
|
1056
|
2 |
|
|
|
1057
|
|
|
$this->maybe_enqueue_flexibility(); |
|
1058
|
|
|
|
|
1059
|
2 |
|
$gravityview_view->render( 'widget', 'search', false ); |
|
1060
|
|
|
} |
|
1061
|
2 |
|
|
|
1062
|
|
|
/** |
|
1063
|
|
|
* Get the search class for a search form |
|
1064
|
|
|
* |
|
1065
|
|
|
* @since 1.5.4 |
|
1066
|
|
|
* |
|
1067
|
|
|
* @return string Sanitized CSS class for the search form |
|
1068
|
|
|
*/ |
|
1069
|
|
|
public static function get_search_class( $custom_class = '' ) { |
|
1070
|
|
|
$gravityview_view = GravityView_View::getInstance(); |
|
1071
|
2 |
|
|
|
1072
|
2 |
|
$search_class = 'gv-search-'.$gravityview_view->search_layout; |
|
|
|
|
|
|
1073
|
|
|
|
|
1074
|
2 |
|
if ( ! empty( $custom_class ) ) { |
|
1075
|
|
|
$search_class .= ' '.$custom_class; |
|
1076
|
2 |
|
} |
|
1077
|
|
|
|
|
1078
|
2 |
|
/** |
|
1079
|
|
|
* @filter `gravityview_search_class` Modify the CSS class for the search form |
|
1080
|
|
|
* @param string $search_class The CSS class for the search form |
|
1081
|
|
|
*/ |
|
1082
|
|
|
$search_class = apply_filters( 'gravityview_search_class', $search_class ); |
|
1083
|
|
|
|
|
1084
|
|
|
// Is there an active search being performed? Used by fe-views.js |
|
1085
|
|
|
$search_class .= GravityView_frontend::getInstance()->isSearch() ? ' gv-is-search' : ''; |
|
1086
|
|
|
|
|
1087
|
2 |
|
return gravityview_sanitize_html_class( $search_class ); |
|
1088
|
|
|
} |
|
1089
|
2 |
|
|
|
1090
|
|
|
|
|
1091
|
2 |
|
/** |
|
1092
|
|
|
* Calculate the search form action |
|
1093
|
2 |
|
* @since 1.6 |
|
1094
|
|
|
* |
|
1095
|
2 |
|
* @return string |
|
1096
|
2 |
|
*/ |
|
1097
|
2 |
|
public static function get_search_form_action() { |
|
1098
|
2 |
|
$gravityview_view = GravityView_View::getInstance(); |
|
1099
|
|
|
|
|
1100
|
|
|
$post_id = $gravityview_view->getPostId() ? $gravityview_view->getPostId() : $gravityview_view->getViewId(); |
|
1101
|
|
|
|
|
1102
|
|
|
$url = add_query_arg( array(), get_permalink( $post_id ) ); |
|
1103
|
|
|
|
|
1104
|
|
|
return esc_url( $url ); |
|
1105
|
|
|
} |
|
1106
|
|
|
|
|
1107
|
|
|
/** |
|
1108
|
|
|
* Get the label for a search form field |
|
1109
|
|
|
* @param array $field Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys |
|
1110
|
|
|
* @param array $form_field Form field data, as fetched by `gravityview_get_field()` |
|
1111
|
|
|
* @return string Label for the search form |
|
1112
|
|
|
*/ |
|
1113
|
|
|
private static function get_field_label( $field, $form_field = array() ) { |
|
1114
|
|
|
|
|
1115
|
|
|
$label = \GV\Utils::_GET( 'label', \GV\Utils::get( $field, 'label' ) ); |
|
1116
|
|
|
|
|
1117
|
|
|
if ( ! $label ) { |
|
1118
|
|
|
|
|
1119
|
|
|
$label = isset( $form_field['label'] ) ? $form_field['label'] : ''; |
|
1120
|
|
|
|
|
1121
|
|
|
switch( $field['field'] ) { |
|
1122
|
|
|
case 'search_all': |
|
1123
|
|
|
$label = __( 'Search Entries:', 'gravityview' ); |
|
1124
|
|
|
break; |
|
1125
|
|
|
case 'entry_date': |
|
1126
|
|
|
$label = __( 'Filter by date:', 'gravityview' ); |
|
1127
|
|
|
break; |
|
1128
|
|
|
case 'entry_id': |
|
1129
|
|
|
$label = __( 'Entry ID:', 'gravityview' ); |
|
1130
|
|
|
break; |
|
1131
|
2 |
|
default: |
|
1132
|
|
|
// If this is a field input, not a field |
|
1133
|
2 |
|
if ( strpos( $field['field'], '.' ) > 0 && ! empty( $form_field['inputs'] ) ) { |
|
1134
|
|
|
|
|
1135
|
|
|
// Get the label for the field in question, which returns an array |
|
1136
|
|
|
$items = wp_list_filter( $form_field['inputs'], array( 'id' => $field['field'] ) ); |
|
1137
|
|
|
|
|
1138
|
|
|
// Get the item with the `label` key |
|
1139
|
|
|
$values = wp_list_pluck( $items, 'label' ); |
|
1140
|
|
|
|
|
1141
|
|
|
// There will only one item in the array, but this is easier |
|
1142
|
2 |
|
foreach ( $values as $value ) { |
|
1143
|
|
|
$label = $value; |
|
1144
|
2 |
|
break; |
|
1145
|
|
|
} |
|
1146
|
2 |
|
} |
|
1147
|
|
|
} |
|
1148
|
|
|
} |
|
1149
|
2 |
|
|
|
1150
|
|
|
/** |
|
1151
|
|
|
* @filter `gravityview_search_field_label` Modify the label for a search field. Supports returning HTML |
|
1152
|
2 |
|
* @since 1.17.3 Added $field parameter |
|
1153
|
|
|
* @param[in,out] string $label Existing label text, sanitized. |
|
1154
|
|
|
* @param[in] array $form_field Gravity Forms field array, as returned by `GFFormsModel::get_field()` |
|
1155
|
2 |
|
* @param[in] array $field Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys |
|
1156
|
|
|
*/ |
|
1157
|
|
|
$label = apply_filters( 'gravityview_search_field_label', esc_attr( $label ), $form_field, $field ); |
|
1158
|
2 |
|
|
|
1159
|
2 |
|
return $label; |
|
1160
|
2 |
|
} |
|
1161
|
2 |
|
|
|
1162
|
2 |
|
/** |
|
1163
|
2 |
|
* Prepare search fields to frontend render with other details (label, field type, searched values) |
|
1164
|
|
|
* |
|
1165
|
|
|
* @param array $field |
|
1166
|
|
|
* @return array |
|
1167
|
2 |
|
*/ |
|
1168
|
|
|
private function get_search_filter_details( $field ) { |
|
1169
|
2 |
|
|
|
1170
|
|
|
$gravityview_view = GravityView_View::getInstance(); |
|
1171
|
|
|
|
|
1172
|
|
|
$form = $gravityview_view->getForm(); |
|
1173
|
2 |
|
|
|
1174
|
|
|
// for advanced field ids (eg, first name / last name ) |
|
1175
|
|
|
$name = 'filter_' . str_replace( '.', '_', $field['field'] ); |
|
1176
|
|
|
|
|
1177
|
2 |
|
// get searched value from $_GET/$_POST (string or array) |
|
1178
|
|
|
$value = $this->rgget_or_rgpost( $name ); |
|
1179
|
|
|
|
|
1180
|
|
|
// get form field details |
|
1181
|
|
|
$form_field = gravityview_get_field( $form, $field['field'] ); |
|
1182
|
|
|
|
|
1183
|
|
|
$filter = array( |
|
1184
|
|
|
'key' => $field['field'], |
|
1185
|
|
|
'name' => $name, |
|
1186
|
|
|
'label' => self::get_field_label( $field, $form_field ), |
|
1187
|
|
|
'input' => $field['input'], |
|
1188
|
|
|
'value' => $value, |
|
1189
|
|
|
'type' => $form_field['type'], |
|
1190
|
|
|
); |
|
1191
|
|
|
|
|
1192
|
|
|
// collect choices |
|
1193
|
|
|
if ( 'post_category' === $form_field['type'] && ! empty( $form_field['displayAllCategories'] ) && empty( $form_field['choices'] ) ) { |
|
1194
|
|
|
$filter['choices'] = gravityview_get_terms_choices(); |
|
1195
|
|
|
} elseif ( ! empty( $form_field['choices'] ) ) { |
|
1196
|
|
|
$filter['choices'] = $form_field['choices']; |
|
1197
|
|
|
} |
|
1198
|
|
|
|
|
1199
|
|
|
if ( 'date_range' === $field['input'] && empty( $value ) ) { |
|
1200
|
|
|
$filter['value'] = array( 'start' => '', 'end' => '' ); |
|
1201
|
|
|
} |
|
1202
|
|
|
|
|
1203
|
|
|
return $filter; |
|
1204
|
|
|
|
|
1205
|
|
|
} |
|
1206
|
|
|
|
|
1207
|
|
|
/** |
|
1208
|
|
|
* Calculate the search choices for the users |
|
1209
|
|
|
* |
|
1210
|
|
|
* @since 1.8 |
|
1211
|
|
|
* |
|
1212
|
2 |
|
* @return array Array of user choices (value = ID, text = display name) |
|
1213
|
2 |
|
*/ |
|
1214
|
|
|
private static function get_created_by_choices() { |
|
1215
|
2 |
|
|
|
1216
|
|
|
/** |
|
1217
|
|
|
* filter gravityview/get_users/search_widget |
|
1218
|
|
|
* @see \GVCommon::get_users |
|
1219
|
|
|
*/ |
|
1220
|
|
|
$users = GVCommon::get_users( 'search_widget', array( 'fields' => array( 'ID', 'display_name' ) ) ); |
|
1221
|
|
|
|
|
1222
|
2 |
|
$choices = array(); |
|
1223
|
|
|
foreach ( $users as $user ) { |
|
1224
|
|
|
$choices[] = array( |
|
1225
|
|
|
'value' => $user->ID, |
|
1226
|
|
|
'text' => $user->display_name, |
|
1227
|
|
|
); |
|
1228
|
|
|
} |
|
1229
|
|
|
|
|
1230
|
|
|
return $choices; |
|
1231
|
|
|
} |
|
1232
|
|
|
|
|
1233
|
2 |
|
|
|
1234
|
2 |
|
/** |
|
1235
|
|
|
* Output the Clear Search Results button |
|
1236
|
2 |
|
* @since 1.5.4 |
|
1237
|
|
|
*/ |
|
1238
|
2 |
|
public static function the_clear_search_button() { |
|
1239
|
|
|
$gravityview_view = GravityView_View::getInstance(); |
|
1240
|
2 |
|
|
|
1241
|
|
|
if ( $gravityview_view->search_clear ) { |
|
|
|
|
|
|
1242
|
2 |
|
|
|
1243
|
|
|
$url = strtok( add_query_arg( array() ), '?' ); |
|
1244
|
|
|
|
|
1245
|
|
|
echo gravityview_get_link( $url, esc_html__( 'Clear', 'gravityview' ), 'class=button gv-search-clear' ); |
|
|
|
|
|
|
1246
|
|
|
|
|
1247
|
|
|
} |
|
1248
|
|
|
} |
|
1249
|
|
|
|
|
1250
|
|
|
/** |
|
1251
|
|
|
* Based on the search method, fetch the value for a specific key |
|
1252
|
|
|
* |
|
1253
|
|
|
* @since 1.16.4 |
|
1254
|
|
|
* |
|
1255
|
|
|
* @param string $name Name of the request key to fetch the value for |
|
1256
|
|
|
* |
|
1257
|
|
|
* @return mixed|string Value of request at $name key. Empty string if empty. |
|
1258
|
|
|
*/ |
|
1259
|
|
|
private function rgget_or_rgpost( $name ) { |
|
1260
|
|
|
$value = \GV\Utils::_REQUEST( $name ); |
|
1261
|
|
|
|
|
1262
|
|
|
$value = stripslashes_deep( $value ); |
|
1263
|
|
|
|
|
1264
|
|
|
$value = gv_map_deep( $value, 'rawurldecode' ); |
|
1265
|
|
|
|
|
1266
|
|
|
$value = gv_map_deep( $value, '_wp_specialchars' ); |
|
1267
|
|
|
|
|
1268
|
|
|
return $value; |
|
1269
|
|
|
} |
|
1270
|
|
|
|
|
1271
|
|
|
|
|
1272
|
|
|
/** |
|
1273
|
|
|
* Require the datepicker script for the frontend GV script |
|
1274
|
|
|
* @param array $js_dependencies Array of existing required scripts for the fe-views.js script |
|
1275
|
|
|
* @return array Array required scripts, with `jquery-ui-datepicker` added |
|
1276
|
|
|
*/ |
|
1277
|
|
|
public function add_datepicker_js_dependency( $js_dependencies ) { |
|
1278
|
|
|
|
|
1279
|
|
|
$js_dependencies[] = 'jquery-ui-datepicker'; |
|
1280
|
|
|
|
|
1281
|
|
|
return $js_dependencies; |
|
1282
|
|
|
} |
|
1283
|
|
|
|
|
1284
|
|
|
/** |
|
1285
|
|
|
* Modify the array passed to wp_localize_script() |
|
1286
|
|
|
* |
|
1287
|
|
|
* @param array $js_localization The data padded to the Javascript file |
|
|
|
|
|
|
1288
|
|
|
* @param array $view_data View data array with View settings |
|
1289
|
|
|
* |
|
1290
|
|
|
* @return array |
|
1291
|
|
|
*/ |
|
1292
|
|
|
public function add_datepicker_localization( $localizations = array(), $view_data = array() ) { |
|
1293
|
|
|
global $wp_locale; |
|
|
|
|
|
|
1294
|
|
|
|
|
1295
|
|
|
/** |
|
1296
|
|
|
* @filter `gravityview_datepicker_settings` Modify the datepicker settings |
|
1297
|
|
|
* @see http://api.jqueryui.com/datepicker/ Learn what settings are available |
|
1298
|
|
|
* @see http://www.renegadetechconsulting.com/tutorials/jquery-datepicker-and-wordpress-i18n Thanks for the helpful information on $wp_locale |
|
1299
|
|
|
* @param array $js_localization The data padded to the Javascript file |
|
1300
|
|
|
* @param array $view_data View data array with View settings |
|
1301
|
|
|
*/ |
|
1302
|
|
|
$datepicker_settings = apply_filters( 'gravityview_datepicker_settings', array( |
|
1303
|
|
|
'yearRange' => '-5:+5', |
|
1304
|
|
|
'changeMonth' => true, |
|
1305
|
|
|
'changeYear' => true, |
|
1306
|
|
|
'closeText' => esc_attr_x( 'Close', 'Close calendar', 'gravityview' ), |
|
1307
|
|
|
'prevText' => esc_attr_x( 'Prev', 'Previous month in calendar', 'gravityview' ), |
|
1308
|
|
|
'nextText' => esc_attr_x( 'Next', 'Next month in calendar', 'gravityview' ), |
|
1309
|
|
|
'currentText' => esc_attr_x( 'Today', 'Today in calendar', 'gravityview' ), |
|
1310
|
|
|
'weekHeader' => esc_attr_x( 'Week', 'Week in calendar', 'gravityview' ), |
|
1311
|
|
|
'monthStatus' => __( 'Show a different month', 'gravityview' ), |
|
1312
|
|
|
'monthNames' => array_values( $wp_locale->month ), |
|
1313
|
|
|
'monthNamesShort' => array_values( $wp_locale->month_abbrev ), |
|
1314
|
|
|
'dayNames' => array_values( $wp_locale->weekday ), |
|
1315
|
|
|
'dayNamesShort' => array_values( $wp_locale->weekday_abbrev ), |
|
1316
|
|
|
'dayNamesMin' => array_values( $wp_locale->weekday_initial ), |
|
1317
|
|
|
// get the start of week from WP general setting |
|
1318
|
|
|
'firstDay' => get_option( 'start_of_week' ), |
|
1319
|
|
|
// is Right to left language? default is false |
|
1320
|
|
|
'isRTL' => is_rtl(), |
|
1321
|
|
|
), $view_data ); |
|
1322
|
|
|
|
|
1323
|
2 |
|
$localizations['datepicker'] = $datepicker_settings; |
|
1324
|
2 |
|
|
|
1325
|
|
|
return $localizations; |
|
1326
|
|
|
|
|
1327
|
2 |
|
} |
|
1328
|
|
|
|
|
1329
|
|
|
/** |
|
1330
|
|
|
* Register search widget scripts, including Flexibility |
|
1331
|
|
|
* |
|
1332
|
|
|
* @see https://github.com/10up/flexibility |
|
1333
|
|
|
* |
|
1334
|
|
|
* @since 1.17 |
|
1335
|
|
|
* |
|
1336
|
|
|
* @return void |
|
1337
|
|
|
*/ |
|
1338
|
|
|
public function register_scripts() { |
|
1339
|
|
|
wp_register_script( 'gv-flexibility', plugins_url( 'assets/lib/flexibility/flexibility.js', GRAVITYVIEW_FILE ), array(), \GV\Plugin::$version, true ); |
|
1340
|
|
|
} |
|
1341
|
|
|
|
|
1342
|
|
|
/** |
|
1343
|
|
|
* If the current visitor is running IE 8 or 9, enqueue Flexibility |
|
1344
|
|
|
* |
|
1345
|
|
|
* @since 1.17 |
|
1346
|
|
|
* |
|
1347
|
|
|
* @return void |
|
1348
|
|
|
*/ |
|
1349
|
|
|
private function maybe_enqueue_flexibility() { |
|
1350
|
|
|
if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && preg_match( '/MSIE [8-9]/', $_SERVER['HTTP_USER_AGENT'] ) ) { |
|
|
|
|
|
|
1351
|
|
|
wp_enqueue_script( 'gv-flexibility' ); |
|
1352
|
|
|
} |
|
1353
|
|
|
} |
|
1354
|
|
|
|
|
1355
|
|
|
/** |
|
1356
|
|
|
* Enqueue the datepicker script |
|
1357
|
|
|
* |
|
1358
|
|
|
* It sets the $gravityview->datepicker_class parameter |
|
1359
|
|
|
* |
|
1360
|
|
|
* @todo Use own datepicker javascript instead of GF datepicker.js - that way, we can localize the settings and not require the changeMonth and changeYear pickers. |
|
1361
|
|
|
* @return void |
|
1362
|
|
|
*/ |
|
1363
|
|
|
public function enqueue_datepicker() { |
|
1364
|
|
|
$gravityview_view = GravityView_View::getInstance(); |
|
1365
|
|
|
|
|
1366
|
|
|
wp_enqueue_script( 'jquery-ui-datepicker' ); |
|
1367
|
|
|
|
|
1368
|
|
|
add_filter( 'gravityview_js_dependencies', array( $this, 'add_datepicker_js_dependency' ) ); |
|
1369
|
|
|
add_filter( 'gravityview_js_localization', array( $this, 'add_datepicker_localization' ), 10, 2 ); |
|
1370
|
|
|
|
|
1371
|
|
|
$scheme = is_ssl() ? 'https://' : 'http://'; |
|
1372
|
|
|
wp_enqueue_style( 'jquery-ui-datepicker', $scheme.'ajax.googleapis.com/ajax/libs/jqueryui/1.8.18/themes/smoothness/jquery-ui.css' ); |
|
1373
|
|
|
|
|
1374
|
|
|
/** |
|
1375
|
|
|
* @filter `gravityview_search_datepicker_class` |
|
1376
|
|
|
* Modify the CSS class for the datepicker, used by the CSS class is used by Gravity Forms' javascript to determine the format for the date picker. The `gv-datepicker` class is required by the GravityView datepicker javascript. |
|
1377
|
|
|
* @param string $css_class CSS class to use. Default: `gv-datepicker datepicker mdy` \n |
|
1378
|
|
|
* Options are: |
|
1379
|
|
|
* - `mdy` (mm/dd/yyyy) |
|
1380
|
|
|
* - `dmy` (dd/mm/yyyy) |
|
1381
|
|
|
* - `dmy_dash` (dd-mm-yyyy) |
|
1382
|
|
|
* - `dmy_dot` (dd.mm.yyyy) |
|
1383
|
|
|
* - `ymp_slash` (yyyy/mm/dd) |
|
1384
|
|
|
* - `ymd_dash` (yyyy-mm-dd) |
|
1385
|
|
|
* - `ymp_dot` (yyyy.mm.dd) |
|
1386
|
|
|
*/ |
|
1387
|
|
|
$datepicker_class = apply_filters( 'gravityview_search_datepicker_class', 'gv-datepicker datepicker mdy' ); |
|
1388
|
|
|
|
|
1389
|
|
|
$gravityview_view->datepicker_class = $datepicker_class; |
|
|
|
|
|
|
1390
|
|
|
|
|
1391
|
|
|
} |
|
1392
|
|
|
|
|
1393
|
|
|
|
|
1394
|
|
|
} // end class |
|
1395
|
|
|
|
|
1396
|
|
|
new GravityView_Widget_Search; |
|
1397
|
|
|
|
gravityview /
GravityView
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.