Completed
Push — develop ( ce7f6f...f5b0bc )
by Zack
07:24
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 10
	public static function no_results( $wpautop = true, $context = null ) {
300 10
		$is_search = false;
301
302 10
		if ( $context instanceof \GV\Template_Context ) {
303 9
			if ( $context->request->is_search() ) {
304 9
				$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 10
		$setting = '';
315
316 10
		if ( $is_search ) {
317
318 1
			$output = esc_html__( 'This search returned no results.', 'gravityview' );
319
320 1
			if( $context ) {
321 1
				$setting = $context->view->settings->get( 'no_search_results_text', $output );
322
			}
323
324
		} else {
325
326 10
			$output = esc_html__( 'No entries match your request.', 'gravityview' );
327
328 10
			if( $context ) {
329 9
				$setting = $context->view->settings->get( 'no_results_text', $output );
330
			}
331
		}
332
333 10
		if ( '' !== $setting ) {
334 1
			$output = $setting;
335
		}
336
337
		/**
338
		 * Added now that users are able to modify via View settings
339
		 * @since 2.8.2
340
		 */
341 10
		$output = wp_kses(
342 10
			$output,
343
			array(
344 10
				'p'      => array( 'class' => array(), 'id' => array() ),
345
				'h1'     => array( 'class' => array(), 'id' => array() ),
346
				'h2'     => array( 'class' => array(), 'id' => array() ),
347
				'h3'     => array( 'class' => array(), 'id' => array() ),
348
				'h4'     => array( 'class' => array(), 'id' => array() ),
349
				'h5'     => array( 'class' => array(), 'id' => array() ),
350
				'strong' => array( 'class' => array(), 'id' => array() ),
351
				'span'   => array( 'class' => array(), 'id' => array() ),
352
				'b'      => array( 'class' => array(), 'id' => array() ),
353
				'em'     => array( 'class' => array(), 'id' => array() ),
354
				'a'      => array( 'class' => array(), 'id' => array(), 'href' => array(), 'title' => array(), 'rel' => array(), 'target' => array() ),
355
				'div'    => array( 'class' => array(), 'id' => array() ),
356
				'br'     => array(),
357
			)
358
		);
359
360
		/**
361
		 * @filter `gravitview_no_entries_text` Modify the text displayed when there are no entries.
362
		 * Note: this filter is, and always has been, misspelled. This will not be fixed, since the filter is deprecated.
363
		 * @param string $output The existing "No Entries" text
364
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
365
		 * @return string The modified text.
366
		 * @deprecated Use `gravityview/template/text/no_entries`
367
		 */
368 10
		$output = apply_filters( 'gravitview_no_entries_text', $output, $is_search );
369
370
		/**
371
		 * @filter `gravityview/template/text/no_entries` Modify the text displayed when there are no entries.
372
		 * @since 2.0
373
		 * @param string $output The existing "No Entries" text
374
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
375
		 * @param \GV\Template_Context $context The context.
376
		 * @return string The modified text.
377
		 */
378 10
		$output = apply_filters( 'gravityview/template/text/no_entries', $output, $is_search, $context );
379
380 10
		return $wpautop ? wpautop( $output ) : $output;
381
	}
382
383
	/**
384
	 * Generate a URL to the Directory context
385
	 *
386
	 * 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!
387
	 *
388
	 * @param int $post_id Post ID
389
	 * @param boolean $add_query_args Add pagination and sorting arguments
390
	 *
391
	 * @since 2.0
392
	 * @param \GV\Template_Context $context The context this is being used in.
393
	 *
394
	 * @return string      Permalink to multiple entries view
395
	 */
396 46
	public static function directory_link( $post_id = NULL, $add_query_args = true, $context = null ) {
397 46
		global $post;
398
399 46
		if ( empty( $post_id ) ) {
400
			// DataTables passes the Post ID
401 21
			if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
402
				$post_id = \GV\Utils::_POST( 'post_id', false );
403
			} else {
404 21
				if ( $context instanceof \GV\Template_Context ) {
405
					// Shortcodes, embeds
406 17
					if ( is_a( $post, 'WP_Post' ) ) {
407 5
						$post_id = $post->ID;
408
409
					// Actual views
410
					} else {
411 17
						$post_id = $context->view ? $context->view->ID : false;
412
					}
413
				} else {
414
					/** @deprecated path of execution */
415 4
					$gravityview_view = GravityView_View::getInstance();
416
417
					// The Post ID has been passed via the shortcode
418 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...
419 2
						$post_id = $gravityview_view->getPostId();
420
					} else {
421
						// This is a GravityView post type
422 2
						if ( GravityView_frontend::getInstance()->isGravityviewPostType() ) {
423
							$post_id = isset( $gravityview_view ) ? $gravityview_view->getViewId() : $post->ID;
424
						} else {
425
							// This is an embedded GravityView; use the embedded post's ID as the base.
426 2
							if ( GravityView_frontend::getInstance()->isPostHasShortcode() && is_a( $post, 'WP_Post' ) ) {
427
								$post_id = $post->ID;
428 2
							} elseif ( $gravityview_view->getViewId() ) {
429
								// The GravityView has been embedded in a widget or in a template, and
430
								// is not in the current content. Thus, we defer to the View's own ID.
431 1
								$post_id = $gravityview_view->getViewId();
432
							}
433
						}
434
					}
435
				}
436
			}
437
		}
438
439
		// No post ID, get outta here.
440 46
		if ( empty( $post_id ) ) {
441 1
			return null;
442
		}
443
444
		// If we've saved the permalink in memory, use it
445
		// @since 1.3
446 45
		$link = wp_cache_get( 'gv_directory_link_'.$post_id );
447
448 45
		if ( (int) $post_id === (int) get_option( 'page_on_front' ) ) {
449
			$link = home_url();
450
		}
451
452 45
		if ( empty( $link ) ) {
453 45
			$link = get_permalink( $post_id );
454
455
			// If not yet saved, cache the permalink.
456
			// @since 1.3
457 45
			wp_cache_set( 'gv_directory_link_'.$post_id, $link );
458
		}
459
460
		// Deal with returning to proper pagination for embedded views
461 45
		if ( $link && $add_query_args ) {
462
463 41
			$args = array();
464
465 41
			if( $pagenum = \GV\Utils::_GET( 'pagenum' ) ) {
466 2
				$args['pagenum'] = intval( $pagenum );
467
			}
468
469 41
			if( $sort = \GV\Utils::_GET( 'sort' ) ) {
470
				$args['sort'] = $sort;
471
				$args['dir'] = \GV\Utils::_GET( 'dir' );
472
			}
473
474 41
			$link = add_query_arg( $args, $link );
475
		}
476
477
		/**
478
		 * @filter `gravityview_directory_link` Modify the URL to the View "directory" context
479
		 * @since 1.19.4
480
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
481
		 * @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
482
		 */
483 45
		$link = apply_filters( 'gravityview_directory_link', $link, $post_id );
484
485
		/**
486
		 * @filter `gravityview/view/links/directory` Modify the URL to the View "directory" context
487
		 * @since 2.0
488
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
489
		 * @param \GV\Template_Context $context
490
		 */
491 45
		return apply_filters( 'gravityview/view/links/directory', $link, $context );
492
	}
493
494
	/**
495
	 * Calculate an *unique* hash for an entry based on the entry ID
496
	 *
497
	 * 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.
498
	 *
499
	 * The hashed value MUST be unique, otherwise multiple entries will share the same URL, which leads to obvious problems.
500
	 *
501
	 * @param  int|string $id Entry ID to generate the hash for.
502
	 * @param  array  $entry        Entry data passed to provide additional information when generating the hash. Optional - don't rely on it being available.
503
	 * @return string               Hashed unique value for entry
504
	 */
505 3
	private static function get_custom_entry_slug( $id, $entry = array() ) {
506
507
		// Generate an unique hash to use as the default value
508 3
		$slug = substr( wp_hash( $id, 'gravityview'.$id ), 0, 8 );
509
510
		/**
511
		 * @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}`
512
		 * @param string $hash Existing hash generated by GravityView
513
		 * @param  string $id The entry ID
514
		 * @param  array $entry Entry data array. May be empty.
515
		 */
516 3
		$slug = apply_filters( 'gravityview_entry_slug', $slug, $id, $entry );
517
518
		// Make sure we have something - use the original ID as backup.
519 3
		if( empty( $slug ) ) {
520
			$slug = $id;
521
		}
522
523 3
		return sanitize_title( $slug );
524
	}
525
526
	/**
527
	 * Get the entry slug for the entry. By default, it is the entry ID.
528
	 *
529
	 *
530
	 * @see gravityview_get_entry()
531
	 * @uses GravityView_API::get_custom_entry_slug() If using custom slug, gets the custom slug value
532
	 * @since 1.4
533
	 * @param  int|string $id_or_string ID of the entry, or custom slug string
534
	 * @param  array  $entry        Gravity Forms Entry array, optional. Used only to provide data to customize the `gravityview_entry_slug` filter
535
	 * @return string               Unique slug ID, passed through `sanitize_title()`
536
	 */
537 156
	public static function get_entry_slug( $id_or_string, $entry = array() ) {
538
539
		/**
540
		 * Default: use the entry ID as the unique identifier
541
		 */
542 156
		$slug = $id_or_string;
543
544
		/**
545
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
546
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
547
		 */
548 156
		$custom = apply_filters( 'gravityview_custom_entry_slug', false );
549
550
		// If we're using custom slug...
551 156
		if ( $custom ) {
552
553
			// Get the entry hash
554 3
			$hash = self::get_custom_entry_slug( $id_or_string, $entry );
555
556
			// Cache the slugs
557 3
			static $cache = array();
558
559 3
			if ( ! isset( $cache[ $id_or_string ] ) ) {
560 3
				global $wpdb;
561
562 3
				if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) ) {
563 3
					$table = GFFormsModel::get_entry_meta_table_name();
564 3
					$column = 'entry_id';
565
				} else {
566
					$table = RGFormsModel::get_lead_meta_table_name();
567
					$column = 'lead_id';
568
				}
569
570 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 ) );
571
572 3
				if ( $results ) {
573
					$cache = array_replace( $cache, array_combine( wp_list_pluck( $results, $column ), wp_list_pluck( $results, 'meta_value' ) ) );
574
				}
575
576 3
				if ( ! isset( $cache[ $id_or_string ] ) ) {
577 3
					$cache[ $id_or_string ] = false;
578
				}
579
			}
580
581 3
			$value = $cache[ $id_or_string ];
582
583
			// If it does have a hash set, and the hash is expected, use it.
584
			// This check allows users to change the hash structure using the
585
			// gravityview_entry_hash filter and have the old hashes expire.
586 3
			if ( empty( $value ) || $value !== $hash ) {
587 3
				gravityview()->log->debug( 'Setting hash for entry {entry}: {hash}', array( 'entry' => $id_or_string, 'hash' => $hash ) );
588 3
				gform_update_meta( $id_or_string, 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
589
			}
590
591 3
			$slug = $hash;
592
593 3
			unset( $value, $hash );
594
		}
595
596 156
		return sanitize_title( $slug );
597
	}
598
599
    /**
600
     * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
601
     *
602
     * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
603
     *
604
     * @param $entry array Gravity Forms entry object
605
     * @param $form array Gravity Forms form object
606
     */
607
    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...
608
        /**
609
         * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
610
         * @param boolean $custom Should we process the custom entry slug?
611
         */
612
        $custom = apply_filters( 'gravityview_custom_entry_slug', false );
613
        if( $custom ) {
614
            // create the gravityview_unique_id and save it
615
616
            // Get the entry hash
617
            $hash = self::get_custom_entry_slug( $entry['id'], $entry );
618
619
	        gravityview()->log->debug( 'Setting hash for entry {entry_id}: {hash}', array( 'entry_id' => $entry['id'], 'hash' => $hash ) );
620
621
            gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
622
623
        }
624
    }
625
626
627
628
629
	/**
630
	 * return href for single entry
631
	 *
632
	 * @since 1.7.3 Added $add_directory_args parameter
633
	 * @since 2.7.2 Added $view_id parameter
634
	 *
635
	 * @param  array|int $entry   Entry array or entry ID
636
	 * @param  int|null $post_id If wanting to define the parent post, pass a post ID
637
	 * @param boolean $add_directory_args True: Add args to help return to directory; False: only include args required to get to entry
638
	 * @param int $view_id
639
	 *
640
	 * @return string Link to the entry with the directory parent slug, or empty string if embedded post or View doesn't exist
641
	 */
642 6
	public static function entry_link( $entry, $post_id = NULL, $add_directory_args = true, $view_id = 0 ) {
643
644 6
		if ( ! empty( $entry ) && ! is_array( $entry ) ) {
645
			$entry = GVCommon::get_entry( $entry );
646 6
		} else if( empty( $entry ) ) {
647
			// @deprecated path
648
			$entry = GravityView_frontend::getInstance()->getEntry();
649
		}
650
651
		// Second parameter used to be passed as $field; this makes sure it's not an array
652 6
		if ( ! is_numeric( $post_id ) ) {
653 1
			$post_id = NULL;
654
		}
655
656
		// Get the permalink to the View
657 6
		$directory_link = self::directory_link( $post_id, false );
658
659
		// No post ID? Get outta here.
660 6
		if ( empty( $directory_link ) ) {
661 1
			return '';
662
		}
663
664 5
		$query_arg_name = \GV\Entry::get_endpoint_name();
665
666 5
		if ( ! empty( $entry['_multi'] ) ) {
667 1
			$entry_slugs = array();
668
669 1
			foreach ( $entry['_multi'] as $_multi ) {
670
671 1
				if( $gv_multi = \GV\GF_Entry::from_entry( $_multi ) ) {
672 1
					$entry_slugs[] = $gv_multi->get_slug();
673
				} else {
674
					// TODO: This path isn't covered by unit tests
675
					$entry_slugs[] = \GravityView_API::get_entry_slug( $_multi['id'], $_multi );
676
				}
677
678 1
				unset( $gv_multi );
679
680 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...
681
			}
682
683 1
			$entry_slug = implode( ',', $entry_slugs );
684
		} else {
685
686
			// Fallback when
687 5
			if( $gv_entry = \GV\GF_Entry::from_entry( $entry ) ) {
688 5
				$entry_slug = $gv_entry->get_slug();
689
			} else {
690
				// TODO: This path isn't covered by unit tests
691
				$entry_slug = \GravityView_API::get_entry_slug( $entry['id'], $entry );
692
			}
693
694 5
			unset( $gv_entry );
695
		}
696
697 5
		if ( get_option('permalink_structure') && !is_preview() ) {
698
699
			$args = array();
700
701
			/**
702
			 * Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
703
			 * @since 1.16.5
704
			 */
705
			$link_parts = explode( '?', $directory_link );
706
707
			$query = !empty( $link_parts[1] ) ? '?'.$link_parts[1] : '';
708
709
			$directory_link = trailingslashit( $link_parts[0] ) . $query_arg_name . '/'. $entry_slug .'/' . $query;
710
711
		} else {
712
713 5
			$args = array( $query_arg_name => $entry_slug );
714
		}
715
716
		/**
717
		 * @since 1.7.3
718
		 */
719 5
		if ( $add_directory_args ) {
720
721 5
			if ( ! empty( $_GET['pagenum'] ) ) {
722
				$args['pagenum'] = intval( $_GET['pagenum'] );
723
			}
724
725
			/**
726
			 * @since 1.7
727
			 */
728 5
			if ( $sort = \GV\Utils::_GET( 'sort' ) ) {
729
				$args['sort'] = $sort;
730
				$args['dir'] = \GV\Utils::_GET( 'dir' );
731
			}
732
733
		}
734
735 5
		if( $post_id ) {
736 5
			$passed_post = get_post( $post_id );
737 5
			$views       = \GV\View_Collection::from_post( $passed_post );
738 5
			$has_multiple_views = $views->count() > 1;
739
		} else {
740
			$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...
741
		}
742
743 5
		if ( $has_multiple_views ) {
744 1
			$args['gvid'] = $view_id ? $view_id : gravityview_get_view_id();
745
		}
746
747 5
		return add_query_arg( $args, $directory_link );
748
749
	}
750
751
752
}
753
754
755
// inside loop functions
756
757
/**
758
 * @deprecated Use \GV\Field::get_label()
759
 */
760
function gv_label( $field, $entry = NULL ) {
761 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...
762
}
763
764
function gv_class( $field, $form = NULL, $entry = array() ) {
765 37
	return GravityView_API::field_class( $field, $form, $entry  );
766
}
767
768
/**
769
 * Generate a CSS class to be added to the wrapper <div> of a View
770
 *
771
 * @since 1.5.4
772
 * @since 1.16 Added $echo parameter.
773
 * @since 2.0 Added $context parameter.
774
 *
775
 * @param string $passed_css_class Default: `gv-container gv-container-{view id}`. If View is hidden until search, adds ` hidden`
776
 * @param boolean $echo Whether to echo the output. Default: true
777
 * @param \GV\Template_Context $context The template context.
778
 *
779
 * @return string CSS class, sanitized by gravityview_sanitize_html_class()
780
 */
781
function gv_container_class( $passed_css_class = '', $echo = true, $context = null ) {
782 38
	if ( $context instanceof \GV\Template_Context ) {
783 36
		$hide_until_searched = false;
784 36
		$total_entries = 0;
785 36
		$view_id = 0;
786 36
		if ( $context->view ) {
787 36
			$view_id = $context->view->ID;
788 36
			if( $context->view->settings->get( 'hide_until_searched' ) ) {
789 4
				$hide_until_searched = ( empty( $context->entry ) && ! $context->request->is_search() );
790
			}
791
		}
792 36
		if ( $context->entries ) {
793 23
			$total_entries = $context->entries->total();
794 17
		} else if ( $context->entry ) {
795 36
			$total_entries = 1;
796
		}
797
	} else {
798
		/** @deprecated legacy execution path */
799 3
		$view_id = GravityView_View::getInstance()->getViewId();
800 3
		$hide_until_searched = GravityView_View::getInstance()->isHideUntilSearched();
801 3
		$total_entries = GravityView_View::getInstance()->getTotalEntries();
802
	}
803
804 38
	$passed_css_class = trim( $passed_css_class );
805
806 38
	$default_css_class = ! empty( $view_id ) ? sprintf( 'gv-container gv-container-%d', $view_id ) : 'gv-container';
807
808 38
	if ( $hide_until_searched ) {
809 4
		$default_css_class .= ' hidden';
810
	}
811
812 38
	if ( 0 === $total_entries ) {
813 8
		$default_css_class .= ' gv-container-no-results';
814
	}
815
816 38
	$css_class = trim( $passed_css_class . ' '. $default_css_class );
817
818
	/**
819
	 * @filter `gravityview/render/container/class` Modify the CSS class to be added to the wrapper <div> of a View
820
	 * @since 1.5.4
821
	 * @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`
822
	 * @since 2.0
823
	 * @param \GV\Template_Context $context The context.
824
	 */
825 38
	$css_class = apply_filters( 'gravityview/render/container/class', $css_class, $context );
826
827 38
	$css_class = gravityview_sanitize_html_class( $css_class );
828
829 38
	if ( $echo ) {
830 38
		echo $css_class;
831
	}
832
833 38
	return $css_class;
834
}
835
836
/**
837
 * @deprecated Use \GV\Field_Template::render()
838
 */
839
function gv_value( $entry, $field ) {
840
841 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...
842
843 2
	if( $value === '' ) {
844
		/**
845
		 * @filter `gravityview_empty_value` What to display when a field is empty
846
		 * @param string $value (empty string)
847
		 */
848 1
		$value = apply_filters( 'gravityview_empty_value', '' );
849
	}
850
851 2
	return $value;
852
}
853
854
function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
855 18
	return GravityView_API::directory_link( $post, $add_pagination, $context );
856
}
857
858
function gv_entry_link( $entry, $post_id = NULL ) {
859 2
	return GravityView_API::entry_link( $entry, $post_id );
860
}
861
862
function gv_no_results( $wpautop = true, $context = null ) {
863 9
	return GravityView_API::no_results( $wpautop, $context );
864
}
865
866
/**
867
 * Generate HTML for the back link from single entry view
868
 * @since 1.0.1
869
 * @since 2.0
870
 * @param \GV\Template_Context $context The context this link is being displayed from.
871
 * @return string|null      If no GV post exists, null. Otherwise, HTML string of back link.
872
 */
873
function gravityview_back_link( $context = null ) {
874
875 17
	$href = gv_directory_link( null, true, $context );
876
877
	/**
878
	 * @filter `gravityview_go_back_url` Modify the back link URL
879
	 * @since 1.17.5
880
	 * @see gv_directory_link() Generated the original back link
881
	 * @param string $href Existing label URL
882
	 * @deprecated Use `gravityview/template/links/back/url`
883
	 */
884 17
	$href = apply_filters( 'gravityview_go_back_url', $href );
885
886
	/**
887
	 * @filter `gravityview/template/links/back/url` Modify the back link URL
888
	 * @since 2.0
889
	 * @see gv_directory_link() Generated the original back link
890
	 * @param string $href Existing label URL
891
	 * @param \GV\Template_Context The context.
892
	 */
893 17
	$href = apply_filters( 'gravityview/template/links/back/url', $href, $context );
894
895 17
	if ( empty( $href ) ) {
896 4
		return NULL;
897
	}
898
899 14
	if ( $context instanceof \GV\Template_Context ) {
900 14
		$view_id = $context->view->ID;
901 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...
902
	} else {
903
		/** @deprecated legacy path */
904
		$gravityview_view = GravityView_View::getInstance();
905
		$view_id = $gravityview_view->getViewId();
906
		$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...
907
	}
908
909
	/** Default */
910 14
	$label = $view_label ? $view_label : __( '&larr; Go back', 'gravityview' );
911
912
	/**
913
	 * @filter `gravityview_go_back_label` Modify the back link text
914
	 * @since 1.0.9
915
	 * @param string $label Existing label text
916
	 * @deprecated Use `gravityview/template/links/back/label`
917
	 */
918 14
	$label = apply_filters( 'gravityview_go_back_label', $label );
919
920
	/**
921
	 * @filter `gravityview/template/links/back/label` Modify the back link text
922
	 * @since 2.0
923
	 * @see gv_directory_link() Generated the original back link
924
	 * @param string $label Existing label text
925
	 * @param \GV\Template_Context The context.
926
	 */
927 14
	$label = apply_filters( 'gravityview/template/links/back/label', $label, $context );
928
929
	/**
930
	 * @filter `gravityview/template/links/back/atts` Modify the attributes used on the back link anchor tag
931
	 * @since 2.1
932
	 * @param array $atts Original attributes, default: [ data-viewid => $view_id ]
933
	 * @param \GV\Template_Context The context.
934
	 */
935 14
	$atts = apply_filters( 'gravityview/template/links/back/atts', array( 'data-viewid' => $view_id ), $context );
936
937 14
	$link = gravityview_get_link( $href, esc_html( $label ), $atts );
938
939 14
	return $link;
940
}
941
942
/**
943
 * Handle getting values for complex Gravity Forms fields
944
 *
945
 * If the field is complex, like a product, the field ID, for example, 11, won't exist. Instead,
946
 * it will be 11.1, 11.2, and 11.3. This handles being passed 11 and 11.2 with the same function.
947
 *
948
 * @since 1.0.4
949
 * @param  array      $entry    GF entry array
950
 * @param  string      $field_id [description]
951
 * @param  string 	$display_value The value generated by Gravity Forms
952
 * @return string                Value
953
 */
954
function gravityview_get_field_value( $entry, $field_id, $display_value ) {
955
956 15
	if( floatval( $field_id ) === floor( floatval( $field_id ) ) ) {
957
958
		// For the complete field value as generated by Gravity Forms
959 12
		return $display_value;
960
961
	} else {
962
963
		// For one part of the address (City, ZIP, etc.)
964 7
		return isset( $entry[ $field_id ] ) ? $entry[ $field_id ] : '';
965
966
	}
967
968
}
969
970
/**
971
 * Take a passed CSV of terms and generate a linked list of terms
972
 *
973
 * Gravity Forms passes categories as "Name:ID" so we handle that using the ID, which
974
 * is more accurate than checking the name, which is more likely to change.
975
 *
976
 * @param  string      $value    Existing value
977
 * @param  string      $taxonomy Type of term (`post_tag` or `category`)
978
 * @return string                CSV of linked terms
979
 */
980
function gravityview_convert_value_to_term_list( $value, $taxonomy = 'post_tag' ) {
981
982 1
	$output = array();
983
984 1
	if ( is_array( $value ) ) {
985 1
		$terms = array_filter( array_values( $value ), 'strlen' );
986
	} else {
987 1
		$terms = explode( ', ', $value );
988
	}
989
990 1
	foreach ($terms as $term_name ) {
991
992
		// If we're processing a category,
993 1
		if( $taxonomy === 'category' ) {
994
995
			// Use rgexplode to prevent errors if : doesn't exist
996 1
			list( $term_name, $term_id ) = rgexplode( ':', $term_name, 2 );
997
998
			// The explode was succesful; we have the category ID
999 1
			if( !empty( $term_id )) {
1000 1
				$term = get_term_by( 'id', $term_id, $taxonomy );
1001
			} else {
1002
			// We have to fall back to the name
1003 1
				$term = get_term_by( 'name', $term_name, $taxonomy );
1004
			}
1005
1006
		} else {
1007
			// Use the name of the tag to get the full term information
1008 1
			$term = get_term_by( 'name', $term_name, $taxonomy );
1009
		}
1010
1011
		// There's still a tag/category here.
1012 1
		if( $term ) {
1013
1014 1
			$term_link = get_term_link( $term, $taxonomy );
1015
1016
			// If there was an error, continue to the next term.
1017 1
			if ( is_wp_error( $term_link ) ) {
1018
			    continue;
1019
			}
1020
1021 1
			$output[] = gravityview_get_link( $term_link, esc_html( $term->name ) );
1022
		}
1023
	}
1024
1025 1
	return implode(', ', $output );
1026
}
1027
1028
/**
1029
 * Get the links for post_tags and post_category output based on post ID
1030
 * @param  int      $post_id  The ID of the post
1031
 * @param  boolean     $link     Add links or no?
1032
 * @param  string      $taxonomy Taxonomy of term to fetch.
1033
 * @return string                String with terms
1034
 */
1035
function gravityview_get_the_term_list( $post_id, $link = true, $taxonomy = 'post_tag' ) {
1036
1037 1
	$output = get_the_term_list( $post_id, $taxonomy, NULL, ', ' );
1038
1039 1
	if( empty( $link ) ) {
1040 1
		return strip_tags( $output);
1041
	}
1042
1043 1
	return $output;
1044
1045
}
1046
1047
1048
/**
1049
 * Get all views processed so far for the current page load
1050
 *
1051
 * @see  GravityView_View_Data::add_view()
1052
 * @return array Array of View data, each View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
1053
 */
1054
function gravityview_get_current_views() {
1055
1056 1
	$fe = GravityView_frontend::getInstance();
1057
1058
	// Solve problem when loading content via admin-ajax.php
1059 1
	if( ! $fe->getGvOutputData() ) {
1060
1061 1
		gravityview()->log->debug( 'gv_output_data not defined; parsing content.' );
1062
1063 1
		$fe->parse_content();
1064
	}
1065
1066
	// Make 100% sure that we're dealing with a properly called situation
1067 1
	if( !is_a( $fe->getGvOutputData(), 'GravityView_View_Data' ) ) {
1068
1069
		gravityview()->log->debug( 'gv_output_data not an object or get_view not callable.', array( 'data' => $fe->getGvOutputData() ) );
1070
1071
		return array();
1072
	}
1073
1074 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...
1075
}
1076
1077
/**
1078
 * Get data for a specific view
1079
 *
1080
 * @deprecated use \GV\View API instead
1081
 * @since 2.5
1082
 *
1083
 * @see  GravityView_View_Data::get_view()
1084
 * @return array View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
1085
 */
1086
function gravityview_get_current_view_data( $view_id = 0 ) {
1087
	if ( $view_id ) {
1088
		if ( $view = \GV\View::by_id( $view_id ) ) {
1089
			return $view; // implements ArrayAccess
1090
		}
1091
		return array();
1092
	}
1093
1094
	$fe = GravityView_frontend::getInstance();
1095
1096
	// If not set, grab the current view ID
1097
	if ( empty( $view_id ) ) {
1098
		$view_id = $fe->get_context_view_id();
1099
	}
1100
1101
	if ( ! $fe->getGvOutputData() ) { return array(); }
1102
1103
	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...
1104
}
1105
1106
// Templates' hooks
1107
function gravityview_before() {
1108
	/**
1109
	 * @action `gravityview/template/before` Append content to the view.
1110
	 * @param object $gravityview The $gravityview object available in templates.
1111
	 */
1112 37
	if ( count( $args = func_get_args() ) ) {
1113 35
		$gravityview = reset( $args );
1114 35
		if ( $gravityview instanceof \GV\Template_Context ) {
1115
			/**
1116
			 * @action `gravityview/template/before` Prepend content to the view.
1117
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1118
			 */
1119 35
			do_action( 'gravityview/template/before', $gravityview );
1120
1121
			/**
1122
			 * @deprecated Use `gravityview/template/before`
1123
			 */
1124 35
			return do_action( 'gravityview_before', $gravityview->view->ID );
1125
		}
1126
	}
1127
1128
	/**
1129
	 * @action `gravityview_before` Prepend content to the View container `<div>`
1130
	 * @deprecated Use `gravityview/template/before`.
1131
	 * @param int $view_id The ID of the View being displayed
1132
	 */
1133 2
	do_action( 'gravityview_before', gravityview_get_view_id() );
1134 2
}
1135
1136
function gravityview_header() {
1137
	/**
1138
	 * @action `gravityview/template/header` Append content to the view.
1139
	 * @param object $gravityview The $gravityview object available in templates.
1140
	 */
1141 33
	if ( count( $args = func_get_args() ) ) {
1142 31
		$gravityview = reset( $args );
1143 31
		if ( $gravityview instanceof \GV\Template_Context ) {
1144
			/**
1145
			 * @action `gravityview/template/header` Prepend content to the view container <div>.
1146
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1147
			 */
1148 31
			do_action( 'gravityview/template/header', $gravityview );
1149
1150
			/**
1151
			 * @deprecated Use `gravityview/template/header`
1152
			 */
1153 31
			return do_action( 'gravityview_header', $gravityview->view->ID );
1154
		}
1155
	}
1156
1157
	/**
1158
	 * @action `gravityview_header` Prepend content to the View container `<div>`
1159
	 * @deprecated Use `gravityview/template/header`.
1160
	 * @param int $view_id The ID of the View being displayed
1161
	 */
1162 2
	do_action( 'gravityview_header', gravityview_get_view_id() );
1163 2
}
1164
1165
function gravityview_footer() {
1166
	/**
1167
	 * @action `gravityview/template/footer` Append content to the view.
1168
	 * @param object $gravityview The $gravityview object available in templates.
1169
	 */
1170 33
	if ( count( $args = func_get_args() ) ) {
1171 31
		$gravityview = reset( $args );
1172 31
		if ( $gravityview instanceof \GV\Template_Context ) {
1173
			/**
1174
			 * @action `gravityview/template/footer` Prepend outside of the view container <div>.
1175
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1176
			 */
1177 31
			do_action( 'gravityview/template/footer', $gravityview );
1178
1179
			/**
1180
			 * @deprecated Use `gravityview/template/footer`
1181
			 */
1182 31
			return do_action( 'gravityview_footer', $gravityview->view->ID );
1183
		}
1184
	}
1185
1186
	/**
1187
	 * @action `gravityview_after` Display content after a View. Used to render footer widget areas. Rendered outside the View container `<div>`
1188
	 * @deprecated Use `gravityview/template/footer`.
1189
	 * @param int $view_id The ID of the View being displayed
1190
	 */
1191 2
	do_action( 'gravityview_footer', gravityview_get_view_id() );
1192 2
}
1193
1194
function gravityview_after() {
1195 37
	if ( count( $args = func_get_args() ) ) {
1196 35
		$gravityview = reset( $args );
1197 35
		if ( $gravityview instanceof \GV\Template_Context ) {
1198
			/**
1199
			 * @action `gravityview/template/after` Append content to the view.
1200
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1201
			 */
1202 35
			do_action( 'gravityview/template/after', $gravityview );
1203
1204
			/**
1205
			 * @deprecated Use `gravityview/template/after`
1206
			 */
1207 35
			do_action( 'gravityview_after', $gravityview->view->ID );
1208
1209 35
			return;
1210
		}
1211
	}
1212
1213
	/**
1214
	 * @action `gravityview_after` Append content to the View container `<div>`
1215
	 * @deprecated Use `gravityview/template/after`
1216
	 * @param int $view_id The ID of the View being displayed
1217
	 */
1218 2
	do_action( 'gravityview_after', gravityview_get_view_id() );
1219 2
}
1220
1221
/**
1222
 * Get the current View ID being rendered
1223
 *
1224
 * @global GravityView_View $gravityview_view
1225
 *
1226
 * @return int View ID, if exists. `0` if `GravityView_View` doesn't exist, like in the admin, or no View is set.
1227
 */
1228
function gravityview_get_view_id() {
1229
1230 2
	if ( ! class_exists( 'GravityView_View' ) ) {
1231
		return 0;
1232
	}
1233
1234 2
	return GravityView_View::getInstance()->getViewId();
1235
}
1236
1237
/**
1238
 * Returns the current GravityView context, or empty string if not GravityView
1239
 *
1240
 * - Returns empty string on GravityView archive pages
1241
 * - Returns empty string on archive pages containing embedded Views
1242
 * - Returns empty string for embedded Views, not 'directory'
1243
 * - Returns empty string for embedded entries (oEmbed or [gventry]), not 'single'
1244
 * - Returns 'single' when viewing a [gravityview] shortcode-embedded single entry
1245
 *
1246
 * @global GravityView_View $gravityview_view
1247
 * @deprecated since 2.0.6.2 Use `gravityview()->request`
1248
 * @return string View context "directory", "single", "edit", or empty string if not GravityView
1249
 */
1250
function gravityview_get_context() {
1251 4
	global $wp_query;
1252
1253 4
	if ( isset( $wp_query ) && $wp_query->post_count > 1 ) {
1254
		return '';
1255
	}
1256
1257
	/**
1258
	 * @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
1259
	 * The Edit Entry functionality overrides this value.
1260
	 * @param boolean $is_edit_entry
1261
	 */
1262 4
	$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );
1263
1264 4
	if ( $is_edit_entry ) {
1265
		return 'edit';
1266 4
	} else if ( gravityview()->request->is_entry() ) {
1267 1
		return 'single';
1268 4
	} else if ( gravityview()->request->is_view() ) {
1269 4
		return 'directory';
1270
	}
1271
1272
	return '';
1273
}
1274
1275
1276
/**
1277
 * Return an array of files prepared for output. Wrapper for GravityView_Field_FileUpload::get_files_array()
1278
 *
1279
 * Processes files by file type and generates unique output for each.
1280
 *
1281
 * Returns array for each file, with the following keys:
1282
 *
1283
 * `file_path` => The file path of the file, with a line break
1284
 * `html` => The file output HTML formatted
1285
 *
1286
 * @see GravityView_Field_FileUpload::get_files_array()
1287
 *
1288
 * @since  1.2
1289
 * @param  string $value    Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
1290
 * @param  string $gv_class Field class to add to the output HTML
1291
 * @since  2.0
1292
 * @param  \GV\Template_Context $context The context
1293
 * @return array           Array of file output, with `file_path` and `html` keys (see comments above)
1294
 */
1295
function gravityview_get_files_array( $value, $gv_class = '', $context = null ) {
1296
	/** @define "GRAVITYVIEW_DIR" "../" */
1297
1298 5
	if( !class_exists( 'GravityView_Field' ) ) {
1299
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field.php' );
1300
	}
1301
1302 5
	if( !class_exists( 'GravityView_Field_FileUpload' ) ) {
1303
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field-fileupload.php' );
1304
	}
1305
1306 5
	if ( is_null( $context ) ) {
1307
		_doing_it_wrong( __FUNCTION__, '2.0', 'Please pass an \GV\Template_Context object as the 3rd parameter' );
1308
	}
1309
1310 5
	return GravityView_Field_FileUpload::get_files_array( $value, $gv_class, $context );
1311
}
1312
1313
/**
1314
 * Generate a mapping link from an address
1315
 *
1316
 * The address should be plain text with new line (`\n`) or `<br />` line breaks separating sections
1317
 *
1318
 * @todo use GF's field get_export_value() instead
1319
 *
1320
 * @see https://gravityview.co/support/documentation/201608159 Read how to modify the link
1321
 * @param  string $address Address
1322
 * @return string          URL of link to map of address
1323
 */
1324
function gravityview_get_map_link( $address ) {
1325
1326 1
	$address_qs = str_replace( array( '<br />', "\n" ), ' ', $address ); // Replace \n with spaces
1327 1
	$address_qs = urlencode( $address_qs );
1328
1329 1
	$url = "https://maps.google.com/maps?q={$address_qs}";
1330
1331 1
	$link_text = esc_html__( 'Map It', 'gravityview' );
1332
1333 1
	$link = gravityview_get_link( $url, $link_text, 'class=map-it-link' );
1334
1335
	/**
1336
	 * @filter `gravityview_map_link` Modify the map link generated. You can use a different mapping service, for example.
1337
	 * @param[in,out]  string $link Map link
1338
	 * @param[in] string $address Address to generate link for
1339
	 * @param[in] string $url URL generated by the function
1340
	 */
1341 1
	$link = apply_filters( 'gravityview_map_link', $link, $address, $url );
1342
1343 1
	return $link;
1344
}
1345
1346
1347
/**
1348
 * Output field based on a certain html markup
1349
 *
1350
 *   markup - string to be used on a sprintf statement.
1351
 *      Use:
1352
 *         {{label}} - field label
1353
 *         {{value}} - entry field value
1354
 *         {{class}} - field class
1355
 *
1356
 *   wpautop - true will filter the value using wpautop function
1357
 *
1358
 * @since  1.1.5
1359
 * @param  array $passed_args Associative array with field data. `field` and `form` are required.
1360
 * @since  2.0
1361
 * @param  \GV\Template_Context The template context.
1362
 * @return string Field output. If empty value and hide empty is true, return empty.
1363
 */
1364
function gravityview_field_output( $passed_args, $context = null ) {
1365
	$defaults = array(
1366 34
		'entry' => null,
1367
		'field' => null,
1368
		'form' => null,
1369
		'hide_empty' => true,
1370
		'markup' => '<div id="{{ field_id }}" class="{{ class }}">{{ label }}{{ value }}</div>',
1371
		'label_markup' => '',
1372
		'wpautop' => false,
1373
		'zone_id' => null,
1374
	);
1375
1376 34
	$args = wp_parse_args( $passed_args, $defaults );
1377
1378
	/**
1379
	 * @filter `gravityview/field_output/args` Modify the args before generation begins
1380
	 * @since 1.7
1381
	 * @param array $args Associative array; `field` and `form` is required.
1382
	 * @param array $passed_args Original associative array with field data. `field` and `form` are required.
1383
	 * @since 2.0
1384
	 * @param \GV\Template_Context $context The context.
1385
	 * @deprecated
1386
	 */
1387 34
	$args = apply_filters( 'gravityview/field_output/args', $args, $passed_args, $context );
1388
1389
	/**
1390
	 * @filter `gravityview/template/field_output/context` Modify the context before generation begins.
1391
	 * @since 2.0
1392
	 * @param[in,out] \GV\Template_Context $context The context.
1393
	 * @param array $args The sanitized arguments, these should not be trusted any longer.
1394
	 * @param array $passed_args The passed arguments, these should not be trusted any longer.
1395
	 */
1396 34
	$context = apply_filters( 'gravityview/template/field_output/context', $context, $args, $passed_args );
1397
1398 34
	if ( $context instanceof \GV\Template_Context ) {
1399 32
		if ( ! $context->field || ! $context->view || ! $context->view->form ) {
1400
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => array( $context->field, $context->view->form ) ) );
1401 32
			return '';
1402
		}
1403
	} else {
1404
		// @deprecated path
1405
		// Required fields.
1406 2
		if ( empty( $args['field'] ) || empty( $args['form'] ) ) {
1407
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => $args ) );
1408
			return '';
1409
		}
1410
	}
1411
1412 34
	if ( $context instanceof \GV\Template_Context ) {
1413 32
		$entry = $args['entry'] ? : ( $context->entry ? $context->entry->as_entry() : array() );
1414 32
		$field = $args['field'] ? : ( $context->field ? $context->field->as_configuration() : array() );
1415 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...
1416
	} else {
1417
		// @deprecated path
1418 2
		$entry = empty( $args['entry'] ) ? array() : $args['entry'];
1419 2
		$field = $args['field'];
1420 2
		$form = $args['form'];
1421
	}
1422
1423
	/**
1424
	 * Create the content variables for replacing.
1425
	 * @since 1.11
1426
	 */
1427
	$placeholders = array(
1428 34
		'value' => '',
1429
		'width' => '',
1430
		'width:style' => '',
1431
		'label' => '',
1432
		'label_value' => '',
1433
		'label_value:esc_attr' => '',
1434
		'label_value:data-label' => '',
1435
		'class' => '',
1436
		'field_id' => '',
1437
	);
1438
1439 34
	if ( $context instanceof \GV\Template_Context ) {
1440 32
		$placeholders['value'] = \GV\Utils::get( $args, 'value', '' );
1441
	} else {
1442
		// @deprecated path
1443 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...
1444
	}
1445
1446
	// If the value is empty and we're hiding empty, return empty.
1447 34
	if ( $placeholders['value'] === '' && ! empty( $args['hide_empty'] ) ) {
1448 5
		return '';
1449
	}
1450
1451 34
	if ( $placeholders['value'] !== '' && ! empty( $args['wpautop'] ) ) {
1452 5
		$placeholders['value'] = wpautop( $placeholders['value'] );
1453
	}
1454
1455
	// Get width setting, if exists
1456 34
	$placeholders['width'] = GravityView_API::field_width( $field );
1457
1458
	// If replacing with CSS inline formatting, let's do it.
1459 34
	$placeholders['width:style'] = GravityView_API::field_width( $field, 'width:' . $placeholders['width'] . '%;' );
1460
1461
	// Grab the Class using `gv_class`
1462 34
	$placeholders['class'] = gv_class( $field, $form, $entry );
1463 34
	$placeholders['field_id'] = GravityView_API::field_html_attr_id( $field, $form, $entry );
1464
1465 34
	if ( $context instanceof \GV\Template_Context ) {
1466 32
		$placeholders['label_value'] = \GV\Utils::get( $args, 'label' );
1467
	} else {
1468
		// Default Label value
1469 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...
1470
	}
1471
1472 34
	$placeholders['label_value:data-label'] = trim( esc_attr( strip_tags( str_replace( '>&nbsp;', '>', $placeholders['label_value'] ) ) ) );
1473 34
	$placeholders['label_value:esc_attr'] = esc_attr( $placeholders['label_value'] );
1474
1475 34
	if ( empty( $placeholders['label'] ) && ! empty( $placeholders['label_value'] ) ){
1476 34
		$placeholders['label'] = '<span class="gv-field-label">{{ label_value }}</span>';
1477
	}
1478
1479
	/**
1480
	 * @filter `gravityview/field_output/pre_html` Allow Pre filtering of the HTML
1481
	 * @since 1.11
1482
	 * @param string $markup The HTML for the markup
1483
	 * @param array $args All args for the field output
1484
	 * @since 2.0
1485
	 * @param \GV\Template_Context $context The context.
1486
	 */
1487 34
	$html = apply_filters( 'gravityview/field_output/pre_html', $args['markup'], $args, $context );
1488
1489
	/**
1490
	 * @filter `gravityview/field_output/open_tag` Modify the opening tags for the template content placeholders
1491
	 * @since 1.11
1492
	 * @param string $open_tag Open tag for template content placeholders. Default: `{{`
1493
	 * @since 2.0
1494
	 * @param \GV\Template_Context $context The context.
1495
	 */
1496 34
	$open_tag = apply_filters( 'gravityview/field_output/open_tag', '{{', $args, $context );
1497
1498
	/**
1499
	 * @filter `gravityview/field_output/close_tag` Modify the closing tags for the template content placeholders
1500
	 * @since 1.11
1501
	 * @param string $close_tag Close tag for template content placeholders. Default: `}}`
1502
	 * @since 2.0
1503
	 * @param \GV\Template_Context $context The context.
1504
	 */
1505 34
	$close_tag = apply_filters( 'gravityview/field_output/close_tag', '}}', $args, $context );
1506
1507
	/**
1508
	 * Loop through each of the tags to replace and replace both `{{tag}}` and `{{ tag }}` with the values
1509
	 * @since 1.11
1510
	 */
1511 34
	foreach ( $placeholders as $tag => $value ) {
1512
1513
		// If the tag doesn't exist just skip it
1514 34
		if ( false === strpos( $html, $open_tag . $tag . $close_tag ) && false === strpos( $html, $open_tag . ' ' . $tag . ' ' . $close_tag ) ){
1515 34
			continue;
1516
		}
1517
1518
		// Array to search
1519
		$search = array(
1520 34
			$open_tag . $tag . $close_tag,
1521 34
			$open_tag . ' ' . $tag . ' ' . $close_tag,
1522
		);
1523
1524
		/**
1525
		 * `gravityview/field_output/context/{$tag}` Allow users to filter content on context
1526
		 * @since 1.11
1527
		 * @param string $value The content to be shown instead of the {{tag}} placeholder
1528
		 * @param array $args Arguments passed to the function
1529
		 * @since 2.0
1530
		 * @param \GV\Template_Context $context The context.
1531
		 */
1532 34
		$value = apply_filters( 'gravityview/field_output/context/' . $tag, $value, $args, $context );
1533
1534
		// Finally do the replace
1535 34
		$html = str_replace( $search, $value, $html );
1536
	}
1537
1538
	/**
1539
	 * @filter `gravityview_field_output` Modify field HTML output
1540
	 * @param string $html Existing HTML output
1541
	 * @param array $args Arguments passed to the function
1542
	 * @since 2.0
1543
	 * @param \GV\Template_Context $context The context.
1544
	 */
1545 34
	$html = apply_filters( 'gravityview_field_output', $html, $args, $context );
1546
1547
	/**
1548
	 * @filter `gravityview/field_output/html` Modify field HTML output
1549
	 * @param string $html Existing HTML output
1550
	 * @param array $args Arguments passed to the function
1551
	 * @since 2.0
1552
	 * @param \GV\Template_Context $context The context.
1553
	 */
1554 34
	$html = apply_filters( 'gravityview/field_output/html', $html, $args, $context );
1555
1556
	/** @since 2.0.8 Remove unused atts */
1557 34
	$html = str_replace( array( ' style=""', ' class=""', ' id=""' ), '', $html );
1558
1559 34
	return $html;
1560
}
1561