Completed
Push — develop ( 230c78...0c0247 )
by Gennady
17:15
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'] ) ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
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 ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
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'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
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']
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
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 23
	public static function replace_variables( $text, $form = array(), $entry = array(), $url_encode = false, $esc_html = true, $nl2br = true, $format = 'html', $aux_data = array() ) {
120 23
		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 25
	public static function field_width( $field, $format = '%d%%' ) {
134
135 25
		$width = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
136
137 25
		if( !empty( $field['width'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
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 25
		return $width;
149
	}
150
151
	/**
152
	 * Fetch Field class
153
	 *
154
	 * @access public
155
	 * @static
156
	 * @param mixed $field
157
	 * @return string
158
	 */
159 26
	public static function field_class( $field, $form = NULL, $entry = NULL ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
160 26
		$classes = array();
161
162 26
		if( !empty( $field['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
163
164 2
            $custom_class = $field['custom_class'];
165
166 2
            if( !empty( $entry ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
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`
0 ignored issues
show
Unused Code Comprehensibility introduced by
38% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
171 2
                add_filter('gform_merge_tag_filter', 'sanitize_html_class');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
172
173 2
                $custom_class = self::replace_variables( $custom_class, $form, $entry);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
174
175
                // And then we want life to return to normal
176 2
                remove_filter('gform_merge_tag_filter', 'sanitize_html_class');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
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 26
		if(!empty($field['id'])) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
Expected 1 space before "!"; 0 found
Loading history...
introduced by
Expected 1 space after "!"; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
185 26
			if( !empty( $form ) && !empty( $form['id'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
186 26
				$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 26
			$classes[] = 'gv-field'.$form_id.'-'.$field['id'];
195
		}
196
197 26
		return esc_attr(implode(' ', $classes));
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
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 24
	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 24
		$id = $field['id'];
214
215 24
		if ( ! empty( $id ) ) {
216 24
			if ( ! empty( $form ) && ! empty( $form['id'] ) ) {
217 24
				$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 24
			$id = 'gv-field' . $form_id . '-' . $field['id'];
226
		}
227
228 24
		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 3
	public static function entry_link_html( $entry = array(), $anchor_text = '', $passed_tag_atts = array(), $field_settings = array(), $base_id = null ) {
264
265 3
		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;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
268
		}
269
270 3
		$href = self::entry_link( $entry, $base_id );
271
272 3
		if( '' === $href ) {
273
			return NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
274
		}
275
276 3
		$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 3
		$output = apply_filters( 'gravityview_field_entry_link', $link, $href, $entry, $field_settings );
286
287 3
		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
				$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
		 * @param string $output The existing "No Entries" text
323
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
324
		 * @return string The modified text.
325
		 * @deprecated Use `gravityview/template/text/no_entries`
326
		 */
327 9
		$output = apply_filters( 'gravitview_no_entries_text', $output, $is_search );
328
329
		/**
330
		 * @filter `gravityview/template/text/no_entries` Modify the text displayed when there are no entries.
331
		 * @since 2.0
332
		 * @param string $output The existing "No Entries" text
333
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
334
		 * @param \GV\Template_Context $context The context.
335
		 * @return string The modified text.
336
		 */
337 9
		$output = apply_filters( 'gravityview/template/text/no_entries', $output, $is_search, $context );
338
339 9
		return $wpautop ? wpautop( $output ) : $output;
340
	}
341
342
	/**
343
	 * Generate a URL to the Directory context
344
	 *
345
	 * 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!
346
	 *
347
	 * @param int $post_id Post ID
348
	 * @param boolean $add_query_args Add pagination and sorting arguments
349
	 *
350
	 * @since 2.0
351
	 * @param \GV\Template_Context $context The context this is being used in.
352
	 *
353
	 * @return string      Permalink to multiple entries view
354
	 */
355 23
	public static function directory_link( $post_id = NULL, $add_query_args = true, $context = null ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
356 23
		global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
357
358 23
		if ( empty( $post_id ) ) {
359
			// DataTables passes the Post ID
360 14
			if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
361
				$post_id = \GV\Utils::_POST( 'post_id', false );
362
			} else {
363 14
				if ( $context instanceof \GV\Template_Context ) {
364
					// Shortcodes, embeds
365 11
					if ( is_a( $post, 'WP_Post' ) ) {
366 1
						$post_id = $post->ID;
367
368
					// Actual views
369
					} else {
370 11
						$post_id = $context->view ? $context->view->ID : false;
371
					}
372
				} else {
373
					/** @deprecated path of execution */
374 3
					$gravityview_view = GravityView_View::getInstance();
375
376
					// The Post ID has been passed via the shortcode
377 3
					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...
378 2
						$post_id = $gravityview_view->getPostId();
379
					} else {
380
						// This is a GravityView post type
381 1
						if ( GravityView_frontend::getInstance()->isGravityviewPostType() ) {
382
							$post_id = isset( $gravityview_view ) ? $gravityview_view->getViewId() : $post->ID;
383
						} else {
384
							// This is an embedded GravityView; use the embedded post's ID as the base.
385 1
							if ( GravityView_frontend::getInstance()->isPostHasShortcode() && is_a( $post, 'WP_Post' ) ) {
386
								$post_id = $post->ID;
387 1
							} elseif ( $gravityview_view->getViewId() ) {
388
								// The GravityView has been embedded in a widget or in a template, and
389
								// is not in the current content. Thus, we defer to the View's own ID.
390
								$post_id = $gravityview_view->getViewId();
391
							}
392
						}
393
					}
394
				}
395
			}
396
		}
397
398
		// No post ID, get outta here.
399 23
		if ( empty( $post_id ) ) {
400 1
			return null;
401
		}
402
403
		// If we've saved the permalink in memory, use it
404
		// @since 1.3
405 22
		$link = wp_cache_get( 'gv_directory_link_'.$post_id );
406
407 22
		if ( (int) $post_id === (int) get_option( 'page_on_front' ) ) {
408
			$link = home_url();
409
		}
410
411 22
		if ( empty( $link ) ) {
412 22
			$link = get_permalink( $post_id );
413
414
			// If not yet saved, cache the permalink.
415
			// @since 1.3
416 22
			wp_cache_set( 'gv_directory_link_'.$post_id, $link );
417
		}
418
419
		// Deal with returning to proper pagination for embedded views
420 22
		if ( $link && $add_query_args ) {
421
422 17
			$args = array();
423
424 17
			if( $pagenum = \GV\Utils::_GET( 'pagenum' ) ) {
425 1
				$args['pagenum'] = intval( $pagenum );
426
			}
427
428 17
			if( $sort = \GV\Utils::_GET( 'sort' ) ) {
429
				$args['sort'] = $sort;
430
				$args['dir'] = \GV\Utils::_GET( 'dir' );
431
			}
432
433 17
			$link = add_query_arg( $args, $link );
434
		}
435
436
		/**
437
		 * @filter `gravityview_directory_link` Modify the URL to the View "directory" context
438
		 * @since 1.19.4
439
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
440
		 * @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
441
		 */
442 22
		$link = apply_filters( 'gravityview_directory_link', $link, $post_id );
443
444
		/**
445
		 * @filter `gravityview/view/links/directory` Modify the URL to the View "directory" context
446
		 * @since 2.0
447
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
448
		 * @param \GV\Template_Context $context 
449
		 */
450 22
		return apply_filters( 'gravityview/view/links/directory', $link, $context );
451
	}
452
453
	/**
454
	 * Calculate an *unique* hash for an entry based on the entry ID
455
	 *
456
	 * 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.
457
	 *
458
	 * The hashed value MUST be unique, otherwise multiple entries will share the same URL, which leads to obvious problems.
459
	 *
460
	 * @param  int|string $id Entry ID to generate the hash for.
461
	 * @param  array  $entry        Entry data passed to provide additional information when generating the hash. Optional - don't rely on it being available.
462
	 * @return string               Hashed unique value for entry
463
	 */
464 2
	private static function get_custom_entry_slug( $id, $entry = array() ) {
465
466
		// Generate an unique hash to use as the default value
467 2
		$slug = substr( wp_hash( $id, 'gravityview'.$id ), 0, 8 );
468
469
		/**
470
		 * @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}`
471
		 * @param string $hash Existing hash generated by GravityView
472
		 * @param  string $id The entry ID
473
		 * @param  array $entry Entry data array. May be empty.
474
		 */
475 2
		$slug = apply_filters( 'gravityview_entry_slug', $slug, $id, $entry );
476
477
		// Make sure we have something - use the original ID as backup.
478 2
		if( empty( $slug ) ) {
479
			$slug = $id;
480
		}
481
482 2
		return sanitize_title( $slug );
483
	}
484
485
	/**
486
	 * Get the entry slug for the entry. By default, it is the entry ID.
487
	 *
488
	 *
489
	 * @see gravityview_get_entry()
490
	 * @uses GravityView_API::get_custom_entry_slug() If using custom slug, gets the custom slug value
491
	 * @since 1.4
492
	 * @param  int|string $id_or_string ID of the entry, or custom slug string
493
	 * @param  array  $entry        Gravity Forms Entry array, optional. Used only to provide data to customize the `gravityview_entry_slug` filter
494
	 * @return string               Unique slug ID, passed through `sanitize_title()`
495
	 */
496 68
	public static function get_entry_slug( $id_or_string, $entry = array() ) {
497
498
		/**
499
		 * Default: use the entry ID as the unique identifier
500
		 */
501 68
		$slug = $id_or_string;
502
503
		/**
504
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
505
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
506
		 */
507 68
		$custom = apply_filters( 'gravityview_custom_entry_slug', false );
508
509
		// If we're using custom slug...
510 68
		if ( $custom ) {
511
512
			// Get the entry hash
513 2
			$hash = self::get_custom_entry_slug( $id_or_string, $entry );
514
515
			// Cache the slugs
516 2
			static $cache = array();
517
518 2
			if ( ! isset( $cache[ $id_or_string ] ) ) {
519 2
				global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
520
521 2
				if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) ) {
522 2
					$table = GFFormsModel::get_entry_meta_table_name();
523 2
					$column = 'entry_id';
524
				} else {
525
					$table = RGFormsModel::get_lead_meta_table_name();
526
					$column = 'lead_id';
527
				}
528
529 2
				$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 ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
530 2
				$cache = array_replace( $cache, array_combine( wp_list_pluck( $results, $column ), wp_list_pluck( $results, 'meta_value' ) ) );
531
532 2
				if ( ! isset( $cache[ $id_or_string ] ) ) {
533 2
					$cache[ $id_or_string ] = false;
534
				}
535
			}
536
537 2
			$value = $cache[ $id_or_string ];
538
539
			// If it does have a hash set, and the hash is expected, use it.
540
			// This check allows users to change the hash structure using the
541
			// gravityview_entry_hash filter and have the old hashes expire.
542 2
			if ( empty( $value ) || $value !== $hash ) {
543 2
				gravityview()->log->debug( 'Setting hash for entry {entry}: {hash}', array( 'entry' => $id_or_string, 'hash' => $hash ) );
544 2
				gform_update_meta( $id_or_string, 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
545
			}
546
547 2
			$slug = $hash;
548
549 2
			unset( $value, $hash );
550
		}
551
552 68
		return sanitize_title( $slug );
553
	}
554
555
    /**
556
     * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
557
     *
558
     * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
559
     *
560
     * @param $entry array Gravity Forms entry object
561
     * @param $form array Gravity Forms form object
562
     */
563
    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...
564
        /**
565
         * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
566
         * @param boolean $custom Should we process the custom entry slug?
567
         */
568
        $custom = apply_filters( 'gravityview_custom_entry_slug', false );
569
        if( $custom ) {
570
            // create the gravityview_unique_id and save it
571
572
            // Get the entry hash
573
            $hash = self::get_custom_entry_slug( $entry['id'], $entry );
574
575
	        gravityview()->log->debug( 'Setting hash for entry {entry_id}: {hash}', array( 'entry_id' => $entry['id'], 'hash' => $hash ) );
576
577
            gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash, \GV\Utils::get( $entry, 'form_id' ) );
578
579
        }
580
    }
581
582
583
584
585
	/**
586
	 * return href for single entry
587
	 * @param  array|int $entry   Entry array or entry ID
588
	 * @param  int|null $post_id If wanting to define the parent post, pass a post ID
589
	 * @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}
590
	 * @return string          Link to the entry with the directory parent slug, or empty string if embedded post or View doesn't exist
591
	 */
592 7
	public static function entry_link( $entry, $post_id = NULL, $add_directory_args = true ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
593
594 7
		if ( ! empty( $entry ) && ! is_array( $entry ) ) {
595
			$entry = GVCommon::get_entry( $entry );
596 7
		} else if( empty( $entry ) ) {
597
			// @deprecated path
598
			$entry = GravityView_frontend::getInstance()->getEntry();
599
		}
600
601
		// Second parameter used to be passed as $field; this makes sure it's not an array
602 7
		if ( ! is_numeric( $post_id ) ) {
603 1
			$post_id = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
604
		}
605
606
		// Get the permalink to the View
607 7
		$directory_link = self::directory_link( $post_id, false );
608
609
		// No post ID? Get outta here.
610 7
		if ( empty( $directory_link ) ) {
611 1
			return '';
612
		}
613
614 6
		$query_arg_name = \GV\Entry::get_endpoint_name();
615
616 6
		$entry_slug = self::get_entry_slug( $entry['id'], $entry );
617
618 6
		if ( get_option('permalink_structure') && !is_preview() ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
introduced by
Expected 1 space after "!"; 0 found
Loading history...
619
620
			$args = array();
621
622
			/**
623
			 * Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
624
			 * @since 1.16.5
625
			 */
626
			$link_parts = explode( '?', $directory_link );
627
628
			$query = !empty( $link_parts[1] ) ? '?'.$link_parts[1] : '';
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
629
630
			$directory_link = trailingslashit( $link_parts[0] ) . $query_arg_name . '/'. $entry_slug .'/' . $query;
631
632
		} else {
633
634 6
			$args = array( $query_arg_name => $entry_slug );
635
		}
636
637
		/**
638
		 * @since 1.7.3
639
		 */
640 6
		if ( $add_directory_args ) {
641
642 6
			if ( ! empty( $_GET['pagenum'] ) ) {
643
				$args['pagenum'] = intval( $_GET['pagenum'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
644
			}
645
646
			/**
647
			 * @since 1.7
648
			 */
649 6
			if ( $sort = \GV\Utils::_GET( 'sort' ) ) {
650
				$args['sort'] = $sort;
651
				$args['dir'] = \GV\Utils::_GET( 'dir' );
652
			}
653
654
		}
655
656 6
		if ( 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...
657
			$args['gvid'] = gravityview_get_view_id();
658
		}
659
660 6
		return add_query_arg( $args, $directory_link );
661
662
	}
663
664
665
}
666
667
668
// inside loop functions
669
670
/**
671
 * @deprecated Use \GV\Field::get_label()
672
 */
673
function gv_label( $field, $entry = NULL ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
674 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...
675
}
676
677
function gv_class( $field, $form = NULL, $entry = array() ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
678 25
	return GravityView_API::field_class( $field, $form, $entry  );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 2 found
Loading history...
679
}
680
681
/**
682
 * Generate a CSS class to be added to the wrapper <div> of a View
683
 *
684
 * @since 1.5.4
685
 * @since 1.16 Added $echo parameter.
686
 * @since 2.0 Added $context parameter.
687
 *
688
 * @param string $passed_css_class Default: `gv-container gv-container-{view id}`. If View is hidden until search, adds ` hidden`
689
 * @param boolean $echo Whether to echo the output. Default: true
690
 * @param \GV\Template_Context $context The template context.
691
 *
692
 * @return string CSS class, sanitized by gravityview_sanitize_html_class()
693
 */
694
function gv_container_class( $passed_css_class = '', $echo = true, $context = null ) {
695 28
	if ( $context instanceof \GV\Template_Context ) {
696 26
		$hide_until_searched = false;
697 26
		$total_entries = 0;
698 26
		$view_id = 0;
699 26
		if ( $context->view ) {
700 26
			$view_id = $context->view->ID;
701 26
			if( $context->view->settings->get( 'hide_until_searched' ) ) {
702 4
				$hide_until_searched = ( empty( $context->entry ) && ! $context->request->is_search() );
703
			}
704
		}
705 26
		if ( $context->entries ) {
706 16
			$total_entries = $context->entries->total();
707 11
		} else if ( $context->entry ) {
708 26
			$total_entries = 1;
709
		}
710
	} else {
711
		/** @deprecated legacy execution path */
712 3
		$view_id = GravityView_View::getInstance()->getViewId();
713 3
		$hide_until_searched = GravityView_View::getInstance()->isHideUntilSearched();
714 3
		$total_entries = GravityView_View::getInstance()->getTotalEntries();
715
	}
716
717 28
	$passed_css_class = trim( $passed_css_class );
718
719 28
	$default_css_class = ! empty( $view_id ) ? sprintf( 'gv-container gv-container-%d', $view_id ) : 'gv-container';
720
721 28
	if ( $hide_until_searched ) {
722 4
		$default_css_class .= ' hidden';
723
	}
724
725 28
	if ( 0 === $total_entries ) {
726 7
		$default_css_class .= ' gv-container-no-results';
727
	}
728
729 28
	$css_class = trim( $passed_css_class . ' '. $default_css_class );
730
731
	/**
732
	 * @filter `gravityview/render/container/class` Modify the CSS class to be added to the wrapper <div> of a View
733
	 * @since 1.5.4
734
	 * @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`
735
	 * @since 2.0
736
	 * @param \GV\Template_Context $context The context.
737
	 */
738 28
	$css_class = apply_filters( 'gravityview/render/container/class', $css_class, $context );
739
740 28
	$css_class = gravityview_sanitize_html_class( $css_class );
741
742 28
	if ( $echo ) {
743 28
		echo $css_class;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$css_class'
Loading history...
744
	}
745
746 28
	return $css_class;
747
}
748
749
/**
750
 * @deprecated Use \GV\Field_Template::render()
751
 */
752
function gv_value( $entry, $field ) {
753
754 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...
755
756 2
	if( $value === '' ) {
757
		/**
758
		 * @filter `gravityview_empty_value` What to display when a field is empty
759
		 * @param string $value (empty string)
760
		 */
761 1
		$value = apply_filters( 'gravityview_empty_value', '' );
762
	}
763
764 2
	return $value;
765
}
766
767
function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
0 ignored issues
show
introduced by
Overridding WordPress globals is prohibited
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
768 12
	return GravityView_API::directory_link( $post, $add_pagination, $context );
769
}
770
771
function gv_entry_link( $entry, $post_id = NULL ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
772 2
	return GravityView_API::entry_link( $entry, $post_id );
773
}
774
775
function gv_no_results( $wpautop = true, $context = null ) {
776 8
	return GravityView_API::no_results( $wpautop, $context );
777
}
778
779
/**
780
 * Generate HTML for the back link from single entry view
781
 * @since 1.0.1
782
 * @since 2.0
783
 * @param \GV\Template_Context $context The context this link is being displayed from.
784
 * @return string|null      If no GV post exists, null. Otherwise, HTML string of back link.
785
 */
786
function gravityview_back_link( $context = null ) {
787
788 11
	$href = gv_directory_link( null, true, $context );
789
790
	/**
791
	 * @filter `gravityview_go_back_url` Modify the back link URL
792
	 * @since 1.17.5
793
	 * @see gv_directory_link() Generated the original back link
794
	 * @param string $href Existing label URL
795
	 * @deprecated Use `gravityview/template/links/back/url`
796
	 */
797 11
	$href = apply_filters( 'gravityview_go_back_url', $href );
798
799
	/**
800
	 * @filter `gravityview/template/links/back/url` Modify the back link URL
801
	 * @since 2.0
802
	 * @see gv_directory_link() Generated the original back link
803
	 * @param string $href Existing label URL
804
	 * @param \GV\Template_Context The context.
805
	 */
806 11
	$href = apply_filters( 'gravityview/template/links/back/url', $href, $context );
807
808 11
	if ( empty( $href ) ) {
809 3
		return NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
810
	}
811
812 9
	if ( $context instanceof \GV\Template_Context ) {
813 9
		$view_id = $context->view->ID;
814 9
		$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...
815
	} else {
816
		/** @deprecated legacy path */
817
		$gravityview_view = GravityView_View::getInstance();
818
		$view_id = $gravityview_view->getViewId();
819
		$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...
820
	}
821
822
	/** Default */
823 9
	$label = $view_label ? $view_label : __( '&larr; Go back', 'gravityview' );
824
825
	/**
826
	 * @filter `gravityview_go_back_label` Modify the back link text
827
	 * @since 1.0.9
828
	 * @param string $label Existing label text
829
	 * @deprecated Use `gravityview/template/links/back/label`
830
	 */
831 9
	$label = apply_filters( 'gravityview_go_back_label', $label );
832
833
	/**
834
	 * @filter `gravityview_go_back_label` Modify the back link text
835
	 * @since 2.0
836
	 * @see gv_directory_link() Generated the original back link
837
	 * @param string $label Existing label text
838
	 * @param \GV\Template_Context The context.
839
	 */
840 9
	$label = apply_filters( 'gravityview/template/links/back/label', $label, $context );
841
842 9
	$link = gravityview_get_link( $href, esc_html( $label ), array(
843 9
		'data-viewid' => $view_id,
844
	) );
845
846 9
	return $link;
847
}
848
849
/**
850
 * Handle getting values for complex Gravity Forms fields
851
 *
852
 * If the field is complex, like a product, the field ID, for example, 11, won't exist. Instead,
853
 * it will be 11.1, 11.2, and 11.3. This handles being passed 11 and 11.2 with the same function.
854
 *
855
 * @since 1.0.4
856
 * @param  array      $entry    GF entry array
857
 * @param  string      $field_id [description]
858
 * @param  string 	$display_value The value generated by Gravity Forms
859
 * @return string                Value
860
 */
861
function gravityview_get_field_value( $entry, $field_id, $display_value ) {
862
863 6
	if( floatval( $field_id ) === floor( floatval( $field_id ) ) ) {
864
865
		// For the complete field value as generated by Gravity Forms
866 3
		return $display_value;
867
868
	} else {
869
870
		// For one part of the address (City, ZIP, etc.)
871 6
		return isset( $entry[ $field_id ] ) ? $entry[ $field_id ] : '';
872
873
	}
874
875
}
876
877
/**
878
 * Take a passed CSV of terms and generate a linked list of terms
879
 *
880
 * Gravity Forms passes categories as "Name:ID" so we handle that using the ID, which
881
 * is more accurate than checking the name, which is more likely to change.
882
 *
883
 * @param  string      $value    Existing value
884
 * @param  string      $taxonomy Type of term (`post_tag` or `category`)
885
 * @return string                CSV of linked terms
886
 */
887
function gravityview_convert_value_to_term_list( $value, $taxonomy = 'post_tag' ) {
888
889 1
	$output = array();
890
891 1
	if ( is_array( $value ) ) {
892 1
		$terms = array_filter( array_values( $value ), 'strlen' );
893
	} else {
894 1
		$terms = explode( ', ', $value );
895
	}
896
897 1
	foreach ($terms as $term_name ) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
898
899
		// If we're processing a category,
900 1
		if( $taxonomy === 'category' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
901
902
			// Use rgexplode to prevent errors if : doesn't exist
903 1
			list( $term_name, $term_id ) = rgexplode( ':', $term_name, 2 );
904
905
			// The explode was succesful; we have the category ID
906 1
			if( !empty( $term_id )) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
907 1
				$term = get_term_by( 'id', $term_id, $taxonomy );
908
			} else {
909
			// We have to fall back to the name
910 1
				$term = get_term_by( 'name', $term_name, $taxonomy );
911
			}
912
913
		} else {
914
			// Use the name of the tag to get the full term information
915 1
			$term = get_term_by( 'name', $term_name, $taxonomy );
916
		}
917
918
		// There's still a tag/category here.
919 1
		if( $term ) {
920
921 1
			$term_link = get_term_link( $term, $taxonomy );
922
923
			// If there was an error, continue to the next term.
924 1
			if ( is_wp_error( $term_link ) ) {
925
			    continue;
926
			}
927
928 1
			$output[] = gravityview_get_link( $term_link, esc_html( $term->name ) );
929
		}
930
	}
931
932 1
	return implode(', ', $output );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
933
}
934
935
/**
936
 * Get the links for post_tags and post_category output based on post ID
937
 * @param  int      $post_id  The ID of the post
938
 * @param  boolean     $link     Add links or no?
939
 * @param  string      $taxonomy Taxonomy of term to fetch.
940
 * @return string                String with terms
941
 */
942
function gravityview_get_the_term_list( $post_id, $link = true, $taxonomy = 'post_tag' ) {
943
944 1
	$output = get_the_term_list( $post_id, $taxonomy, NULL, ', ' );
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
945
946 1
	if( empty( $link ) ) {
947 1
		return strip_tags( $output);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
948
	}
949
950 1
	return $output;
951
952
}
953
954
955
/**
956
 * Get all views processed so far for the current page load
957
 *
958
 * @see  GravityView_View_Data::add_view()
959
 * @return array Array of View data, each View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
960
 */
961
function gravityview_get_current_views() {
962
963 1
	$fe = GravityView_frontend::getInstance();
964
965
	// Solve problem when loading content via admin-ajax.php
966 1
	if( ! $fe->getGvOutputData() ) {
967
968 1
		gravityview()->log->debug( 'gv_output_data not defined; parsing content.' );
969
970 1
		$fe->parse_content();
971
	}
972
973
	// Make 100% sure that we're dealing with a properly called situation
974 1
	if( !is_a( $fe->getGvOutputData(), 'GravityView_View_Data' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
975
976
		gravityview()->log->debug( 'gv_output_data not an object or get_view not callable.', array( 'data' => $fe->getGvOutputData() ) );
977
978
		return array();
979
	}
980
981 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...
982
}
983
984
/**
985
 * Get data for a specific view
986
 *
987
 * @see  GravityView_View_Data::get_view()
988
 * @return array View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
989
 */
990
function gravityview_get_current_view_data( $view_id = 0 ) {
991
992
	$fe = GravityView_frontend::getInstance();
993
994
	// If not set, grab the current view ID
995
	if ( empty( $view_id ) ) {
996
		$view_id = $fe->get_context_view_id();
997
	}
998
999
	if ( ! $fe->getGvOutputData() ) { return array(); }
1000
1001
	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...
1002
}
1003
1004
// Templates' hooks
1005
function gravityview_before() {
1006
	/**
1007
	 * @action `gravityview/template/before` Append content to the view.
1008
	 * @param object $gravityview The $gravityview object available in templates.
1009
	 */
1010 27
	if ( count( $args = func_get_args() ) ) {
1011 25
		$gravityview = reset( $args );
1012 25
		if ( $gravityview instanceof \GV\Template_Context ) {
1013
			/**
1014
			 * @action `gravityview/template/before` Prepend content to the view.
1015
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1016
			 */
1017 25
			do_action( 'gravityview/template/before', $gravityview );
1018
1019
			/**
1020
			 * @deprecated Use `gravityview/template/before`
1021
			 */
1022 25
			return do_action( 'gravityview_before', $gravityview->view->ID );
1023
		}
1024
	}
1025
1026
	/**
1027
	 * @action `gravityview_before` Prepend content to the View container `<div>`
1028
	 * @deprecated Use `gravityview/template/before`.
1029
	 * @param int $view_id The ID of the View being displayed
1030
	 */
1031 2
	do_action( 'gravityview_before', gravityview_get_view_id() );
1032 2
}
1033
1034
function gravityview_header() {
1035
	/**
1036
	 * @action `gravityview/template/header` Append content to the view.
1037
	 * @param object $gravityview The $gravityview object available in templates.
1038
	 */
1039 23
	if ( count( $args = func_get_args() ) ) {
1040 21
		$gravityview = reset( $args );
1041 21
		if ( $gravityview instanceof \GV\Template_Context ) {
1042
			/**
1043
			 * @action `gravityview/template/header` Prepend content to the view container <div>.
1044
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1045
			 */
1046 21
			do_action( 'gravityview/template/header', $gravityview );
1047
1048
			/**
1049
			 * @deprecated Use `gravityview/template/header`
1050
			 */
1051 21
			return do_action( 'gravityview_header', $gravityview->view->ID );
1052
		}
1053
	}
1054
1055
	/**
1056
	 * @action `gravityview_header` Prepend content to the View container `<div>`
1057
	 * @deprecated Use `gravityview/template/header`.
1058
	 * @param int $view_id The ID of the View being displayed
1059
	 */
1060 2
	do_action( 'gravityview_header', gravityview_get_view_id() );
1061 2
}
1062
1063
function gravityview_footer() {
1064
	/**
1065
	 * @action `gravityview/template/footer` Append content to the view.
1066
	 * @param object $gravityview The $gravityview object available in templates.
1067
	 */
1068 23
	if ( count( $args = func_get_args() ) ) {
1069 21
		$gravityview = reset( $args );
1070 21
		if ( $gravityview instanceof \GV\Template_Context ) {
1071
			/**
1072
			 * @action `gravityview/template/footer` Prepend outside of the view container <div>.
1073
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1074
			 */
1075 21
			do_action( 'gravityview/template/footer', $gravityview );
1076
1077
			/**
1078
			 * @deprecated Use `gravityview/template/footer`
1079
			 */
1080 21
			return do_action( 'gravityview_footer', $gravityview->view->ID );
1081
		}
1082
	}
1083
1084
	/**
1085
	 * @action `gravityview_after` Display content after a View. Used to render footer widget areas. Rendered outside the View container `<div>`
1086
	 * @deprecated Use `gravityview/template/footer`.
1087
	 * @param int $view_id The ID of the View being displayed
1088
	 */
1089 2
	do_action( 'gravityview_footer', gravityview_get_view_id() );
1090 2
}
1091
1092
function gravityview_after() {
1093 27
	if ( count( $args = func_get_args() ) ) {
1094 25
		$gravityview = reset( $args );
1095 25
		if ( $gravityview instanceof \GV\Template_Context ) {
1096
			/**
1097
			 * @action `gravityview/template/after` Append content to the view.
1098
			 * @param \GV\Template_Context $gravityview The $gravityview object available in templates.
1099
			 */
1100 25
			do_action( 'gravityview/template/after', $gravityview );
1101
1102
			/**
1103
			 * @deprecated Use `gravityview/template/after`
1104
			 */
1105 25
			do_action( 'gravityview_after', $gravityview->view->ID );
1106
1107 25
			return;
1108
		}
1109
	}
1110
1111
	/**
1112
	 * @action `gravityview_after` Append content to the View container `<div>`
1113
	 * @deprecated Use `gravityview/template/after`
1114
	 * @param int $view_id The ID of the View being displayed
1115
	 */
1116 2
	do_action( 'gravityview_after', gravityview_get_view_id() );
1117 2
}
1118
1119
/**
1120
 * Get the current View ID being rendered
1121
 *
1122
 * @global GravityView_View $gravityview_view
1123
 *
1124
 * @return int View ID, if exists. `0` if `GravityView_View` doesn't exist, like in the admin, or no View is set.
1125
 */
1126
function gravityview_get_view_id() {
1127
1128 2
	if ( ! class_exists( 'GravityView_View' ) ) {
1129
		return 0;
1130
	}
1131
1132 2
	return GravityView_View::getInstance()->getViewId();
1133
}
1134
1135
/**
1136
 * Returns the current GravityView context, or empty string if not GravityView
1137
 *
1138
 * - Returns empty string on GravityView archive pages
1139
 * - Returns empty string on archive pages containing embedded Views
1140
 * - Returns empty string for embedded Views, not 'directory'
1141
 * - Returns empty string for embedded entries (oEmbed or [gventry]), not 'single'
1142
 * - Returns 'single' when viewing a [gravityview] shortcode-embedded single entry
1143
 *
1144
 * @global GravityView_View $gravityview_view
1145
 * @deprecated since 2.0.6.2 Use `gravityview()->request`
1146
 * @return string View context "directory", "single", "edit", or empty string if not GravityView
1147
 */
1148
function gravityview_get_context() {
1149 4
	global $wp_query;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
1150
1151 4
	if ( isset( $wp_query ) && $wp_query->post_count > 1 ) {
1152
		return '';
1153
	}
1154
1155
	/**
1156
	 * @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
1157
	 * The Edit Entry functionality overrides this value.
1158
	 * @param boolean $is_edit_entry
1159
	 */
1160 4
	$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );
1161
1162 4
	if ( $is_edit_entry ) {
1163
		return 'edit';
1164 4
	} else if ( gravityview()->request->is_entry() ) {
1165 1
		return 'single';
1166 3
	} else if ( gravityview()->request->is_view() ) {
1167 2
		return 'directory';
1168
	}
1169
1170 1
	return '';
1171
}
1172
1173
1174
/**
1175
 * Return an array of files prepared for output. Wrapper for GravityView_Field_FileUpload::get_files_array()
1176
 *
1177
 * Processes files by file type and generates unique output for each.
1178
 *
1179
 * Returns array for each file, with the following keys:
1180
 *
1181
 * `file_path` => The file path of the file, with a line break
1182
 * `html` => The file output HTML formatted
1183
 *
1184
 * @see GravityView_Field_FileUpload::get_files_array()
1185
 *
1186
 * @since  1.2
1187
 * @param  string $value    Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
1188
 * @param  string $gv_class Field class to add to the output HTML
1189
 * @since  2.0
1190
 * @param  \GV\Template_Context $context The context
1191
 * @return array           Array of file output, with `file_path` and `html` keys (see comments above)
1192
 */
1193
function gravityview_get_files_array( $value, $gv_class = '', $context = null ) {
1194
	/** @define "GRAVITYVIEW_DIR" "../" */
1195
1196 1
	if( !class_exists( 'GravityView_Field' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1197
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field.php' );
1198
	}
1199
1200 1
	if( !class_exists( 'GravityView_Field_FileUpload' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1201
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field-fileupload.php' );
1202
	}
1203
1204 1
	return GravityView_Field_FileUpload::get_files_array( $value, $gv_class, $context );
1205
}
1206
1207
/**
1208
 * Generate a mapping link from an address
1209
 *
1210
 * The address should be plain text with new line (`\n`) or `<br />` line breaks separating sections
1211
 *
1212
 * @todo use GF's field get_export_value() instead
1213
 *
1214
 * @see https://gravityview.co/support/documentation/201608159 Read how to modify the link
1215
 * @param  string $address Address
1216
 * @return string          URL of link to map of address
1217
 */
1218
function gravityview_get_map_link( $address ) {
1219
1220
	$address_qs = str_replace( array( '<br />', "\n" ), ' ', $address ); // Replace \n with spaces
1221
	$address_qs = urlencode( $address_qs );
1222
1223
	$url = "https://maps.google.com/maps?q={$address_qs}";
1224
1225
	$link_text = esc_html__( 'Map It', 'gravityview' );
1226
1227
	$link = gravityview_get_link( $url, $link_text, 'class=map-it-link' );
1228
1229
	/**
1230
	 * @filter `gravityview_map_link` Modify the map link generated. You can use a different mapping service, for example.
1231
	 * @param[in,out]  string $link Map link
1232
	 * @param[in] string $address Address to generate link for
1233
	 * @param[in] string $url URL generated by the function
1234
	 */
1235
	$link = apply_filters( 'gravityview_map_link', $link, $address, $url );
1236
1237
	return $link;
1238
}
1239
1240
1241
/**
1242
 * Output field based on a certain html markup
1243
 *
1244
 *   markup - string to be used on a sprintf statement.
1245
 *      Use:
1246
 *         {{label}} - field label
1247
 *         {{value}} - entry field value
1248
 *         {{class}} - field class
1249
 *
1250
 *   wpautop - true will filter the value using wpautop function
1251
 *
1252
 * @since  1.1.5
1253
 * @param  array $passed_args Associative array with field data. `field` and `form` are required.
1254
 * @since  2.0
1255
 * @param  \GV\Template_Context The template context.
1256
 * @return string Field output. If empty value and hide empty is true, return empty.
1257
 */
1258
function gravityview_field_output( $passed_args, $context = null ) {
1259
	$defaults = array(
1260 24
		'entry' => null,
1261
		'field' => null,
1262
		'form' => null,
1263
		'hide_empty' => true,
1264
		'markup' => '<div id="{{ field_id }}" class="{{ class }}">{{ label }}{{ value }}</div>',
1265
		'label_markup' => '',
1266
		'wpautop' => false,
1267
		'zone_id' => null,
1268
	);
1269
1270 24
	$args = wp_parse_args( $passed_args, $defaults );
1271
1272
	/**
1273
	 * @filter `gravityview/field_output/args` Modify the args before generation begins
1274
	 * @since 1.7
1275
	 * @param array $args Associative array; `field` and `form` is required.
1276
	 * @param array $passed_args Original associative array with field data. `field` and `form` are required.
1277
	 * @since 2.0
1278
	 * @param \GV\Template_Context $context The context.
1279
	 * @deprecated
1280
	 */
1281 24
	$args = apply_filters( 'gravityview/field_output/args', $args, $passed_args, $context );
1282
1283
	/**
1284
	 * @filter `gravityview/template/field_output/context` Modify the context before generation begins.
1285
	 * @since 2.0
1286
	 * @param[in,out] \GV\Template_Context $context The context.
1287
	 * @param array $args The sanitized arguments, these should not be trusted any longer.
1288
	 * @param array $passed_args The passed arguments, these should not be trusted any longer.
1289
	 */
1290 24
	$context = apply_filters( 'gravityview/template/field_output/context', $context, $args, $passed_args );
1291
1292 24
	if ( $context instanceof \GV\Template_Context ) {
1293 22
		if ( ! $context->field || ! $context->view || ! $context->view->form ) {
1294
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => array( $context->field, $context->view->form ) ) );
1295 22
			return '';
1296
		}
1297
	} else {
1298
		// @deprecated path
1299
		// Required fields.
1300 2
		if ( empty( $args['field'] ) || empty( $args['form'] ) ) {
1301
			gravityview()->log->error( 'Field or form are empty.', array( 'data' => $args ) );
1302
			return '';
1303
		}
1304
	}
1305
1306 24
	if ( $context instanceof \GV\Template_Context ) {
1307 22
		$entry = $args['entry'] ? : ( $context->entry ? $context->entry->as_entry() : array() );
1308 22
		$field = $args['field'] ? : ( $context->field ? $context->field->as_configuration() : array() );
1309 22
		$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...
1310
	} else {
1311
		// @deprecated path
1312 2
		$entry = empty( $args['entry'] ) ? array() : $args['entry'];
1313 2
		$field = $args['field'];
1314 2
		$form = $args['form'];
1315
	}
1316
1317
	/**
1318
	 * Create the content variables for replacing.
1319
	 * @since 1.11
1320
	 */
1321
	$placeholders = array(
1322 24
		'value' => '',
1323
		'width' => '',
1324
		'width:style' => '',
1325
		'label' => '',
1326
		'label_value' => '',
1327
		'class' => '',
1328
		'field_id' => '',
1329
	);
1330
1331 24
	if ( $context instanceof \GV\Template_Context ) {
1332 22
		$placeholders['value'] = \GV\Utils::get( $args, 'value', '' );
1333
	} else {
1334
		// @deprecated path
1335 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...
1336
	}
1337
1338
	// If the value is empty and we're hiding empty, return empty.
1339 24
	if ( $placeholders['value'] === '' && ! empty( $args['hide_empty'] ) ) {
1340 5
		return '';
1341
	}
1342
1343 24
	if ( $placeholders['value'] !== '' && ! empty( $args['wpautop'] ) ) {
1344 5
		$placeholders['value'] = wpautop( $placeholders['value'] );
1345
	}
1346
1347
	// Get width setting, if exists
1348 24
	$placeholders['width'] = GravityView_API::field_width( $field );
1349
1350
	// If replacing with CSS inline formatting, let's do it.
1351 24
	$placeholders['width:style'] = GravityView_API::field_width( $field, 'width:' . $placeholders['width'] . '%;' );
1352
1353
	// Grab the Class using `gv_class`
1354 24
	$placeholders['class'] = gv_class( $field, $form, $entry );
1355 24
	$placeholders['field_id'] = GravityView_API::field_html_attr_id( $field, $form, $entry );
1356
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1357
1358
	// Get field label if needed
1359 24
	if ( ! empty( $args['label_markup'] ) && ! empty( $args['field']['show_label'] ) ) {
1360 1
		$placeholders['label'] = str_replace( array( '{{label}}', '{{ label }}' ), '<span class="gv-field-label">{{ label_value }}</span>', $args['label_markup'] );
1361
	}
1362
1363 24
	if ( $context instanceof \GV\Template_Context ) {
1364 22
		$placeholders['label_value'] = \GV\Utils::get( $args, 'label' );
1365
	} else {
1366
		// Default Label value
1367 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...
1368
	}
1369
1370 24
	if ( empty( $placeholders['label'] ) && ! empty( $placeholders['label_value'] ) ){
1371 24
		$placeholders['label'] = '<span class="gv-field-label">{{ label_value }}</span>';
1372
	}
1373
1374
	/**
1375
	 * @filter `gravityview/field_output/pre_html` Allow Pre filtering of the HTML
1376
	 * @since 1.11
1377
	 * @param string $markup The HTML for the markup
1378
	 * @param array $args All args for the field output
1379
	 * @since 2.0
1380
	 * @param \GV\Template_Context $context The context.
1381
	 */
1382 24
	$html = apply_filters( 'gravityview/field_output/pre_html', $args['markup'], $args, $context );
1383
1384
	/**
1385
	 * @filter `gravityview/field_output/open_tag` Modify the opening tags for the template content placeholders
1386
	 * @since 1.11
1387
	 * @param string $open_tag Open tag for template content placeholders. Default: `{{`
1388
	 * @since 2.0
1389
	 * @param \GV\Template_Context $context The context.
1390
	 */
1391 24
	$open_tag = apply_filters( 'gravityview/field_output/open_tag', '{{', $args, $context );
1392
1393
	/**
1394
	 * @filter `gravityview/field_output/close_tag` Modify the closing tags for the template content placeholders
1395
	 * @since 1.11
1396
	 * @param string $close_tag Close tag for template content placeholders. Default: `}}`
1397
	 * @since 2.0
1398
	 * @param \GV\Template_Context $context The context.
1399
	 */
1400 24
	$close_tag = apply_filters( 'gravityview/field_output/close_tag', '}}', $args, $context );
1401
1402
	/**
1403
	 * Loop through each of the tags to replace and replace both `{{tag}}` and `{{ tag }}` with the values
1404
	 * @since 1.11
1405
	 */
1406 24
	foreach ( $placeholders as $tag => $value ) {
1407
1408
		// If the tag doesn't exist just skip it
1409 24
		if ( false === strpos( $html, $open_tag . $tag . $close_tag ) && false === strpos( $html, $open_tag . ' ' . $tag . ' ' . $close_tag ) ){
1410 24
			continue;
1411
		}
1412
1413
		// Array to search
1414
		$search = array(
1415 24
			$open_tag . $tag . $close_tag,
1416 24
			$open_tag . ' ' . $tag . ' ' . $close_tag,
1417
		);
1418
1419
		/**
1420
		 * `gravityview/field_output/context/{$tag}` Allow users to filter content on context
1421
		 * @since 1.11
1422
		 * @param string $value The content to be shown instead of the {{tag}} placeholder
1423
		 * @param array $args Arguments passed to the function
1424
		 * @since 2.0
1425
		 * @param \GV\Template_Context $context The context.
1426
		 */
1427 24
		$value = apply_filters( 'gravityview/field_output/context/' . $tag, $value, $args, $context );
1428
1429
		// Finally do the replace
1430 24
		$html = str_replace( $search, $value, $html );
1431
	}
1432
1433
	/**
1434
	 * @filter `gravityview_field_output` Modify field HTML output
1435
	 * @param string $html Existing HTML output
1436
	 * @param array $args Arguments passed to the function
1437
	 * @since 2.0
1438
	 * @param \GV\Template_Context $context The context.
1439
	 */
1440 24
	$html = apply_filters( 'gravityview_field_output', $html, $args, $context );
1441
1442
	/**
1443
	 * @filter `gravityview/field_output/html` Modify field HTML output
1444
	 * @param string $html Existing HTML output
1445
	 * @param array $args Arguments passed to the function
1446
	 * @since 2.0
1447
	 * @param \GV\Template_Context $context The context.
1448
	 */
1449 24
	$html = apply_filters( 'gravityview/field_output/html', $html, $args, $context );
1450
1451
	/** @since 2.0.8 Remove unused atts */
1452 24
	$html = str_replace( array( ' style=""', ' class=""', ' id=""' ), '', $html );
1453
1454 24
	return $html;
1455
}
1456