Completed
Pull Request — master (#868)
by Zack
06:16
created

process_search_only_approved()   B

Complexity

Conditions 4
Paths 3

Size

Total Lines 22
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

Changes 0
Metric Value
cc 4
eloc 11
nc 3
nop 2
dl 0
loc 22
ccs 0
cts 9
cp 0
crap 20
rs 8.9197
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 15 and the first side effect is on line 1804.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
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;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $is_gravityview_post_type.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
30
31
	/**
32
	 * Does the current post have a `[gravityview]` shortcode?
33
	 * @var boolean
34
	 */
35
	var $post_has_shortcode = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $post_has_shortcode.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
36
37
	/**
38
	 * The Post ID of the currently viewed post. Not necessarily GV
39
	 * @var int
40
	 */
41
	var $post_id = null;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $post_id.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $single_entry.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
49
50
	/**
51
	 * If we are viewing a single entry, the entry data
52
	 * @var array|false
53
	 */
54
	var $entry = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $entry.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $context_view_id.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
61
62
	/**
63
	 * The View is showing search results
64
	 * @since 1.5.4
65
	 * @var boolean
66
	 */
67
	var $is_search = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $is_search.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $gv_output_data.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
76
77
	/**
78
	 * @var GravityView_frontend
79
	 */
80
	static $instance;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
81
82
	/**
83
	 * Class constructor, enforce Singleton pattern
84
	 */
85
	private function __construct() {}
86
87 2
	private function initialize() {
88 2
		add_action( 'wp', array( $this, 'parse_content'), 11 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
89 2
		add_filter( 'parse_query', array( $this, 'parse_query_fix_frontpage' ), 10 );
90 2
		add_action( 'template_redirect', array( $this, 'set_entry_data'), 1 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
91
92
		// Enqueue scripts and styles after GravityView_Template::register_styles()
93 2
		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 2
		add_action( 'wp_print_footer_scripts', array( $this, 'add_scripts_and_styles' ), 1 );
97
98 2
		add_filter( 'the_title', array( $this, 'single_entry_title' ), 1, 2 );
99 2
		add_filter( 'the_content', array( $this, 'insert_view_in_content' ) );
100 2
		add_filter( 'comments_open', array( $this, 'comments_open' ), 10, 2 );
101
102 2
		add_action( 'gravityview_after', array( $this, 'context_not_configured_warning' ) );
103 2
	}
104
105
	/**
106
	 * Get the one true instantiated self
107
	 * @return GravityView_frontend
108
	 */
109 2
	public static function getInstance() {
0 ignored issues
show
Coding Style introduced by
The function name getInstance is in camel caps, but expected get_instance instead as per the coding standard.
Loading history...
110
111 2
		if ( empty( self::$instance ) ) {
112 2
			self::$instance = new self;
113 2
			self::$instance->initialize();
114
		}
115
116 2
		return self::$instance;
117
	}
118
119
	/**
120
	 * @return GravityView_View_Data
121
	 */
122
	public function getGvOutputData() {
0 ignored issues
show
Coding Style introduced by
The function name getGvOutputData is in camel caps, but expected get_gv_output_data instead as per the coding standard.
Loading history...
123
		return $this->gv_output_data;
124
	}
125
126
	/**
127
	 * @param GravityView_View_Data $gv_output_data
128
	 */
129
	public function setGvOutputData( $gv_output_data ) {
0 ignored issues
show
Coding Style introduced by
The function name setGvOutputData is in camel caps, but expected set_gv_output_data instead as per the coding standard.
Loading history...
130
		$this->gv_output_data = $gv_output_data;
131
	}
132
133
	/**
134
	 * @return boolean
135
	 */
136
	public function isSearch() {
0 ignored issues
show
Coding Style introduced by
The function name isSearch is in camel caps, but expected is_search instead as per the coding standard.
Loading history...
137
		return $this->is_search;
138
	}
139
140
	/**
141
	 * @param boolean $is_search
142
	 */
143
	public function setIsSearch( $is_search ) {
0 ignored issues
show
Coding Style introduced by
The function name setIsSearch is in camel caps, but expected set_is_search instead as per the coding standard.
Loading history...
144
		$this->is_search = $is_search;
145
	}
146
147
	/**
148
	 * @return bool|int
149
	 */
150 1
	public function getSingleEntry() {
0 ignored issues
show
Coding Style introduced by
The function name getSingleEntry is in camel caps, but expected get_single_entry instead as per the coding standard.
Loading history...
151 1
		return $this->single_entry;
152
	}
153
154
	/**
155
	 * Sets the single entry ID and also the entry
156
	 * @param bool|int|string $single_entry
157
	 */
158
	public function setSingleEntry( $single_entry ) {
0 ignored issues
show
Coding Style introduced by
The function name setSingleEntry is in camel caps, but expected set_single_entry instead as per the coding standard.
Loading history...
159
160
		$this->single_entry = $single_entry;
161
162
	}
163
164
	/**
165
	 * @return array
166
	 */
167
	public function getEntry() {
0 ignored issues
show
Coding Style introduced by
The function name getEntry is in camel caps, but expected get_entry instead as per the coding standard.
Loading history...
168
		return $this->entry;
169
	}
170
171
	/**
172
	 * Set the current entry
173
	 * @param array|int $entry Entry array or entry slug or ID
174
	 */
175
	public function setEntry( $entry ) {
0 ignored issues
show
Coding Style introduced by
The function name setEntry is in camel caps, but expected set_entry instead as per the coding standard.
Loading history...
176
177
		if ( ! is_array( $entry ) ) {
178
			$entry = GVCommon::get_entry( $entry );
179
		}
180
181
		$this->entry = $entry;
182
	}
183
184
	/**
185
	 * @return int
186
	 */
187
	public function getPostId() {
0 ignored issues
show
Coding Style introduced by
The function name getPostId is in camel caps, but expected get_post_id instead as per the coding standard.
Loading history...
188
		return $this->post_id;
189
	}
190
191
	/**
192
	 * @param int $post_id
193
	 */
194
	public function setPostId( $post_id ) {
0 ignored issues
show
Coding Style introduced by
The function name setPostId is in camel caps, but expected set_post_id instead as per the coding standard.
Loading history...
195
		$this->post_id = $post_id;
196
	}
197
198
	/**
199
	 * @return boolean
200
	 */
201 2
	public function isPostHasShortcode() {
0 ignored issues
show
Coding Style introduced by
The function name isPostHasShortcode is in camel caps, but expected is_post_has_shortcode instead as per the coding standard.
Loading history...
202 2
		return $this->post_has_shortcode;
203
	}
204
205
	/**
206
	 * @param boolean $post_has_shortcode
207
	 */
208
	public function setPostHasShortcode( $post_has_shortcode ) {
0 ignored issues
show
Coding Style introduced by
The function name setPostHasShortcode is in camel caps, but expected set_post_has_shortcode instead as per the coding standard.
Loading history...
209
		$this->post_has_shortcode = $post_has_shortcode;
210
	}
211
212
	/**
213
	 * @return boolean
214
	 */
215 2
	public function isGravityviewPostType() {
0 ignored issues
show
Coding Style introduced by
The function name isGravityviewPostType is in camel caps, but expected is_gravityview_post_type instead as per the coding standard.
Loading history...
216 2
		return $this->is_gravityview_post_type;
217
	}
218
219
	/**
220
	 * @param boolean $is_gravityview_post_type
221
	 */
222
	public function setIsGravityviewPostType( $is_gravityview_post_type ) {
0 ignored issues
show
Coding Style introduced by
The function name setIsGravityviewPostType is in camel caps, but expected set_is_gravityview_post_type instead as per the coding standard.
Loading history...
223
		$this->is_gravityview_post_type = $is_gravityview_post_type;
224
	}
225
226
	/**
227
	 * Set the context view ID used when page contains multiple embedded views or displaying the single entry view
228
	 *
229
	 *
230
	 *
231
	 * @param null $view_id
232
	 */
233 2
	public function set_context_view_id( $view_id = null ) {
234 2
		$multiple_views = defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? gravityview()->views->count() > 1 : ( $this->getGvOutputData() && $this->getGvOutputData()->has_multiple_views() );
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...
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
235
236 2
		if ( ! empty( $view_id ) ) {
237
238 2
			$this->context_view_id = $view_id;
239
240 2
		} elseif ( isset( $_GET['gvid'] ) && $multiple_views ) {
241
			/**
242
			 * used on a has_multiple_views context
243
			 * @see GravityView_API::entry_link
244
			 */
245 1
			$this->context_view_id = $_GET['gvid'];
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
246
247 2
		} elseif ( ! $multiple_views ) {
248 2
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
249 2
				$view = gravityview()->views->last();
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...
250 2
				$this->context_view_id = $view ? $view->ID : null;
251
			} else {
252
				/** GravityView_View_Data::get_views is deprecated. */
253
				$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...
254
				$this->context_view_id = array_pop( $array_keys );
255
				unset( $array_keys );
256
			}
257
		}
258
259 2
	}
260
261
	/**
262
	 * Returns the the view_id context when page contains multiple embedded views or displaying single entry view
263
	 *
264
	 * @since 1.5.4
265
	 *
266
	 * @return string
267
	 */
268
	public function get_context_view_id() {
269
		return $this->context_view_id;
270
	}
271
272
	/**
273
	 * Allow GravityView entry endpoints on the front page of a site
274
	 *
275
	 * @link  https://core.trac.wordpress.org/ticket/23867 Fixes this core issue
276
	 * @link https://wordpress.org/plugins/cpt-on-front-page/ Code is based on this
277
	 *
278
	 * @since 1.17.3
279
	 *
280
	 * @param WP_Query &$query (passed by reference)
281
	 *
282
	 * @return void
283
	 */
284 4
	public function parse_query_fix_frontpage( &$query ) {
285 4
		global $wp_rewrite;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
286
287 4
		$is_front_page = ( $query->is_home || $query->is_page );
288 4
		$show_on_front = ( 'page' === get_option('show_on_front') );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
289 4
		$front_page_id = get_option('page_on_front');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
290
291 4
		if (  $is_front_page && $show_on_front && $front_page_id ) {
292
293
			// Force to be an array, potentially a query string ( entry=16 )
294
			$_query = wp_parse_args( $query->query );
295
296
			// pagename can be set and empty depending on matched rewrite rules. Ignore an empty pagename.
297
			if ( isset( $_query['pagename'] ) && '' === $_query['pagename'] ) {
298
				unset( $_query['pagename'] );
299
			}
300
301
			// this is where will break from core wordpress
302
			$ignore = array( 'preview', 'page', 'paged', 'cpage' );
303
			$endpoints = rgobj( $wp_rewrite, 'endpoints' );
304
			foreach ( (array) $endpoints as $endpoint ) {
305
				$ignore[] = $endpoint[1];
306
			}
307
			unset( $endpoints );
308
309
			// Modify the query if:
310
			// - We're on the "Page on front" page (which we are), and:
311
			// - The query is empty OR
312
			// - The query includes keys that are associated with registered endpoints. `entry`, for example.
313
			if ( empty( $_query ) || ! array_diff( array_keys( $_query ), $ignore ) ) {
314
315
				$qv =& $query->query_vars;
316
317
				// Prevent redirect when on the single entry endpoint
318
				if( self::is_single_entry() ) {
319
					add_filter( 'redirect_canonical', '__return_false' );
320
				}
321
322
				$query->is_page = true;
323
				$query->is_home = false;
324
				$qv['page_id']  = $front_page_id;
325
326
				// Correct <!--nextpage--> for page_on_front
327
				if ( ! empty( $qv['paged'] ) ) {
328
					$qv['page'] = $qv['paged'];
329
					unset( $qv['paged'] );
330
				}
331
			}
332
333
			// reset the is_singular flag after our updated code above
334
			$query->is_singular = $query->is_single || $query->is_page || $query->is_attachment;
335
		}
336 4
	}
337
338
	/**
339
	 * Read the $post and process the View data inside
340
	 * @param  array  $wp Passed in the `wp` hook. Not used.
341
	 * @return void
342
	 */
343
	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...
344
		global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
345
346
		// If in admin and NOT AJAX request, get outta here.
347
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) && gravityview()->request->is_admin() ) {
348
			return;
349
			/** Deprecated in favor of gravityview()->request->is_admin(). */
350
		} else if ( GravityView_Plugin::is_admin() ) {
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_Plugin::is_admin() has been deprecated.

This method has been deprecated.

Loading history...
351
			return;
352
		}
353
354
		// Calculate requested Views
355
		$this->setGvOutputData( GravityView_View_Data::getInstance( $post ) );
356
357
		// !important: we need to run this before getting single entry (to kick the advanced filter)
358
		$this->set_context_view_id();
359
360
		$this->setIsGravityviewPostType( get_post_type( $post ) === 'gravityview' );
361
362
		$post_id = $this->getPostId() ? $this->getPostId() : (isset( $post ) ? $post->ID : null );
363
		$this->setPostId( $post_id );
364
		$post_has_shortcode = ! empty( $post->post_content ) ? gravityview_has_shortcode_r( $post->post_content, 'gravityview' ) : false;
365
		$this->setPostHasShortcode( $this->isGravityviewPostType() ? null : ! empty( $post_has_shortcode ) );
366
367
		// check if the View is showing search results (only for multiple entries View)
368
		$this->setIsSearch( $this->is_searching() );
369
370
		unset( $entry, $post_id, $post_has_shortcode );
371
	}
372
373
	/**
374
	 * Set the entry
375
	 */
376
	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...
377
		$entry_id = self::is_single_entry();
378
		$this->setSingleEntry( $entry_id );
379
		$this->setEntry( $entry_id );
380
	}
381
382
	/**
383
	 * Checks if the current View is presenting search results
384
	 *
385
	 * @since 1.5.4
386
	 *
387
	 * @return boolean True: Yes, it's a search; False: No, not a search.
388
	 */
389
	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...
390
391
		// It's a single entry, not search
392
		if ( $this->getSingleEntry() ) {
393
			return false;
394
		}
395
396
		$search_method = GravityView_Widget_Search::getInstance()->get_search_method();
397
398
		if( 'post' === $search_method ) {
399
			$get = $_POST;
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
400
		} else {
401
			$get = $_GET;
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
402
		}
403
404
		// No $_GET parameters
405
		if ( empty( $get ) || ! is_array( $get ) ) {
406
			return false;
407
		}
408
409
		// Remove empty values
410
		$get = array_filter( $get );
411
412
		// If the $_GET parameters are empty, it's no search.
413
		if ( empty( $get ) ) {
414
			return false;
415
		}
416
417
		$search_keys = array_keys( $get );
418
419
		$search_match = implode( '|', self::$search_parameters );
420
421
		foreach ( $search_keys as $search_key ) {
422
423
			// Analyze the search key $_GET parameter and see if it matches known GV args
424
			if ( preg_match( '/(' . $search_match . ')/i', $search_key ) ) {
425
				return true;
426
			}
427
		}
428
429
		return false;
430
	}
431
432
	/**
433
	 * Filter the title for the single entry view
434
	 *
435
	 * @param  string $title   current title
436
	 * @param  int $passed_post_id Post ID
437
	 * @return string          (modified) title
438
	 */
439 1
	public function single_entry_title( $title, $passed_post_id = null ) {
440 1
		global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
441
442
		// If this is the directory view, return.
443 1
		if ( ! $this->getSingleEntry() ) {
444
			return $title;
445
		}
446
447 1
		$entry = $this->getEntry();
448
449
		/**
450
		 * @filter `gravityview/single/title/out_loop` Apply the Single Entry Title filter outside the WordPress loop?
451
		 * @param boolean $in_the_loop Whether to apply the filter to the menu title and the meta tag <title> - outside the loop
452
		 * @param array $entry Current entry
453
		 */
454 1
		$apply_outside_loop = apply_filters( 'gravityview/single/title/out_loop' , in_the_loop(), $entry );
455
456 1
		if ( ! $apply_outside_loop ) {
457
			return $title;
458
		}
459
460
		// User reported WooCommerce doesn't pass two args.
461 1
		if ( empty( $passed_post_id ) )  {
462
			return $title;
463
		}
464
465
		// Don't modify the title for anything other than the current view/post.
466
		// This is true for embedded shortcodes and Views.
467 1
		if ( is_object( $post ) && (int) $post->ID !== (int) $passed_post_id ) {
468
			return $title;
469
		}
470
471 1
		$context_view_id = $this->get_context_view_id();
472
473 1
		$multiple_views = defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? gravityview()->views->count() > 1 : $this->getGvOutputData()->has_multiple_views();
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...
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
474
475 1
		if ( $multiple_views && ! empty( $context_view_id ) ) {
476 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
477 1
				$view = gravityview()->views->get( $context_view_id );
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...
478 1
				if ( ! $view ) {
479
					/** Emulate the weird behavior of \GravityView_View_Data::get_view adding a view which wasn't there to begin with. */
480
					gravityview()->views->add( \GV\View::by_id( $context_view_id ) );
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...
481 1
					$view = gravityview()->views->get( $context_view_id );
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...
482
				}
483
			} else {
484
				/** Deprecated. Use gravityview()->views->get() or gravityview()->request->get() */
485 1
				$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...
486
			}
487
		} else {
488 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
489 1
				foreach ( gravityview()->views->all() as $_view ) {
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...
490 1
					if ( intval( $_view->form->ID ) === intval( $entry['form_id'] ) ) {
491 1
						$view = $_view;
492 1
						break;
493
					}
494
				}
495
496
				/** No matching form sources were found, happens when requesting an entry from a different form . */
497 1
				if ( ! isset( $view ) )
0 ignored issues
show
Coding Style Best Practice introduced by
It is generally a best practice to always use braces with control structures.

Adding braces to control structures avoids accidental mistakes as your code changes:

// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
Loading history...
498 1
					return $title;
499
			} else {
500
				/** Deprecated. Use gravityview()->views->all() or gravityview()->request->all() */
501
				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...
502
					if ( intval( $view_data['form_id'] ) === intval( $entry['form_id'] ) ) {
503
						$view_meta = $view_data;
504
						break;
505
					}
506
				}
507
			}
508
		}
509
510 1
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
511 1
			if ( $title = $view->settings->get( 'single_title' ) ) {
512 1
				$title = GravityView_API::replace_variables( $title, $view->form, $entry );
0 ignored issues
show
Bug introduced by
The variable $view does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
513 1
				$title = do_shortcode( $title );
514
			}
515
		} else {
516
			/** Deprecated stuff in the future. See the branch above. */
517
			if ( ! empty( $view_meta['atts']['single_title'] ) ) {
518
519
				$title = $view_meta['atts']['single_title'];
520
521
				// We are allowing HTML in the fields, so no escaping the output
522
				$title = GravityView_API::replace_variables( $title, $view_meta['form'], $entry );
523
524
				$title = do_shortcode( $title );
525
			}
526
		}
527
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
528
529 1
		return $title;
530
	}
531
532
533
	/**
534
	 * In case View post is called directly, insert the view in the post content
535
	 *
536
	 * @access public
537
	 * @static
538
	 * @param mixed $content
539
	 * @return string Add the View output into View CPT content
540
	 */
541 1
	public function insert_view_in_content( $content ) {
542
543
		// Plugins may run through the content in the header. WP SEO does this for its OpenGraph functionality.
544 1
		if ( ! did_action( 'loop_start' ) ) {
545
546
			do_action( 'gravityview_log_debug', '[insert_view_in_content] Not processing yet: loop_start hasn\'t run yet. Current action:', current_filter() );
547
548
			return $content;
549
		}
550
551
		//	We don't want this filter to run infinite loop on any post content fields
552 1
		remove_filter( 'the_content', array( $this, 'insert_view_in_content' ) );
553
554
		// Otherwise, this is called on the Views page when in Excerpt mode.
555 1
		if ( is_admin() ) {
556
			return $content;
557
		}
558
559
		// Only render in the loop. Fixes issues with the_content filter being applied in places like the sidebar
560 1
		if( ! in_the_loop() ) {
561
			return $content;
562
		}
563
564 1
		if ( $this->isGravityviewPostType() ) {
565
566
			/** @since 1.7.4 */
567 1
			if ( is_preview() && ! gravityview_get_form_id( $this->post_id ) ) {
568
				$content .= __( 'When using a preset template, you must save the View before a Preview is available.', 'gravityview' );
569
			} else {
570 1
				if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
571 1
					foreach ( gravityview()->views->all() as $view ) {
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...
572 1
						$content .= $this->render_view( array( 'id' => $view->ID ) );
573
					}
574
				} else {
575
					/** The \GravityView_View_Data::get_views method is depreacted. */
576
					foreach ( $this->getGvOutputData()->get_views() as $view_id => $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...
577
						$content .= $this->render_view( array( 'id' => $view_id ) );
578
					}
579
				}
580
			}
581
		}
582
583
		//	Add the filter back in
584 1
		add_filter( 'the_content', array( $this, 'insert_view_in_content' ) );
585
586 1
		return $content;
587
	}
588
589
	/**
590
	 * Disable comments on GravityView post types
591
	 * @param  boolean $open    existing status
592
	 * @param  int $post_id Post ID
593
	 * @return boolean
594
	 */
595
	public function comments_open( $open, $post_id ) {
596
597
		if ( $this->isGravityviewPostType() ) {
598
			$open = false;
599
		}
600
601
		/**
602
		 * @filter `gravityview/comments_open` Whether to set comments to open or closed.
603
		 * @since  1.5.4
604
		 * @param  boolean $open Open or closed status
605
		 * @param  int $post_id Post ID to set comment status for
606
		 */
607
		$open = apply_filters( 'gravityview/comments_open', $open, $post_id );
608
609
		return $open;
610
	}
611
612
	/**
613
	 * Display a warning when a View has not been configured
614
	 *
615
	 * @since 1.19.2
616
	 *
617
	 * @param int $view_id The ID of the View currently being displayed
618
	 *
619
	 * @return void
620
	 */
621
	public function context_not_configured_warning( $view_id = 0 ) {
622
623
		if ( ! class_exists( 'GravityView_View' ) ) {
624
			return;
625
		}
626
627
		$fields = GravityView_View::getInstance()->getContextFields();
628
629
		if ( ! empty( $fields ) ) {
630
			return;
631
		}
632
633
		$context = GravityView_View::getInstance()->getContext();
634
635
		switch( $context ) {
636
			case 'directory':
637
				$tab = __( 'Multiple Entries', 'gravityview' );
638
				break;
639
			case 'edit':
640
				$tab = __( 'Edit Entry', 'gravityview' );
641
				break;
642
			case 'single':
643
			default:
644
				$tab = __( 'Single Entry', 'gravityview' );
645
				break;
646
		}
647
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
648
649
		$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 );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
650
		$edit_link = admin_url( sprintf( 'post.php?post=%d&action=edit#%s-view', $view_id, $context ) );
651
		$action_text = sprintf( esc_html__('Add fields to %s', 'gravityview' ), $tab );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
652
		$message = esc_html__( 'You can only see this message because you are able to edit this View.', 'gravityview' );
653
654
		$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 ) ) );
0 ignored issues
show
introduced by
Expected 1 space after "="; 2 found
Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
655
		$output = sprintf( '<h3>%s <strong><a href="%s">%s</a></strong></h3><p>%s</p>', $title, esc_url( $edit_link ), $action_text, $message );
656
657
		echo GVCommon::generate_notice( $output . $image, 'gv-error error', 'edit_gravityview', $view_id );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
658
	}
659
660
661
	/**
662
	 * Core function to render a View based on a set of arguments
663
	 *
664
	 * @access public
665
	 * @static
666
	 * @param array $passed_args {
667
	 *
668
	 *      Settings for rendering the View
669
	 *
670
	 *      @type int $id View id
671
	 *      @type int $page_size Number of entries to show per page
672
	 *      @type string $sort_field Form field id to sort
673
	 *      @type string $sort_direction Sorting direction ('ASC' or 'DESC')
674
	 *      @type string $start_date - Ymd
675
	 *      @type string $end_date - Ymd
676
	 *      @type string $class - assign a html class to the view
677
	 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
678
	 * }
679
	 *
680
	 * @return string|null HTML output of a View, NULL if View isn't found
681
	 */
682 1
	public function render_view( $passed_args ) {
683
684
		// validate attributes
685 1
		if ( empty( $passed_args['id'] ) ) {
686
			do_action( 'gravityview_log_error', '[render_view] Returning; no ID defined.', $passed_args );
687
			return null;
688
		}
689
690
		// Solve problem when loading content via admin-ajax.php
691
		// @hack
692 1
		if ( ! $this->getGvOutputData() ) {
693
694 1
			do_action( 'gravityview_log_error', '[render_view] gv_output_data not defined; parsing content.', $passed_args );
695
696 1
			$this->parse_content();
697
		}
698
699
		// Make 100% sure that we're dealing with a properly called situation
700 1
		if ( ! is_object( $this->getGvOutputData() ) || ! is_callable( array( $this->getGvOutputData(), 'get_view' ) ) ) {
701
702
			do_action( 'gravityview_log_error', '[render_view] gv_output_data not an object or get_view not callable.', $this->getGvOutputData() );
703
704
			return null;
705
		}
706
707 1
		$view_id = $passed_args['id'];
708
709 1
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
710 1
			$view = gravityview()->views->get( $view_id );
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...
711 1
			if ( ! $view ) {
712
				/** Emulate the weird behavior of \GravityView_View_Data::get_view adding a view which wasn't there to begin with. */
713 1
				gravityview()->views->add( \GV\View::by_id( $view_id ) );
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...
714 1
				$view = gravityview()->views->get( $view_id );
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...
715
			}
716
717
			/** Update the view settings with the requested arguments. */
718 1
			$view->settings->update( $passed_args );
719
		} else {
720
			/** \GravityView_View_Data::get_view is deprecated. */
721
			$view_data = $this->getGvOutputData()->get_view( $view_id, $passed_args );
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...
722
723
			do_action( 'gravityview_log_debug', '[render_view] View Data: ', $view_data );
724
725
			do_action( 'gravityview_log_debug', '[render_view] Init View. Arguments: ', $passed_args );
726
727
			// The passed args were always winning, even if they were NULL.
728
			// This prevents that. Filters NULL, FALSE, and empty strings.
729
			$passed_args = array_filter( $passed_args, 'strlen' );
730
731
			//Override shortcode args over View template settings
732
			$atts = wp_parse_args( $passed_args, $view_data['atts'] );
733
734
			do_action( 'gravityview_log_debug', '[render_view] Arguments after merging with View settings: ', $atts );
735
		}
736
737
		// It's password protected and you need to log in.
738 1
		if ( post_password_required( $view_id ) ) {
739
740
			do_action( 'gravityview_log_error', sprintf( '[render_view] Returning: View %d is password protected.', $view_id ) );
741
742
			// If we're in an embed or on an archive page, show the password form
743
			if ( get_the_ID() !== $view_id ) {
744
				return get_the_password_form();
745
			}
746
747
			// Otherwise, just get outta here
748
			return null;
749
		}
750
751
		/**
752
		 * Don't render View if user isn't allowed to see it
753
		 * @since 1.15
754
		 * @since 1.17.2 Added check for if a user has no caps but is logged in (member of multisite, but not any site). Treat as if logged-out.
755
		 */
756 1
		if( is_user_logged_in() && ! ( empty( wp_get_current_user()->caps ) && empty( wp_get_current_user()->roles ) ) && false === GVCommon::has_cap( 'read_gravityview', $view_id ) ) {
757
758
			do_action( 'gravityview_log_debug', sprintf( '%s Returning: View %d is not visible by current user.', __METHOD__, $view_id ) );
759
760
			return null;
761
		}
762
763 1
		if( $this->isGravityviewPostType() ) {
764
765
			/**
766
			 * @filter `gravityview_direct_access` Should Views be directly accessible, or only visible using the shortcode?
767
			 * @see https://codex.wordpress.org/Function_Reference/register_post_type#public
768
			 * @see \GV\Entry::get_endpoint_name
769
			 * @since 1.15.2
770
			 * @param[in,out] boolean `true`: allow Views to be accessible directly. `false`: Only allow Views to be embedded via shortcode. Default: `true`
771
			 * @param int $view_id The ID of the View currently being requested. `0` for general setting
772
			 */
773 1
			$direct_access = apply_filters( 'gravityview_direct_access', true, $view_id );
774
775 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
776 1
				$embed_only = $view->settings->get( 'embed_only' );
0 ignored issues
show
Bug introduced by
The variable $view does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
777
			} else {
778
				/** Deprecated. View attributes moved to \GV\View::$settings. */
779
				$embed_only = ! empty( $atts['embed_only'] );
780
			}
781
782 1
			if( ! $direct_access || ( $embed_only && ! GVCommon::has_cap( 'read_private_gravityviews' ) ) ) {
783 1
				return __( 'You are not allowed to view this content.', 'gravityview' );
784
			}
785
		}
786
787 1
		ob_start();
788
789
		/**
790
		 * Set globals for templating
791
		 * @deprecated 1.6.2
792
		 */
793 1
		global $gravityview_view;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
794
795 1
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
796 1
			$view_data = $view->as_data();
797 1
			$gravityview_view = new GravityView_View( $view_data );
798 1
			$post_id = intval( $view->settings->get( 'post_id' ) ? : get_the_ID() );
799 1
			$template_id = $view->template ? $view->template->ID : null;
800
		} else {
801
			/** These constructs are deprecated. Use the new gravityview() wrapper. */
802
			$gravityview_view = new GravityView_View( $view_data );
0 ignored issues
show
Bug introduced by
The variable $view_data does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
803
			$post_id = ! empty( $atts['post_id'] ) ? intval( $atts['post_id'] ) : get_the_ID();
804
			$template_id = $view_data['template_id'];
805
		}
806
807 1
		$gravityview_view->setPostId( $post_id );
808
809 1
		if ( ! $this->getSingleEntry() ) {
810
811
			// user requested Directory View
812 1
			do_action( 'gravityview_log_debug', '[render_view] Executing Directory View' );
813
814
			//fetch template and slug
815 1
			$view_slug = apply_filters( 'gravityview_template_slug_'. $template_id, 'table', 'directory' );
816
817 1
			do_action( 'gravityview_log_debug', '[render_view] View template slug: ', $view_slug );
818
819
			/**
820
			 * Disable fetching initial entries for views that don't need it (DataTables)
821
			 */
822 1
			$get_entries = apply_filters( 'gravityview_get_view_entries_'.$view_slug, true );
823
824 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
825 1
				$hide_until_searched = $view->settings->get( 'hide_until_searched' );
826
			} else {
827
				/** $atts is deprecated, use \GV\View:$settings */
828
				$hide_until_searched = ! empty( $atts['hide_until_searched'] );
829
			}
830
831
			/**
832
			 * Hide View data until search is performed
833
			 * @since 1.5.4
834
			 */
835 1
			if ( $hide_until_searched && ! $this->isSearch() ) {
836
				$gravityview_view->setHideUntilSearched( true );
837
				$get_entries = false;
838
			}
839
840 1
			if ( $get_entries ) {
841
842 1
				if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
843 1
					$sort_columns = $view->settings->get( 'sort_columns' );
844
				} else {
845
					/** $atts is deprecated, use \GV\View:$settings */
846
					$sort_columns = ! empty( $atts['sort_columns'] );
847
				}
848
849 1
				if ( $sort_columns ) {
850
					// add filter to enable column sorting
851
					add_filter( 'gravityview/template/field_label', array( $this, 'add_columns_sort_links' ) , 100, 3 );
852
				}
853
854 1
				if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
855 1
					$view_entries = self::get_view_entries( $view->settings->as_atts(), $view->form->ID );
856
				} else {
857
					/** $atts is deprecated, use \GV\View:$settings */
858
					/** $view_data is depreacted, use \GV\View properties */
859
					$view_entries = self::get_view_entries( $atts, $view_data['form_id'] );
0 ignored issues
show
Bug introduced by
The variable $atts does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
860
				}
861
862 1
				do_action( 'gravityview_log_debug', sprintf( '[render_view] Get Entries. Found %s entries total, showing %d entries', $view_entries['count'], sizeof( $view_entries['entries'] ) ) );
863
864
			} else {
865
866
				$view_entries = array( 'count' => null, 'entries' => null, 'paging' => null );
867
868
				do_action( 'gravityview_log_debug', '[render_view] Not fetching entries because `gravityview_get_view_entries_'.$view_slug.'` is false' );
869
			}
870
871 1
			$gravityview_view->setPaging( $view_entries['paging'] );
872 1
			$gravityview_view->setContext( 'directory' );
873 1
			$sections = array( 'header', 'body', 'footer' );
874
875
		} else {
876
877
			// user requested Single Entry View
878 1
			do_action( 'gravityview_log_debug', '[render_view] Executing Single View' );
879
880
			/**
881
			 * @action `gravityview_render_entry_{View ID}` Before rendering a single entry for a specific View ID
882
			 * @since 1.17
883
			 */
884 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
885 1
				do_action( 'gravityview_render_entry_' . $view->ID );
886
			} else {
887
				/** $view_data is depreacted, use \GV\View properties */
888
				do_action( 'gravityview_render_entry_'.$view_data['id'] );
889
			}
890
891 1
			$entry = $this->getEntry();
892
893
			// You are not permitted to view this entry.
894 1
			if ( empty( $entry ) || ! self::is_entry_approved( $entry, defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? $view->settings->as_atts() : $atts ) ) {
895
896
				do_action( 'gravityview_log_debug', '[render_view] Entry does not exist. This may be because of View filters limiting access.' );
897
898
				// Only display warning once when multiple Views are embedded
899
				if( $view_id !== (int) GravityView_frontend::get_context_view_id() ) {
900
					ob_end_clean();
901
					return null;
902
				}
903
904
				/**
905
				 * @filter `gravityview/render/entry/not_visible` Modify the message shown to users when the entry doesn't exist or they aren't allowed to view it.
906
				 * @since 1.6
907
				 * @param string $message Default: "You have attempted to view an entry that is not visible or may not exist."
908
				 */
909
				$message = apply_filters( 'gravityview/render/entry/not_visible', __( 'You have attempted to view an entry that is not visible or may not exist.', 'gravityview' ) );
910
911
				/**
912
				 * @since 1.6
913
				 */
914
				echo esc_attr( $message );
915
916
				ob_end_clean();
917
				return null;
918
			}
919
920
			// We're in single view, but the view being processed is not the same view the single entry belongs to.
921
			// important: do not remove this as it prevents fake attempts of displaying entries from other views/forms
922 1
			$multiple_views = defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? gravityview()->views->count() > 1 : $this->getGvOutputData()->has_multiple_views();
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...
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
923 1
			if ( $multiple_views && $view_id != $this->get_context_view_id() ) {
924
				do_action( 'gravityview_log_debug', '[render_view] In single entry view, but the entry does not belong to this View. Perhaps there are multiple views on the page. View ID: '. $view_id );
925
				ob_end_clean();
926
				return null;
927
			}
928
929
			//fetch template and slug
930 1
			$view_slug = apply_filters( 'gravityview_template_slug_' . $template_id, 'table', 'single' );
931 1
			do_action( 'gravityview_log_debug', '[render_view] View single template slug: ', $view_slug );
932
933
			//fetch entry detail
934 1
			$view_entries['count'] = 1;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$view_entries was never initialized. Although not strictly required by PHP, it is generally a good practice to add $view_entries = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
935 1
			$view_entries['entries'][] = $entry;
936 1
			do_action( 'gravityview_log_debug', '[render_view] Get single entry: ', $view_entries['entries'] );
937
938 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
939 1
				$back_link_label = $view->settings->get( 'back_link_label', null );
940
			} else {
941
				$back_link_label = isset( $atts['back_link_label'] ) ? $atts['back_link_label'] : null;
942
			}
943
944
			// set back link label
945 1
			$gravityview_view->setBackLinkLabel( $back_link_label );
946 1
			$gravityview_view->setContext( 'single' );
947 1
			$sections = array( 'single' );
948
949
		}
950
951
		// add template style
952 1
		self::add_style( $template_id );
953
954
		// Prepare to render view and set vars
955 1
		$gravityview_view->setEntries( $view_entries['entries'] );
956 1
		$gravityview_view->setTotalEntries( $view_entries['count'] );
957
958
		// If Edit
959 1
		if ( 'edit' === gravityview_get_context() ) {
960
961
			do_action( 'gravityview_log_debug', '[render_view] Edit Entry ' );
962
963
			do_action( 'gravityview_edit_entry', $this->getGvOutputData() );
964
965
			return ob_get_clean();
966
967
		} else {
968
			// finaly we'll render some html
969 1
			$sections = apply_filters( 'gravityview_render_view_sections', $sections, $template_id );
970
971 1
			do_action( 'gravityview_log_debug', '[render_view] Sections to render: ', $sections );
972 1
			foreach ( $sections as $section ) {
973 1
				do_action( 'gravityview_log_debug', '[render_view] Rendering '. $section . ' section.' );
974 1
				$gravityview_view->render( $view_slug, $section, false );
975
			}
976
		}
977
978
		//@todo: check why we need the IF statement vs. print the view id always.
979 1
		if ( $this->isGravityviewPostType() || $this->isPostHasShortcode() ) {
980
			// Print the View ID to enable proper cookie pagination
981 1
			echo '<input type="hidden" class="gravityview-view-id" value="' . esc_attr( $view_id ) . '">';
982
		}
983 1
		$output = ob_get_clean();
984
985 1
		return $output;
986
	}
987
988
	/**
989
	 * Process the start and end dates for a view - overrides values defined in shortcode (if needed)
990
	 *
991
	 * The `start_date` and `end_date` keys need to be in a format processable by GFFormsModel::get_date_range_where(),
992
	 * which uses \DateTime() format.
993
	 *
994
	 * 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()},
995
	 * including strings like "now" or "-1 year" or "-3 days".
996
	 *
997
	 * @see GFFormsModel::get_date_range_where
998
	 *
999
	 * @param  array      $args            View settings
1000
	 * @param  array      $search_criteria Search being performed, if any
1001
	 * @return array                       Modified `$search_criteria` array
1002
	 */
1003 1
	public static function process_search_dates( $args, $search_criteria = array() ) {
1004
1005 1
		$return_search_criteria = $search_criteria;
1006
1007 1
		foreach ( array( 'start_date', 'end_date' ) as $key ) {
1008
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1009
1010
			// Is the start date or end date set in the view or shortcode?
1011
			// If so, we want to make sure that the search doesn't go outside the bounds defined.
1012 1
			if ( ! empty( $args[ $key ] ) ) {
1013
1014
				// Get a timestamp and see if it's a valid date format
1015 1
				$date = strtotime( $args[ $key ] );
1016
1017
				// The date was invalid
1018 1
				if ( empty( $date ) ) {
1019
					do_action( 'gravityview_log_error', __METHOD__ . ' Invalid ' . $key . ' date format: ' . $args[ $key ] );
1020
					continue;
1021
				}
1022
1023
				// The format that Gravity Forms expects for start_date and day-specific (not hour/second-specific) end_date
1024 1
				$datetime_format = 'Y-m-d H:i:s';
1025 1
				$search_is_outside_view_bounds = false;
1026
1027 1
				if( ! empty( $search_criteria[ $key ] ) ) {
1028
1029 1
					$search_date = strtotime( $search_criteria[ $key ] );
1030
1031
					// The search is for entries before the start date defined by the settings
1032
					switch ( $key ) {
1033 1
						case 'end_date':
1034
							/**
1035
							 * If the end date is formatted as 'Y-m-d', it should be formatted without hours and seconds
1036
							 * so that Gravity Forms can convert the day to 23:59:59 the previous day.
1037
							 *
1038
							 * If it's a relative date ("now" or "-1 day"), then it should use the precise date format
1039
							 *
1040
							 * @see GFFormsModel::get_date_range_where
1041
							 */
1042 1
							$datetime_format               = gravityview_is_valid_datetime( $args[ $key ] ) ? 'Y-m-d' : 'Y-m-d H:i:s';
1043 1
							$search_is_outside_view_bounds = ( $search_date > $date );
1044 1
							break;
1045 1
						case 'start_date':
1046 1
							$search_is_outside_view_bounds = ( $search_date < $date );
1047 1
							break;
1048
					}
1049
				}
1050
1051
				// If there is no search being performed, or if there is a search being performed that's outside the bounds
1052 1
				if ( empty( $search_criteria[ $key ] ) || $search_is_outside_view_bounds ) {
1053
1054
					// Then we override the search and re-set the start date
1055 1
					$return_search_criteria[ $key ] = date_i18n( $datetime_format , $date, true );
1056
				}
1057
			}
1058
		}
1059
1060 1
		if( isset( $return_search_criteria['start_date'] ) && isset( $return_search_criteria['end_date'] ) ) {
1061
			// The start date is AFTER the end date. This will result in no results, but let's not force the issue.
1062 1
			if ( strtotime( $return_search_criteria['start_date'] ) > strtotime( $return_search_criteria['end_date'] ) ) {
1063 1
				do_action( 'gravityview_log_error', __METHOD__ . ' Invalid search: the start date is after the end date.', $return_search_criteria );
1064
			}
1065
		}
1066
1067 1
		return $return_search_criteria;
1068
	}
1069
1070
1071
	/**
1072
	 * Process the approved only search criteria according to the View settings
1073
	 *
1074
	 * @param  array      $args            View settings
1075
	 * @param  array      $search_criteria Search being performed, if any
1076
	 * @return array                       Modified `$search_criteria` array
1077
	 */
1078
	public static function process_search_only_approved( $args, $search_criteria ) {
1079
1080
		/** @since 1.19 */
1081
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1082
			do_action( 'gravityview_log_debug', __METHOD__ . ': User can moderate entries; showing all approval statuses' );
1083
			return $search_criteria;
1084
		}
1085
1086
		if ( ! empty( $args['show_only_approved'] ) ) {
1087
1088
			$search_criteria['field_filters'][] = array(
1089
				'key' => GravityView_Entry_Approval::meta_key,
1090
				'value' => GravityView_Entry_Approval_Status::APPROVED
0 ignored issues
show
introduced by
Each line in an array declaration must end in a comma
Loading history...
1091
			);
1092
1093
			$search_criteria['field_filters']['mode'] = 'all'; // force all the criterias to be met
1094
1095
			do_action( 'gravityview_log_debug', '[process_search_only_approved] Search Criteria if show only approved: ', $search_criteria );
1096
		}
1097
1098
		return $search_criteria;
1099
	}
1100
1101
1102
	/**
1103
	 * Check if a certain entry is approved.
1104
	 *
1105
	 * If we pass the View settings ($args) it will check the 'show_only_approved' setting before
1106
	 *   checking the entry approved field, returning true if show_only_approved = false.
1107
	 *
1108
	 * @since 1.7
1109
	 * @since 1.18 Converted check to use GravityView_Entry_Approval_Status::is_approved
1110
	 *
1111
	 * @uses GravityView_Entry_Approval_Status::is_approved
1112
	 *
1113
	 * @param array $entry  Entry object
1114
	 * @param array $args   View settings (optional)
1115
	 *
1116
	 * @return bool
1117
	 */
1118
	public static function is_entry_approved( $entry, $args = array() ) {
1119
1120
		if ( empty( $entry['id'] ) || ( array_key_exists( 'show_only_approved', $args ) && ! $args['show_only_approved'] ) ) {
1121
			// is implicitly approved if entry is null or View settings doesn't require to check for approval
1122
			return true;
1123
		}
1124
1125
		/** @since 1.19 */
1126
		if( ! empty( $args['admin_show_all_statuses'] ) && GVCommon::has_cap('gravityview_moderate_entries') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1127
			do_action( 'gravityview_log_debug', __METHOD__ . ': User can moderate entries, so entry is approved for viewing' );
1128
			return true;
1129
		}
1130
1131
		$is_approved = gform_get_meta( $entry['id'], GravityView_Entry_Approval::meta_key );
1132
1133
		return GravityView_Entry_Approval_Status::is_approved( $is_approved );
1134
	}
1135
1136
	/**
1137
	 * Parse search criteria for a entries search.
1138
	 *
1139
	 * array(
1140
	 * 	'search_field' => 1, // ID of the field
1141
	 *  'search_value' => '', // Value of the field to search
1142
	 *  'search_operator' => 'contains', // 'is', 'isnot', '>', '<', 'contains'
1143
	 *  'show_only_approved' => 0 or 1 // Boolean
1144
	 * )
1145
	 *
1146
	 * @param  array $args    Array of args
1147
	 * @param  int $form_id Gravity Forms form ID
1148
	 * @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.
1149
	 */
1150
	public static function get_search_criteria( $args, $form_id ) {
1151
1152
		/**
1153
		 * @filter `gravityview_fe_search_criteria` Modify the search criteria
1154
		 * @see GravityView_Widget_Search::filter_entries Adds the default search criteria
1155
		 * @param array $search_criteria Empty `field_filters` key
1156
		 * @param int $form_id ID of the Gravity Forms form that is being searched
1157
		 */
1158
		$search_criteria = apply_filters( 'gravityview_fe_search_criteria', array( 'field_filters' => array() ), $form_id );
1159
1160
		$original_search_criteria = $search_criteria;
1161
1162
		do_action( 'gravityview_log_debug', '[get_search_criteria] Search Criteria after hook gravityview_fe_search_criteria: ', $search_criteria );
1163
1164
		// implicity search
1165
		if ( ! empty( $args['search_value'] ) ) {
1166
1167
			// Search operator options. Options: `is` or `contains`
1168
			$operator = ! empty( $args['search_operator'] ) && in_array( $args['search_operator'], array( 'is', 'isnot', '>', '<', 'contains' ) ) ? $args['search_operator'] : 'contains';
1169
1170
			$search_criteria['field_filters'][] = array(
1171
				'key' => rgget( 'search_field', $args ), // The field ID to search
1172
				'value' => _wp_specialchars( $args['search_value'] ), // The value to search. Encode ampersands but not quotes.
1173
				'operator' => $operator,
1174
			);
1175
		}
1176
1177
		if( $search_criteria !== $original_search_criteria ) {
1178
			do_action( 'gravityview_log_debug', '[get_search_criteria] Search Criteria after implicity search: ', $search_criteria );
1179
		}
1180
1181
		// Handle setting date range
1182
		$search_criteria = self::process_search_dates( $args, $search_criteria );
1183
1184
		if( $search_criteria !== $original_search_criteria ) {
1185
			do_action( 'gravityview_log_debug', '[get_search_criteria] Search Criteria after date params: ', $search_criteria );
1186
		}
1187
1188
		// remove not approved entries
1189
		$search_criteria = self::process_search_only_approved( $args, $search_criteria );
1190
1191
		/**
1192
		 * @filter `gravityview_status` Modify entry status requirements to be included in search results.
1193
		 * @param string $status Default: `active`. Accepts all Gravity Forms entry statuses, including `spam` and `trash`
1194
		 */
1195
		$search_criteria['status'] = apply_filters( 'gravityview_status', 'active', $args );
1196
1197
		return $search_criteria;
1198
	}
1199
1200
1201
1202
	/**
1203
	 * Core function to calculate View multi entries (directory) based on a set of arguments ($args):
1204
	 *   $id - View id
1205
	 *   $page_size - Page
1206
	 *   $sort_field - form field id to sort
1207
	 *   $sort_direction - ASC / DESC
1208
	 *   $start_date - Ymd
1209
	 *   $end_date - Ymd
1210
	 *   $class - assign a html class to the view
1211
	 *   $offset (optional) - This is the start point in the current data set (0 index based).
1212
	 *
1213
	 *
1214
	 *
1215
	 * @uses  gravityview_get_entries()
1216
	 * @access public
1217
	 * @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...
1218
	 *   - $id - View id
1219
	 *   - $page_size - Page
1220
	 *   - $sort_field - form field id to sort
1221
	 *   - $sort_direction - ASC / DESC
1222
	 *   - $start_date - Ymd
1223
	 *   - $end_date - Ymd
1224
	 *   - $class - assign a html class to the view
1225
	 *   - $offset (optional) - This is the start point in the current data set (0 index based).
1226
	 * @param int $form_id Gravity Forms Form ID
1227
	 * @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
1228
	 */
1229
	public static function get_view_entries( $args, $form_id ) {
1230
1231
		do_action( 'gravityview_log_debug', '[get_view_entries] init' );
1232
		// start filters and sorting
1233
1234
		$parameters = self::get_view_entries_parameters( $args, $form_id );
1235
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1236
1237
		$count = 0; // Must be defined so that gravityview_get_entries can use by reference
1238
1239
		//fetch entries
1240
		$entries = gravityview_get_entries( $form_id, $parameters, $count );
1241
1242
		/** Adjust count by defined offset. */
1243
		$count = max( 0, ( $count - rgar( $args, 'offset', 0 ) ) );
1244
1245
		do_action( 'gravityview_log_debug', sprintf( '%s: Get Entries. Found: %s entries', __METHOD__, $count ), $entries );
1246
1247
		/**
1248
		 * @filter `gravityview_view_entries` Filter the entries output to the View
1249
		 * @deprecated since 1.5.2
1250
		 * @param array $args View settings associative array
1251
		 * @var array
1252
		 */
1253
		$entries = apply_filters( 'gravityview_view_entries', $entries, $args );
1254
1255
		$return = array(
1256
			'count' => $count,
1257
			'entries' => $entries,
1258
			'paging' => rgar( $parameters, 'paging' ),
1259
		);
1260
1261
		/**
1262
		 * @filter `gravityview/view/entries` Filter the entries output to the View
1263
		 * @param array $criteria associative array containing count, entries & paging
1264
		 * @param array $args View settings associative array
1265
		 * @since 1.5.2
1266
		 */
1267
		return apply_filters( 'gravityview/view/entries', $return, $args );
1268
	}
1269
1270
	/**
1271
	 * Get an array of search parameters formatted as Gravity Forms requires
1272
	 *
1273
	 * Results are filtered by `gravityview_get_entries` and `gravityview_get_entries_{View ID}` filters
1274
	 *
1275
	 * @uses GravityView_frontend::get_search_criteria
1276
	 * @uses GravityView_frontend::get_search_criteria_paging
1277
	 *
1278
	 * @since 1.20
1279
	 *
1280
	 * @see \GV\View_Settings::defaults For $args options
1281
	 *
1282
	 * @param array $args Array of View settings, as structured in \GV\View_Settings::defaults
1283
	 * @param int $form_id Gravity Forms form ID to search
1284
	 *
1285
	 * @return array With `search_criteria`, `sorting`, `paging`, `cache` keys
1286
	 */
1287
	public static function get_view_entries_parameters( $args = array(), $form_id = 0 ) {
1288
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1289
1290
		if ( ! is_array( $args ) || ! is_numeric( $form_id ) ) {
1291
1292
			do_action( 'gravityview_log_error', __METHOD__ . ': Passed args are not an array or the form ID is not numeric' );
1293
1294
			return array();
1295
		}
1296
1297
		$form_id = intval( $form_id );
1298
1299
		/**
1300
		 * Process search parameters
1301
		 * @var array
1302
		 */
1303
		$search_criteria = self::get_search_criteria( $args, $form_id );
1304
1305
		$paging = self::get_search_criteria_paging( $args );
1306
1307
		$parameters = array(
1308
			'search_criteria' => $search_criteria,
1309
			'sorting' => self::updateViewSorting( $args, $form_id ),
1310
			'paging' => $paging,
1311
			'cache' => isset( $args['cache'] ) ? $args['cache'] : true,
1312
		);
1313
1314
		/**
1315
		 * @filter `gravityview_get_entries` Filter get entries criteria
1316
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
1317
		 * @param array $args View configuration args. {
1318
		 *      @type int $id View id
1319
		 *      @type int $page_size Number of entries to show per page
1320
		 *      @type string $sort_field Form field id to sort
1321
		 *      @type string $sort_direction Sorting direction ('ASC' or 'DESC')
1322
		 *      @type string $start_date - Ymd
1323
		 *      @type string $end_date - Ymd
1324
		 *      @type string $class - assign a html class to the view
1325
		 *      @type string $offset (optional) - This is the start point in the current data set (0 index based).
1326
		 * }
1327
		 * @param int $form_id ID of Gravity Forms form
1328
		 */
1329
		$parameters = apply_filters( 'gravityview_get_entries', $parameters, $args, $form_id );
1330
1331
		/**
1332
		 * @filter `gravityview_get_entries_{View ID}` Filter get entries criteria
1333
		 * @param array $parameters Array with `search_criteria`, `sorting` and `paging` keys.
1334
		 * @param array $args View configuration args.
1335
		 */
1336
		$parameters = apply_filters( 'gravityview_get_entries_'.$args['id'], $parameters, $args, $form_id );
1337
1338
		do_action( 'gravityview_log_debug', __METHOD__ . ': $parameters passed to gravityview_get_entries(): ', $parameters );
1339
1340
		return $parameters;
1341
	}
1342
1343
	/**
1344
	 * Get the paging array for the View
1345
	 *
1346
	 * @since 1.19.5
1347
	 *
1348
	 * @param $args
1349
	 * @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...
1350
	 */
1351
	public static function get_search_criteria_paging( $args ) {
1352
1353
		/**
1354
		 * @filter `gravityview_default_page_size` The default number of entries displayed in a View
1355
		 * @since 1.1.6
1356
		 * @param int $default_page_size Default: 25
1357
		 */
1358
		$default_page_size = apply_filters( 'gravityview_default_page_size', 25 );
1359
1360
		// Paging & offset
1361
		$page_size = ! empty( $args['page_size'] ) ? intval( $args['page_size'] ) : $default_page_size;
1362
1363
		if ( -1 === $page_size ) {
1364
			$page_size = PHP_INT_MAX;
1365
		}
1366
1367
		$curr_page = empty( $_GET['pagenum'] ) ? 1 : intval( $_GET['pagenum'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1368
		$offset = ( $curr_page - 1 ) * $page_size;
1369
1370
		if ( ! empty( $args['offset'] ) ) {
1371
			$offset += intval( $args['offset'] );
1372
		}
1373
1374
		$paging = array(
1375
			'offset' => $offset,
1376
			'page_size' => $page_size,
1377
		);
1378
1379
		do_action( 'gravityview_log_debug', __METHOD__ . ': Paging: ', $paging );
1380
1381
		return $paging;
1382
	}
1383
1384
	/**
1385
	 * Updates the View sorting criteria
1386
	 *
1387
	 * @since 1.7
1388
	 *
1389
	 * @param array $args View settings. Required to have `sort_field` and `sort_direction` keys
1390
	 * @param int $form_id The ID of the form used to sort
1391
	 * @return array $sorting Array with `key`, `direction` and `is_numeric` keys
1392
	 */
1393
	public static function updateViewSorting( $args, $form_id ) {
0 ignored issues
show
Coding Style introduced by
The function name updateViewSorting is in camel caps, but expected update_view_sorting instead as per the coding standard.
Loading history...
1394
		$sorting = array();
1395
		$sort_field_id = isset( $_GET['sort'] ) ? $_GET['sort'] : rgar( $args, 'sort_field' );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
1396
		$sort_direction = isset( $_GET['dir'] ) ? $_GET['dir'] : rgar( $args, 'sort_direction' );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
1397
1398
		$sort_field_id = self::_override_sorting_id_by_field_type( $sort_field_id, $form_id );
1399
1400
		if ( ! empty( $sort_field_id ) ) {
1401
			$sorting = array(
1402
				'key' => $sort_field_id,
1403
				'direction' => strtolower( $sort_direction ),
1404
				'is_numeric' => GVCommon::is_field_numeric( $form_id, $sort_field_id )
1405
			);
1406
		}
1407
1408
		GravityView_View::getInstance()->setSorting( $sorting );
1409
1410
		do_action( 'gravityview_log_debug', '[updateViewSorting] Sort Criteria : ', $sorting );
1411
1412
		return $sorting;
1413
1414
	}
1415
1416
	/**
1417
	 * Override sorting per field
1418
	 *
1419
	 * Currently only modifies sorting ID when sorting by the full name. Sorts by first name.
1420
	 * Use the `gravityview/sorting/full-name` filter to override.
1421
	 *
1422
	 * @todo Filter from GravityView_Field
1423
	 * @since 1.7.4
1424
	 *
1425
	 * @param int|string $sort_field_id Field used for sorting (`id` or `1.2`)
1426
	 * @param int $form_id GF Form ID
1427
	 *
1428
	 * @return string Possibly modified sorting ID
1429
	 */
1430
	private static function _override_sorting_id_by_field_type( $sort_field_id, $form_id ) {
1431
1432
		$form = gravityview_get_form( $form_id );
1433
1434
		$sort_field = GFFormsModel::get_field( $form, $sort_field_id );
1435
1436
		if( ! $sort_field ) {
1437
			return $sort_field_id;
1438
		}
1439
1440
		switch ( $sort_field['type'] ) {
1441
1442
			case 'address':
1443
				// Sorting by full address
1444
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1445
1446
					/**
1447
					 * Override how to sort when sorting address
1448
					 *
1449
					 * @since 1.8
1450
					 *
1451
					 * @param string $address_part `street`, `street2`, `city`, `state`, `zip`, or `country` (default: `city`)
1452
					 * @param string $sort_field_id Field used for sorting
1453
					 * @param int $form_id GF Form ID
1454
					 */
1455
					$address_part = apply_filters( 'gravityview/sorting/address', 'city', $sort_field_id, $form_id );
1456
1457
					switch( strtolower( $address_part ) ){
1458
						case 'street':
1459
							$sort_field_id .= '.1';
1460
							break;
1461
						case 'street2':
1462
							$sort_field_id .= '.2';
1463
							break;
1464
						default:
1465
						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...
1466
							$sort_field_id .= '.3';
1467
							break;
1468
						case 'state':
1469
							$sort_field_id .= '.4';
1470
							break;
1471
						case 'zip':
1472
							$sort_field_id .= '.5';
1473
							break;
1474
						case 'country':
1475
							$sort_field_id .= '.6';
1476
							break;
1477
					}
1478
1479
				}
1480
				break;
1481
			case 'name':
1482
				// Sorting by full name, not first, last, etc.
1483
				if ( floatval( $sort_field_id ) === floor( $sort_field_id ) ) {
1484
					/**
1485
					 * @filter `gravityview/sorting/full-name` Override how to sort when sorting full name.
1486
					 * @since 1.7.4
1487
					 * @param[in,out] string $name_part Sort by `first` or `last` (default: `first`)
1488
					 * @param[in] string $sort_field_id Field used for sorting
1489
					 * @param[in] int $form_id GF Form ID
1490
					 */
1491
					$name_part = apply_filters( 'gravityview/sorting/full-name', 'first', $sort_field_id, $form_id );
1492
1493
					if ( 'last' === strtolower( $name_part ) ) {
1494
						$sort_field_id .= '.6';
1495
					} else {
1496
						$sort_field_id .= '.3';
1497
					}
1498
				}
1499
				break;
1500
			case 'list':
1501
				$sort_field_id = false;
1502
				break;
1503
			case 'time':
1504
1505
				/**
1506
				 * @filter `gravityview/sorting/time` Override how to sort when sorting time
1507
				 * @see GravityView_Field_Time
1508
				 * @since 1.14
1509
				 * @param[in,out] string $name_part Field used for sorting
1510
				 * @param[in] int $form_id GF Form ID
1511
				 */
1512
				$sort_field_id = apply_filters( 'gravityview/sorting/time', $sort_field_id, $form_id );
1513
				break;
1514
		}
1515
1516
		return $sort_field_id;
1517
	}
1518
1519
	/**
1520
	 * Verify if user requested a single entry view
1521
	 * @return boolean|string false if not, single entry slug if true
1522
	 */
1523 2
	public static function is_single_entry() {
1524
1525 2
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1526 2
			$var_name = \GV\Entry::get_endpoint_name();
1527
		} else {
1528
			/** Deprecated. Use \GV\Entry::get_endpoint_name instead. */
1529
			$var_name = GravityView_Post_Types::get_entry_var_name();
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_Post_Types::get_entry_var_name() has been deprecated.

This method has been deprecated.

Loading history...
1530
		}
1531
1532 2
		$single_entry = get_query_var( $var_name );
1533
1534
		/**
1535
		 * Modify the entry that is being displayed.
1536
		 *
1537
		 * @internal Should only be used by things like the oEmbed functionality.
1538
		 * @since 1.6
1539
		 */
1540 2
		$single_entry = apply_filters( 'gravityview/is_single_entry', $single_entry );
1541
1542 2
		if ( empty( $single_entry ) ){
1543
			return false;
1544
		} else {
1545 2
			return $single_entry;
1546
		}
1547
	}
1548
1549
1550
	/**
1551
	 * Register styles and scripts
1552
	 *
1553
	 * @access public
1554
	 * @return void
1555
	 */
1556 1
	public function add_scripts_and_styles() {
1557 1
		global $post, $posts;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
1558
		// enqueue template specific styles
1559 1
		if ( $this->getGvOutputData() ) {
1560
1561 1
			if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1562 1
				$views = gravityview()->views->all();
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...
1563
			} else {
1564
				/** \GravityView_View_Data::get_view is no more... */
1565
				$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...
1566
			}
1567
1568 1
			foreach ( $views as $view_id => $data ) {
1569 1
				if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1570 1
					$view = $data;
1571 1
					$view_id = $view->ID;
1572 1
					$template_id = $view->template ? $view->template->ID : null;
1573 1
					$data = $view->as_data();
1574
				} else {
1575
					$template_id = $data['template_id'];
1576
				}
1577
1578
				/**
1579
				 * Don't enqueue the scripts or styles if it's not going to be displayed.
1580
				 * @since 1.15
1581
				 */
1582 1
				if( is_user_logged_in() && false === GVCommon::has_cap( 'read_gravityview', $view_id ) ) {
1583
					continue;
1584
				}
1585
1586
				// By default, no thickbox
1587 1
				$js_dependencies = array( 'jquery', 'gravityview-jquery-cookie' );
1588 1
				$css_dependencies = array();
1589
1590 1
				if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1591 1
					$lightbox = $view->settings->get( 'lightbox' );
0 ignored issues
show
Bug introduced by
The variable $view does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1592
				} else {
1593
					/** View data attributes are now stored in \GV\View::$settings */
1594
					$lightbox = ! empty( $data['atts']['lightbox'] );
1595
				}
1596
1597
				// If the thickbox is enqueued, add dependencies
1598 1
				if ( $lightbox ) {
1599
1600
					/**
1601
					 * @filter `gravity_view_lightbox_script` Override the lightbox script to enqueue. Default: `thickbox`
1602
					 * @param string $script_slug If you want to use a different lightbox script, return the name of it here.
1603
					 */
1604 1
					$js_dependencies[] = apply_filters( 'gravity_view_lightbox_script', 'thickbox' );
1605
1606
					/**
1607
					 * @filter `gravity_view_lightbox_style` Modify the lightbox CSS slug. Default: `thickbox`
1608
					 * @param string $script_slug If you want to use a different lightbox script, return the name of its CSS file here.
1609
					 */
1610 1
					$css_dependencies[] = apply_filters( 'gravity_view_lightbox_style', 'thickbox' );
1611
				}
1612
1613
				/**
1614
				 * If the form has checkbox fields, enqueue dashicons
1615
				 * @see https://github.com/katzwebservices/GravityView/issues/536
1616
				 * @since 1.15
1617
				 */
1618 1
				if( gravityview_view_has_single_checkbox_or_radio( $data['form'], $data['fields'] ) ) {
1619
					$css_dependencies[] = 'dashicons';
1620
				}
1621
1622 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 );
1623
1624 1
				$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
1625
1626 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 );
1627
1628 1
				wp_enqueue_script( 'gravityview-fe-view' );
1629
1630 1
				if ( ! empty( $data['atts']['sort_columns'] ) ) {
1631
					wp_enqueue_style( 'gravityview_font', plugins_url( 'assets/css/font.css', GRAVITYVIEW_FILE ), $css_dependencies, GravityView_Plugin::version, 'all' );
1632
				}
1633
1634 1
				$this->enqueue_default_style( $css_dependencies );
1635
1636 1
				self::add_style( $template_id );
1637
			}
1638
1639 1
			if ( 'wp_print_footer_scripts' === current_filter() ) {
1640
1641
				$js_localization = array(
1642
					'cookiepath' => COOKIEPATH,
1643
					'clear' => _x( 'Clear', 'Clear all data from the form', 'gravityview' ),
1644
					'reset' => _x( 'Reset', 'Reset the search form to the state that existed on page load', 'gravityview' ),
1645
				);
1646
1647
				/**
1648
				 * @filter `gravityview_js_localization` Modify the array passed to wp_localize_script()
1649
				 * @param array $js_localization The data padded to the Javascript file
1650
				 * @param array $views Array of View data arrays with View settings
1651
				 */
1652
				$js_localization = apply_filters( 'gravityview_js_localization', $js_localization, $views );
1653
1654
				wp_localize_script( 'gravityview-fe-view', 'gvGlobals', $js_localization );
1655
			}
1656
		}
1657 1
	}
1658
1659
	/**
1660
	 * Handle enqueuing the `gravityview_default_style` stylesheet
1661
	 *
1662
	 * @since 1.17
1663
	 *
1664
	 * @param array $css_dependencies Dependencies for the `gravityview_default_style` stylesheet
1665
	 *
1666
	 * @return void
1667
	 */
1668
	private function enqueue_default_style( $css_dependencies = array() ) {
1669
1670
		/**
1671
		 * @filter `gravityview_use_legacy_search_css` Should GravityView use the legacy Search Bar stylesheet (from before Version 1.17)?
1672
		 * @since 1.17
1673
		 * @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`
1674
		 */
1675
		$use_legacy_search_style = apply_filters( 'gravityview_use_legacy_search_style', false );
1676
1677
		$rtl = is_rtl() ? '-rtl' : '';
1678
1679
		$css_file_base = $use_legacy_search_style ? 'gv-legacy-search' : 'gv-default-styles';
1680
1681
		$path = gravityview_css_url( $css_file_base . $rtl . '.css' );
1682
1683
		wp_enqueue_style( 'gravityview_default_style', $path, $css_dependencies, GravityView_Plugin::version, 'all' );
1684
	}
1685
1686
	/**
1687
	 * Add template extra style if exists
1688
	 * @param string $template_id
1689
	 */
1690
	public static function add_style( $template_id ) {
1691
1692
		if ( ! empty( $template_id ) && wp_style_is( 'gravityview_style_' . $template_id, 'registered' ) ) {
1693
			do_action( 'gravityview_log_debug', sprintf( '[add_style] Adding extra template style for %s', $template_id ) );
1694
			wp_enqueue_style( 'gravityview_style_' . $template_id );
1695
		} elseif ( empty( $template_id ) ) {
1696
			do_action( 'gravityview_log_error', '[add_style] Cannot add template style; template_id is empty' );
1697
		} else {
1698
			do_action( 'gravityview_log_error', sprintf( '[add_style] Cannot add template style; %s is not registered', 'gravityview_style_'.$template_id ) );
1699
		}
1700
1701
	}
1702
1703
1704
	/**
1705
	 * Inject the sorting links on the table columns
1706
	 *
1707
	 * Callback function for hook 'gravityview/template/field_label'
1708
	 * @see GravityView_API::field_label() (in includes/class-api.php)
1709
	 *
1710
	 * @since 1.7
1711
	 *
1712
	 * @param string $label Field label
1713
	 * @param array $field Field settings
1714
	 *
1715
	 * @return string Field Label
1716
	 */
1717
	public function add_columns_sort_links( $label = '', $field, $form ) {
1718
1719
		/**
1720
		 * Not a table-based template; don't add sort icons
1721
		 * @since 1.12
1722
		 */
1723
		if( ! preg_match( '/table/ism', GravityView_View::getInstance()->getTemplatePartSlug() ) ) {
1724
			return $label;
1725
		}
1726
1727
		if ( ! $this->is_field_sortable( $field['id'], $form ) ) {
1728
			return $label;
1729
		}
1730
1731
		$sorting = GravityView_View::getInstance()->getSorting();
1732
1733
		$class = 'gv-sort';
1734
1735
		$sort_field_id = self::_override_sorting_id_by_field_type( $field['id'], $form['id'] );
1736
1737
		$sort_args = array(
1738
			'sort' => $field['id'],
1739
			'dir' => 'asc',
1740
		);
1741
1742
		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
1743
			//toggle sorting direction.
1744
			if ( 'asc' === $sorting['direction'] ) {
1745
				$sort_args['dir'] = 'desc';
1746
				$class .= ' gv-icon-sort-desc';
1747
			} else {
1748
				$sort_args['dir'] = 'asc';
1749
				$class .= ' gv-icon-sort-asc';
1750
			}
1751
		} else {
1752
			$class .= ' gv-icon-caret-up-down';
1753
		}
1754
1755
		$url = add_query_arg( $sort_args, remove_query_arg( array('pagenum') ) );
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
introduced by
No space before closing parenthesis of array is bad style
Loading history...
1756
1757
		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a>&nbsp;'. $label;
1758
1759
	}
1760
1761
	/**
1762
	 * Checks if field (column) is sortable
1763
	 *
1764
	 * @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...
1765
	 * @param array $form Gravity Forms form array
1766
	 *
1767
	 * @since 1.7
1768
	 *
1769
	 * @return bool True: Yes, field is sortable; False: not sortable
1770
	 */
1771
	public function is_field_sortable( $field_id = '', $form = array() ) {
1772
1773
		$field_type = $field_id;
1774
1775
		if( is_numeric( $field_id ) ) {
1776
			$field = GFFormsModel::get_field( $form, $field_id );
1777
			$field_type = $field->type;
1778
		}
1779
1780
		$not_sortable = array(
1781
			'edit_link',
1782
			'delete_link',
1783
		);
1784
1785
		/**
1786
		 * @filter `gravityview/sortable/field_blacklist` Modify what fields should never be sortable.
1787
		 * @since 1.7
1788
		 * @param[in,out] array $not_sortable Array of field types that aren't sortable
1789
		 * @param string $field_type Field type to check whether the field is sortable
1790
		 * @param array $form Gravity Forms form
1791
		 */
1792
		$not_sortable = apply_filters( 'gravityview/sortable/field_blacklist', $not_sortable, $field_type, $form );
1793
1794
		if ( in_array( $field_type, $not_sortable ) ) {
1795
			return false;
1796
		}
1797
1798
		return apply_filters( "gravityview/sortable/formfield_{$form['id']}_{$field_id}", apply_filters( "gravityview/sortable/field_{$field_id}", true, $form ) );
1799
1800
	}
1801
1802
}
1803
1804
GravityView_frontend::getInstance();
1805
1806
1807
1808