Completed
Push — develop ( 1c83ad...4f9882 )
by Zack
26:36 queued 12:16
created

GravityView_frontend::render_view()   A

Complexity

Conditions 5
Paths 3

Size

Total Lines 25

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 5.0187

Importance

Changes 0
Metric Value
cc 5
nc 3
nop 1
dl 0
loc 25
ccs 10
cts 11
cp 0.9091
crap 5.0187
rs 9.2088
c 0
b 0
f 0
1
<?php
2
/**
3
 * GravityView Frontend functions
4
 *
5
 * @package   GravityView
6
 * @license   GPL2+
7
 * @author    Katz Web Services, Inc.
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 37
	private function initialize() {
88 37
		add_action( 'wp', array( $this, 'parse_content'), 11 );
89 37
		add_filter( 'parse_query', array( $this, 'parse_query_fix_frontpage' ), 10 );
90 37
		add_action( 'template_redirect', array( $this, 'set_entry_data'), 1 );
91
92
		// Enqueue scripts and styles after GravityView_Template::register_styles()
93 37
		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 37
		add_action( 'wp_print_footer_scripts', array( $this, 'add_scripts_and_styles' ), 1 );
97
98 37
		add_filter( 'the_title', array( $this, 'single_entry_title' ), 1, 2 );
99 37
		add_filter( 'comments_open', array( $this, 'comments_open' ), 10, 2 );
100
101 37
		add_action( 'gravityview_after', array( $this, 'context_not_configured_warning' ) );
102 37
	}
103
104
	/**
105
	 * Get the one true instantiated self
106
	 * @return GravityView_frontend
107
	 */
108 43
	public static function getInstance() {
109
110 43
		if ( empty( self::$instance ) ) {
111 37
			self::$instance = new self;
112 37
			self::$instance->initialize();
113
		}
114
115 43
		return self::$instance;
116
	}
117
118
	/**
119
	 * @return GravityView_View_Data
120
	 */
121 37
	public function getGvOutputData() {
122 37
		return $this->gv_output_data;
123
	}
124
125
	/**
126
	 * @param \GravityView_View_Data $gv_output_data
127
	 */
128 37
	public function setGvOutputData( $gv_output_data ) {
129 37
		$this->gv_output_data = $gv_output_data;
130 37
	}
131
132
	/**
133
	 * @return boolean
134
	 */
135 36
	public function isSearch() {
136 36
		return $this->is_search;
137
	}
138
139
	/**
140
	 * @param boolean $is_search
141
	 */
142 37
	public function setIsSearch( $is_search ) {
143 37
		$this->is_search = $is_search;
144 37
	}
145
146
	/**
147
	 * @return bool|int
148
	 */
149 50
	public function getSingleEntry() {
150 50
		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 36
	public function setSingleEntry( $single_entry ) {
158
159 36
		$this->single_entry = $single_entry;
160
161 36
	}
162
163
	/**
164
	 * @return array
165
	 */
166 44
	public function getEntry() {
167 44
		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 36
	public function setEntry( $entry ) {
175
176 36
		if ( ! is_array( $entry ) ) {
177 27
			$entry = GVCommon::get_entry( $entry );
178
		}
179
180 36
		$this->entry = $entry;
181 36
	}
182
183
	/**
184
	 * @return int
185
	 */
186 37
	public function getPostId() {
187 37
		return $this->post_id;
188
	}
189
190
	/**
191
	 * @param int $post_id
192
	 */
193 37
	public function setPostId( $post_id ) {
194 37
		$this->post_id = $post_id;
195 37
	}
196
197
	/**
198
	 * @return boolean
199
	 */
200 38
	public function isPostHasShortcode() {
201 38
		return $this->post_has_shortcode;
202
	}
203
204
	/**
205
	 * @param boolean $post_has_shortcode
206
	 */
207 37
	public function setPostHasShortcode( $post_has_shortcode ) {
208 37
		$this->post_has_shortcode = $post_has_shortcode;
209 37
	}
210
211
	/**
212
	 * @return boolean
213
	 */
214 39
	public function isGravityviewPostType() {
215 39
		return $this->is_gravityview_post_type;
216
	}
217
218
	/**
219
	 * @param boolean $is_gravityview_post_type
220
	 */
221 37
	public function setIsGravityviewPostType( $is_gravityview_post_type ) {
222 37
		$this->is_gravityview_post_type = $is_gravityview_post_type;
223 37
	}
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 2
	public function set_context_view_id( $view_id = null ) {
233 2
		$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 2
		if ( ! empty( $view_id ) ) {
236
237 1
			$this->context_view_id = $view_id;
238
239 2
		} 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 = $_GET['gvid'];
245
246 2
		} elseif ( ! $multiple_views ) {
247 2
			$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 2
			$this->context_view_id = array_pop( $array_keys );
249 2
			unset( $array_keys );
250
		}
251
252 2
	}
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 string
260
	 */
261 36
	public function get_context_view_id() {
262 36
		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 168
	public function parse_query_fix_frontpage( &$query ) {
278 168
		global $wp_rewrite;
279
280 168
		$is_front_page = ( $query->is_home || $query->is_page );
281 168
		$show_on_front = ( 'page' === get_option('show_on_front') );
282 168
		$front_page_id = get_option('page_on_front');
283
284 168
		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 168
	}
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 1
	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 1
		global $post;
339
340
		// If in admin and NOT AJAX request, get outta here.
341 1
		if ( gravityview()->request->is_admin() ) {
342
			return;
343
		}
344
345
		// Calculate requested Views
346 1
		$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 1
		$this->set_context_view_id();
350
351 1
		$this->setIsGravityviewPostType( get_post_type( $post ) === 'gravityview' );
352
353 1
		$post_id = $this->getPostId() ? $this->getPostId() : (isset( $post ) ? $post->ID : null );
354 1
		$this->setPostId( $post_id );
355 1
		$post_has_shortcode = ! empty( $post->post_content ) ? gravityview_has_shortcode_r( $post->post_content, 'gravityview' ) : false;
356 1
		$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 1
		$this->setIsSearch( $this->is_searching() );
360
361 1
		unset( $entry, $post_id, $post_has_shortcode );
362 1
	}
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 1
	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 1
		if ( $this->getSingleEntry() ) {
384 1
			return false;
385
		}
386
387 1
		$search_method = GravityView_Widget_Search::getInstance()->get_search_method();
388
389 1
		if( 'post' === $search_method ) {
390
			$get = $_POST;
391
		} else {
392 1
			$get = $_GET;
393
		}
394
395
		// No $_GET parameters
396 1
		if ( empty( $get ) || ! is_array( $get ) ) {
397 1
			return false;
398
		}
399
400
		// Remove empty values
401
		$get = array_filter( $get );
402
403
		// If the $_GET parameters are empty, it's no search.
404
		if ( empty( $get ) ) {
405
			return false;
406
		}
407
408
		$search_keys = array_keys( $get );
409
410
		$search_match = implode( '|', self::$search_parameters );
411
412
		foreach ( $search_keys as $search_key ) {
413
414
			// Analyze the search key $_GET parameter and see if it matches known GV args
415
			if ( preg_match( '/(' . $search_match . ')/i', $search_key ) ) {
416
				return true;
417
			}
418
		}
419
420
		return false;
421
	}
422
423
	/**
424
	 * Filter the title for the single entry view
425
	 *
426
	 *
427
	 * @param  string $title   current title
428
	 * @param  int $passed_post_id Post ID
429
	 * @return string          (modified) title
430
	 */
431 8
	public function single_entry_title( $title, $passed_post_id = null ) {
432 8
		global $post;
433
434
		// If this is the directory view, return.
435 8
		if ( ! $this->getSingleEntry() ) {
436 8
			return $title;
437
		}
438
439 8
		$entry = $this->getEntry();
440
441
		/**
442
		 * @filter `gravityview/single/title/out_loop` Apply the Single Entry Title filter outside the WordPress loop?
443
		 * @param boolean $in_the_loop Whether to apply the filter to the menu title and the meta tag <title> - outside the loop
444
		 * @param array $entry Current entry
445
		 */
446 8
		$apply_outside_loop = apply_filters( 'gravityview/single/title/out_loop' , in_the_loop(), $entry );
447
448 8
		if ( ! $apply_outside_loop ) {
449 8
			return $title;
450
		}
451
452
		// User reported WooCommerce doesn't pass two args.
453
		if ( empty( $passed_post_id ) )  {
454
			return $title;
455
		}
456
457
		// Don't modify the title for anything other than the current view/post.
458
		// This is true for embedded shortcodes and Views.
459
		if ( is_object( $post ) && (int) $post->ID !== (int) $passed_post_id ) {
460
			return $title;
461
		}
462
463
		$context_view_id = $this->get_context_view_id();
464
465
		$multiple_views = $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...
466
467
		if ( $multiple_views && ! empty( $context_view_id ) ) {
468
			$view_meta = $this->getGvOutputData()->get_view( $context_view_id );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::get_view() has been deprecated.

This method has been deprecated.

Loading history...
469
		} else {
470
			foreach ( $this->getGvOutputData()->get_views() as $view_id => $view_data ) {
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...
471
				if ( intval( $view_data['form_id'] ) === intval( $entry['form_id'] ) ) {
472
					$view_meta = $view_data;
473
					break;
474
				}
475
			}
476
		}
477
478
		/** Deprecated stuff in the future. See the branch above. */
479
		if ( ! empty( $view_meta['atts']['single_title'] ) ) {
480
481
			$title = $view_meta['atts']['single_title'];
482
483
			// We are allowing HTML in the fields, so no escaping the output
484
			$title = GravityView_API::replace_variables( $title, $view_meta['form'], $entry );
485
486
			$title = do_shortcode( $title );
487
		}
488
489
490
		return $title;
491
	}
492
493
494
	/**
495
	 * In case View post is called directly, insert the view in the post content
496
	 *
497
	 * @deprecated Use \GV\View::content() instead.
498
	 *
499
	 * @access public
500
	 * @static
501
	 * @param mixed $content
502
	 * @return string Add the View output into View CPT content
503
	 */
504 4
	public function insert_view_in_content( $content ) {
505 4
		gravityview()->log->notice( '\GravityView_frontend::insert_view_in_content is deprecated. Use \GV\View::content()' );
506 4
		return \GV\View::content( $content );
507
	}
508
509
	/**
510
	 * Disable comments on GravityView post types
511
	 * @param  boolean $open    existing status
512
	 * @param  int $post_id Post ID
513
	 * @return boolean
514
	 */
515
	public function comments_open( $open, $post_id ) {
516
517
		if ( $this->isGravityviewPostType() ) {
518
			$open = false;
519
		}
520
521
		/**
522
		 * @filter `gravityview/comments_open` Whether to set comments to open or closed.
523
		 * @since  1.5.4
524
		 * @param  boolean $open Open or closed status
525
		 * @param  int $post_id Post ID to set comment status for
526
		 */
527
		$open = apply_filters( 'gravityview/comments_open', $open, $post_id );
528
529
		return $open;
530
	}
531
532
	/**
533
	 * Display a warning when a View has not been configured
534
	 *
535
	 * @since 1.19.2
536
	 *
537
	 * @param int $view_id The ID of the View currently being displayed
538
	 *
539
	 * @return void
540
	 */
541 2
	public function context_not_configured_warning( $view_id = 0 ) {
542
543 2
		if ( ! class_exists( 'GravityView_View' ) ) {
544
			return;
545
		}
546
547 2
		$fields = GravityView_View::getInstance()->getContextFields();
548
549 2
		if ( ! empty( $fields ) ) {
550 2
			return;
551
		}
552
553
		$context = GravityView_View::getInstance()->getContext();
554
555
		switch( $context ) {
556
			case 'directory':
557
				$tab = __( 'Multiple Entries', 'gravityview' );
558
				break;
559
			case 'edit':
560
				$tab = __( 'Edit Entry', 'gravityview' );
561
				break;
562
			case 'single':
563
			default:
564
				$tab = __( 'Single Entry', 'gravityview' );
565
				break;
566
		}
567
568
569
		$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 );
570
		$edit_link = admin_url( sprintf( 'post.php?post=%d&action=edit#%s-view', $view_id, $context ) );
571
		$action_text = sprintf( esc_html__('Add fields to %s', 'gravityview' ), $tab );
572
		$message = esc_html__( 'You can only see this message because you are able to edit this View.', 'gravityview' );
573
574
		$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 ) ) );
575
		$output = sprintf( '<h3>%s <strong><a href="%s">%s</a></strong></h3><p>%s</p>', $title, esc_url( $edit_link ), $action_text, $message );
576
577
		echo GVCommon::generate_notice( $output . $image, 'gv-error error', 'edit_gravityview', $view_id );
578
	}
579
580
581
	/**
582
	 * Core function to render a View based on a set of arguments
583
	 *
584
	 * @access public
585
	 * @static
586
	 * @param array $passed_args {
587
	 *
588
	 *      Settings for rendering the View
589
	 *
590
	 *      @type int $id View id
591
	 *      @type int $page_size Number of entries to show per page
592
	 *      @type string $sort_field Form field id to sort
593
	 *      @type string $sort_direction Sorting direction ('ASC', 'DESC', or 'RAND')
594
	 *      @type string $start_date - Ymd
595
	 *      @type string $end_date - Ymd
596
	 *      @type string $class - assign a html class to the view
597
	 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
598
	 * }
599
	 *
600
	 * @deprecated Use \GV\View_Renderer
601
	 *
602
	 * @return string|null HTML output of a View, NULL if View isn't found
603
	 */
604 1
	public function render_view( $passed_args ) {
605 1
		gravityview()->log->notice( '\GravityView_frontend::render_view is deprecated. Use \GV\View_Renderer etc.' );
606
607
		/**
608
		 * We can use a shortcode here, since it's pretty much the same.
609
		 *
610
		 * But we do need to check embed permissions, since shortcodes don't do this.
611
		 */
612
613 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...
614
			return null;
615
		}
616
617 1
		$view->settings->update( $passed_args );
618
619 1
		$direct_access = apply_filters( 'gravityview_direct_access', true, $view->ID );
620 1
		$embed_only = $view->settings->get( 'embed_only' );
621
622 1
		if( ! $direct_access || ( $embed_only && ! GVCommon::has_cap( 'read_private_gravityviews' ) ) ) {
623 1
			return __( 'You are not allowed to view this content.', 'gravityview' );
624
		}
625
626 1
		$shortcode = new \GV\Shortcodes\gravityview();
627 1
		return $shortcode->callback( $passed_args );
628
	}
629
630
	/**
631
	 * Process the start and end dates for a view - overrides values defined in shortcode (if needed)
632
	 *
633
	 * The `start_date` and `end_date` keys need to be in a format processable by GFFormsModel::get_date_range_where(),
634
	 * which uses \DateTime() format.
635
	 *
636
	 * 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()},
637
	 * including strings like "now" or "-1 year" or "-3 days".
638
	 *
639
	 * @see GFFormsModel::get_date_range_where
640
	 *
641
	 * @param  array      $args            View settings
642
	 * @param  array      $search_criteria Search being performed, if any
643
	 * @return array                       Modified `$search_criteria` array
644
	 */
645 63
	public static function process_search_dates( $args, $search_criteria = array() ) {
646
647 63
		$return_search_criteria = $search_criteria;
648
649 63
		foreach ( array( 'start_date', 'end_date' ) as $key ) {
650
651
652
			// Is the start date or end date set in the view or shortcode?
653
			// If so, we want to make sure that the search doesn't go outside the bounds defined.
654 63
			if ( ! empty( $args[ $key ] ) ) {
655
656
				// Get a timestamp and see if it's a valid date format
657 2
				$date = strtotime( $args[ $key ] );
658
659
				// The date was invalid
660 2
				if ( empty( $date ) ) {
661
					gravityview()->log->error( ' Invalid {key} date format: {format}', array( 'key' => $key, 'format' => $args[ $key ] ) );
662
					continue;
663
				}
664
665
				// The format that Gravity Forms expects for start_date and day-specific (not hour/second-specific) end_date
666 2
				$datetime_format = 'Y-m-d H:i:s';
667 2
				$search_is_outside_view_bounds = false;
668
669 2
				if( ! empty( $search_criteria[ $key ] ) ) {
670
671 1
					$search_date = strtotime( $search_criteria[ $key ] );
672
673
					// The search is for entries before the start date defined by the settings
674 1
					switch ( $key ) {
675 1
						case 'end_date':
676
							/**
677
							 * If the end date is formatted as 'Y-m-d', it should be formatted without hours and seconds
678
							 * so that Gravity Forms can convert the day to 23:59:59 the previous day.
679
							 *
680
							 * If it's a relative date ("now" or "-1 day"), then it should use the precise date format
681
							 *
682
							 * @see GFFormsModel::get_date_range_where
683
							 */
684 1
							$datetime_format               = gravityview_is_valid_datetime( $args[ $key ] ) ? 'Y-m-d' : 'Y-m-d H:i:s';
685 1
							$search_is_outside_view_bounds = ( $search_date > $date );
686 1
							break;
687 1
						case 'start_date':
688 1
							$search_is_outside_view_bounds = ( $search_date < $date );
689 1
							break;
690
					}
691
				}
692
693
				// If there is no search being performed, or if there is a search being performed that's outside the bounds
694 2
				if ( empty( $search_criteria[ $key ] ) || $search_is_outside_view_bounds ) {
695
696
					// Then we override the search and re-set the start date
697 2
					$return_search_criteria[ $key ] = date_i18n( $datetime_format , $date, true );
698
				}
699
			}
700
		}
701
702 63
		if( isset( $return_search_criteria['start_date'] ) && isset( $return_search_criteria['end_date'] ) ) {
703
			// The start date is AFTER the end date. This will result in no results, but let's not force the issue.
704 2
			if ( strtotime( $return_search_criteria['start_date'] ) > strtotime( $return_search_criteria['end_date'] ) ) {
705 1
				gravityview()->log->error( 'Invalid search: the start date is after the end date.', array( 'data' => $return_search_criteria ) );
706
			}
707
		}
708
709 63
		return $return_search_criteria;
710
	}
711
712
713
	/**
714
	 * Process the approved only search criteria according to the View settings
715
	 *
716
	 * @param  array      $args            View settings
717
	 * @param  array      $search_criteria Search being performed, if any
718
	 * @return array                       Modified `$search_criteria` array
719
	 */
720 62
	public static function process_search_only_approved( $args, $search_criteria ) {
721
722
		/** @since 1.19 */
723 62
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
724
			gravityview()->log->debug( 'User can moderate entries; showing all approval statuses' );
725
			return $search_criteria;
726
		}
727
728 62
		if ( ! empty( $args['show_only_approved'] ) ) {
729
730 6
			$search_criteria['field_filters'][] = array(
731
				'key' => GravityView_Entry_Approval::meta_key,
732
				'value' => GravityView_Entry_Approval_Status::APPROVED
733
			);
734
735 6
			$search_criteria['field_filters']['mode'] = 'all'; // force all the criterias to be met
736
737 6
			gravityview()->log->debug( '[process_search_only_approved] Search Criteria if show only approved: ', array( 'data' => $search_criteria ) );
738
		}
739
740 62
		return $search_criteria;
741
	}
742
743
744
	/**
745
	 * Check if a certain entry is approved.
746
	 *
747
	 * If we pass the View settings ($args) it will check the 'show_only_approved' setting before
748
	 *   checking the entry approved field, returning true if show_only_approved = false.
749
	 *
750
	 * @since 1.7
751
	 * @since 1.18 Converted check to use GravityView_Entry_Approval_Status::is_approved
752
	 *
753
	 * @uses GravityView_Entry_Approval_Status::is_approved
754
	 *
755
	 * @param array $entry  Entry object
756
	 * @param array $args   View settings (optional)
757
	 *
758
	 * @return bool
759
	 */
760
	public static function is_entry_approved( $entry, $args = array() ) {
761
762
		if ( empty( $entry['id'] ) || ( array_key_exists( 'show_only_approved', $args ) && ! $args['show_only_approved'] ) ) {
763
			// is implicitly approved if entry is null or View settings doesn't require to check for approval
764
			return true;
765
		}
766
767
		/** @since 1.19 */
768
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
769
			gravityview()->log->debug( 'User can moderate entries, so entry is approved for viewing' );
770
			return true;
771
		}
772
773
		$is_approved = gform_get_meta( $entry['id'], GravityView_Entry_Approval::meta_key );
774
775
		return GravityView_Entry_Approval_Status::is_approved( $is_approved );
776
	}
777
778
	/**
779
	 * Parse search criteria for a entries search.
780
	 *
781
	 * array(
782
	 * 	'search_field' => 1, // ID of the field
783
	 *  'search_value' => '', // Value of the field to search
784
	 *  'search_operator' => 'contains', // 'is', 'isnot', '>', '<', 'contains'
785
	 *  'show_only_approved' => 0 or 1 // Boolean
786
	 * )
787
	 *
788
	 * @param  array $args    Array of args
789
	 * @param  int $form_id Gravity Forms form ID
790
	 * @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.
791
	 */
792 63
	public static function get_search_criteria( $args, $form_id ) {
793
		/**
794
		 * Compatibility with filters hooking in `gravityview_search_criteria` instead of `gravityview_fe_search_criteria`.
795
		 */
796 63
		$criteria = apply_filters( 'gravityview_search_criteria', array(), array( $form_id ), \GV\Utils::get( $args, 'id' ) );
797 63
		$search_criteria = isset( $criteria['search_criteria'] ) ? $criteria['search_criteria'] : array( 'field_filters' => array() );
798
799
		/**
800
		 * @filter `gravityview_fe_search_criteria` Modify the search criteria
801
		 * @see GravityView_Widget_Search::filter_entries Adds the default search criteria
802
		 * @param array $search_criteria Empty `field_filters` key
803
		 * @param int $form_id ID of the Gravity Forms form that is being searched
804
		 * @param array $args The View settings.
805
		 */
806 63
		$search_criteria = apply_filters( 'gravityview_fe_search_criteria', $search_criteria, $form_id, $args );
807
808 63
		$original_search_criteria = $search_criteria;
809
810 63
		gravityview()->log->debug( '[get_search_criteria] Search Criteria after hook gravityview_fe_search_criteria: ', array( 'data' =>$search_criteria ) );
811
812
		// implicity search
813 63
		if ( ! empty( $args['search_value'] ) ) {
814
815
			// Search operator options. Options: `is` or `contains`
816 3
			$operator = ! empty( $args['search_operator'] ) && in_array( $args['search_operator'], array( 'is', 'isnot', '>', '<', 'contains' ) ) ? $args['search_operator'] : 'contains';
817
818 3
			$search_criteria['field_filters'][] = array(
819 3
				'key' => \GV\Utils::_GET( 'search_field', \GV\Utils::get( $args, 'search_field' ) ), // The field ID to search
820 3
				'value' => _wp_specialchars( $args['search_value'] ), // The value to search. Encode ampersands but not quotes.
821 3
				'operator' => $operator,
822
			);
823
824
			// Lock search mode to "all" with implicit presearch filter.
825 3
			$search_criteria['field_filters']['mode'] = 'all';
826
		}
827
828 63
		if( $search_criteria !== $original_search_criteria ) {
829 3
			gravityview()->log->debug( '[get_search_criteria] Search Criteria after implicity search: ', array( 'data' => $search_criteria ) );
830
		}
831
832
		// Handle setting date range
833 63
		$search_criteria = self::process_search_dates( $args, $search_criteria );
834
835 63
		if( $search_criteria !== $original_search_criteria ) {
836 4
			gravityview()->log->debug( '[get_search_criteria] Search Criteria after date params: ', array( 'data' => $search_criteria ) );
837
		}
838
839
		// remove not approved entries
840 63
		$search_criteria = self::process_search_only_approved( $args, $search_criteria );
841
842
		/**
843
		 * @filter `gravityview_status` Modify entry status requirements to be included in search results.
844
		 * @param string $status Default: `active`. Accepts all Gravity Forms entry statuses, including `spam` and `trash`
845
		 */
846 63
		$search_criteria['status'] = apply_filters( 'gravityview_status', 'active', $args );
847
848 63
		return $search_criteria;
849
	}
850
851
852
853
	/**
854
	 * Core function to calculate View multi entries (directory) based on a set of arguments ($args):
855
	 *   $id - View id
856
	 *   $page_size - Page
857
	 *   $sort_field - form field id to sort
858
	 *   $sort_direction - ASC / DESC
859
	 *   $start_date - Ymd
860
	 *   $end_date - Ymd
861
	 *   $class - assign a html class to the view
862
	 *   $offset (optional) - This is the start point in the current data set (0 index based).
863
	 *
864
	 *
865
	 *
866
	 * @uses  gravityview_get_entries()
867
	 * @access public
868
	 * @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...
869
	 *   - $id - View id
870
	 *   - $page_size - Page
871
	 *   - $sort_field - form field id to sort
872
	 *   - $sort_direction - ASC / DESC
873
	 *   - $start_date - Ymd
874
	 *   - $end_date - Ymd
875
	 *   - $class - assign a html class to the view
876
	 *   - $offset (optional) - This is the start point in the current data set (0 index based).
877
	 * @param int $form_id Gravity Forms Form ID
878
	 * @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
879
	 */
880 1
	public static function get_view_entries( $args, $form_id ) {
881
882 1
		gravityview()->log->debug( '[get_view_entries] init' );
883
		// start filters and sorting
884
885 1
		$parameters = self::get_view_entries_parameters( $args, $form_id );
886
887 1
		$count = 0; // Must be defined so that gravityview_get_entries can use by reference
888
889
		// fetch entries
890
		list( $entries, $paging, $count ) =
891 1
			\GV\Mocks\GravityView_frontend_get_view_entries( $args, $form_id, $parameters, $count );
892
893 1
		gravityview()->log->debug( 'Get Entries. Found: {count} entries', array( 'count' => $count, 'data' => $entries ) );
894
895
		/**
896
		 * @filter `gravityview_view_entries` Filter the entries output to the View
897
		 * @deprecated since 1.5.2
898
		 * @param array $args View settings associative array
899
		 * @var array
900
		 */
901 1
		$entries = apply_filters( 'gravityview_view_entries', $entries, $args );
902
903
		$return = array(
904 1
			'count' => $count,
905 1
			'entries' => $entries,
906 1
			'paging' => $paging,
907
		);
908
909
		/**
910
		 * @filter `gravityview/view/entries` Filter the entries output to the View
911
		 * @param array $criteria associative array containing count, entries & paging
912
		 * @param array $args View settings associative array
913
		 * @since 1.5.2
914
		 */
915 1
		return apply_filters( 'gravityview/view/entries', $return, $args );
916
	}
917
918
	/**
919
	 * Get an array of search parameters formatted as Gravity Forms requires
920
	 *
921
	 * Results are filtered by `gravityview_get_entries` and `gravityview_get_entries_{View ID}` filters
922
	 *
923
	 * @uses GravityView_frontend::get_search_criteria
924
	 * @uses GravityView_frontend::get_search_criteria_paging
925
	 *
926
	 * @since 1.20
927
	 *
928
	 * @see \GV\View_Settings::defaults For $args options
929
	 *
930
	 * @param array $args Array of View settings, as structured in \GV\View_Settings::defaults
931
	 * @param int $form_id Gravity Forms form ID to search
932
	 *
933
	 * @return array With `search_criteria`, `sorting`, `paging`, `cache` keys
934
	 */
935 62
	public static function get_view_entries_parameters( $args = array(), $form_id = 0 ) {
936
937
938 62
		if ( ! is_array( $args ) || ! is_numeric( $form_id ) ) {
939
940
			gravityview()->log->error( 'Passed args are not an array or the form ID is not numeric' );
941
942
			return array();
943
		}
944
945 62
		$form_id = intval( $form_id );
946
947
		/**
948
		 * Process search parameters
949
		 * @var array
950
		 */
951 62
		$search_criteria = self::get_search_criteria( $args, $form_id );
952
953 62
		$paging = self::get_search_criteria_paging( $args );
954
955
		$parameters = array(
956 62
			'search_criteria' => $search_criteria,
957 62
			'sorting' => self::updateViewSorting( $args, $form_id ),
958 62
			'paging' => $paging,
959 62
			'cache' => isset( $args['cache'] ) ? $args['cache'] : true,
960
		);
961
962
		/**
963
		 * @filter `gravityview_get_entries` Filter get entries criteria
964
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
965
		 * @param array $args View configuration args. {
966
		 *      @type int $id View id
967
		 *      @type int $page_size Number of entries to show per page
968
		 *      @type string $sort_field Form field id to sort
969
		 *      @type string $sort_direction Sorting direction ('ASC', 'DESC', or 'RAND')
970
		 *      @type string $start_date - Ymd
971
		 *      @type string $end_date - Ymd
972
		 *      @type string $class - assign a html class to the view
973
		 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
974
		 * }
975
		 * @param int $form_id ID of Gravity Forms form
976
		 */
977 62
		$parameters = apply_filters( 'gravityview_get_entries', $parameters, $args, $form_id );
978
979
		/**
980
		 * @filter `gravityview_get_entries_{View ID}` Filter get entries criteria
981
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
982
		 * @param array $args View configuration args.
983
		 */
984 62
		$parameters = apply_filters( 'gravityview_get_entries_'.\GV\Utils::get( $args, 'id' ), $parameters, $args, $form_id );
985
986 62
		gravityview()->log->debug( '$parameters passed to gravityview_get_entries(): ', array( 'data' => $parameters ) );
987
988 62
		return $parameters;
989
	}
990
991
	/**
992
	 * Get the paging array for the View
993
	 *
994
	 * @since 1.19.5
995
	 *
996
	 * @param $args
997
	 * @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...
998
	 */
999 62
	public static function get_search_criteria_paging( $args ) {
1000
1001
		/**
1002
		 * @filter `gravityview_default_page_size` The default number of entries displayed in a View
1003
		 * @since 1.1.6
1004
		 * @param int $default_page_size Default: 25
1005
		 */
1006 62
		$default_page_size = apply_filters( 'gravityview_default_page_size', 25 );
1007
1008
		// Paging & offset
1009 62
		$page_size = ! empty( $args['page_size'] ) ? intval( $args['page_size'] ) : $default_page_size;
1010
1011 62
		if ( -1 === $page_size ) {
1012 1
			$page_size = PHP_INT_MAX;
1013
		}
1014
1015 62
		$curr_page = empty( $_GET['pagenum'] ) ? 1 : intval( $_GET['pagenum'] );
1016 62
		$offset = ( $curr_page - 1 ) * $page_size;
1017
1018 62
		if ( ! empty( $args['offset'] ) ) {
1019
			$offset += intval( $args['offset'] );
1020
		}
1021
1022
		$paging = array(
1023 62
			'offset' => $offset,
1024 62
			'page_size' => $page_size,
1025
		);
1026
1027 62
		gravityview()->log->debug( 'Paging: ', array( 'data' => $paging ) );
1028
1029 62
		return $paging;
1030
	}
1031
1032
	/**
1033
	 * Updates the View sorting criteria
1034
	 *
1035
	 * @since 1.7
1036
	 *
1037
	 * @param array $args View settings. Required to have `sort_field` and `sort_direction` keys
1038
	 * @param int $form_id The ID of the form used to sort
1039
	 * @return array $sorting Array with `key`, `direction` and `is_numeric` keys
1040
	 */
1041 62
	public static function updateViewSorting( $args, $form_id ) {
1042 62
		$sorting = array();
1043
1044 62
		$has_values = isset( $_GET['sort'] );
1045
1046 62
		if ( $has_values && is_array( $_GET['sort'] ) ) {
1047 1
			$has_values = array_filter( array_values( $_GET['sort'] ) );
1048
		}
1049
1050 62
		$sort_field_id = $has_values ? $_GET['sort'] : \GV\Utils::get( $args, 'sort_field' );
1051 62
		$sort_direction = isset( $_GET['dir'] ) ? $_GET['dir'] : \GV\Utils::get( $args, 'sort_direction' );
1052
1053 62
		if ( is_array( $sort_field_id ) ) {
1054 1
			$sort_field_id = array_pop( $sort_field_id );
1055
		}
1056
1057 62
		if ( is_array( $sort_direction ) ) {
1058
			$sort_direction = array_pop( $sort_direction );
1059
		}
1060
1061 62
		if ( ! empty( $sort_field_id ) ) {
1062 3
			if ( is_array( $sort_field_id ) ) {
1063
				$sort_direction = array_values( $sort_field_id );
1064
				$sort_field_id = array_keys( $sort_field_id );
1065
1066
				$sort_field_id = reset( $sort_field_id );
1067
				$sort_direction = reset( $sort_direction );
1068
			}
1069
1070 3
			$sort_field_id = self::_override_sorting_id_by_field_type( $sort_field_id, $form_id );
1071
			$sorting = array(
1072 3
				'key' => $sort_field_id,
1073 3
				'direction' => strtolower( $sort_direction ),
1074 3
				'is_numeric' => GVCommon::is_field_numeric( $form_id, $sort_field_id )
1075
			);
1076
1077 3
			if ( 'RAND' === $sort_direction ) {
1078
1079
				$form = GFAPI::get_form( $form_id );
1080
1081
				// Get the first GF_Field field ID, set as the key for entry randomization
1082
				if ( ! empty( $form['fields'] ) ) {
1083
1084
					/** @var GF_Field $field */
1085
					foreach ( $form['fields'] as $field ) {
1086
						if ( ! is_a( $field, 'GF_Field' ) ) {
1087
							continue;
1088
						}
1089
1090
						$sorting = array(
1091
							'key'        => $field->id,
1092
							'is_numeric' => false,
1093
							'direction'  => 'RAND',
1094
						);
1095
1096
						break;
1097
					}
1098
				}
1099
			}
1100
		}
1101
1102 62
		GravityView_View::getInstance()->setSorting( $sorting );
1103
1104 62
		gravityview()->log->debug( '[updateViewSorting] Sort Criteria : ', array( 'data' => $sorting ) );
1105
1106 62
		return $sorting;
1107
1108
	}
1109
1110
	/**
1111
	 * Override sorting per field
1112
	 *
1113
	 * Currently only modifies sorting ID when sorting by the full name. Sorts by first name.
1114
	 * Use the `gravityview/sorting/full-name` filter to override.
1115
	 *
1116
	 * @todo Filter from GravityView_Field
1117
	 * @since 1.7.4
1118
	 * @internal Hi developer! Although this is public, don't call this method; we're going to replace it.
1119
	 *
1120
	 * @param int|string|array $sort_field_id Field used for sorting (`id` or `1.2`), or an array for multisorts
1121
	 * @param int $form_id GF Form ID
1122
	 *
1123
	 * @return string Possibly modified sorting ID
1124
	 */
1125 3
	public static function _override_sorting_id_by_field_type( $sort_field_id, $form_id ) {
1126
1127 3
		if ( is_array( $sort_field_id ) ) {
1128
			$modified_ids = array();
1129
			foreach ( $sort_field_id as $_sort_field_id ) {
1130
				$modified_ids []= self::_override_sorting_id_by_field_type( $_sort_field_id, $form_id );
1131
			}
1132
			return $modified_ids;
1133
		}
1134
1135 3
		$form = gravityview_get_form( $form_id );
1136
1137 3
		$sort_field = GFFormsModel::get_field( $form, $sort_field_id );
1138
1139 3
		if( ! $sort_field ) {
1140 1
			return $sort_field_id;
1141
		}
1142
1143 3
		switch ( $sort_field['type'] ) {
1144
1145 3
			case 'address':
1146
				// Sorting by full address
1147
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1148
1149
					/**
1150
					 * Override how to sort when sorting address
1151
					 *
1152
					 * @since 1.8
1153
					 *
1154
					 * @param string $address_part `street`, `street2`, `city`, `state`, `zip`, or `country` (default: `city`)
1155
					 * @param string $sort_field_id Field used for sorting
1156
					 * @param int $form_id GF Form ID
1157
					 */
1158
					$address_part = apply_filters( 'gravityview/sorting/address', 'city', $sort_field_id, $form_id );
1159
1160
					switch( strtolower( $address_part ) ){
1161
						case 'street':
1162
							$sort_field_id .= '.1';
1163
							break;
1164
						case 'street2':
1165
							$sort_field_id .= '.2';
1166
							break;
1167
						default:
1168
						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...
1169
							$sort_field_id .= '.3';
1170
							break;
1171
						case 'state':
1172
							$sort_field_id .= '.4';
1173
							break;
1174
						case 'zip':
1175
							$sort_field_id .= '.5';
1176
							break;
1177
						case 'country':
1178
							$sort_field_id .= '.6';
1179
							break;
1180
					}
1181
1182
				}
1183
				break;
1184 3
			case 'name':
1185
				// Sorting by full name, not first, last, etc.
1186
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1187
					/**
1188
					 * @filter `gravityview/sorting/full-name` Override how to sort when sorting full name.
1189
					 * @since 1.7.4
1190
					 * @param[in,out] string $name_part Sort by `first` or `last` (default: `first`)
1191
					 * @param[in] string $sort_field_id Field used for sorting
1192
					 * @param[in] int $form_id GF Form ID
1193
					 */
1194
					$name_part = apply_filters( 'gravityview/sorting/full-name', 'first', $sort_field_id, $form_id );
1195
1196
					if ( 'last' === strtolower( $name_part ) ) {
1197
						$sort_field_id .= '.6';
1198
					} else {
1199
						$sort_field_id .= '.3';
1200
					}
1201
				}
1202
				break;
1203 3
			case 'list':
1204
				$sort_field_id = false;
1205
				break;
1206 3
			case 'time':
1207
1208
				/**
1209
				 * @filter `gravityview/sorting/time` Override how to sort when sorting time
1210
				 * @see GravityView_Field_Time
1211
				 * @since 1.14
1212
				 * @param[in,out] string $name_part Field used for sorting
1213
				 * @param[in] int $form_id GF Form ID
1214
				 */
1215
				$sort_field_id = apply_filters( 'gravityview/sorting/time', $sort_field_id, $form_id );
1216
				break;
1217
		}
1218
1219 3
		return $sort_field_id;
1220
	}
1221
1222
	/**
1223
	 * Verify if user requested a single entry view
1224
	 * @since 2.3.3 Added return null
1225
	 * @return boolean|string|null false if not, single entry slug if true, null if \GV\Entry doesn't exist yet
1226
	 */
1227 18
	public static function is_single_entry() {
1228
1229
		// Since this is a public method, it can be called outside of the plugin. Don't assume things have been loaded properly.
1230 18
		if ( ! class_exists( '\GV\Entry' ) ) {
1231
1232
			// Not using gravityview()->log->error(), since that may not exist yet either!
1233
			do_action( 'gravityview_log_error', '\GV\Entry not defined yet. Backtrace: ' . wp_debug_backtrace_summary()  );
1234
1235
			return null;
1236
		}
1237
1238 18
		$var_name = \GV\Entry::get_endpoint_name();
1239
1240 18
		$single_entry = get_query_var( $var_name );
1241
1242
		/**
1243
		 * Modify the entry that is being displayed.
1244
		 *
1245
		 * @internal Should only be used by things like the oEmbed functionality.
1246
		 * @since 1.6
1247
		 */
1248 18
		$single_entry = apply_filters( 'gravityview/is_single_entry', $single_entry );
1249
1250 18
		if ( empty( $single_entry ) ){
1251 3
			return false;
1252
		} else {
1253 15
			return $single_entry;
1254
		}
1255
	}
1256
1257
1258
	/**
1259
	 * Register styles and scripts
1260
	 *
1261
	 * @access public
1262
	 * @return void
1263
	 */
1264 1
	public function add_scripts_and_styles() {
1265 1
		global $post, $posts;
1266
		// enqueue template specific styles
1267 1
		if ( $this->getGvOutputData() ) {
1268
1269 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...
1270
1271 1
			foreach ( $views as $view_id => $data ) {
1272 1
				$view = \GV\View::by_id( $data['id'] );
1273 1
				$view_id = $view->ID;
1274 1
				$template_id = gravityview_get_template_id( $view->ID );
1275 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...
1276
1277
				/**
1278
				 * Don't enqueue the scripts or styles if it's not going to be displayed.
1279
				 * @since 1.15
1280
				 */
1281 1
				if( is_user_logged_in() && false === GVCommon::has_cap( 'read_gravityview', $view_id ) ) {
1282
					continue;
1283
				}
1284
1285
				// By default, no thickbox
1286 1
				$js_dependencies = array( 'jquery', 'gravityview-jquery-cookie' );
1287 1
				$css_dependencies = array();
1288
1289 1
				$lightbox = $view->settings->get( 'lightbox' );
1290
1291
				// If the thickbox is enqueued, add dependencies
1292 1
				if ( $lightbox ) {
1293
1294
					/**
1295
					 * @filter `gravity_view_lightbox_script` Override the lightbox script to enqueue. Default: `thickbox`
1296
					 * @param string $script_slug If you want to use a different lightbox script, return the name of it here.
1297
					 */
1298 1
					$js_dependencies[] = apply_filters( 'gravity_view_lightbox_script', 'thickbox' );
1299
1300
					/**
1301
					 * @filter `gravity_view_lightbox_style` Modify the lightbox CSS slug. Default: `thickbox`
1302
					 * @param string $script_slug If you want to use a different lightbox script, return the name of its CSS file here.
1303
					 */
1304 1
					$css_dependencies[] = apply_filters( 'gravity_view_lightbox_style', 'thickbox' );
1305
				}
1306
1307
				/**
1308
				 * If the form has checkbox fields, enqueue dashicons
1309
				 * @see https://github.com/katzwebservices/GravityView/issues/536
1310
				 * @since 1.15
1311
				 */
1312 1
				if( gravityview_view_has_single_checkbox_or_radio( $data['form'], $data['fields'] ) ) {
1313
					$css_dependencies[] = 'dashicons';
1314
				}
1315
1316 1
				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...
1317
1318 1
				$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
1319
1320 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...
1321
1322 1
				wp_enqueue_script( 'gravityview-fe-view' );
1323
1324 1
				if ( ! empty( $data['atts']['sort_columns'] ) ) {
1325
					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...
1326
				}
1327
1328 1
				$this->enqueue_default_style( $css_dependencies );
1329
1330 1
				self::add_style( $template_id );
1331
			}
1332
1333 1
			if ( 'wp_print_footer_scripts' === current_filter() ) {
1334
1335
				$js_localization = array(
1336
					'cookiepath' => COOKIEPATH,
1337
					'clear' => _x( 'Clear', 'Clear all data from the form', 'gravityview' ),
1338
					'reset' => _x( 'Reset', 'Reset the search form to the state that existed on page load', 'gravityview' ),
1339
				);
1340
1341
				/**
1342
				 * @filter `gravityview_js_localization` Modify the array passed to wp_localize_script()
1343
				 * @param array $js_localization The data padded to the Javascript file
1344
				 * @param array $views Array of View data arrays with View settings
1345
				 */
1346
				$js_localization = apply_filters( 'gravityview_js_localization', $js_localization, $views );
1347
1348
				wp_localize_script( 'gravityview-fe-view', 'gvGlobals', $js_localization );
1349
			}
1350
		}
1351 1
	}
1352
1353
	/**
1354
	 * Handle enqueuing the `gravityview_default_style` stylesheet
1355
	 *
1356
	 * @since 1.17
1357
	 *
1358
	 * @param array $css_dependencies Dependencies for the `gravityview_default_style` stylesheet
1359
	 *
1360
	 * @return void
1361
	 */
1362
	private function enqueue_default_style( $css_dependencies = array() ) {
1363
1364
		/**
1365
		 * @filter `gravityview_use_legacy_search_css` Should GravityView use the legacy Search Bar stylesheet (from before Version 1.17)?
1366
		 * @since 1.17
1367
		 * @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`
1368
		 */
1369
		$use_legacy_search_style = apply_filters( 'gravityview_use_legacy_search_style', false );
1370
1371
		$rtl = is_rtl() ? '-rtl' : '';
1372
1373
		$css_file_base = $use_legacy_search_style ? 'gv-legacy-search' : 'gv-default-styles';
1374
1375
		$path = gravityview_css_url( $css_file_base . $rtl . '.css' );
1376
1377
		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...
1378
	}
1379
1380
	/**
1381
	 * Add template extra style if exists
1382
	 * @param string $template_id
1383
	 */
1384
	public static function add_style( $template_id ) {
1385
1386
		if ( ! empty( $template_id ) && wp_style_is( 'gravityview_style_' . $template_id, 'registered' ) ) {
1387
			gravityview()->log->debug(  'Adding extra template style for {template_id}', array( 'template_id' => $template_id ) );
1388
			wp_enqueue_style( 'gravityview_style_' . $template_id );
1389
		} elseif ( empty( $template_id ) ) {
1390
			gravityview()->log->error( 'Cannot add template style; template_id is empty' );
1391
		} else {
1392
			gravityview()->log->error( 'Cannot add template style; {template_id} is not registered', array( 'template_id' => 'gravityview_style_' . $template_id ) );
1393
		}
1394
1395
	}
1396
1397
1398
	/**
1399
	 * Inject the sorting links on the table columns
1400
	 *
1401
	 * Callback function for hook 'gravityview/template/field_label'
1402
	 * @see GravityView_API::field_label() (in includes/class-api.php)
1403
	 *
1404
	 * @since 1.7
1405
	 *
1406
	 * @param string $label Field label
1407
	 * @param array $field Field settings
1408
	 * @param array $form Form object
1409
	 *
1410
	 * @return string Field Label
1411
	 */
1412
	public function add_columns_sort_links( $label = '', $field, $form ) {
1413
1414
		/**
1415
		 * Not a table-based template; don't add sort icons
1416
		 * @since 1.12
1417
		 */
1418
		if( ! preg_match( '/table/ism', GravityView_View::getInstance()->getTemplatePartSlug() ) ) {
1419
			return $label;
1420
		}
1421
1422
		if ( ! $this->is_field_sortable( $field['id'], $form ) ) {
1423
			return $label;
1424
		}
1425
1426
		$sorting = GravityView_View::getInstance()->getSorting();
1427
1428
		$class = 'gv-sort';
1429
1430
		$sort_field_id = self::_override_sorting_id_by_field_type( $field['id'], $form['id'] );
1431
1432
		$sort_args = array(
1433
			'sort' => $field['id'],
1434
			'dir' => 'asc',
1435
		);
1436
1437
		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
1438
			//toggle sorting direction.
1439
			if ( 'asc' === $sorting['direction'] ) {
1440
				$sort_args['dir'] = 'desc';
1441
				$class .= ' gv-icon-sort-desc';
1442
			} else {
1443
				$sort_args['dir'] = 'asc';
1444
				$class .= ' gv-icon-sort-asc';
1445
			}
1446
		} else {
1447
			$class .= ' gv-icon-caret-up-down';
1448
		}
1449
1450
		$url = add_query_arg( $sort_args, remove_query_arg( array('pagenum') ) );
1451
1452
		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a>&nbsp;'. $label;
1453
1454
	}
1455
1456
	/**
1457
	 * Checks if field (column) is sortable
1458
	 *
1459
	 * @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...
1460
	 * @param array $form Gravity Forms form array
1461
	 *
1462
	 * @since 1.7
1463
	 *
1464
	 * @return bool True: Yes, field is sortable; False: not sortable
1465
	 */
1466 1
	public function is_field_sortable( $field_id = '', $form = array() ) {
1467
1468 1
		$field_type = $field_id;
1469
1470 1
		if( is_numeric( $field_id ) ) {
1471 1
			$field = GFFormsModel::get_field( $form, $field_id );
1472 1
			$field_type = $field ? $field->type : $field_id;
1473
		}
1474
1475
		$not_sortable = array(
1476 1
			'edit_link',
1477
			'delete_link',
1478
		);
1479
1480
		/**
1481
		 * @filter `gravityview/sortable/field_blacklist` Modify what fields should never be sortable.
1482
		 * @since 1.7
1483
		 * @param[in,out] array $not_sortable Array of field types that aren't sortable
1484
		 * @param string $field_type Field type to check whether the field is sortable
1485
		 * @param array $form Gravity Forms form
1486
		 */
1487 1
		$not_sortable = apply_filters( 'gravityview/sortable/field_blacklist', $not_sortable, $field_type, $form );
1488
1489 1
		if ( in_array( $field_type, $not_sortable ) ) {
1490
			return false;
1491
		}
1492
1493 1
		return apply_filters( "gravityview/sortable/formfield_{$form['id']}_{$field_id}", apply_filters( "gravityview/sortable/field_{$field_id}", true, $form ) );
1494
1495
	}
1496
1497
}
1498
1499
GravityView_frontend::getInstance();
1500
1501
1502
1503