Completed
Pull Request — develop (#1484)
by Zack
33:52 queued 13:53
created

GravityView_frontend::setIsSearch()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 1
dl 0
loc 3
ccs 3
cts 3
cp 1
crap 1
rs 10
c 0
b 0
f 0
1
<?php
2
/**
3
 * GravityView Frontend functions
4
 *
5
 * @package   GravityView
6
 * @license   GPL2+
7
 * @author    GravityView <[email protected]>
8
 * @link      http://gravityview.co
9
 * @copyright Copyright 2014, Katz Web Services, Inc.
10
 *
11
 * @since 1.0.0
12
 */
13
14
15
class GravityView_frontend {
0 ignored issues
show
Coding Style introduced by
Since you have declared the constructor as private, maybe you should also declare the class as final.
Loading history...
16
17
	/**
18
	 * Regex strings that are used to determine whether the current request is a GravityView search or not.
19
	 * @see GravityView_frontend::is_searching()
20
	 * @since 1.7.4.1
21
	 * @var array
22
	 */
23
	private static $search_parameters = array( 'gv_search', 'gv_start', 'gv_end', 'gv_id', 'gv_by', 'filter_*' );
24
25
	/**
26
	 * Is the currently viewed post a `gravityview` post type?
27
	 * @var boolean
28
	 */
29
	var $is_gravityview_post_type = false;
30
31
	/**
32
	 * Does the current post have a `[gravityview]` shortcode?
33
	 * @var boolean
34
	 */
35
	var $post_has_shortcode = false;
36
37
	/**
38
	 * The Post ID of the currently viewed post. Not necessarily GV
39
	 * @var int
40
	 */
41
	var $post_id = null;
42
43
	/**
44
	 * Are we currently viewing a single entry?
45
	 * If so, the int value of the entry ID. Otherwise, false.
46
	 * @var int|boolean
47
	 */
48
	var $single_entry = false;
49
50
	/**
51
	 * If we are viewing a single entry, the entry data
52
	 * @var array|false
53
	 */
54
	var $entry = false;
55
56
	/**
57
	 * When displaying the single entry we should always know to which View it belongs (the context is everything!)
58
	 * @var null
59
	 */
60
	var $context_view_id = null;
61
62
	/**
63
	 * The View is showing search results
64
	 * @since 1.5.4
65
	 * @var boolean
66
	 */
67
	var $is_search = false;
68
69
	/**
70
	 * The view data parsed from the $post
71
	 *
72
	 * @see  GravityView_View_Data::__construct()
73
	 * @var GravityView_View_Data
74
	 */
75
	var $gv_output_data = null;
76
77
	/**
78
	 * @var GravityView_frontend
79
	 */
80
	static $instance;
81
82
	/**
83
	 * Class constructor, enforce Singleton pattern
84
	 */
85
	private function __construct() {}
86
87 39
	private function initialize() {
88 39
		add_action( 'wp', array( $this, 'parse_content'), 11 );
89 39
		add_filter( 'parse_query', array( $this, 'parse_query_fix_frontpage' ), 10 );
90 39
		add_action( 'template_redirect', array( $this, 'set_entry_data'), 1 );
91
92
		// Enqueue scripts and styles after GravityView_Template::register_styles()
93 39
		add_action( 'wp_enqueue_scripts', array( $this, 'add_scripts_and_styles' ), 20 );
94
95
		// Enqueue and print styles in the footer. Added 1 priorty so stuff gets printed at 10 priority.
96 39
		add_action( 'wp_print_footer_scripts', array( $this, 'add_scripts_and_styles' ), 1 );
97
98 39
		add_filter( 'the_title', array( $this, 'single_entry_title' ), 1, 2 );
99 39
		add_filter( 'comments_open', array( $this, 'comments_open' ), 10, 2 );
100
101 39
		add_action( 'gravityview_after', array( $this, 'context_not_configured_warning' ) );
102 39
	}
103
104
	/**
105
	 * Get the one true instantiated self
106
	 * @return GravityView_frontend
107
	 */
108 42
	public static function getInstance() {
109
110 42
		if ( empty( self::$instance ) ) {
111 39
			self::$instance = new self;
112 39
			self::$instance->initialize();
113
		}
114
115 42
		return self::$instance;
116
	}
117
118
	/**
119
	 * @return GravityView_View_Data
120
	 */
121 40
	public function getGvOutputData() {
122 40
		return $this->gv_output_data;
123
	}
124
125
	/**
126
	 * @param \GravityView_View_Data $gv_output_data
127
	 */
128 40
	public function setGvOutputData( $gv_output_data ) {
129 40
		$this->gv_output_data = $gv_output_data;
130 40
	}
131
132
	/**
133
	 * @return boolean
134
	 */
135 39
	public function isSearch() {
136 39
		return $this->is_search;
137
	}
138
139
	/**
140
	 * @param boolean $is_search
141
	 */
142 40
	public function setIsSearch( $is_search ) {
143 40
		$this->is_search = $is_search;
144 40
	}
145
146
	/**
147
	 * @return bool|int
148
	 */
149 41
	public function getSingleEntry() {
150 41
		return $this->single_entry;
151
	}
152
153
	/**
154
	 * Sets the single entry ID and also the entry
155
	 * @param bool|int|string $single_entry
156
	 */
157 39
	public function setSingleEntry( $single_entry ) {
158
159 39
		$this->single_entry = $single_entry;
160
161 39
	}
162
163
	/**
164
	 * @return array
165
	 */
166 39
	public function getEntry() {
167 39
		return $this->entry;
168
	}
169
170
	/**
171
	 * Set the current entry
172
	 * @param array|int $entry Entry array or entry slug or ID
173
	 */
174 39
	public function setEntry( $entry ) {
175
176 39
		if ( ! is_array( $entry ) ) {
177 30
			$entry = GVCommon::get_entry( $entry );
178
		}
179
180 39
		$this->entry = $entry;
181 39
	}
182
183
	/**
184
	 * @return int
185
	 */
186 40
	public function getPostId() {
187 40
		return $this->post_id;
188
	}
189
190
	/**
191
	 * @param int $post_id
192
	 */
193 40
	public function setPostId( $post_id ) {
194 40
		$this->post_id = $post_id;
195 40
	}
196
197
	/**
198
	 * @return boolean
199
	 */
200 41
	public function isPostHasShortcode() {
201 41
		return $this->post_has_shortcode;
202
	}
203
204
	/**
205
	 * @param boolean $post_has_shortcode
206
	 */
207 40
	public function setPostHasShortcode( $post_has_shortcode ) {
208 40
		$this->post_has_shortcode = $post_has_shortcode;
209 40
	}
210
211
	/**
212
	 * @return boolean
213
	 */
214 42
	public function isGravityviewPostType() {
215 42
		return $this->is_gravityview_post_type;
216
	}
217
218
	/**
219
	 * @param boolean $is_gravityview_post_type
220
	 */
221 40
	public function setIsGravityviewPostType( $is_gravityview_post_type ) {
222 40
		$this->is_gravityview_post_type = $is_gravityview_post_type;
223 40
	}
224
225
	/**
226
	 * Set the context view ID used when page contains multiple embedded views or displaying the single entry view
227
	 *
228
	 *
229
	 *
230
	 * @param null $view_id
231
	 */
232 3
	public function set_context_view_id( $view_id = null ) {
233 3
		$multiple_views = $this->getGvOutputData() && $this->getGvOutputData()->has_multiple_views();
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
234
235 3
		if ( ! empty( $view_id ) ) {
236
237 1
			$this->context_view_id = (int) $view_id;
238
239 3
		} elseif ( isset( $_GET['gvid'] ) && $multiple_views ) {
240
			/**
241
			 * used on a has_multiple_views context
242
			 * @see GravityView_API::entry_link
243
			 */
244
			$this->context_view_id = (int) $_GET['gvid'];
245
246 3
		} elseif ( ! $multiple_views ) {
247 3
			$array_keys = array_keys( $this->getGvOutputData()->get_views() );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::get_views() has been deprecated.

This method has been deprecated.

Loading history...
248 3
			$this->context_view_id = (int) array_pop( $array_keys );
249 3
			unset( $array_keys );
250
		}
251
252 3
	}
253
254
	/**
255
	 * Returns the the view_id context when page contains multiple embedded views or displaying single entry view
256
	 *
257
	 * @since 1.5.4
258
	 *
259
	 * @return int|null
260
	 */
261 39
	public function get_context_view_id() {
262 39
		return $this->context_view_id;
263
	}
264
265
	/**
266
	 * Allow GravityView entry endpoints on the front page of a site
267
	 *
268
	 * @link  https://core.trac.wordpress.org/ticket/23867 Fixes this core issue
269
	 * @link https://wordpress.org/plugins/cpt-on-front-page/ Code is based on this
270
	 *
271
	 * @since 1.17.3
272
	 *
273
	 * @param WP_Query &$query (passed by reference)
274
	 *
275
	 * @return void
276
	 */
277 186
	public function parse_query_fix_frontpage( &$query ) {
278 186
		global $wp_rewrite;
279
280 186
		$is_front_page = ( $query->is_home || $query->is_page );
281 186
		$show_on_front = ( 'page' === get_option('show_on_front') );
282 186
		$front_page_id = get_option('page_on_front');
283
284 186
		if (  $is_front_page && $show_on_front && $front_page_id ) {
285
286
			// Force to be an array, potentially a query string ( entry=16 )
287
			$_query = wp_parse_args( $query->query );
288
289
			// pagename can be set and empty depending on matched rewrite rules. Ignore an empty pagename.
290
			if ( isset( $_query['pagename'] ) && '' === $_query['pagename'] ) {
291
				unset( $_query['pagename'] );
292
			}
293
294
			// this is where will break from core wordpress
295
			/** @internal Don't use this filter; it will be unnecessary soon - it's just a patch for specific use case */
296
			$ignore = apply_filters( 'gravityview/internal/ignored_endpoints', array( 'preview', 'page', 'paged', 'cpage' ), $query );
297
			$endpoints = \GV\Utils::get( $wp_rewrite, 'endpoints' );
298
			foreach ( (array) $endpoints as $endpoint ) {
299
				$ignore[] = $endpoint[1];
300
			}
301
			unset( $endpoints );
302
303
			// Modify the query if:
304
			// - We're on the "Page on front" page (which we are), and:
305
			// - The query is empty OR
306
			// - The query includes keys that are associated with registered endpoints. `entry`, for example.
307
			if ( empty( $_query ) || ! array_diff( array_keys( $_query ), $ignore ) ) {
308
309
				$qv =& $query->query_vars;
310
311
				// Prevent redirect when on the single entry endpoint
312
				if( self::is_single_entry() ) {
313
					add_filter( 'redirect_canonical', '__return_false' );
314
				}
315
316
				$query->is_page = true;
317
				$query->is_home = false;
318
				$qv['page_id']  = $front_page_id;
319
320
				// Correct <!--nextpage--> for page_on_front
321
				if ( ! empty( $qv['paged'] ) ) {
322
					$qv['page'] = $qv['paged'];
323
					unset( $qv['paged'] );
324
				}
325
			}
326
327
			// reset the is_singular flag after our updated code above
328
			$query->is_singular = $query->is_single || $query->is_page || $query->is_attachment;
329
		}
330 186
	}
331
332
	/**
333
	 * Read the $post and process the View data inside
334
	 * @param  array  $wp Passed in the `wp` hook. Not used.
335
	 * @return void
336
	 */
337 2
	public function parse_content( $wp = array() ) {
0 ignored issues
show
Unused Code introduced by
The parameter $wp is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
338 2
		global $post;
339
340
		// If in admin and NOT AJAX request, get outta here.
341 2
		if ( gravityview()->request->is_admin() ) {
342
			return;
343
		}
344
345
		// Calculate requested Views
346 2
		$this->setGvOutputData( GravityView_View_Data::getInstance( $post ) );
347
348
		// !important: we need to run this before getting single entry (to kick the advanced filter)
349 2
		$this->set_context_view_id();
350
351 2
		$this->setIsGravityviewPostType( get_post_type( $post ) === 'gravityview' );
352
353 2
		$post_id = $this->getPostId() ? $this->getPostId() : (isset( $post ) ? $post->ID : null );
354 2
		$this->setPostId( $post_id );
355 2
		$post_has_shortcode = ! empty( $post->post_content ) ? gravityview_has_shortcode_r( $post->post_content, 'gravityview' ) : false;
356 2
		$this->setPostHasShortcode( $this->isGravityviewPostType() ? null : ! empty( $post_has_shortcode ) );
357
358
		// check if the View is showing search results (only for multiple entries View)
359 2
		$this->setIsSearch( $this->is_searching() );
360
361 2
		unset( $entry, $post_id, $post_has_shortcode );
362 2
	}
363
364
	/**
365
	 * Set the entry
366
	 */
367
	function set_entry_data() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
368
		$entry_id = self::is_single_entry();
369
		$this->setSingleEntry( $entry_id );
370
		$this->setEntry( $entry_id );
371
	}
372
373
	/**
374
	 * Checks if the current View is presenting search results
375
	 *
376
	 * @since 1.5.4
377
	 *
378
	 * @return boolean True: Yes, it's a search; False: No, not a search.
379
	 */
380 2
	function is_searching() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
381
382
		// It's a single entry, not search
383 2
		if ( $this->getSingleEntry() ) {
384 2
			return false;
385
		}
386
387 2
		$search_method = GravityView_Widget_Search::getInstance()->get_search_method();
388
389 2
		if( 'post' === $search_method ) {
390
			$get = $_POST;
391
		} else {
392 2
			$get = $_GET;
393
		}
394
395
		// No $_GET parameters
396 2
		if ( empty( $get ) || ! is_array( $get ) ) {
397 2
			return false;
398
		}
399
400
		// Remove empty values
401 1
		$get = array_filter( $get );
402
403
		// If the $_GET parameters are empty, it's no search.
404 1
		if ( empty( $get ) ) {
405
			return false;
406
		}
407
408 1
		$search_keys = array_keys( $get );
409
410 1
		$search_match = implode( '|', self::$search_parameters );
411
412 1
		foreach ( $search_keys as $search_key ) {
413
414
			// Analyze the search key $_GET parameter and see if it matches known GV args
415 1
			if ( preg_match( '/(' . $search_match . ')/i', $search_key ) ) {
416
				return true;
417
			}
418
		}
419
420 1
		return false;
421
	}
422
423
	/**
424
	 * Filter the title for the single entry view
425
	 *
426
	 * @param  string $passed_title  Current title
427
	 * @param  int $passed_post_id Post ID
428
	 * @return string (modified) title
429
	 */
430 9
	public function single_entry_title( $passed_title, $passed_post_id = null ) {
431 9
		global $post;
432
433
		// Since this is a public method, it can be called outside of the plugin. Don't assume things have been loaded properly.
434 9
		if ( ! class_exists( '\GV\Entry' ) ) {
435
			return $passed_title;
436
		}
437
438 9
		$gventry = gravityview()->request->is_entry();
439
440
		// If this is the directory view, return.
441 9
		if( ! $gventry ) {
442 8
			return $passed_title;
443
		}
444
445 1
		$entry = $gventry->as_entry();
446
447
		/**
448
		 * @filter `gravityview/single/title/out_loop` Apply the Single Entry Title filter outside the WordPress loop?
449
		 * @param boolean $in_the_loop Whether to apply the filter to the menu title and the meta tag <title> - outside the loop
450
		 * @param array $entry Current entry
451
		 */
452 1
		$apply_outside_loop = apply_filters( 'gravityview/single/title/out_loop', in_the_loop(), $entry );
453
454 1
		if ( ! $apply_outside_loop ) {
455 1
			return $passed_title;
456
		}
457
458
		// WooCommerce doesn't $post_id
459 1
		if ( empty( $passed_post_id ) )  {
460 1
			return $passed_title;
461
		}
462
463
		// Don't modify the title for anything other than the current view/post.
464
		// This is true for embedded shortcodes and Views.
465 1
		if ( is_object( $post ) && (int) $post->ID !== (int) $passed_post_id ) {
466 1
			return $passed_title;
467
		}
468
469 1
		$view = gravityview()->request->is_view();
470
471 1
		if( $view ) {
472 1
			return $this->_get_single_entry_title( $view, $entry, $passed_title );
473
		}
474
475 1
		$_gvid = \GV\Utils::_GET( 'gvid', null );
476
477
		// $_GET['gvid'] is set; we know what View to render
478 1
		if ( $_gvid ) {
479
480 1
			$view = \GV\View::by_id( $_gvid );
481
482 1
			return $this->_get_single_entry_title( $view, $entry, $passed_title );
483
		}
484
485 1
		global $post;
486
487 1
		if ( ! $post ) {
488
			return $passed_title;
489
		}
490
491 1
		$view_collection = \GV\View_Collection::from_post( $post );
492
493
		// We have multiple Views, but no gvid...this isn't valid security
494 1
		if( 1 < $view_collection->count() ) {
495 1
			return $passed_title;
496
		}
497
498
		return $this->_get_single_entry_title( $view_collection->first(), $entry, $passed_title );
499
	}
500
501
	/**
502
	 * Returns the single entry title for a View with variables replaced and shortcodes parsed
503
	 *
504
	 * @since 2.7.2
505
	 *
506
	 * @param \GV\View|null $view
507
	 * @param array $entry
508
	 * @param string $passed_title
509
	 *
510
	 * @return string
511
	 */
512
	private function _get_single_entry_title( $view, $entry = array(), $passed_title = '' ) {
513
514
		if ( ! $view ) {
515
			return $passed_title;
516
		}
517
518
		/**
519
		 * @filter `gravityview/single/title/check_entry_display` Override whether to check entry display rules against filters
520
		 * @internal This might change in the future! Don't rely on it.
521
		 * @since 2.7.2
522
		 * @param bool $check_entry_display Check whether the entry is visible for the current View configuration. Default: true.
523
		 * @param array $entry Gravity Forms entry array
524
		 * @param \GV\View $view The View
525
		 */
526
		$check_entry_display = apply_filters( 'gravityview/single/title/check_entry_display', true, $entry, $view );
527
528
		if( $check_entry_display ) {
529
530
			$check_display = GVCommon::check_entry_display( $entry, $view );
531
532
			if( is_wp_error( $check_display ) ) {
533
				return $passed_title;
534
			}
535
		}
536
537
		$title = $view->settings->get( 'single_title', $passed_title );
538
539
		$form = GVCommon::get_form( $entry['form_id'] );
540
541
		// We are allowing HTML in the fields, so no escaping the output
542
		$title = GravityView_API::replace_variables( $title, $form, $entry );
543
544
		$title = do_shortcode( $title );
545
546
		return $title;
547
	}
548
549
550
	/**
551
	 * In case View post is called directly, insert the view in the post content
552
	 *
553
	 * @deprecated Use \GV\View::content() instead.
554
	 *
555
	 * @static
556
	 * @param mixed $content
557
	 * @return string Add the View output into View CPT content
558
	 */
559 4
	public function insert_view_in_content( $content ) {
560 4
		gravityview()->log->notice( '\GravityView_frontend::insert_view_in_content is deprecated. Use \GV\View::content()' );
561 4
		return \GV\View::content( $content );
562
	}
563
564
	/**
565
	 * Disable comments on GravityView post types
566
	 * @param  boolean $open    existing status
567
	 * @param  int $post_id Post ID
568
	 * @return boolean
569
	 */
570
	public function comments_open( $open, $post_id ) {
571
572
		if ( $this->isGravityviewPostType() ) {
573
			$open = false;
574
		}
575
576
		/**
577
		 * @filter `gravityview/comments_open` Whether to set comments to open or closed.
578
		 * @since  1.5.4
579
		 * @param  boolean $open Open or closed status
580
		 * @param  int $post_id Post ID to set comment status for
581
		 */
582
		$open = apply_filters( 'gravityview/comments_open', $open, $post_id );
583
584
		return $open;
585
	}
586
587
	/**
588
	 * Display a warning when a View has not been configured
589
	 *
590
	 * @since 1.19.2
591
	 *
592
	 * @param int $view_id The ID of the View currently being displayed
593
	 *
594
	 * @return void
595
	 */
596 2
	public function context_not_configured_warning( $view_id = 0 ) {
597
598 2
		if ( ! class_exists( 'GravityView_View' ) ) {
599
			return;
600
		}
601
602 2
		$fields = GravityView_View::getInstance()->getContextFields();
603
604 2
		if ( ! empty( $fields ) ) {
605 2
			return;
606
		}
607
608
		$context = GravityView_View::getInstance()->getContext();
609
610
		switch( $context ) {
611
			case 'directory':
612
				$tab = __( 'Multiple Entries', 'gravityview' );
613
				break;
614
			case 'edit':
615
				$tab = __( 'Edit Entry', 'gravityview' );
616
				break;
617
			case 'single':
618
			default:
619
				$tab = __( 'Single Entry', 'gravityview' );
620
				break;
621
		}
622
623
624
		$title = sprintf( esc_html_x('The %s layout has not been configured.', 'Displayed when a View is not configured. %s is replaced by the tab label', 'gravityview' ), $tab );
625
		$edit_link = admin_url( sprintf( 'post.php?post=%d&action=edit#%s-view', $view_id, $context ) );
626
		$action_text = sprintf( esc_html__('Add fields to %s', 'gravityview' ), $tab );
627
		$message = esc_html__( 'You can only see this message because you are able to edit this View.', 'gravityview' );
628
629
		$image =  sprintf( '<img alt="%s" src="%s" style="margin-top: 10px;" />', $tab, esc_url(plugins_url( sprintf( 'assets/images/tab-%s.png', $context ), GRAVITYVIEW_FILE ) ) );
630
		$output = sprintf( '<h3>%s <strong><a href="%s">%s</a></strong></h3><p>%s</p>', $title, esc_url( $edit_link ), $action_text, $message );
631
632
		echo GVCommon::generate_notice( $output . $image, 'gv-error error', 'edit_gravityview', $view_id );
633
	}
634
635
636
	/**
637
	 * Core function to render a View based on a set of arguments
638
	 *
639
	 * @static
640
	 * @param array $passed_args {
641
	 *
642
	 *      Settings for rendering the View
643
	 *
644
	 *      @type int $id View id
645
	 *      @type int $page_size Number of entries to show per page
646
	 *      @type string $sort_field Form field id to sort
647
	 *      @type string $sort_direction Sorting direction ('ASC', 'DESC', or 'RAND')
648
	 *      @type string $start_date - Ymd
649
	 *      @type string $end_date - Ymd
650
	 *      @type string $class - assign a html class to the view
651
	 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
652
	 * }
653
	 *
654
	 * @deprecated Use \GV\View_Renderer
655
	 *
656
	 * @return string|null HTML output of a View, NULL if View isn't found
657
	 */
658 1
	public function render_view( $passed_args ) {
659 1
		gravityview()->log->notice( '\GravityView_frontend::render_view is deprecated. Use \GV\View_Renderer etc.' );
660
661
		/**
662
		 * We can use a shortcode here, since it's pretty much the same.
663
		 *
664
		 * But we do need to check embed permissions, since shortcodes don't do this.
665
		 */
666
667 1
		if ( ! $view = gravityview()->views->get( $passed_args ) ) {
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
668
			return null;
669
		}
670
671 1
		$view->settings->update( $passed_args );
672
673 1
		$direct_access = apply_filters( 'gravityview_direct_access', true, $view->ID );
674 1
		$embed_only = $view->settings->get( 'embed_only' );
675
676 1
		if( ! $direct_access || ( $embed_only && ! GVCommon::has_cap( 'read_private_gravityviews' ) ) ) {
677 1
			return __( 'You are not allowed to view this content.', 'gravityview' );
678
		}
679
680 1
		$shortcode = new \GV\Shortcodes\gravityview();
681 1
		return $shortcode->callback( $passed_args );
682
	}
683
684
	/**
685
	 * Process the start and end dates for a view - overrides values defined in shortcode (if needed)
686
	 *
687
	 * The `start_date` and `end_date` keys need to be in a format processable by GFFormsModel::get_date_range_where(),
688
	 * which uses \DateTime() format.
689
	 *
690
	 * You can set the `start_date` or `end_date` to any value allowed by {@link http://www.php.net//manual/en/function.strtotime.php strtotime()},
691
	 * including strings like "now" or "-1 year" or "-3 days".
692
	 *
693
	 * @see GFFormsModel::get_date_range_where
694
	 *
695
	 * @param  array      $args            View settings
696
	 * @param  array      $search_criteria Search being performed, if any
697
	 * @return array                       Modified `$search_criteria` array
698
	 */
699 75
	public static function process_search_dates( $args, $search_criteria = array() ) {
700
701 75
		$return_search_criteria = $search_criteria;
702
703 75
		foreach ( array( 'start_date', 'end_date' ) as $key ) {
704
705
706
			// Is the start date or end date set in the view or shortcode?
707
			// If so, we want to make sure that the search doesn't go outside the bounds defined.
708 75
			if ( ! empty( $args[ $key ] ) ) {
709
710
				// Get a timestamp and see if it's a valid date format
711 2
				$date = strtotime( $args[ $key ], GFCommon::get_local_timestamp() );
712
713
				// The date was invalid
714 2
				if ( empty( $date ) ) {
715
					gravityview()->log->error( ' Invalid {key} date format: {format}', array( 'key' => $key, 'format' => $args[ $key ] ) );
716
					continue;
717
				}
718
719
				// The format that Gravity Forms expects for start_date and day-specific (not hour/second-specific) end_date
720 2
				$datetime_format = 'Y-m-d H:i:s';
721 2
				$search_is_outside_view_bounds = false;
722
723 2
				if( ! empty( $search_criteria[ $key ] ) ) {
724
725 1
					$search_date = strtotime( $search_criteria[ $key ], GFCommon::get_local_timestamp() );
726
727
					// The search is for entries before the start date defined by the settings
728 1
					switch ( $key ) {
729 1
						case 'end_date':
730
							/**
731
							 * If the end date is formatted as 'Y-m-d', it should be formatted without hours and seconds
732
							 * so that Gravity Forms can convert the day to 23:59:59 the previous day.
733
							 *
734
							 * If it's a relative date ("now" or "-1 day"), then it should use the precise date format
735
							 *
736
							 * @see GFFormsModel::get_date_range_where
737
							 */
738 1
							$datetime_format               = gravityview_is_valid_datetime( $args[ $key ] ) ? 'Y-m-d' : $datetime_format;
739 1
							$search_is_outside_view_bounds = ( $search_date > $date );
740 1
							break;
741 1
						case 'start_date':
742 1
							$search_is_outside_view_bounds = ( $search_date < $date );
743 1
							break;
744
					}
745
				}
746
747
				// If there is no search being performed, or if there is a search being performed that's outside the bounds
748 2
				if ( empty( $search_criteria[ $key ] ) || $search_is_outside_view_bounds ) {
749
750
					// Then we override the search and re-set the start date
751 2
					$return_search_criteria[ $key ] = date_i18n( $datetime_format , $date, true );
752
				}
753
			}
754
		}
755
756 75
		if( isset( $return_search_criteria['start_date'] ) && isset( $return_search_criteria['end_date'] ) ) {
757
			// The start date is AFTER the end date. This will result in no results, but let's not force the issue.
758 2
			if ( strtotime( $return_search_criteria['start_date'] ) > strtotime( $return_search_criteria['end_date'] ) ) {
759 1
				gravityview()->log->error( 'Invalid search: the start date is after the end date.', array( 'data' => $return_search_criteria ) );
760
			}
761
		}
762
763 75
		return $return_search_criteria;
764
	}
765
766
767
	/**
768
	 * Process the approved only search criteria according to the View settings
769
	 *
770
	 * @param  array      $args            View settings
771
	 * @param  array      $search_criteria Search being performed, if any
772
	 * @return array                       Modified `$search_criteria` array
773
	 */
774 74
	public static function process_search_only_approved( $args, $search_criteria ) {
775
776
		/** @since 1.19 */
777 74
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
778
			gravityview()->log->debug( 'User can moderate entries; showing all approval statuses' );
779
			return $search_criteria;
780
		}
781
782 74
		if ( ! empty( $args['show_only_approved'] ) ) {
783
784 18
			$search_criteria['field_filters'][] = array(
785
				'key' => GravityView_Entry_Approval::meta_key,
786
				'value' => GravityView_Entry_Approval_Status::APPROVED
787
			);
788
789 18
			$search_criteria['field_filters']['mode'] = 'all'; // force all the criterias to be met
790
791 18
			gravityview()->log->debug( '[process_search_only_approved] Search Criteria if show only approved: ', array( 'data' => $search_criteria ) );
792
		}
793
794 74
		return $search_criteria;
795
	}
796
797
798
	/**
799
	 * Check if a certain entry is approved.
800
	 *
801
	 * If we pass the View settings ($args) it will check the 'show_only_approved' setting before
802
	 *   checking the entry approved field, returning true if show_only_approved = false.
803
	 *
804
	 * @since 1.7
805
	 * @since 1.18 Converted check to use GravityView_Entry_Approval_Status::is_approved
806
	 *
807
	 * @uses GravityView_Entry_Approval_Status::is_approved
808
	 *
809
	 * @param array $entry  Entry object
810
	 * @param array $args   View settings (optional)
811
	 *
812
	 * @return bool
813
	 */
814
	public static function is_entry_approved( $entry, $args = array() ) {
815
816
		if ( empty( $entry['id'] ) || ( array_key_exists( 'show_only_approved', $args ) && ! $args['show_only_approved'] ) ) {
817
			// is implicitly approved if entry is null or View settings doesn't require to check for approval
818
			return true;
819
		}
820
821
		/** @since 1.19 */
822
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
823
			gravityview()->log->debug( 'User can moderate entries, so entry is approved for viewing' );
824
			return true;
825
		}
826
827
		$is_approved = gform_get_meta( $entry['id'], GravityView_Entry_Approval::meta_key );
828
829
		return GravityView_Entry_Approval_Status::is_approved( $is_approved );
830
	}
831
832
	/**
833
	 * Parse search criteria for a entries search.
834
	 *
835
	 * array(
836
	 * 	'search_field' => 1, // ID of the field
837
	 *  'search_value' => '', // Value of the field to search
838
	 *  'search_operator' => 'contains', // 'is', 'isnot', '>', '<', 'contains'
839
	 *  'show_only_approved' => 0 or 1 // Boolean
840
	 * )
841
	 *
842
	 * @param  array $args    Array of args
843
	 * @param  int $form_id Gravity Forms form ID
844
	 * @return array          Array of search parameters, formatted in Gravity Forms mode, using `status` key set to "active" by default, `field_filters` array with `key`, `value` and `operator` keys.
845
	 */
846 75
	public static function get_search_criteria( $args, $form_id ) {
847
		/**
848
		 * Compatibility with filters hooking in `gravityview_search_criteria` instead of `gravityview_fe_search_criteria`.
849
		 */
850 75
		$criteria = apply_filters( 'gravityview_search_criteria', array(), array( $form_id ), \GV\Utils::get( $args, 'id' ) );
851 75
		$search_criteria = isset( $criteria['search_criteria'] ) ? $criteria['search_criteria'] : array( 'field_filters' => array() );
852
853
		/**
854
		 * @filter `gravityview_fe_search_criteria` Modify the search criteria
855
		 * @see GravityView_Widget_Search::filter_entries Adds the default search criteria
856
		 * @param array $search_criteria Empty `field_filters` key
857
		 * @param int $form_id ID of the Gravity Forms form that is being searched
858
		 * @param array $args The View settings.
859
		 */
860 75
		$search_criteria = apply_filters( 'gravityview_fe_search_criteria', $search_criteria, $form_id, $args );
861
862 75
		if ( ! is_array( $search_criteria ) ) {
863
			return array();
864
		}
865
866 75
		$original_search_criteria = $search_criteria;
867
868 75
		gravityview()->log->debug( '[get_search_criteria] Search Criteria after hook gravityview_fe_search_criteria: ', array( 'data' =>$search_criteria ) );
869
870
		// implicity search
871 75
		if ( ! empty( $args['search_value'] ) ) {
872
873
			// Search operator options. Options: `is` or `contains`
874 3
			$operator = ! empty( $args['search_operator'] ) && in_array( $args['search_operator'], array( 'is', 'isnot', '>', '<', 'contains' ) ) ? $args['search_operator'] : 'contains';
875
876 3
			$search_criteria['field_filters'][] = array(
877 3
				'key' => \GV\Utils::_GET( 'search_field', \GV\Utils::get( $args, 'search_field' ) ), // The field ID to search
878 3
				'value' => _wp_specialchars( $args['search_value'] ), // The value to search. Encode ampersands but not quotes.
879 3
				'operator' => $operator,
880
			);
881
882
			// Lock search mode to "all" with implicit presearch filter.
883 3
			$search_criteria['field_filters']['mode'] = 'all';
884
		}
885
886 75
		if( $search_criteria !== $original_search_criteria ) {
887 3
			gravityview()->log->debug( '[get_search_criteria] Search Criteria after implicity search: ', array( 'data' => $search_criteria ) );
888
		}
889
890
		// Handle setting date range
891 75
		$search_criteria = self::process_search_dates( $args, $search_criteria );
892
893 75
		if( $search_criteria !== $original_search_criteria ) {
894 4
			gravityview()->log->debug( '[get_search_criteria] Search Criteria after date params: ', array( 'data' => $search_criteria ) );
895
		}
896
897
		// remove not approved entries
898 75
		$search_criteria = self::process_search_only_approved( $args, $search_criteria );
899
900
		/**
901
		 * @filter `gravityview_status` Modify entry status requirements to be included in search results.
902
		 * @param string $status Default: `active`. Accepts all Gravity Forms entry statuses, including `spam` and `trash`
903
		 */
904 75
		$search_criteria['status'] = apply_filters( 'gravityview_status', 'active', $args );
905
906 75
		return $search_criteria;
907
	}
908
909
910
911
	/**
912
	 * Core function to calculate View multi entries (directory) based on a set of arguments ($args):
913
	 *   $id - View id
914
	 *   $page_size - Page
915
	 *   $sort_field - form field id to sort
916
	 *   $sort_direction - ASC / DESC
917
	 *   $start_date - Ymd
918
	 *   $end_date - Ymd
919
	 *   $class - assign a html class to the view
920
	 *   $offset (optional) - This is the start point in the current data set (0 index based).
921
	 *
922
	 *
923
	 *
924
	 * @uses  gravityview_get_entries()
925
	 * @param array $args\n
0 ignored issues
show
Bug introduced by
There is no parameter named $args\n. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
926
	 *   - $id - View id
927
	 *   - $page_size - Page
928
	 *   - $sort_field - form field id to sort
929
	 *   - $sort_direction - ASC / DESC
930
	 *   - $start_date - Ymd
931
	 *   - $end_date - Ymd
932
	 *   - $class - assign a html class to the view
933
	 *   - $offset (optional) - This is the start point in the current data set (0 index based).
934
	 * @param int $form_id Gravity Forms Form ID
935
	 * @return array Associative array with `count`, `entries`, and `paging` keys. `count` has the total entries count, `entries` is an array with Gravity Forms full entry data, `paging` is an array with `offset` and `page_size` keys
936
	 */
937 1
	public static function get_view_entries( $args, $form_id ) {
938
939 1
		gravityview()->log->debug( '[get_view_entries] init' );
940
		// start filters and sorting
941
942 1
		$parameters = self::get_view_entries_parameters( $args, $form_id );
943
944 1
		$count = 0; // Must be defined so that gravityview_get_entries can use by reference
945
946
		// fetch entries
947
		list( $entries, $paging, $count ) =
948 1
			\GV\Mocks\GravityView_frontend_get_view_entries( $args, $form_id, $parameters, $count );
949
950 1
		gravityview()->log->debug( 'Get Entries. Found: {count} entries', array( 'count' => $count, 'data' => $entries ) );
951
952
		/**
953
		 * @filter `gravityview_view_entries` Filter the entries output to the View
954
		 * @deprecated since 1.5.2
955
		 * @param array $args View settings associative array
956
		 * @var array
957
		 */
958 1
		$entries = apply_filters( 'gravityview_view_entries', $entries, $args );
959
960
		$return = array(
961 1
			'count' => $count,
962 1
			'entries' => $entries,
963 1
			'paging' => $paging,
964
		);
965
966
		/**
967
		 * @filter `gravityview/view/entries` Filter the entries output to the View
968
		 * @param array $criteria associative array containing count, entries & paging
969
		 * @param array $args View settings associative array
970
		 * @since 1.5.2
971
		 */
972 1
		return apply_filters( 'gravityview/view/entries', $return, $args );
973
	}
974
975
	/**
976
	 * Get an array of search parameters formatted as Gravity Forms requires
977
	 *
978
	 * Results are filtered by `gravityview_get_entries` and `gravityview_get_entries_{View ID}` filters
979
	 *
980
	 * @uses GravityView_frontend::get_search_criteria
981
	 * @uses GravityView_frontend::get_search_criteria_paging
982
	 *
983
	 * @since 1.20
984
	 *
985
	 * @see \GV\View_Settings::defaults For $args options
986
	 *
987
	 * @param array $args Array of View settings, as structured in \GV\View_Settings::defaults
988
	 * @param int $form_id Gravity Forms form ID to search
989
	 *
990
	 * @return array With `search_criteria`, `sorting`, `paging`, `cache` keys
991
	 */
992 74
	public static function get_view_entries_parameters( $args = array(), $form_id = 0 ) {
993
994
995 74
		if ( ! is_array( $args ) || ! is_numeric( $form_id ) ) {
996
997
			gravityview()->log->error( 'Passed args are not an array or the form ID is not numeric' );
998
999
			return array();
1000
		}
1001
1002 74
		$form_id = intval( $form_id );
1003
1004
		/**
1005
		 * Process search parameters
1006
		 * @var array
1007
		 */
1008 74
		$search_criteria = self::get_search_criteria( $args, $form_id );
1009
1010 74
		$paging = self::get_search_criteria_paging( $args );
1011
1012
		$parameters = array(
1013 74
			'search_criteria' => $search_criteria,
1014 74
			'sorting' => self::updateViewSorting( $args, $form_id ),
1015 74
			'paging' => $paging,
1016 74
			'cache' => isset( $args['cache'] ) ? $args['cache'] : true,
1017
		);
1018
1019
		/**
1020
		 * @filter `gravityview_get_entries` Filter get entries criteria
1021
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
1022
		 * @param array $args View configuration args. {
1023
		 *      @type int $id View id
1024
		 *      @type int $page_size Number of entries to show per page
1025
		 *      @type string $sort_field Form field id to sort
1026
		 *      @type string $sort_direction Sorting direction ('ASC', 'DESC', or 'RAND')
1027
		 *      @type string $start_date - Ymd
1028
		 *      @type string $end_date - Ymd
1029
		 *      @type string $class - assign a html class to the view
1030
		 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
1031
		 * }
1032
		 * @param int $form_id ID of Gravity Forms form
1033
		 */
1034 74
		$parameters = apply_filters( 'gravityview_get_entries', $parameters, $args, $form_id );
1035
1036
		/**
1037
		 * @filter `gravityview_get_entries_{View ID}` Filter get entries criteria
1038
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
1039
		 * @param array $args View configuration args.
1040
		 */
1041 74
		$parameters = apply_filters( 'gravityview_get_entries_'.\GV\Utils::get( $args, 'id' ), $parameters, $args, $form_id );
1042
1043 74
		gravityview()->log->debug( '$parameters passed to gravityview_get_entries(): ', array( 'data' => $parameters ) );
1044
1045 74
		return $parameters;
1046
	}
1047
1048
	/**
1049
	 * Get the paging array for the View
1050
	 *
1051
	 * @since 1.19.5
1052
	 *
1053
	 * @param $args
1054
	 * @param int $form_id
0 ignored issues
show
Bug introduced by
There is no parameter named $form_id. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
1055
	 */
1056 74
	public static function get_search_criteria_paging( $args ) {
1057
1058
		/**
1059
		 * @filter `gravityview_default_page_size` The default number of entries displayed in a View
1060
		 * @since 1.1.6
1061
		 * @param int $default_page_size Default: 25
1062
		 */
1063 74
		$default_page_size = apply_filters( 'gravityview_default_page_size', 25 );
1064
1065
		// Paging & offset
1066 74
		$page_size = ! empty( $args['page_size'] ) ? intval( $args['page_size'] ) : $default_page_size;
1067
1068 74
		if ( -1 === $page_size ) {
1069 1
			$page_size = PHP_INT_MAX;
1070
		}
1071
1072 74
		$curr_page = empty( $_GET['pagenum'] ) ? 1 : intval( $_GET['pagenum'] );
1073 74
		$offset = ( $curr_page - 1 ) * $page_size;
1074
1075 74
		if ( ! empty( $args['offset'] ) ) {
1076
			$offset += intval( $args['offset'] );
1077
		}
1078
1079
		$paging = array(
1080 74
			'offset' => $offset,
1081 74
			'page_size' => $page_size,
1082
		);
1083
1084 74
		gravityview()->log->debug( 'Paging: ', array( 'data' => $paging ) );
1085
1086 74
		return $paging;
1087
	}
1088
1089
	/**
1090
	 * Updates the View sorting criteria
1091
	 *
1092
	 * @since 1.7
1093
	 *
1094
	 * @param array $args View settings. Required to have `sort_field` and `sort_direction` keys
1095
	 * @param int $form_id The ID of the form used to sort
1096
	 * @return array $sorting Array with `key`, `direction` and `is_numeric` keys
1097
	 */
1098 74
	public static function updateViewSorting( $args, $form_id ) {
1099 74
		$sorting = array();
1100
1101 74
		$has_values = isset( $_GET['sort'] );
1102
1103 74
		if ( $has_values && is_array( $_GET['sort'] ) ) {
1104 2
			$sorts = array_keys( $_GET['sort'] );
1105 2
			$dirs  = array_values( $_GET['sort'] );
1106
1107 2
			if ( $has_values = array_filter( $dirs ) ) {
1108 2
				$sort_field_id = end( $sorts );
1109 2
				$sort_direction = end( $dirs );
1110
			}
1111
		}
1112
1113 74
		if ( ! isset( $sort_field_id ) ) {
1114 74
			$sort_field_id = isset( $_GET['sort'] ) ? $_GET['sort'] : \GV\Utils::get( $args, 'sort_field' );
1115
		}
1116
1117 74
		if ( ! isset( $sort_direction ) ) {
1118 74
			$sort_direction = isset( $_GET['dir'] ) ? $_GET['dir'] : \GV\Utils::get( $args, 'sort_direction' );
1119
		}
1120
1121 74
		if ( is_array( $sort_field_id ) ) {
1122 1
			$sort_field_id = array_pop( $sort_field_id );
1123
		}
1124
1125 74
		if ( is_array( $sort_direction ) ) {
1126
			$sort_direction = array_pop( $sort_direction );
1127
		}
1128
1129 74
		if ( ! empty( $sort_field_id ) ) {
1130 5
			if ( is_array( $sort_field_id ) ) {
1131
				$sort_direction = array_values( $sort_field_id );
1132
				$sort_field_id = array_keys( $sort_field_id );
1133
1134
				$sort_field_id = reset( $sort_field_id );
1135
				$sort_direction = reset( $sort_direction );
1136
			}
1137
1138 5
			$sort_field_id = self::_override_sorting_id_by_field_type( $sort_field_id, $form_id );
1139
			$sorting = array(
1140 5
				'key' => $sort_field_id,
1141 5
				'direction' => strtolower( $sort_direction ),
1142 5
				'is_numeric' => GVCommon::is_field_numeric( $form_id, $sort_field_id )
1143
			);
1144
1145 5
			if ( 'RAND' === $sort_direction ) {
1146
1147
				$form = GFAPI::get_form( $form_id );
1148
1149
				// Get the first GF_Field field ID, set as the key for entry randomization
1150
				if ( ! empty( $form['fields'] ) ) {
1151
1152
					/** @var GF_Field $field */
1153
					foreach ( $form['fields'] as $field ) {
1154
						if ( ! is_a( $field, 'GF_Field' ) ) {
1155
							continue;
1156
						}
1157
1158
						$sorting = array(
1159
							'key'        => $field->id,
1160
							'is_numeric' => false,
1161
							'direction'  => 'RAND',
1162
						);
1163
1164
						break;
1165
					}
1166
				}
1167
			}
1168
		}
1169
1170 74
		GravityView_View::getInstance()->setSorting( $sorting );
1171
1172 74
		gravityview()->log->debug( '[updateViewSorting] Sort Criteria : ', array( 'data' => $sorting ) );
1173
1174 74
		return $sorting;
1175
1176
	}
1177
1178
	/**
1179
	 * Override sorting per field
1180
	 *
1181
	 * Currently only modifies sorting ID when sorting by the full name. Sorts by first name.
1182
	 * Use the `gravityview/sorting/full-name` filter to override.
1183
	 *
1184
	 * @todo Filter from GravityView_Field
1185
	 * @since 1.7.4
1186
	 * @internal Hi developer! Although this is public, don't call this method; we're going to replace it.
1187
	 *
1188
	 * @param int|string|array $sort_field_id Field used for sorting (`id` or `1.2`), or an array for multisorts
1189
	 * @param int $form_id GF Form ID
1190
	 *
1191
	 * @return string Possibly modified sorting ID
1192
	 */
1193 5
	public static function _override_sorting_id_by_field_type( $sort_field_id, $form_id ) {
1194
1195 5
		if ( is_array( $sort_field_id ) ) {
1196
			$modified_ids = array();
1197
			foreach ( $sort_field_id as $_sort_field_id ) {
1198
				$modified_ids []= self::_override_sorting_id_by_field_type( $_sort_field_id, $form_id );
1199
			}
1200
			return $modified_ids;
1201
		}
1202
1203 5
		$form = gravityview_get_form( $form_id );
1204
1205 5
		$sort_field = GFFormsModel::get_field( $form, $sort_field_id );
1206
1207 5
		if( ! $sort_field ) {
1208
			return $sort_field_id;
1209
		}
1210
1211 5
		switch ( $sort_field['type'] ) {
1212
1213 5
			case 'address':
1214
				// Sorting by full address
1215
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1216
1217
					/**
1218
					 * Override how to sort when sorting address
1219
					 *
1220
					 * @since 1.8
1221
					 *
1222
					 * @param string $address_part `street`, `street2`, `city`, `state`, `zip`, or `country` (default: `city`)
1223
					 * @param string $sort_field_id Field used for sorting
1224
					 * @param int $form_id GF Form ID
1225
					 */
1226
					$address_part = apply_filters( 'gravityview/sorting/address', 'city', $sort_field_id, $form_id );
1227
1228
					switch( strtolower( $address_part ) ){
1229
						case 'street':
1230
							$sort_field_id .= '.1';
1231
							break;
1232
						case 'street2':
1233
							$sort_field_id .= '.2';
1234
							break;
1235
						default:
1236
						case 'city':
0 ignored issues
show
Unused Code introduced by
case 'city': $sort_f..._id .= '.3'; break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
1237
							$sort_field_id .= '.3';
1238
							break;
1239
						case 'state':
1240
							$sort_field_id .= '.4';
1241
							break;
1242
						case 'zip':
1243
							$sort_field_id .= '.5';
1244
							break;
1245
						case 'country':
1246
							$sort_field_id .= '.6';
1247
							break;
1248
					}
1249
1250
				}
1251
				break;
1252 5
			case 'name':
1253
				// Sorting by full name, not first, last, etc.
1254
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1255
					/**
1256
					 * @filter `gravityview/sorting/full-name` Override how to sort when sorting full name.
1257
					 * @since 1.7.4
1258
					 * @param[in,out] string $name_part Sort by `first` or `last` (default: `first`)
1259
					 * @param[in] string $sort_field_id Field used for sorting
1260
					 * @param[in] int $form_id GF Form ID
1261
					 */
1262
					$name_part = apply_filters( 'gravityview/sorting/full-name', 'first', $sort_field_id, $form_id );
1263
1264
					if ( 'last' === strtolower( $name_part ) ) {
1265
						$sort_field_id .= '.6';
1266
					} else {
1267
						$sort_field_id .= '.3';
1268
					}
1269
				}
1270
				break;
1271 5
			case 'list':
1272
				$sort_field_id = false;
1273
				break;
1274 5
			case 'time':
1275
1276
				/**
1277
				 * @filter `gravityview/sorting/time` Override how to sort when sorting time
1278
				 * @see GravityView_Field_Time
1279
				 * @since 1.14
1280
				 * @param[in,out] string $name_part Field used for sorting
1281
				 * @param[in] int $form_id GF Form ID
1282
				 */
1283 1
				$sort_field_id = apply_filters( 'gravityview/sorting/time', $sort_field_id, $form_id );
1284 1
				break;
1285
		}
1286
1287 5
		return $sort_field_id;
1288
	}
1289
1290
	/**
1291
	 * Verify if user requested a single entry view
1292
	 * @since 2.3.3 Added return null
1293
	 * @return boolean|string|null false if not, single entry slug if true, null if \GV\Entry doesn't exist yet
1294
	 */
1295 26
	public static function is_single_entry() {
1296
1297
		// Since this is a public method, it can be called outside of the plugin. Don't assume things have been loaded properly.
1298 26
		if ( ! class_exists( '\GV\Entry' ) ) {
1299
1300
			// Not using gravityview()->log->error(), since that may not exist yet either!
1301
			do_action( 'gravityview_log_error', '\GV\Entry not defined yet. Backtrace: ' . wp_debug_backtrace_summary()  );
1302
1303
			return null;
1304
		}
1305
1306 26
		$var_name = \GV\Entry::get_endpoint_name();
1307
1308 26
		$single_entry = get_query_var( $var_name );
1309
1310
		/**
1311
		 * Modify the entry that is being displayed.
1312
		 *
1313
		 * @internal Should only be used by things like the oEmbed functionality.
1314
		 * @since 1.6
1315
		 */
1316 26
		$single_entry = apply_filters( 'gravityview/is_single_entry', $single_entry );
1317
1318 26
		if ( empty( $single_entry ) ){
1319 4
			return false;
1320
		} else {
1321 22
			return $single_entry;
1322
		}
1323
	}
1324
1325
1326
	/**
1327
	 * Register styles and scripts
1328
	 *
1329
	 * @return void
1330
	 */
1331 1
	public function add_scripts_and_styles() {
1332 1
		global $post, $posts;
1333
		// enqueue template specific styles
1334 1
		if ( $this->getGvOutputData() ) {
1335
1336 1
			$views = $this->getGvOutputData()->get_views();
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::get_views() has been deprecated.

This method has been deprecated.

Loading history...
1337
1338 1
			foreach ( $views as $view_id => $data ) {
1339 1
				$view = \GV\View::by_id( $data['id'] );
1340 1
				$view_id = $view->ID;
1341 1
				$template_id = gravityview_get_template_id( $view->ID );
1342 1
				$data = $view->as_data();
0 ignored issues
show
Deprecated Code introduced by
The method GV\View::as_data() has been deprecated.

This method has been deprecated.

Loading history...
1343
1344
				/**
1345
				 * Don't enqueue the scripts or styles if it's not going to be displayed.
1346
				 * @since 1.15
1347
				 */
1348 1
				if( is_user_logged_in() && false === GVCommon::has_cap( 'read_gravityview', $view_id ) ) {
1349
					continue;
1350
				}
1351
1352
				// By default, no thickbox
1353 1
				$js_dependencies = array( 'jquery', 'gravityview-jquery-cookie' );
1354 1
				$css_dependencies = array();
1355
1356 1
				$lightbox = $view->settings->get( 'lightbox' );
1357
1358
				// If the thickbox is enqueued, add dependencies
1359 1
				if ( $lightbox ) {
1360
1361 1
					global $wp_filter;
1362
1363 1
					/**
1364
					 * @filter `gravity_view_lightbox_script` Override the lightbox script to enqueue. Default: `thickbox`
1365
					 * @param string $script_slug If you want to use a different lightbox script, return the name of it here.
1366
					 * @deprecated 2.5.1 Naming. See `gravityview_lightbox_script` instead.
1367
					 */
1368
					$js_dependency = apply_filters_deprecated( 'gravity_view_lightbox_script', array( 'thickbox' ), '2.5.1', 'gravityview_lightbox_script' );
1369
1370
					/**
1371
					 * @filter `gravityview_lightbox_script` Override the lightbox script to enqueue. Default: `thickbox`
1372 1
					 * @since 2.5.1
1373
					 * @param string $script_slug If you want to use a different lightbox script, return the name of it here.
1374
					 * @param \GV\View The View.
1375
					 */
1376
					$js_dependency = apply_filters( 'gravityview_lightbox_script', $js_dependency, $view );
1377
					$js_dependencies[] = $js_dependency;
1378
1379
					/**
1380 1
					 * @filter `gravity_view_lightbox_style` Modify the lightbox CSS slug. Default: `thickbox`
1381 1
					 * @param string $script_slug If you want to use a different lightbox script, return the name of its CSS file here.
1382
					 * @deprecated 2.5.1 Naming. See `gravityview_lightbox_style` instead.
1383 1
					 */
1384
					$css_dependency = apply_filters_deprecated( 'gravity_view_lightbox_style', array( 'thickbox' ), '2.5.1', 'gravityview_lightbox_style' );
1385
1386
					/**
1387
					 * @filter `gravityview_lightbox_script` Override the lightbox script to enqueue. Default: `thickbox`
1388
					 * @since 2.5.1
1389
					 * @param string $script_slug If you want to use a different lightbox script, return the name of it here.
1390
					 * @param \GV\View The View.
1391
					 */
1392 1
					$css_dependency = apply_filters( 'gravityview_lightbox_style', $css_dependency, $view );
1393
					$css_dependencies[] = $css_dependency;
1394
				}
1395
1396
				/**
1397
				 * If the form has checkbox fields, enqueue dashicons
1398
				 * @see https://github.com/katzwebservices/GravityView/issues/536
1399
				 * @since 1.15
1400 1
				 */
1401 1
				if( gravityview_view_has_single_checkbox_or_radio( $data['form'], $data['fields'] ) ) {
1402
					$css_dependencies[] = 'dashicons';
1403
				}
1404
1405
				wp_register_script( 'gravityview-jquery-cookie', plugins_url( 'assets/lib/jquery.cookie/jquery.cookie.min.js', GRAVITYVIEW_FILE ), array( 'jquery' ), GravityView_Plugin::version, true );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
1406
1407
				$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
1408
1409 1
				wp_register_script( 'gravityview-fe-view', plugins_url( 'assets/js/fe-views' . $script_debug . '.js', GRAVITYVIEW_FILE ), apply_filters( 'gravityview_js_dependencies', $js_dependencies ) , GravityView_Plugin::version, true );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
1410
1411
				wp_enqueue_script( 'gravityview-fe-view' );
1412
1413 1
				if ( ! empty( $data['atts']['sort_columns'] ) ) {
1414
					wp_enqueue_style( 'gravityview_font', plugins_url( 'assets/css/font.css', GRAVITYVIEW_FILE ), $css_dependencies, GravityView_Plugin::version, 'all' );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
1415 1
				}
1416
1417 1
				$this->enqueue_default_style( $css_dependencies );
1418
1419 1
				self::add_style( $template_id );
1420
			}
1421 1
1422
			if ( 'wp_print_footer_scripts' === current_filter() ) {
1423
1424
				$js_localization = array(
1425 1
					'cookiepath' => COOKIEPATH,
1426
					'clear' => _x( 'Clear', 'Clear all data from the form', 'gravityview' ),
1427 1
					'reset' => _x( 'Reset', 'Reset the search form to the state that existed on page load', 'gravityview' ),
1428
				);
1429
1430 1
				/**
1431
				 * @filter `gravityview_js_localization` Modify the array passed to wp_localize_script()
1432
				 * @param array $js_localization The data padded to the Javascript file
1433
				 * @param array $views Array of View data arrays with View settings
1434
				 */
1435
				$js_localization = apply_filters( 'gravityview_js_localization', $js_localization, $views );
1436
1437
				wp_localize_script( 'gravityview-fe-view', 'gvGlobals', $js_localization );
1438
			}
1439
		}
1440
	}
1441
1442
	/**
1443
	 * Handle enqueuing the `gravityview_default_style` stylesheet
1444
	 *
1445
	 * @since 1.17
1446
	 *
1447
	 * @param array $css_dependencies Dependencies for the `gravityview_default_style` stylesheet
1448 1
	 *
1449
	 * @return void
1450
	 */
1451
	private function enqueue_default_style( $css_dependencies = array() ) {
1452
1453
		/**
1454
		 * @filter `gravityview_use_legacy_search_css` Should GravityView use the legacy Search Bar stylesheet (from before Version 1.17)?
1455
		 * @since 1.17
1456
		 * @param bool $use_legacy_search_style If true, loads `gv-legacy-search(-rtl).css`. If false, loads `gv-default-styles(-rtl).css`. `-rtl` is added on RTL websites. Default: `false`
1457
		 */
1458
		$use_legacy_search_style = apply_filters( 'gravityview_use_legacy_search_style', false );
1459
1460
		$rtl = is_rtl() ? '-rtl' : '';
1461
1462
		$css_file_base = $use_legacy_search_style ? 'gv-legacy-search' : 'gv-default-styles';
1463
1464
		$path = gravityview_css_url( $css_file_base . $rtl . '.css' );
1465
1466
		wp_enqueue_style( 'gravityview_default_style', $path, $css_dependencies, GravityView_Plugin::version, 'all' );
0 ignored issues
show
Deprecated Code introduced by
The constant GravityView_Plugin::version has been deprecated with message: Use \GV\Plugin::$version

This class constant has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
1467
	}
1468
1469
	/**
1470
	 * Add template extra style if exists
1471
	 * @param string $template_id
1472
	 */
1473
	public static function add_style( $template_id ) {
1474
1475
		if ( ! empty( $template_id ) && wp_style_is( 'gravityview_style_' . $template_id, 'registered' ) ) {
1476
			gravityview()->log->debug(  'Adding extra template style for {template_id}', array( 'template_id' => $template_id ) );
1477
			wp_enqueue_style( 'gravityview_style_' . $template_id );
1478
		} elseif ( empty( $template_id ) ) {
1479
			gravityview()->log->error( 'Cannot add template style; template_id is empty' );
1480
		} else {
1481
			gravityview()->log->error( 'Cannot add template style; {template_id} is not registered', array( 'template_id' => 'gravityview_style_' . $template_id ) );
1482
		}
1483
1484
	}
1485
1486
1487
	/**
1488
	 * Inject the sorting links on the table columns
1489
	 *
1490
	 * Callback function for hook 'gravityview/template/field_label'
1491
	 * @see GravityView_API::field_label() (in includes/class-api.php)
1492
	 *
1493
	 * @since 1.7
1494
	 *
1495
	 * @param string $label Field label
1496
	 * @param array $field Field settings
1497
	 * @param array $form Form object
1498
	 *
1499
	 * @return string Field Label
1500
	 */
1501
	public function add_columns_sort_links( $label = '', $field, $form ) {
1502
1503
		/**
1504
		 * Not a table-based template; don't add sort icons
1505
		 * @since 1.12
1506
		 */
1507
		if( ! preg_match( '/table/ism', GravityView_View::getInstance()->getTemplatePartSlug() ) ) {
1508
			return $label;
1509
		}
1510
1511
		if ( ! $this->is_field_sortable( $field['id'], $form ) ) {
1512
			return $label;
1513
		}
1514
1515
		$sorting = GravityView_View::getInstance()->getSorting();
1516
1517
		$class = 'gv-sort';
1518
1519
		$sort_field_id = self::_override_sorting_id_by_field_type( $field['id'], $form['id'] );
1520
1521
		$sort_args = array(
1522
			'sort' => $field['id'],
1523
			'dir' => 'asc',
1524
		);
1525
1526
		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
1527
			//toggle sorting direction.
1528
			if ( 'asc' === $sorting['direction'] ) {
1529
				$sort_args['dir'] = 'desc';
1530
				$class .= ' gv-icon-sort-desc';
1531
			} else {
1532
				$sort_args['dir'] = 'asc';
1533
				$class .= ' gv-icon-sort-asc';
1534
			}
1535
		} else {
1536
			$class .= ' gv-icon-caret-up-down';
1537
		}
1538
1539
		$url = add_query_arg( $sort_args, remove_query_arg( array('pagenum') ) );
1540
1541
		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a>&nbsp;'. $label;
1542
1543
	}
1544
1545
	/**
1546
	 * Checks if field (column) is sortable
1547
	 *
1548
	 * @param string $field Field settings
0 ignored issues
show
Bug introduced by
There is no parameter named $field. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
1549
	 * @param array $form Gravity Forms form array
1550
	 *
1551
	 * @since 1.7
1552
	 *
1553
	 * @return bool True: Yes, field is sortable; False: not sortable
1554
	 */
1555
	public function is_field_sortable( $field_id = '', $form = array() ) {
1556
1557
		$field_type = $field_id;
1558
1559
		if( is_numeric( $field_id ) ) {
1560
			$field = GFFormsModel::get_field( $form, $field_id );
1561
			$field_type = $field ? $field->type : $field_id;
1562
		}
1563 1
1564
		$not_sortable = array(
1565 1
			'edit_link',
1566
			'delete_link',
1567 1
		);
1568 1
1569 1
		/**
1570
		 * @filter `gravityview/sortable/field_blacklist` Modify what fields should never be sortable.
1571
		 * @since 1.7
1572
		 * @param[in,out] array $not_sortable Array of field types that aren't sortable
1573 1
		 * @param string $field_type Field type to check whether the field is sortable
1574
		 * @param array $form Gravity Forms form
1575
		 */
1576
		$not_sortable = apply_filters( 'gravityview/sortable/field_blacklist', $not_sortable, $field_type, $form );
1577
1578
		if ( in_array( $field_type, $not_sortable ) ) {
1579
			return false;
1580
		}
1581
1582
		return apply_filters( "gravityview/sortable/formfield_{$form['id']}_{$field_id}", apply_filters( "gravityview/sortable/field_{$field_id}", true, $form ) );
1583
1584 1
	}
1585
1586 1
}
1587
1588
GravityView_frontend::getInstance();
1589
1590 1
1591
1592