Completed
Pull Request — master (#1422)
by Zack
17:24 queued 14:35
created

GravityView_API::replace_variables()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 8
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
c 0
b 0
f 0

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
<?php
2
/**
3
 * GravityView template tags API
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
class GravityView_API {
15
16
	/**
17
	 * Fetch Field Label
18
	 *
19
	 * @deprecated Use \GV\Field::get_label()
20
	 *
21
	 * @access public
22
	 * @static
23
	 * @param array $field GravityView field array
24
	 * @param array $entry Gravity Forms entry array
25
	 * @param boolean $force_show_label Whether to always show the label, regardless of field settings
26
	 * @return string
27
	 */
28 3
	public static function field_label( $field, $entry = array(), $force_show_label = false ) {
29
30 3
		$gravityview_view = GravityView_View::getInstance();
31
32 3
		$form = $gravityview_view->getForm();
33
34 3
		if ( defined( 'DOING_GRAVITYVIEW_TESTS' ) && ! empty( $GLOBALS['GravityView_API_field_label_override'] ) ) {
35
			/** Allow to fall through for back compatibility testing purposes. */
36
		} else {
37 3
			return \GV\Mocks\GravityView_API_field_label( $form, $field, $entry, $force_show_label );
38
		}
39
40 1
		$label = '';
41
42 1
		if( !empty( $field['show_label'] ) || $force_show_label ) {
43
44 1
			$label = $field['label'];
45
46
			// Support Gravity Forms 1.9+
47 1
			if( class_exists( 'GF_Field' ) ) {
48
49 1
				$field_object = RGFormsModel::get_field( $form, $field['id'] );
50
51 1
				if( $field_object ) {
52
53 1
					$input = GFFormsModel::get_input( $field_object, $field['id'] );
54
55
					// This is a complex field, with labels on a per-input basis
56 1
					if( $input ) {
57
58
						// Does the input have a custom label on a per-input basis? Otherwise, default label.
59 1
						$label = ! empty( $input['customLabel'] ) ? $input['customLabel'] : $input['label'];
60
61
					} else {
62
63
						// This is a field with one label
64 1
						$label = $field_object->get_field_label( true, $field['label'] );
65
66
					}
67
68
				}
69
70
			}
71
72
			// Use Gravity Forms label by default, but if a custom label is defined in GV, use it.
73 1
			if ( !empty( $field['custom_label'] ) ) {
74
75 1
				$label = self::replace_variables( $field['custom_label'], $form, $entry );
76
77
			}
78
79
			/**
80
			 * @filter `gravityview_render_after_label` Append content to a field label
81
			 * @param[in,out] string $appended_content Content you can add after a label. Empty by default.
82
			 * @param[in] array $field GravityView field array
83
			 */
84 1
			$label .= apply_filters( 'gravityview_render_after_label', '', $field );
85
86
		} // End $field['show_label']
87
88
		/**
89
		 * @filter `gravityview/template/field_label` Modify field label output
90
		 * @since 1.7
91
		 * @param[in,out] string $label Field label HTML
92
		 * @param[in] array $field GravityView field array
93
		 * @param[in] array $form Gravity Forms form array
94
		 * @param[in] array $entry Gravity Forms entry array
95
		 *
96
		 * @deprecated Use the context-aware version `gravityview/template/field/label`
97
		 */
98 1
		$label = apply_filters( 'gravityview/template/field_label', $label, $field, $form, $entry );
99
100 1
		return $label;
101
	}
102
103
	/**
104
	 * Alias for GravityView_Merge_Tags::replace_variables()
105
	 *
106
	 * @see GravityView_Merge_Tags::replace_variables() Moved in 1.8.4
107
	 * @since 1.22.4 - Added $nl2br, $format, $aux_data args
108
	 *
109
	 * @param  string     $text         Text to replace variables in
110
	 * @param  array      $form         GF Form array
111
	 * @param  array      $entry        GF Entry array
112
	 * @param  bool       $url_encode   Pass return value through `url_encode()`
113
	 * @param  bool       $esc_html     Pass return value through `esc_html()`
114
	 * @param  bool       $nl2br        Convert newlines to <br> HTML tags
115
	 * @param  string     $format       The format requested for the location the merge is being used. Possible values: html, text or url.
116
	 * @param  array      $aux_data     Additional data to be used to replace merge tags {@see https://www.gravityhelp.com/documentation/article/gform_merge_tag_data/}
117
	 * @return string                   Text with variables maybe replaced
118
	 */
119 50
	public static function replace_variables( $text, $form = array(), $entry = array(), $url_encode = false, $esc_html = true, $nl2br = true, $format = 'html', $aux_data = array() ) {
120 50
		return GravityView_Merge_Tags::replace_variables( $text, $form, $entry, $url_encode, $esc_html, $nl2br, $format, $aux_data );
121
	}
122
123
	/**
124
	 * Get column width from the field setting
125
	 *
126
	 * @since 1.9
127
	 *
128
	 * @param array $field Array of settings for the field
129
	 * @param string $format Format for width. "%" (default) will return
130
	 *
131
	 * @return string|null If not empty, string in $format format. Otherwise, null.
132
	 */
133 35
	public static function field_width( $field, $format = '%d%%' ) {
134
135 35
		$width = NULL;
136
137 35
		if( !empty( $field['width'] ) ) {
138 1
			$width = absint( $field['width'] );
139
140
			// If using percentages, limit to 100%
141 1
			if( '%d%%' === $format && $width > 100 ) {
142 1
				$width = 100;
143
			}
144
145 1
			$width = sprintf( $format, $width );
146
		}
147
148 35
		return $width;
149
	}
150
151
	/**
152
	 * Fetch Field class
153
	 *
154
	 * @access public
155
	 * @static
156
	 * @param mixed $field
157
	 * @return string
158
	 */
159 38
	public static function field_class( $field, $form = NULL, $entry = NULL ) {
160 38
		$classes = array();
161
162 38
		if( !empty( $field['custom_class'] ) ) {
163
164 2
            $custom_class = $field['custom_class'];
165
166 2
            if( !empty( $entry ) ) {
167
168
                // We want the merge tag to be formatted as a class. The merge tag may be
169
                // replaced by a multiple-word value that should be output as a single class.
170
                // "Office Manager" will be formatted as `.OfficeManager`, not `.Office` and `.Manager`
171 2
                add_filter('gform_merge_tag_filter', 'sanitize_html_class');
172
173 2
                $custom_class = self::replace_variables( $custom_class, $form, $entry);
174
175
                // And then we want life to return to normal
176 2
                remove_filter('gform_merge_tag_filter', 'sanitize_html_class');
177
            }
178
179
			// And now we want the spaces to be handled nicely.
180 2
			$classes[] = gravityview_sanitize_html_class( $custom_class );
181
182
		}
183
184 38
		if(!empty($field['id'])) {
185 38
			if( !empty( $form ) && !empty( $form['id'] ) ) {
186 38
				$form_id = '-'.$form['id'];
187
			} else {
188
				// @deprecated path. Form should always be given.
189
				gravityview()->log->warning( 'GravityView_View::getInstance() legacy API called' );
190
				$gravityview_view = GravityView_View::getInstance();
191
				$form_id = $gravityview_view->getFormId() ? '-'. $gravityview_view->getFormId() : '';
192
			}
193
194 38
			$classes[] = 'gv-field'.$form_id.'-'.$field['id'];
195
		}
196
197 38
		return esc_attr(implode(' ', $classes));
198
	}
199
200
	/**
201
	 * Fetch Field HTML ID
202
	 *
203
	 * @since 1.11
204
	 *
205
	 * @access public
206
	 * @static
207
	 * @param array $field GravityView field array passed to gravityview_field_output()
208
	 * @param array $form Gravity Forms form array, if set.
209
	 * @param array $entry Gravity Forms entry array
210
	 * @return string Sanitized unique HTML `id` attribute for the field
211
	 */
212 34
	public static function field_html_attr_id( $field, $form = array(), $entry = array() ) {
0 ignored issues
show
Unused Code introduced by
The parameter $entry 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...
213 34
		$id = $field['id'];
214
215 34
		if ( ! empty( $id ) ) {
216 34
			if ( ! empty( $form ) && ! empty( $form['id'] ) ) {
217 34
				$form_id = '-' . $form['id'];
218
			} else {
219
				// @deprecated path. Form should always be given.
220
				gravityview()->log->warning( 'GravityView_View::getInstance() legacy API called' );
221
				$gravityview_view = GravityView_View::getInstance();
222
				$form_id = $gravityview_view->getFormId() ? '-' . $gravityview_view->getFormId() : '';
223
			}
224
225 34
			$id = 'gv-field' . $form_id . '-' . $field['id'];
226
		}
227
228 34
		return esc_attr( $id );
229
	}
230
231
232
	/**
233
	 * Given an entry and a form field id, calculate the entry value for that field.
234
	 *
235
	 * @deprecated Use \GV\Field_Template::render() or the more low-level \GV\Field::get_value()
236
	 *
237
	 * @access public
238
	 * @param array $entry
239
	 * @param array $field
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...
240
	 * @return null|string
241
	 */
242 3
	public static function field_value( $entry, $field_settings, $format = 'html' ) {
243 3
		gravityview()->log->notice( '\GravityView_API::field_value is deprecated. Use \GV\Field_Template::render() or \GV\Field::get_value()' );
244 3
		return \GV\Mocks\GravityView_API_field_value( $entry, $field_settings, $format );
0 ignored issues
show
Deprecated Code introduced by
The function GV\Mocks\GravityView_API_field_value() has been deprecated with message: Use \GV\Field_Template::render()

This function has been deprecated. The supplier of the file has supplied an explanatory message.

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

Loading history...
245
	}
246
247
	/**
248
	 * Generate an anchor tag that links to an entry.
249
	 *
250
	 * @since 1.6
251
	 * @see GVCommon::get_link_html()
252
	 *
253
	 * @param string $anchor_text The text or HTML inside the link
254
	 * @param array $entry Gravity Forms entry array
255
	 * @param array|string $passed_tag_atts Attributes to be added to the anchor tag, such as `title` or `rel`.
256
	 * @param array $field_settings Array of field settings. Optional, but passed to the `gravityview_field_entry_link` filter
257
	 *
258
	 * @since 2.0
259
	 * @param int $base_id The post or the view that this entry is linked from.
260
	 *
261
	 * @return string|null Returns HTML for an anchor link. Null if $entry isn't defined or is missing an ID.
262
	 */
263 2
	public static function entry_link_html( $entry = array(), $anchor_text = '', $passed_tag_atts = array(), $field_settings = array(), $base_id = null ) {
264
265 2
		if ( empty( $entry ) || ! is_array( $entry ) || ! isset( $entry['id'] ) ) {
266 1
			gravityview()->log->debug( 'Entry not defined; returning null', array( 'data' => $entry ) );
267 1
			return NULL;
268
		}
269
270 2
		$href = self::entry_link( $entry, $base_id );
271
272 2
		if( '' === $href ) {
273
			return NULL;
274
		}
275
276 2
		$link = gravityview_get_link( $href, $anchor_text, $passed_tag_atts );
277
278
		/**
279
		 * @filter `gravityview_field_entry_link` Modify the link HTML
280
		 * @param string $link HTML output of the link
281
		 * @param string $href URL of the link
282
		 * @param array  $entry The GF entry array
283
		 * @param  array $field_settings Settings for the particular GV field
284
		 */
285 2
		$output = apply_filters( 'gravityview_field_entry_link', $link, $href, $entry, $field_settings );
286
287 2
		return $output;
288
	}
289
290
	/**
291
	 * Get the "No Results" text depending on whether there were results.
292
	 * @param  boolean     $wpautop Apply wpautop() to the output?
293
	 *
294
	 * @since 2.0
295
	 * @param \GV\Template_Context $context The context
296
	 *
297
	 * @return string               HTML of "no results" text
298
	 */
299 9
	public static function no_results( $wpautop = true, $context = null ) {
300 9
		$is_search = false;
301
302 9
		if ( $context instanceof \GV\Template_Context ) {
303 7
			if ( $context->request->is_search() ) {
304 7
				$is_search = true;
305
			}
306
		} else {
307 2
			$gravityview_view = GravityView_View::getInstance();
308
309 2
			if( $gravityview_view && ( $gravityview_view->curr_start || $gravityview_view->curr_end || $gravityview_view->curr_search ) ) {
0 ignored issues
show
Documentation introduced by
The property curr_start does not exist on object<GravityView_View>. 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...
Documentation introduced by
The property curr_end does not exist on object<GravityView_View>. 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...
Documentation introduced by
The property curr_search does not exist on object<GravityView_View>. 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...
310 1
				$is_search = true;
311
			}
312
		}
313
314 9
		if ( $is_search ) {
315 1
			$output = __( 'This search returned no results.', 'gravityview' );
316
		} else {
317 9
			$output = __( 'No entries match your request.', 'gravityview' );
318
		}
319
320
		/**
321
		 * @filter `gravitview_no_entries_text` Modify the text displayed when there are no entries.
322
		 * Note: this filter is, and always has been, misspelled. This will not be fixed, since the filter is deprecated.
323
		 * @param string $output The existing "No Entries" text
324
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
325
		 * @return string The modified text.
326
		 * @deprecated Use `gravityview/template/text/no_entries`
327
		 */
328 9
		$output = apply_filters( 'gravitview_no_entries_text', $output, $is_search );
329
330
		/**
331
		 * @filter `gravityview/template/text/no_entries` Modify the text displayed when there are no entries.
332
		 * @since 2.0
333
		 * @param string $output The existing "No Entries" text
334
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
335
		 * @param \GV\Template_Context $context The context.
336
		 * @return string The modified text.
337
		 */
338 9
		$output = apply_filters( 'gravityview/template/text/no_entries', $output, $is_search, $context );
339
340 9
		return $wpautop ? wpautop( $output ) : $output;
341
	}
342
343
	/**
344
	 * Generate a URL to the Directory context
345
	 *
346
	 * Uses `wp_cache_get` and `wp_cache_get` (since 1.3) to speed up repeated requests to get permalink, which improves load time. Since we may be doing this hundreds of times per request, it adds up!
347
	 *
348
	 * @param int $post_id Post ID
349
	 * @param boolean $add_query_args Add pagination and sorting arguments
350
	 *
351
	 * @since 2.0
352
	 * @param \GV\Template_Context $context The context this is being used in.
353
	 *
354
	 * @return string      Permalink to multiple entries view
355
	 */
356 46
	public static function directory_link( $post_id = NULL, $add_query_args = true, $context = null ) {
357 46
		global $post;
358
359 46
		if ( empty( $post_id ) ) {
360
			// DataTables passes the Post ID
361 21
			if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
362
				$post_id = \GV\Utils::_POST( 'post_id', false );
363
			} else {
364 21
				if ( $context instanceof \GV\Template_Context ) {
365
					// Shortcodes, embeds
366 17
					if ( is_a( $post, 'WP_Post' ) ) {
367 5
						$post_id = $post->ID;
368
369
					// Actual views
370
					} else {
371 17
						$post_id = $context->view ? $context->view->ID : false;
372
					}
373
				} else {
374
					/** @deprecated path of execution */
375 4
					$gravityview_view = GravityView_View::getInstance();
376
377
					// The Post ID has been passed via the shortcode
378 4
					if ( ! empty( $gravityview_view ) && $gravityview_view->getPostId() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $gravityview_view->getPostId() of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
379 2
						$post_id = $gravityview_view->getPostId();
380
					} else {
381
						// This is a GravityView post type
382 2
						if ( GravityView_frontend::getInstance()->isGravityviewPostType() ) {
383
							$post_id = isset( $gravityview_view ) ? $gravityview_view->getViewId() : $post->ID;
384
						} else {
385
							// This is an embedded GravityView; use the embedded post's ID as the base.
386 2
							if ( GravityView_frontend::getInstance()->isPostHasShortcode() && is_a( $post, 'WP_Post' ) ) {
387
								$post_id = $post->ID;
388 2
							} elseif ( $gravityview_view->getViewId() ) {
389
								// The GravityView has been embedded in a widget or in a template, and
390
								// is not in the current content. Thus, we defer to the View's own ID.
391 1
								$post_id = $gravityview_view->getViewId();
392
							}
393
						}
394
					}
395
				}
396
			}
397
		}
398
399
		// No post ID, get outta here.
400 46
		if ( empty( $post_id ) ) {
401 1
			return null;
402
		}
403
404
		// If we've saved the permalink in memory, use it
405
		// @since 1.3
406 45
		$link = wp_cache_get( 'gv_directory_link_'.$post_id );
407
408 45
		if ( (int) $post_id === (int) get_option( 'page_on_front' ) ) {
409
			$link = home_url();
410
		}
411
412 45
		if ( empty( $link ) ) {
413 45
			$link = get_permalink( $post_id );
414
415
			// If not yet saved, cache the permalink.
416
			// @since 1.3
417 45
			wp_cache_set( 'gv_directory_link_'.$post_id, $link );
418
		}
419
420
		// Deal with returning to proper pagination for embedded views
421 45
		if ( $link && $add_query_args ) {
422
423 41
			$args = array();
424
425 41
			if( $pagenum = \GV\Utils::_GET( 'pagenum' ) ) {
426 2
				$args['pagenum'] = intval( $pagenum );
427
			}
428
429 41
			if( $sort = \GV\Utils::_GET( 'sort' ) ) {
430
				$args['sort'] = $sort;
431
				$args['dir'] = \GV\Utils::_GET( 'dir' );
432
			}
433
434 41
			$link = add_query_arg( $args, $link );
435
		}
436
437
		/**
438
		 * @filter `gravityview_directory_link` Modify the URL to the View "directory" context
439
		 * @since 1.19.4
440
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
441
		 * @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
442
		 */
443 45
		$link = apply_filters( 'gravityview_directory_link', $link, $post_id );
444
445
		/**
446
		 * @filter `gravityview/view/links/directory` Modify the URL to the View "directory" context
447
		 * @since 2.0
448
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
449
		 * @param \GV\Template_Context $context
450
		 */
451 45
		return apply_filters( 'gravityview/view/links/directory', $link, $context );
452
	}
453
454
	/**
455
	 * Calculate an *unique* hash for an entry based on the entry ID
456
	 *
457
	 * This allows you to be more discrete as to the number of the entry - if you don't want users to know that you have made a certain number of sales, for example, or that their entry in the giveaway is entry #3.
458
	 *
459
	 * The hashed value MUST be unique, otherwise multiple entries will share the same URL, which leads to obvious problems.
460
	 *
461
	 * @param  int|string $id Entry ID to generate the hash for.
462
	 * @param  array  $entry        Entry data passed to provide additional information when generating the hash. Optional - don't rely on it being available.
463
	 * @return string               Hashed unique value for entry
464
	 */
465 3
	private static function get_custom_entry_slug( $id, $entry = array() ) {
466
467
		// Generate an unique hash to use as the default value
468 3
		$slug = substr( wp_hash( $id, 'gravityview'.$id ), 0, 8 );
469
470
		/**
471
		 * @filter `gravityview_entry_slug` Modify the unique hash ID generated, if you want to improve usability or change the format. This will allow for custom URLs, such as `{entryid}-{first-name}` or even, if unique, `{first-name}-{last-name}`
472
		 * @param string $hash Existing hash generated by GravityView
473
		 * @param  string $id The entry ID
474
		 * @param  array $entry Entry data array. May be empty.
475
		 */
476 3
		$slug = apply_filters( 'gravityview_entry_slug', $slug, $id, $entry );
477
478
		// Make sure we have something - use the original ID as backup.
479 3
		if( empty( $slug ) ) {
480
			$slug = $id;
481
		}
482
483 3
		return sanitize_title( $slug );
484
	}
485
486
	/**
487
	 * Get the entry slug for the entry. By default, it is the entry ID.
488
	 *
489
	 *
490
	 * @see gravityview_get_entry()
491
	 * @uses GravityView_API::get_custom_entry_slug() If using custom slug, gets the custom slug value
492
	 * @since 1.4
493
	 * @param  int|string $id_or_string ID of the entry, or custom slug string
494
	 * @param  array  $entry        Gravity Forms Entry array, optional. Used only to provide data to customize the `gravityview_entry_slug` filter
495
	 * @return string               Unique slug ID, passed through `sanitize_title()`
496
	 */
497 157
	public static function get_entry_slug( $id_or_string, $entry = array() ) {
498
499
		/**
500
		 * Default: use the entry ID as the unique identifier
501
		 */
502 157
		$slug = $id_or_string;
503
504
		/**
505
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
506
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
507
		 */
508 157
		$custom = apply_filters( 'gravityview_custom_entry_slug', false );
509
510
		// If we're using custom slug...
511 157
		if ( $custom ) {
512
513
			// Get the entry hash
514 3
			$hash = self::get_custom_entry_slug( $id_or_string, $entry );
515
516
			// Cache the slugs
517 3
			static $cache = array();
518
519 3
			if ( ! isset( $cache[ $id_or_string ] ) ) {
520 3
				global $wpdb;
521
522 3
				if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) ) {
523 3
					$table = GFFormsModel::get_entry_meta_table_name();
524 3
					$column = 'entry_id';
525
				} else {
526
					$table = RGFormsModel::get_lead_meta_table_name();
527
					$column = 'lead_id';
528
				}
529
530 3
				$results = $wpdb->get_results( $wpdb->prepare( "SELECT $column, meta_value FROM $table WHERE form_id = (SELECT form_id FROM $table WHERE $column = %d LIMIT 1) AND meta_key = 'gravityview_unique_id'", $id_or_string ) );
531
532 3
				if ( $results ) {
533
					$cache = array_replace( $cache, array_combine( wp_list_pluck( $results, $column ), wp_list_pluck( $results, 'meta_value' ) ) );
534
				}
535
536 3
				if ( ! isset( $cache[ $id_or_string ] ) ) {
537 3
					$cache[ $id_or_string ] = false;
538
				}
539
			}
540
541 3
			$value = $cache[ $id_or_string ];
542
543
			// If it does have a hash set, and the hash is expected, use it.
544
			// This check allows users to change the hash structure using the
545
			// gravityview_entry_hash filter and have the old hashes expire.
546 3
			if ( empty( $value ) || $value !== $hash ) {
547 3
				gravityview()->log->debug( 'Setting hash for entry {entry}: {hash}', array( 'entry' => $id_or_string, 'hash' => $hash ) );
548 3
				gform_update_meta( $id_or_string, 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
549
			}
550
551 3
			$slug = $hash;
552
553 3
			unset( $value, $hash );
554
		}
555
556 157
		return sanitize_title( $slug );
557
	}
558
559
    /**
560
     * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
561
     *
562
     * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
563
     *
564
     * @param $entry array Gravity Forms entry object
565
     * @param $form array Gravity Forms form object
566
     */
567
    public static function entry_create_custom_slug( $entry, $form ) {
0 ignored issues
show
Unused Code introduced by
The parameter $form 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...
568
        /**
569
         * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
570
         * @param boolean $custom Should we process the custom entry slug?
571
         */
572
        $custom = apply_filters( 'gravityview_custom_entry_slug', false );
573
        if( $custom ) {
574
            // create the gravityview_unique_id and save it
575
576
            // Get the entry hash
577
            $hash = self::get_custom_entry_slug( $entry['id'], $entry );
578
579
	        gravityview()->log->debug( 'Setting hash for entry {entry_id}: {hash}', array( 'entry_id' => $entry['id'], 'hash' => $hash ) );
580
581
            gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
582
583
        }
584
    }
585
586
587
588
589
	/**
590
	 * return href for single entry
591
	 * @param  array|int $entry   Entry array or entry ID
592
	 * @param  int|null $post_id If wanting to define the parent post, pass a post ID
593
	 * @param boolean $add_directory_args True: Add args to help return to directory; False: only include args required to get to entry {@since 1.7.3}
594
	 * @return string          Link to the entry with the directory parent slug, or empty string if embedded post or View doesn't exist
595
	 */
596 6
	public static function entry_link( $entry, $post_id = NULL, $add_directory_args = true ) {
597
598 6
		if ( ! empty( $entry ) && ! is_array( $entry ) ) {
599
			$entry = GVCommon::get_entry( $entry );
600 6
		} else if( empty( $entry ) ) {
601
			// @deprecated path
602
			$entry = GravityView_frontend::getInstance()->getEntry();
603
		}
604
605
		// Second parameter used to be passed as $field; this makes sure it's not an array
606 6
		if ( ! is_numeric( $post_id ) ) {
607 1
			$post_id = NULL;
608
		}
609
610
		// Get the permalink to the View
611 6
		$directory_link = self::directory_link( $post_id, false );
612
613
		// No post ID? Get outta here.
614 6
		if ( empty( $directory_link ) ) {
615 1
			return '';
616
		}
617
618 5
		$query_arg_name = \GV\Entry::get_endpoint_name();
619
620 5
		if ( ! empty( $entry['_multi'] ) ) {
621 1
			$entry_slugs = array();
622
623 1
			foreach ( $entry['_multi'] as $_multi ) {
624
625 1
				if( $gv_multi = \GV\GF_Entry::from_entry( $_multi ) ) {
626 1
					$entry_slugs[] = $gv_multi->get_slug();
627
				} else {
628
					// TODO: This path isn't covered by unit tests
629
					$entry_slugs[] = \GravityView_API::get_entry_slug( $_multi['id'], $_multi );
630
				}
631
632 1
				unset( $gv_multi );
633
634 1
				$forms[] = $_multi['form_id'];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$forms was never initialized. Although not strictly required by PHP, it is generally a good practice to add $forms = 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...
635
			}
636
637 1
			$entry_slug = implode( ',', $entry_slugs );
638
		} else {
639
640
			// Fallback when
641 5
			if( $gv_entry = \GV\GF_Entry::from_entry( $entry ) ) {
642 5
				$entry_slug = $gv_entry->get_slug();
643
			} else {
644
				// TODO: This path isn't covered by unit tests
645
				$entry_slug = \GravityView_API::get_entry_slug( $entry['id'], $entry );
646
			}
647
648 5
			unset( $gv_entry );
649
		}
650
651 5
		if ( get_option('permalink_structure') && !is_preview() ) {
652
653
			$args = array();
654
655
			/**
656
			 * Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
657
			 * @since 1.16.5
658
			 */
659
			$link_parts = explode( '?', $directory_link );
660
661
			$query = !empty( $link_parts[1] ) ? '?'.$link_parts[1] : '';
662
663
			$directory_link = trailingslashit( $link_parts[0] ) . $query_arg_name . '/'. $entry_slug .'/' . $query;
664
665
		} else {
666
667 5
			$args = array( $query_arg_name => $entry_slug );
668
		}
669
670
		/**
671
		 * @since 1.7.3
672
		 */
673 5
		if ( $add_directory_args ) {
674
675 5
			if ( ! empty( $_GET['pagenum'] ) ) {
676
				$args['pagenum'] = intval( $_GET['pagenum'] );
677
			}
678
679
			/**
680
			 * @since 1.7
681
			 */
682 5
			if ( $sort = \GV\Utils::_GET( 'sort' ) ) {
683
				$args['sort'] = $sort;
684
				$args['dir'] = \GV\Utils::_GET( 'dir' );
685
			}
686
687
		}
688
689 5
		if( $post_id ) {
690 5
			$passed_post = get_post( $post_id );
691 5
			$views       = \GV\View_Collection::from_post( $passed_post );
692 5
			$has_multiple_views = $views->count() > 1;
693
		} else {
694
			$has_multiple_views = class_exists( 'GravityView_View_Data' ) && GravityView_View_Data::getInstance()->has_multiple_views();
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
695
		}
696
697 5
		if ( $has_multiple_views ) {
698 1
			$args['gvid'] = gravityview_get_view_id();
699
		}
700
701 5
		return add_query_arg( $args, $directory_link );
702
703
	}
704
705
706
}
707
708
709
// inside loop functions
710
711
/**
712
 * @deprecated Use \GV\Field::get_label()
713
 */
714
function gv_label( $field, $entry = NULL ) {
715 2
	return GravityView_API::field_label( $field, $entry );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_API::field_label() has been deprecated with message: Use \GV\Field::get_label()

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

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

Loading history...
716
}
717
718
function gv_class( $field, $form = NULL, $entry = array() ) {
719 37
	return GravityView_API::field_class( $field, $form, $entry  );
720
}
721
722
/**
723
 * Generate a CSS class to be added to the wrapper <div> of a View
724
 *
725
 * @since 1.5.4
726
 * @since 1.16 Added $echo parameter.
727
 * @since 2.0 Added $context parameter.
728
 *
729
 * @param string $passed_css_class Default: `gv-container gv-container-{view id}`. If View is hidden until search, adds ` hidden`
730
 * @param boolean $echo Whether to echo the output. Default: true
731
 * @param \GV\Template_Context $context The template context.
732
 *
733
 * @return string CSS class, sanitized by gravityview_sanitize_html_class()
734
 */
735
function gv_container_class( $passed_css_class = '', $echo = true, $context = null ) {
736 38
	if ( $context instanceof \GV\Template_Context ) {
737 36
		$hide_until_searched = false;
738 36
		$total_entries = 0;
739 36
		$view_id = 0;
740 36
		if ( $context->view ) {
741 36
			$view_id = $context->view->ID;
742 36
			if( $context->view->settings->get( 'hide_until_searched' ) ) {
743 4
				$hide_until_searched = ( empty( $context->entry ) && ! $context->request->is_search() );
744
			}
745
		}
746 36
		if ( $context->entries ) {
747 23
			$total_entries = $context->entries->total();
748 17
		} else if ( $context->entry ) {
749 36
			$total_entries = 1;
750
		}
751
	} else {
752
		/** @deprecated legacy execution path */
753 3
		$view_id = GravityView_View::getInstance()->getViewId();
754 3
		$hide_until_searched = GravityView_View::getInstance()->isHideUntilSearched();
755 3
		$total_entries = GravityView_View::getInstance()->getTotalEntries();
756
	}
757
758 38
	$passed_css_class = trim( $passed_css_class );
759
760 38
	$default_css_class = ! empty( $view_id ) ? sprintf( 'gv-container gv-container-%d', $view_id ) : 'gv-container';
761
762 38
	if ( $hide_until_searched ) {
763 4
		$default_css_class .= ' hidden';
764
	}
765
766 38
	if ( 0 === $total_entries ) {
767 7
		$default_css_class .= ' gv-container-no-results';
768
	}
769
770 38
	$css_class = trim( $passed_css_class . ' '. $default_css_class );
771
772
	/**
773
	 * @filter `gravityview/render/container/class` Modify the CSS class to be added to the wrapper <div> of a View
774
	 * @since 1.5.4
775
	 * @param[in,out] string $css_class Default: `gv-container gv-container-{view id}`. If View is hidden until search, adds ` hidden`. If the View has no results, adds `gv-container-no-results`
776
	 * @since 2.0
777
	 * @param \GV\Template_Context $context The context.
778
	 */
779 38
	$css_class = apply_filters( 'gravityview/render/container/class', $css_class, $context );
780
781 38
	$css_class = gravityview_sanitize_html_class( $css_class );
782
783 38
	if ( $echo ) {
784 38
		echo $css_class;
785
	}
786
787 38
	return $css_class;
788
}
789
790
/**
791
 * @deprecated Use \GV\Field_Template::render()
792
 */
793
function gv_value( $entry, $field ) {
794
795 2
	$value = GravityView_API::field_value( $entry, $field );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_API::field_value() has been deprecated with message: Use \GV\Field_Template::render() or the more low-level \GV\Field::get_value()

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

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

Loading history...
796
797 2
	if( $value === '' ) {
798
		/**
799
		 * @filter `gravityview_empty_value` What to display when a field is empty
800
		 * @param string $value (empty string)
801
		 */
802 1
		$value = apply_filters( 'gravityview_empty_value', '' );
803
	}
804
805 2
	return $value;
806
}
807
808
function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
809 18
	return GravityView_API::directory_link( $post, $add_pagination, $context );
810
}
811
812
function gv_entry_link( $entry, $post_id = NULL ) {
813 2
	return GravityView_API::entry_link( $entry, $post_id );
814
}
815
816
function gv_no_results( $wpautop = true, $context = null ) {
817 8
	return GravityView_API::no_results( $wpautop, $context );
818
}
819
820
/**
821
 * Generate HTML for the back link from single entry view
822
 * @since 1.0.1
823
 * @since 2.0
824
 * @param \GV\Template_Context $context The context this link is being displayed from.
825
 * @return string|null      If no GV post exists, null. Otherwise, HTML string of back link.
826
 */
827
function gravityview_back_link( $context = null ) {
828
829 17
	$href = gv_directory_link( null, true, $context );
830
831
	/**
832
	 * @filter `gravityview_go_back_url` Modify the back link URL
833
	 * @since 1.17.5
834
	 * @see gv_directory_link() Generated the original back link
835
	 * @param string $href Existing label URL
836
	 * @deprecated Use `gravityview/template/links/back/url`
837
	 */
838 17
	$href = apply_filters( 'gravityview_go_back_url', $href );
839
840
	/**
841
	 * @filter `gravityview/template/links/back/url` Modify the back link URL
842
	 * @since 2.0
843
	 * @see gv_directory_link() Generated the original back link
844
	 * @param string $href Existing label URL
845
	 * @param \GV\Template_Context The context.
846
	 */
847 17
	$href = apply_filters( 'gravityview/template/links/back/url', $href, $context );
848
849 17
	if ( empty( $href ) ) {
850 4
		return NULL;
851
	}
852
853 14
	if ( $context instanceof \GV\Template_Context ) {
854 14
		$view_id = $context->view->ID;
855 14
		$view_label = $context->template->get_back_label();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class GV\Template as the method get_back_label() does only exist in the following sub-classes of GV\Template: GV\Entry_Legacy_Template, GV\Entry_List_Template, GV\Entry_Table_Template, GV\Entry_Template. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
856
	} else {
857
		/** @deprecated legacy path */
858
		$gravityview_view = GravityView_View::getInstance();
859
		$view_id = $gravityview_view->getViewId();
860
		$view_label = $gravityview_view->getBackLinkLabel() ? $gravityview_view->getBackLinkLabel() : false;
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View::getBackLinkLabel() has been deprecated with message: Use $template->get_back_label();

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

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

Loading history...
861
	}
862
863
	/** Default */
864 14
	$label = $view_label ? $view_label : __( '&larr; Go back', 'gravityview' );
865
866
	/**
867
	 * @filter `gravityview_go_back_label` Modify the back link text
868
	 * @since 1.0.9
869
	 * @param string $label Existing label text
870
	 * @deprecated Use `gravityview/template/links/back/label`
871
	 */
872 14
	$label = apply_filters( 'gravityview_go_back_label', $label );
873
874
	/**
875
	 * @filter `gravityview/template/links/back/label` Modify the back link text
876
	 * @since 2.0
877
	 * @see gv_directory_link() Generated the original back link
878
	 * @param string $label Existing label text
879
	 * @param \GV\Template_Context The context.
880
	 */
881 14
	$label = apply_filters( 'gravityview/template/links/back/label', $label, $context );
882
883
	/**
884
	 * @filter `gravityview/template/links/back/atts` Modify the attributes used on the back link anchor tag
885
	 * @since 2.1
886
	 * @param array $atts Original attributes, default: [ data-viewid => $view_id ]
887
	 * @param \GV\Template_Context The context.
888
	 */
889 14
	$atts = apply_filters( 'gravityview/template/links/back/atts', array( 'data-viewid' => $view_id ), $context );
890
891 14
	$link = gravityview_get_link( $href, esc_html( $label ), $atts );
892
893 14
	return $link;
894
}
895
896
/**
897
 * Handle getting values for complex Gravity Forms fields
898
 *
899
 * If the field is complex, like a product, the field ID, for example, 11, won't exist. Instead,
900
 * it will be 11.1, 11.2, and 11.3. This handles being passed 11 and 11.2 with the same function.
901
 *
902
 * @since 1.0.4
903
 * @param  array      $entry    GF entry array
904
 * @param  string      $field_id [description]
905
 * @param  string 	$display_value The value generated by Gravity Forms
906
 * @return string                Value
907
 */
908
function gravityview_get_field_value( $entry, $field_id, $display_value ) {
909
910 15
	if( floatval( $field_id ) === floor( floatval( $field_id ) ) ) {
911
912
		// For the complete field value as generated by Gravity Forms
913 12
		return $display_value;
914
915
	} else {
916
917
		// For one part of the address (City, ZIP, etc.)
918 7
		return isset( $entry[ $field_id ] ) ? $entry[ $field_id ] : '';
919
920
	}
921
922
}
923
924
/**
925
 * Take a passed CSV of terms and generate a linked list of terms
926
 *
927
 * Gravity Forms passes categories as "Name:ID" so we handle that using the ID, which
928
 * is more accurate than checking the name, which is more likely to change.
929
 *
930
 * @param  string      $value    Existing value
931
 * @param  string      $taxonomy Type of term (`post_tag` or `category`)
932
 * @return string                CSV of linked terms
933
 */
934
function gravityview_convert_value_to_term_list( $value, $taxonomy = 'post_tag' ) {
935
936 1
	$output = array();
937
938 1
	if ( is_array( $value ) ) {
939 1
		$terms = array_filter( array_values( $value ), 'strlen' );
940
	} else {
941 1
		$terms = explode( ', ', $value );
942
	}
943
944 1
	foreach ($terms as $term_name ) {
945
946
		// If we're processing a category,
947 1
		if( $taxonomy === 'category' ) {
948
949
			// Use rgexplode to prevent errors if : doesn't exist
950 1
			list( $term_name, $term_id ) = rgexplode( ':', $term_name, 2 );
951
952
			// The explode was succesful; we have the category ID
953 1
			if( !empty( $term_id )) {
954 1
				$term = get_term_by( 'id', $term_id, $taxonomy );
955
			} else {
956
			// We have to fall back to the name
957 1
				$term = get_term_by( 'name', $term_name, $taxonomy );
958
			}
959
960
		} else {
961
			// Use the name of the tag to get the full term information
962 1
			$term = get_term_by( 'name', $term_name, $taxonomy );
963
		}
964
965
		// There's still a tag/category here.
966 1
		if( $term ) {
967
968 1
			$term_link = get_term_link( $term, $taxonomy );
969
970
			// If there was an error, continue to the next term.
971 1
			if ( is_wp_error( $term_link ) ) {
972
			    continue;
973
			}
974
975 1
			$output[] = gravityview_get_link( $term_link, esc_html( $term->name ) );
976
		}
977
	}
978
979 1
	return implode(', ', $output );
980
}
981
982
/**
983
 * Get the links for post_tags and post_category output based on post ID
984
 * @param  int      $post_id  The ID of the post
985
 * @param  boolean     $link     Add links or no?
986
 * @param  string      $taxonomy Taxonomy of term to fetch.
987
 * @return string                String with terms
988
 */
989
function gravityview_get_the_term_list( $post_id, $link = true, $taxonomy = 'post_tag' ) {
990
991 1
	$output = get_the_term_list( $post_id, $taxonomy, NULL, ', ' );
992
993 1
	if( empty( $link ) ) {
994 1
		return strip_tags( $output);
995
	}
996
997 1
	return $output;
998
999
}
1000
1001
1002
/**
1003
 * Get all views processed so far for the current page load
1004
 *
1005
 * @see  GravityView_View_Data::add_view()
1006
 * @return array Array of View data, each View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
1007
 */
1008
function gravityview_get_current_views() {
1009
1010 1
	$fe = GravityView_frontend::getInstance();
1011
1012
	// Solve problem when loading content via admin-ajax.php
1013 1
	if( ! $fe->getGvOutputData() ) {
1014
1015 1
		gravityview()->log->debug( 'gv_output_data not defined; parsing content.' );
1016
1017 1
		$fe->parse_content();
1018
	}
1019
1020
	// Make 100% sure that we're dealing with a properly called situation
1021 1
	if( !is_a( $fe->getGvOutputData(), 'GravityView_View_Data' ) ) {
1022
1023
		gravityview()->log->debug( 'gv_output_data not an object or get_view not callable.', array( 'data' => $fe->getGvOutputData() ) );
1024
1025
		return array();
1026
	}
1027
1028 1
	return $fe->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...
1029
}
1030
1031
/**
1032
 * Get data for a specific view
1033
 *
1034
 * @deprecated use \GV\View API instead
1035
 * @since 2.5
1036
 *
1037
 * @see  GravityView_View_Data::get_view()
1038
 * @return array View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
1039
 */
1040
function gravityview_get_current_view_data( $view_id = 0 ) {
1041
	if ( $view_id ) {
1042
		if ( $view = \GV\View::by_id( $view_id ) ) {
1043
			return $view; // implements ArrayAccess
1044
		}
1045
		return array();
1046
	}
1047
1048
	$fe = GravityView_frontend::getInstance();
1049
1050
	// If not set, grab the current view ID
1051
	if ( empty( $view_id ) ) {
1052
		$view_id = $fe->get_context_view_id();
1053
	}
1054
1055
	if ( ! $fe->getGvOutputData() ) { return array(); }
1056
1057
	return $fe->getGvOutputData()->get_view( $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...
1058
}
1059
1060
// Templates' hooks
1061
function gravityview_before() {
1062
	/**
1063
	 * @action `gravityview/template/before` Append content to the view.
1064
	 * @param object $gravityview The $gravityview object available in templates.
1065
	 */
1066 37
	if ( count( $args = func_get_args() ) ) {
1067 35
		$gravityview = reset( $args );
1068 35
		if ( $gravityview instanceof \GV\Template_Context ) {
1069
			/**
1070
			 * @action `gravityview/template/before` Prepend content to the view.
1071
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1072
			 */
1073 35
			do_action( 'gravityview/template/before', $gravityview );
1074
1075
			/**
1076
			 * @deprecated Use `gravityview/template/before`
1077
			 */
1078 35
			return do_action( 'gravityview_before', $gravityview->view->ID );
1079
		}
1080
	}
1081
1082
	/**
1083
	 * @action `gravityview_before` Prepend content to the View container `<div>`
1084
	 * @deprecated Use `gravityview/template/before`.
1085
	 * @param int $view_id The ID of the View being displayed
1086
	 */
1087 2
	do_action( 'gravityview_before', gravityview_get_view_id() );
1088 2
}
1089
1090
function gravityview_header() {
1091
	/**
1092
	 * @action `gravityview/template/header` Append content to the view.
1093
	 * @param object $gravityview The $gravityview object available in templates.
1094
	 */
1095 33
	if ( count( $args = func_get_args() ) ) {
1096 31
		$gravityview = reset( $args );
1097 31
		if ( $gravityview instanceof \GV\Template_Context ) {
1098
			/**
1099
			 * @action `gravityview/template/header` Prepend content to the view container <div>.
1100
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1101
			 */
1102 31
			do_action( 'gravityview/template/header', $gravityview );
1103
1104
			/**
1105
			 * @deprecated Use `gravityview/template/header`
1106
			 */
1107 31
			return do_action( 'gravityview_header', $gravityview->view->ID );
1108
		}
1109
	}
1110
1111
	/**
1112
	 * @action `gravityview_header` Prepend content to the View container `<div>`
1113
	 * @deprecated Use `gravityview/template/header`.
1114
	 * @param int $view_id The ID of the View being displayed
1115
	 */
1116 2
	do_action( 'gravityview_header', gravityview_get_view_id() );
1117 2
}
1118
1119
function gravityview_footer() {
1120
	/**
1121
	 * @action `gravityview/template/footer` Append content to the view.
1122
	 * @param object $gravityview The $gravityview object available in templates.
1123
	 */
1124 33
	if ( count( $args = func_get_args() ) ) {
1125 31
		$gravityview = reset( $args );
1126 31
		if ( $gravityview instanceof \GV\Template_Context ) {
1127
			/**
1128
			 * @action `gravityview/template/footer` Prepend outside of the view container <div>.
1129
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1130
			 */
1131 31
			do_action( 'gravityview/template/footer', $gravityview );
1132
1133
			/**
1134
			 * @deprecated Use `gravityview/template/footer`
1135
			 */
1136 31
			return do_action( 'gravityview_footer', $gravityview->view->ID );
1137
		}
1138
	}
1139
1140
	/**
1141
	 * @action `gravityview_after` Display content after a View. Used to render footer widget areas. Rendered outside the View container `<div>`
1142
	 * @deprecated Use `gravityview/template/footer`.
1143
	 * @param int $view_id The ID of the View being displayed
1144
	 */
1145 2
	do_action( 'gravityview_footer', gravityview_get_view_id() );
1146 2
}
1147
1148
function gravityview_after() {
1149 37
	if ( count( $args = func_get_args() ) ) {
1150 35
		$gravityview = reset( $args );
1151 35
		if ( $gravityview instanceof \GV\Template_Context ) {
1152
			/**
1153
			 * @action `gravityview/template/after` Append content to the view.
1154
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1155
			 */
1156 35
			do_action( 'gravityview/template/after', $gravityview );
1157
1158
			/**
1159
			 * @deprecated Use `gravityview/template/after`
1160
			 */
1161 35
			do_action( 'gravityview_after', $gravityview->view->ID );
1162
1163 35
			return;
1164
		}
1165
	}
1166
1167
	/**
1168
	 * @action `gravityview_after` Append content to the View container `<div>`
1169
	 * @deprecated Use `gravityview/template/after`
1170
	 * @param int $view_id The ID of the View being displayed
1171
	 */
1172 2
	do_action( 'gravityview_after', gravityview_get_view_id() );
1173 2
}
1174
1175
/**
1176
 * Get the current View ID being rendered
1177
 *
1178
 * @global GravityView_View $gravityview_view
1179
 *
1180
 * @return int View ID, if exists. `0` if `GravityView_View` doesn't exist, like in the admin, or no View is set.
1181
 */
1182
function gravityview_get_view_id() {
1183
1184 2
	if ( ! class_exists( 'GravityView_View' ) ) {
1185
		return 0;
1186
	}
1187
1188 2
	return GravityView_View::getInstance()->getViewId();
1189
}
1190
1191
/**
1192
 * Returns the current GravityView context, or empty string if not GravityView
1193
 *
1194
 * - Returns empty string on GravityView archive pages
1195
 * - Returns empty string on archive pages containing embedded Views
1196
 * - Returns empty string for embedded Views, not 'directory'
1197
 * - Returns empty string for embedded entries (oEmbed or [gventry]), not 'single'
1198
 * - Returns 'single' when viewing a [gravityview] shortcode-embedded single entry
1199
 *
1200
 * @global GravityView_View $gravityview_view
1201
 * @deprecated since 2.0.6.2 Use `gravityview()->request`
1202
 * @return string View context "directory", "single", "edit", or empty string if not GravityView
1203
 */
1204
function gravityview_get_context() {
1205 4
	global $wp_query;
1206
1207 4
	if ( isset( $wp_query ) && $wp_query->post_count > 1 ) {
1208
		return '';
1209
	}
1210
1211
	/**
1212
	 * @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
1213
	 * The Edit Entry functionality overrides this value.
1214
	 * @param boolean $is_edit_entry
1215
	 */
1216 4
	$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );
1217
1218 4
	if ( $is_edit_entry ) {
1219
		return 'edit';
1220 4
	} else if ( gravityview()->request->is_entry() ) {
1221 1
		return 'single';
1222 4
	} else if ( gravityview()->request->is_view() ) {
1223 4
		return 'directory';
1224
	}
1225
1226
	return '';
1227
}
1228
1229
1230
/**
1231
 * Return an array of files prepared for output. Wrapper for GravityView_Field_FileUpload::get_files_array()
1232
 *
1233
 * Processes files by file type and generates unique output for each.
1234
 *
1235
 * Returns array for each file, with the following keys:
1236
 *
1237
 * `file_path` => The file path of the file, with a line break
1238
 * `html` => The file output HTML formatted
1239
 *
1240
 * @see GravityView_Field_FileUpload::get_files_array()
1241
 *
1242
 * @since  1.2
1243
 * @param  string $value    Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
1244
 * @param  string $gv_class Field class to add to the output HTML
1245
 * @since  2.0
1246
 * @param  \GV\Template_Context $context The context
1247
 * @return array           Array of file output, with `file_path` and `html` keys (see comments above)
1248
 */
1249
function gravityview_get_files_array( $value, $gv_class = '', $context = null ) {
1250
	/** @define "GRAVITYVIEW_DIR" "../" */
1251
1252 5
	if( !class_exists( 'GravityView_Field' ) ) {
1253
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field.php' );
1254
	}
1255
1256 5
	if( !class_exists( 'GravityView_Field_FileUpload' ) ) {
1257
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field-fileupload.php' );
1258
	}
1259
1260 5
	if ( is_null( $context ) ) {
1261
		_doing_it_wrong( __FUNCTION__, '2.0', 'Please pass an \GV\Template_Context object as the 3rd parameter' );
1262
	}
1263
1264 5
	return GravityView_Field_FileUpload::get_files_array( $value, $gv_class, $context );
1265
}
1266
1267
/**
1268
 * Generate a mapping link from an address
1269
 *
1270
 * The address should be plain text with new line (`\n`) or `<br />` line breaks separating sections
1271
 *
1272
 * @todo use GF's field get_export_value() instead
1273
 *
1274
 * @see https://gravityview.co/support/documentation/201608159 Read how to modify the link
1275
 * @param  string $address Address
1276
 * @return string          URL of link to map of address
1277
 */
1278
function gravityview_get_map_link( $address ) {
1279
1280 1
	$address_qs = str_replace( array( '<br />', "\n" ), ' ', $address ); // Replace \n with spaces
1281 1
	$address_qs = urlencode( $address_qs );
1282
1283 1
	$url = "https://maps.google.com/maps?q={$address_qs}";
1284
1285 1
	$link_text = esc_html__( 'Map It', 'gravityview' );
1286
1287 1
	$link = gravityview_get_link( $url, $link_text, 'class=map-it-link' );
1288
1289
	/**
1290
	 * @filter `gravityview_map_link` Modify the map link generated. You can use a different mapping service, for example.
1291
	 * @param[in,out]  string $link Map link
1292
	 * @param[in] string $address Address to generate link for
1293
	 * @param[in] string $url URL generated by the function
1294
	 */
1295 1
	$link = apply_filters( 'gravityview_map_link', $link, $address, $url );
1296
1297 1
	return $link;
1298
}
1299
1300
1301
/**
1302
 * Output field based on a certain html markup
1303
 *
1304
 *   markup - string to be used on a sprintf statement.
1305
 *      Use:
1306
 *         {{label}} - field label
1307
 *         {{value}} - entry field value
1308
 *         {{class}} - field class
1309
 *
1310
 *   wpautop - true will filter the value using wpautop function
1311
 *
1312
 * @since  1.1.5
1313
 * @param  array $passed_args Associative array with field data. `field` and `form` are required.
1314
 * @since  2.0
1315
 * @param  \GV\Template_Context The template context.
1316
 * @return string Field output. If empty value and hide empty is true, return empty.
1317
 */
1318
function gravityview_field_output( $passed_args, $context = null ) {
1319
	$defaults = array(
1320 34
		'entry' => null,
1321
		'field' => null,
1322
		'form' => null,
1323
		'hide_empty' => true,
1324
		'markup' => '<div id="{{ field_id }}" class="{{ class }}">{{ label }}{{ value }}</div>',
1325
		'label_markup' => '',
1326
		'wpautop' => false,
1327
		'zone_id' => null,
1328
	);
1329
1330 34
	$args = wp_parse_args( $passed_args, $defaults );
1331
1332
	/**
1333
	 * @filter `gravityview/field_output/args` Modify the args before generation begins
1334
	 * @since 1.7
1335
	 * @param array $args Associative array; `field` and `form` is required.
1336
	 * @param array $passed_args Original associative array with field data. `field` and `form` are required.
1337
	 * @since 2.0
1338
	 * @param \GV\Template_Context $context The context.
1339
	 * @deprecated
1340
	 */
1341 34
	$args = apply_filters( 'gravityview/field_output/args', $args, $passed_args, $context );
1342
1343
	/**
1344
	 * @filter `gravityview/template/field_output/context` Modify the context before generation begins.
1345
	 * @since 2.0
1346
	 * @param[in,out] \GV\Template_Context $context The context.
1347
	 * @param array $args The sanitized arguments, these should not be trusted any longer.
1348
	 * @param array $passed_args The passed arguments, these should not be trusted any longer.
1349
	 */
1350 34
	$context = apply_filters( 'gravityview/template/field_output/context', $context, $args, $passed_args );
1351
1352 34
	if ( $context instanceof \GV\Template_Context ) {
1353 32
		if ( ! $context->field || ! $context->view || ! $context->view->form ) {
1354
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => array( $context->field, $context->view->form ) ) );
1355 32
			return '';
1356
		}
1357
	} else {
1358
		// @deprecated path
1359
		// Required fields.
1360 2
		if ( empty( $args['field'] ) || empty( $args['form'] ) ) {
1361
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => $args ) );
1362
			return '';
1363
		}
1364
	}
1365
1366 34
	if ( $context instanceof \GV\Template_Context ) {
1367 32
		$entry = $args['entry'] ? : ( $context->entry ? $context->entry->as_entry() : array() );
1368 32
		$field = $args['field'] ? : ( $context->field ? $context->field->as_configuration() : array() );
1369 32
		$form = $args['form'] ? : ( $context->view->form ? $context->view->form->form : array() );
0 ignored issues
show
Documentation introduced by
The property $form is declared private in GV\Form. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write 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.");
        }
    }

}

Since the property has write access only, you can use the @property-write 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...
1370
	} else {
1371
		// @deprecated path
1372 2
		$entry = empty( $args['entry'] ) ? array() : $args['entry'];
1373 2
		$field = $args['field'];
1374 2
		$form = $args['form'];
1375
	}
1376
1377
	/**
1378
	 * Create the content variables for replacing.
1379
	 * @since 1.11
1380
	 */
1381
	$placeholders = array(
1382 34
		'value' => '',
1383
		'width' => '',
1384
		'width:style' => '',
1385
		'label' => '',
1386
		'label_value' => '',
1387
		'label_value:esc_attr' => '',
1388
		'label_value:data-label' => '',
1389
		'class' => '',
1390
		'field_id' => '',
1391
	);
1392
1393 34
	if ( $context instanceof \GV\Template_Context ) {
1394 32
		$placeholders['value'] = \GV\Utils::get( $args, 'value', '' );
1395
	} else {
1396
		// @deprecated path
1397 2
		$placeholders['value'] = gv_value( $entry, $field );
0 ignored issues
show
Deprecated Code introduced by
The function gv_value() has been deprecated with message: Use \GV\Field_Template::render()

This function has been deprecated. The supplier of the file has supplied an explanatory message.

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

Loading history...
1398
	}
1399
1400
	// If the value is empty and we're hiding empty, return empty.
1401 34
	if ( $placeholders['value'] === '' && ! empty( $args['hide_empty'] ) ) {
1402 5
		return '';
1403
	}
1404
1405 34
	if ( $placeholders['value'] !== '' && ! empty( $args['wpautop'] ) ) {
1406 5
		$placeholders['value'] = wpautop( $placeholders['value'] );
1407
	}
1408
1409
	// Get width setting, if exists
1410 34
	$placeholders['width'] = GravityView_API::field_width( $field );
1411
1412
	// If replacing with CSS inline formatting, let's do it.
1413 34
	$placeholders['width:style'] = GravityView_API::field_width( $field, 'width:' . $placeholders['width'] . '%;' );
1414
1415
	// Grab the Class using `gv_class`
1416 34
	$placeholders['class'] = gv_class( $field, $form, $entry );
1417 34
	$placeholders['field_id'] = GravityView_API::field_html_attr_id( $field, $form, $entry );
1418
1419 34
	if ( $context instanceof \GV\Template_Context ) {
1420 32
		$placeholders['label_value'] = \GV\Utils::get( $args, 'label' );
1421
	} else {
1422
		// Default Label value
1423 2
		$placeholders['label_value'] = gv_label( $field, $entry );
0 ignored issues
show
Deprecated Code introduced by
The function gv_label() has been deprecated with message: Use \GV\Field::get_label()

This function has been deprecated. The supplier of the file has supplied an explanatory message.

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

Loading history...
1424
	}
1425
1426 34
	$placeholders['label_value:data-label'] = trim( esc_attr( strip_tags( str_replace( '>&nbsp;', '>', $placeholders['label_value'] ) ) ) );
1427 34
	$placeholders['label_value:esc_attr'] = esc_attr( $placeholders['label_value'] );
1428
1429 34
	if ( empty( $placeholders['label'] ) && ! empty( $placeholders['label_value'] ) ){
1430 34
		$placeholders['label'] = '<span class="gv-field-label">{{ label_value }}</span>';
1431
	}
1432
1433
	/**
1434
	 * @filter `gravityview/field_output/pre_html` Allow Pre filtering of the HTML
1435
	 * @since 1.11
1436
	 * @param string $markup The HTML for the markup
1437
	 * @param array $args All args for the field output
1438
	 * @since 2.0
1439
	 * @param \GV\Template_Context $context The context.
1440
	 */
1441 34
	$html = apply_filters( 'gravityview/field_output/pre_html', $args['markup'], $args, $context );
1442
1443
	/**
1444
	 * @filter `gravityview/field_output/open_tag` Modify the opening tags for the template content placeholders
1445
	 * @since 1.11
1446
	 * @param string $open_tag Open tag for template content placeholders. Default: `{{`
1447
	 * @since 2.0
1448
	 * @param \GV\Template_Context $context The context.
1449
	 */
1450 34
	$open_tag = apply_filters( 'gravityview/field_output/open_tag', '{{', $args, $context );
1451
1452
	/**
1453
	 * @filter `gravityview/field_output/close_tag` Modify the closing tags for the template content placeholders
1454
	 * @since 1.11
1455
	 * @param string $close_tag Close tag for template content placeholders. Default: `}}`
1456
	 * @since 2.0
1457
	 * @param \GV\Template_Context $context The context.
1458
	 */
1459 34
	$close_tag = apply_filters( 'gravityview/field_output/close_tag', '}}', $args, $context );
1460
1461
	/**
1462
	 * Loop through each of the tags to replace and replace both `{{tag}}` and `{{ tag }}` with the values
1463
	 * @since 1.11
1464
	 */
1465 34
	foreach ( $placeholders as $tag => $value ) {
1466
1467
		// If the tag doesn't exist just skip it
1468 34
		if ( false === strpos( $html, $open_tag . $tag . $close_tag ) && false === strpos( $html, $open_tag . ' ' . $tag . ' ' . $close_tag ) ){
1469 34
			continue;
1470
		}
1471
1472
		// Array to search
1473
		$search = array(
1474 34
			$open_tag . $tag . $close_tag,
1475 34
			$open_tag . ' ' . $tag . ' ' . $close_tag,
1476
		);
1477
1478
		/**
1479
		 * `gravityview/field_output/context/{$tag}` Allow users to filter content on context
1480
		 * @since 1.11
1481
		 * @param string $value The content to be shown instead of the {{tag}} placeholder
1482
		 * @param array $args Arguments passed to the function
1483
		 * @since 2.0
1484
		 * @param \GV\Template_Context $context The context.
1485
		 */
1486 34
		$value = apply_filters( 'gravityview/field_output/context/' . $tag, $value, $args, $context );
1487
1488
		// Finally do the replace
1489 34
		$html = str_replace( $search, $value, $html );
1490
	}
1491
1492
	/**
1493
	 * @filter `gravityview_field_output` Modify field HTML output
1494
	 * @param string $html Existing HTML output
1495
	 * @param array $args Arguments passed to the function
1496
	 * @since 2.0
1497
	 * @param \GV\Template_Context $context The context.
1498
	 */
1499 34
	$html = apply_filters( 'gravityview_field_output', $html, $args, $context );
1500
1501
	/**
1502
	 * @filter `gravityview/field_output/html` Modify field HTML output
1503
	 * @param string $html Existing HTML output
1504
	 * @param array $args Arguments passed to the function
1505
	 * @since 2.0
1506
	 * @param \GV\Template_Context $context The context.
1507
	 */
1508 34
	$html = apply_filters( 'gravityview/field_output/html', $html, $args, $context );
1509
1510
	/** @since 2.0.8 Remove unused atts */
1511 34
	$html = str_replace( array( ' style=""', ' class=""', ' id=""' ), '', $html );
1512
1513 34
	return $html;
1514
}
1515