Completed
Push — develop ( 918969...60c622 )
by Zack
06:57
created

GravityView_frontend::add_style()   A

Complexity

Conditions 4
Paths 3

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

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