Completed
Push — master ( cf9740...0c1274 )
by Zack
19:03 queued 03:33
created

GravityView_API::directory_link()   D

Complexity

Conditions 19
Paths 189

Size

Total Lines 99
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 26
CRAP Score 22.4445

Importance

Changes 0
Metric Value
cc 19
eloc 36
nc 189
nop 2
dl 0
loc 99
ccs 26
cts 33
cp 0.7879
crap 22.4445
rs 4.4786
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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
	 * @access public
20
	 * @static
21
	 * @param array $field GravityView field array
22
	 * @param array $entry Gravity Forms entry array
23
	 * @param boolean $force_show_label Whether to always show the label, regardless of field settings
24
	 * @return string
25
	 */
26
	public static function field_label( $field, $entry = array(), $force_show_label = false ) {
27
		$gravityview_view = GravityView_View::getInstance();
28
29
		$form = $gravityview_view->getForm();
30
31
		$label = '';
32
33
		if( !empty( $field['show_label'] ) || $force_show_label ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
34
35
			$label = $field['label'];
36
37
			// Support Gravity Forms 1.9+
38
			if( class_exists( 'GF_Field' ) ) {
39
40
				$field_object = RGFormsModel::get_field( $form, $field['id'] );
41
42
				if( $field_object ) {
43
44
					$input = GFFormsModel::get_input( $field_object, $field['id'] );
45
46
					// This is a complex field, with labels on a per-input basis
47
					if( $input ) {
48
49
						// Does the input have a custom label on a per-input basis? Otherwise, default label.
50
						$label = ! empty( $input['customLabel'] ) ? $input['customLabel'] : $input['label'];
51
52
					} else {
53
54
						// This is a field with one label
55
						$label = $field_object->get_field_label( true, $field['label'] );
56
57
					}
58
59
				}
60
61
			}
62
63
			// Use Gravity Forms label by default, but if a custom label is defined in GV, use it.
64
			if ( !empty( $field['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
65
66
				$label = self::replace_variables( $field['custom_label'], $form, $entry );
67
68
			}
69
70
			/**
71
			 * @filter `gravityview_render_after_label` Append content to a field label
72
			 * @param[in,out] string $appended_content Content you can add after a label. Empty by default.
73
			 * @param[in] array $field GravityView field array
74
			 */
75
			$label .= apply_filters( 'gravityview_render_after_label', '', $field );
76
77
		} // 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...
78
79
		/**
80
		 * @filter `gravityview/template/field_label` Modify field label output
81
		 * @since 1.7
82
		 * @param[in,out] string $label Field label HTML
83
		 * @param[in] array $field GravityView field array
84
		 * @param[in] array $form Gravity Forms form array
85
		 * @param[in] array $entry Gravity Forms entry array
86
		 */
87
		$label = apply_filters( 'gravityview/template/field_label', $label, $field, $form, $entry );
88
89
		return $label;
90
	}
91
92
	/**
93
	 * Alias for GravityView_Merge_Tags::replace_variables()
94
	 *
95
	 * @see GravityView_Merge_Tags::replace_variables() Moved in 1.8.4
96
	 *
97
	 * @param  string      $text       Text to replace variables in
98
	 * @param  array      $form        GF Form array
99
	 * @param  array      $entry        GF Entry array
100
	 * @return string                  Text with variables maybe replaced
101
	 */
102 1
	public static function replace_variables( $text, $form = array(), $entry = array() ) {
103 1
		return GravityView_Merge_Tags::replace_variables( $text, $form, $entry );
104
	}
105
106
	/**
107
	 * Get column width from the field setting
108
	 *
109
	 * @since 1.9
110
	 *
111
	 * @param array $field Array of settings for the field
112
	 * @param string $format Format for width. "%" (default) will return
113
	 *
114
	 * @return string|null If not empty, string in $format format. Otherwise, null.
115
	 */
116 1
	public static function field_width( $field, $format = '%d%%' ) {
117
118 1
		$width = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
119
120 1
		if( !empty( $field['width'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
121 1
			$width = absint( $field['width'] );
122
123
			// If using percentages, limit to 100%
124 1
			if( '%d%%' === $format && $width > 100 ) {
125 1
				$width = 100;
126
			}
127
128 1
			$width = sprintf( $format, $width );
129
		}
130
131 1
		return $width;
132
	}
133
134
	/**
135
	 * Fetch Field class
136
	 *
137
	 * @access public
138
	 * @static
139
	 * @param mixed $field
140
	 * @return string
141
	 */
142 1
	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...
143 1
		$gravityview_view = GravityView_View::getInstance();
144
145 1
		$classes = array();
146
147 1
		if( !empty( $field['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
148
149 1
            $custom_class = $field['custom_class'];
150
151 1
            if( !empty( $entry ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
152
153
                // We want the merge tag to be formatted as a class. The merge tag may be
154
                // replaced by a multiple-word value that should be output as a single class.
155
                // "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...
156 1
                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...
157
158 1
                $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...
159
160
                // And then we want life to return to normal
161 1
                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...
162
            }
163
164
			// And now we want the spaces to be handled nicely.
165 1
			$classes[] = gravityview_sanitize_html_class( $custom_class );
166
167
		}
168
169 1
		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...
introduced by
No space before closing parenthesis is prohibited
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...
170 1
			if( !empty( $form ) && !empty( $form['id'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
171 1
				$form_id = '-'.$form['id'];
172
			} else {
173
				$form_id = $gravityview_view->getFormId() ? '-'. $gravityview_view->getFormId() : '';
174
			}
175
176 1
			$classes[] = 'gv-field'.$form_id.'-'.$field['id'];
177
		}
178
179 1
		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...
180
	}
181
182
	/**
183
	 * Fetch Field HTML ID
184
	 *
185
	 * @since 1.11
186
	 *
187
	 * @access public
188
	 * @static
189
	 * @param array $field GravityView field array passed to gravityview_field_output()
190
	 * @param array $form Gravity Forms form array, if set.
191
	 * @param array $entry Gravity Forms entry array
192
	 * @return string Sanitized unique HTML `id` attribute for the field
193
	 */
194
	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...
195
		$gravityview_view = GravityView_View::getInstance();
196
		$id = $field['id'];
197
198
		if ( ! empty( $id ) ) {
199
			if ( ! empty( $form ) && ! empty( $form['id'] ) ) {
200
				$form_id = '-' . $form['id'];
201
			} else {
202
				$form_id = $gravityview_view->getFormId() ? '-' . $gravityview_view->getFormId() : '';
203
			}
204
205
			$id = 'gv-field' . $form_id . '-' . $field['id'];
206
		}
207
208
		return esc_attr( $id );
209
	}
210
211
212
	/**
213
	 * Given an entry and a form field id, calculate the entry value for that field.
214
	 *
215
	 * @access public
216
	 * @param array $entry
217
	 * @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...
218
	 * @return null|string
219
	 */
220
	public static function field_value( $entry, $field_settings, $format = 'html' ) {
221
222
		if( empty( $entry['form_id'] ) || empty( $field_settings['id'] ) ) {
223
			return NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
224
		}
225
226
		$gravityview_view = GravityView_View::getInstance();
227
228
		$field_id = $field_settings['id'];
229
		$form = $gravityview_view->getForm();
230
		$field = gravityview_get_field( $form, $field_id );
231
232
		if( $field && is_numeric( $field_id ) ) {
233
			// Used as file name of field template in GV.
234
			// Don't use RGFormsModel::get_input_type( $field ); we don't care if it's a radio input; we want to know it's a 'quiz' field
235
			$field_type = $field->type;
236
			$value = RGFormsModel::get_lead_field_value( $entry, $field );
237
		} else {
238
			$field = GravityView_Fields::get_associated_field( $field_id );
239
			$field_type = $field_id; // Used as file name of field template in GV
240
		}
241
242
		// If a Gravity Forms Field is found, get the field display
243
		if( $field ) {
244
245
			// Prevent any PHP warnings that may be generated
246
			ob_start();
247
248
			$display_value = GFCommon::get_lead_field_display( $field, $value, $entry["currency"], false, $format );
0 ignored issues
show
Bug introduced by
The variable $value does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
Coding Style Comprehensibility introduced by
The string literal currency does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
249
250
			if ( $errors = ob_get_clean() ) {
251
				do_action( 'gravityview_log_error', 'GravityView_API[field_value] Errors when calling GFCommon::get_lead_field_display()', $errors );
252
			}
253
254
			$display_value = apply_filters( "gform_entry_field_value", $display_value, $field, $entry, $form );
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal gform_entry_field_value does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
255
256
			// prevent the use of merge_tags for non-admin fields
257
			if( !empty( $field->adminOnly ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
258
				$display_value = self::replace_variables( $display_value, $form, $entry );
259
			}
260
		} else {
261
			$value = $display_value = rgar( $entry, $field_id );
262
			$display_value = $value;
263
		}
264
265
		// Check whether the field exists in /includes/fields/{$field_type}.php
266
		// This can be overridden by user template files.
267
		$field_path = $gravityview_view->locate_template("fields/{$field_type}.php");
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...
268
269
		// Set the field data to be available in the templates
270
		$gravityview_view->setCurrentField( array(
271
			'form' => $form,
272
			'field_id' => $field_id,
273
			'field' => $field,
274
			'field_settings' => $field_settings,
275
			'value' => $value,
276
			'display_value' => $display_value,
277
			'format' => $format,
278
			'entry' => $entry,
279
			'field_type' => $field_type, /** {@since 1.6} */
280
		    'field_path' => $field_path, /** {@since 1.16} */
281
		));
282
283
		if( ! empty( $field_path ) ) {
284
285
			do_action( 'gravityview_log_debug', sprintf('[field_value] Rendering %s', $field_path ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
286
287
			ob_start();
288
289
			load_template( $field_path, false );
290
291
			$output = ob_get_clean();
292
293
		} else {
294
295
			// Backup; the field template doesn't exist.
296
			$output = $display_value;
297
298
		}
299
300
		// Get the field settings again so that the field template can override the settings
301
		$field_settings = $gravityview_view->getCurrentField('field_settings');
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...
302
303
		/**
304
		 * @filter `gravityview_field_entry_value_{$field_type}_pre_link` Modify the field value output for a field type before Show As Link setting is applied. Example: `gravityview_field_entry_value_number_pre_link`
305
		 * @since 1.16
306
		 * @param string $output HTML value output
307
		 * @param array  $entry The GF entry array
308
		 * @param array  $field_settings Settings for the particular GV field
309
		 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
310
		 */
311
		$output = apply_filters( 'gravityview_field_entry_value_' . $field_type . '_pre_link', $output, $entry, $field_settings, $gravityview_view->getCurrentField() );
312
313
		/**
314
		 * @filter `gravityview_field_entry_value_pre_link` Modify the field value output for a field before Show As Link setting is applied. Example: `gravityview_field_entry_value_pre_link`
315
		 * @since 1.21.4
316
		 * @used-by GV_Inline_Edit
317
		 * @param string $output HTML value output
318
		 * @param array  $entry The GF entry array
319
		 * @param array  $field_settings Settings for the particular GV field
320
		 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
321
		 */
322
		$output = apply_filters( 'gravityview_field_entry_value_pre_link', $output, $entry, $field_settings, $gravityview_view->getCurrentField() );
323
324
		/**
325
		 * Link to the single entry by wrapping the output in an anchor tag
326
		 *
327
		 * Fields can override this by modifying the field data variable inside the field. See /templates/fields/post_image.php for an example.
328
		 *
329
		 */
330
		if( !empty( $field_settings['show_as_link'] ) && ! gv_empty( $output, false, false ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
331
332
			$link_atts = empty( $field_settings['new_window'] ) ? array() : array( 'target' => '_blank' );
333
334
			$output = self::entry_link_html( $entry, $output, $link_atts, $field_settings );
335
336
		}
337
338
		/**
339
		 * @filter `gravityview_field_entry_value_{$field_type}` Modify the field value output for a field type. Example: `gravityview_field_entry_value_number`
340
		 * @since 1.6
341
		 * @param string $output HTML value output
342
		 * @param array  $entry The GF entry array
343
		 * @param  array $field_settings Settings for the particular GV field
344
		 * @param array $field Current field being displayed
345
		 */
346
		$output = apply_filters( 'gravityview_field_entry_value_'.$field_type, $output, $entry, $field_settings, $gravityview_view->getCurrentField() );
347
348
		/**
349
		 * @filter `gravityview_field_entry_value` Modify the field value output for all field types
350
		 * @param string $output HTML value output
351
		 * @param array  $entry The GF entry array
352
		 * @param  array $field_settings Settings for the particular GV field
353
		 * @param array $field_data  {@since 1.6}
354
		 */
355
		$output = apply_filters( 'gravityview_field_entry_value', $output, $entry, $field_settings, $gravityview_view->getCurrentField() );
356
357
		return $output;
358
	}
359
360
	/**
361
	 * Generate an anchor tag that links to an entry.
362
	 *
363
	 * @since 1.6
364
	 * @see GVCommon::get_link_html()
365
	 *
366
	 * @param string $anchor_text The text or HTML inside the link
367
	 * @param array $entry Gravity Forms entry array
368
	 * @param array|string $passed_tag_atts Attributes to be added to the anchor tag, such as `title` or `rel`.
369
	 * @param array $field_settings Array of field settings. Optional, but passed to the `gravityview_field_entry_link` filter
370
	 *
371
	 * @return string|null Returns HTML for an anchor link. Null if $entry isn't defined or is missing an ID.
372
	 */
373 1
	public static function entry_link_html( $entry = array(), $anchor_text = '', $passed_tag_atts = array(), $field_settings = array() ) {
374
375 1
		if ( empty( $entry ) || ! is_array( $entry ) || ! isset( $entry['id'] ) ) {
376 1
			do_action( 'gravityview_log_debug', 'GravityView_API[entry_link_tag] Entry not defined; returning null', $entry );
377 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...
378
		}
379
380 1
		$href = self::entry_link( $entry );
381
382 1
		if( '' === $href ) {
383
			return NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
384
		}
385
386 1
		$link = gravityview_get_link( $href, $anchor_text, $passed_tag_atts );
387
388
		/**
389
		 * @filter `gravityview_field_entry_link` Modify the link HTML
390
		 * @param string $link HTML output of the link
391
		 * @param string $href URL of the link
392
		 * @param array  $entry The GF entry array
393
		 * @param  array $field_settings Settings for the particular GV field
394
		 */
395 1
		$output = apply_filters( 'gravityview_field_entry_link', $link, $href, $entry, $field_settings );
396
397 1
		return $output;
398
	}
399
400
	/**
401
	 * Get the "No Results" text depending on whether there were results.
402
	 * @param  boolean     $wpautop Apply wpautop() to the output?
403
	 * @return string               HTML of "no results" text
404
	 */
405 1
	public static function no_results($wpautop = true) {
406 1
		$gravityview_view = GravityView_View::getInstance();
407
408 1
		$is_search = false;
409
410 1
		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...
411 1
			$is_search = true;
412
		}
413
414 1
		if($is_search) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
415 1
			$output = __('This search returned no results.', 'gravityview');
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...
416
		} else {
417 1
			$output = __('No entries match your request.', 'gravityview');
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...
418
		}
419
420
		/**
421
		 * @filter `gravitview_no_entries_text` Modify the text displayed when there are no entries.
422
		 * @param string $output The existing "No Entries" text
423
		 * @param boolean $is_search Is the current page a search result, or just a multiple entries screen?
424
		 */
425 1
		$output = apply_filters( 'gravitview_no_entries_text', $output, $is_search);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
426
427 1
		return $wpautop ? wpautop($output) : $output;
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...
428
	}
429
430
	/**
431
	 * Generate a URL to the Directory context
432
	 *
433
	 * 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!
434
	 *
435
	 * @param int $post_id Post ID
436
	 * @param boolean $add_query_args Add pagination and sorting arguments
437
	 * @return string      Permalink to multiple entries view
438
	 */
439 4
	public static function directory_link( $post_id = NULL, $add_query_args = true ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
440 4
		global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
441
442 4
		$gravityview_view = GravityView_View::getInstance();
443
444 4
		if( empty( $post_id ) ) {
445
446 4
			$post_id = false;
447
448
			// DataTables passes the Post ID
449 4
			if( defined('DOING_AJAX') && DOING_AJAX ) {
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...
450
451
				$post_id = isset( $_POST['post_id'] ) ? (int)$_POST['post_id'] : false;
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
452
453
			} else {
454
455
				// The Post ID has been passed via the shortcode
456 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...
introduced by
Expected 1 space after "!"; 0 found
Loading history...
457
458 1
					$post_id = $gravityview_view->getPostId();
459
460
				} else {
461
462
					// This is a GravityView post type
463 3
					if( GravityView_frontend::getInstance()->isGravityviewPostType() ) {
464
465
						$post_id = isset( $gravityview_view ) ? $gravityview_view->getViewId() : $post->ID;
466
467
					} else {
468
469
						// This is an embedded GravityView; use the embedded post's ID as the base.
470 3
						if( GravityView_frontend::getInstance()->isPostHasShortcode() && is_a( $post, 'WP_Post' ) ) {
471
472
							$post_id = $post->ID;
473
474 3
						} elseif( $gravityview_view->getViewId() ) {
475
476
							// The GravityView has been embedded in a widget or in a template, and
477
							// is not in the current content. Thus, we defer to the View's own ID.
478 3
							$post_id = $gravityview_view->getViewId();
479
480
						}
481
482
					}
483
484
				}
485
			}
486
		}
487
488
		// No post ID, get outta here.
489 4
		if( empty( $post_id ) ) {
490
			return NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
491
		}
492
493
		// If we've saved the permalink in memory, use it
494
		// @since 1.3
495 4
		$link = wp_cache_get( 'gv_directory_link_'.$post_id );
496
497 4
		if( (int) $post_id === (int) get_option( 'page_on_front' ) ) {
498
			$link = home_url();
499
		}
500
501 4
		if( empty( $link ) ) {
502
503 4
			$link = get_permalink( $post_id );
504
505
			// If not yet saved, cache the permalink.
506
			// @since 1.3
507 4
			wp_cache_set( 'gv_directory_link_'.$post_id, $link );
508
509
		}
510
511
		// Deal with returning to proper pagination for embedded views
512 4
		if( $link && $add_query_args ) {
513
514 4
			$args = array();
515
516 4
			if( $pagenum = rgget('pagenum') ) {
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...
517 1
				$args['pagenum'] = intval( $pagenum );
518
			}
519
520 4
			if( $sort = rgget('sort') ) {
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...
521
				$args['sort'] = $sort;
522
				$args['dir'] = rgget('dir');
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...
523
			}
524
525 4
			$link = add_query_arg( $args, $link );
526
		}
527
528
		/**
529
		 * @filter `gravityview_directory_link` Modify the URL to the View "directory" context
530
		 * @since 1.19.4
531
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
532
		 * @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
533
		 */
534 4
		$link = apply_filters( 'gravityview_directory_link', $link, $post_id );
535
536 4
		return $link;
537
	}
538
539
	/**
540
	 * Calculate an *unique* hash for an entry based on the entry ID
541
	 *
542
	 * 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.
543
	 *
544
	 * The hashed value MUST be unique, otherwise multiple entries will share the same URL, which leads to obvious problems.
545
	 *
546
	 * @param  int|string $id Entry ID to generate the hash for.
547
	 * @param  array  $entry        Entry data passed to provide additional information when generating the hash. Optional - don't rely on it being available.
548
	 * @return string               Hashed unique value for entry
549
	 */
550
	private static function get_custom_entry_slug( $id, $entry = array() ) {
551
552
		// Generate an unique hash to use as the default value
553
		$slug = substr( wp_hash( $id, 'gravityview'.$id ), 0, 8 );
554
555
		/**
556
		 * @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}`
557
		 * @param string $hash Existing hash generated by GravityView
558
		 * @param  string $id The entry ID
559
		 * @param  array $entry Entry data array. May be empty.
560
		 */
561
		$slug = apply_filters( 'gravityview_entry_slug', $slug, $id, $entry );
562
563
		// Make sure we have something - use the original ID as backup.
564
		if( empty( $slug ) ) {
565
			$slug = $id;
566
		}
567
568
		return sanitize_title( $slug );
569
	}
570
571
	/**
572
	 * Get the entry slug for the entry. By default, it is the entry ID.
573
	 *
574
	 *
575
	 * @see gravityview_get_entry()
576
	 * @uses GravityView_API::get_custom_entry_slug() If using custom slug, gets the custom slug value
577
	 * @since 1.4
578
	 * @param  int|string $id_or_string ID of the entry, or custom slug string
579
	 * @param  array  $entry        Gravity Forms Entry array, optional. Used only to provide data to customize the `gravityview_entry_slug` filter
580
	 * @return string               Unique slug ID, passed through `sanitize_title()`
581
	 */
582 3
	public static function get_entry_slug( $id_or_string, $entry = array() ) {
583
584
		/**
585
		 * Default: use the entry ID as the unique identifier
586
		 */
587 3
		$slug = $id_or_string;
588
589
		/**
590
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
591
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
592
		 */
593 3
		$custom = apply_filters('gravityview_custom_entry_slug', false );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
594
595
		// If we're using custom slug...
596 3
		if ( $custom ) {
597
598
			// Get the entry hash
599
			$hash = self::get_custom_entry_slug( $id_or_string, $entry );
600
601
			// See if the entry already has a hash set
602
			$value = gform_get_meta( $id_or_string, 'gravityview_unique_id' );
603
604
			// If it does have a hash set, and the hash is expected, use it.
605
			// This check allows users to change the hash structure using the
606
			// gravityview_entry_hash filter and have the old hashes expire.
607
			if( empty( $value ) || $value !== $hash ) {
608
				do_action( 'gravityview_log_debug', __METHOD__ . ' - Setting hash for entry "'.$id_or_string.'": ' . $hash );
609
				gform_update_meta( $id_or_string, 'gravityview_unique_id', $hash, rgar( $entry, 'form_id' ) );
610
			}
611
612
			$slug = $hash;
613
614
			unset( $value, $hash );
615
		}
616
617 3
		return sanitize_title( $slug );
618
	}
619
620
    /**
621
     * If using the entry custom slug feature, make sure the new entries have the custom slug created and saved as meta
622
     *
623
     * Triggered by add_action( 'gform_entry_created', array( 'GravityView_API', 'entry_create_custom_slug' ), 10, 2 );
624
     *
625
     * @param $entry array Gravity Forms entry object
626
     * @param $form array Gravity Forms form object
627
     */
628
    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...
629
        /**
630
         * @filter `gravityview_custom_entry_slug` On entry creation, check if we are using the custom entry slug feature and update the meta
631
         * @param boolean $custom Should we process the custom entry slug?
632
         */
633
        $custom = apply_filters( 'gravityview_custom_entry_slug', false );
634
        if( $custom ) {
635
            // create the gravityview_unique_id and save it
636
637
            // Get the entry hash
638
            $hash = self::get_custom_entry_slug( $entry['id'], $entry );
639
640
	        do_action( 'gravityview_log_debug', __METHOD__ . ' - Setting hash for entry "'.$entry['id'].'": ' . $hash );
641
642
            gform_update_meta( $entry['id'], 'gravityview_unique_id', $hash, rgar( $entry, 'form_id' ) );
643
644
        }
645
    }
646
647
648
649
650
	/**
651
	 * return href for single entry
652
	 * @param  array|int $entry   Entry array or entry ID
653
	 * @param  int|null $post_id If wanting to define the parent post, pass a post ID
654
	 * @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}
655
	 * @return string          Link to the entry with the directory parent slug
656
	 */
657 1
	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...
658
659 1
		if( ! empty( $entry ) && ! is_array( $entry ) ) {
660
			$entry = GVCommon::get_entry( $entry );
661 1
		} else if( empty( $entry ) ) {
662
			$entry = GravityView_frontend::getInstance()->getEntry();
663
		}
664
665
		// Second parameter used to be passed as $field; this makes sure it's not an array
666 1
		if( !is_numeric( $post_id ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
667
			$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...
668
		}
669
670
		// Get the permalink to the View
671 1
		$directory_link = self::directory_link( $post_id, false );
672
673
		// No post ID? Get outta here.
674 1
		if( empty( $directory_link ) ) {
675
			return '';
676
		}
677
678 1
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
679 1
			$query_arg_name = \GV\Entry::get_endpoint_name();
680
		} else {
681
			/** Deprecated. Use \GV\Entry::get_endpoint_name instead. */
682
			$query_arg_name = GravityView_Post_Types::get_entry_var_name();
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_Post_Types::get_entry_var_name() has been deprecated.

This method has been deprecated.

Loading history...
683
		}
684
685 1
		$entry_slug = self::get_entry_slug( $entry['id'], $entry );
686
687 1
		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...
688
689
			$args = array();
690
691
			/**
692
			 * Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
693
			 * @since 1.16.5
694
			 */
695
			$link_parts = explode( '?', $directory_link );
696
697
			$query = !empty( $link_parts[1] ) ? '?'.$link_parts[1] : '';
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
698
699
			$directory_link = trailingslashit( $link_parts[0] ) . $query_arg_name . '/'. $entry_slug .'/' . $query;
700
701
		} else {
702
703 1
			$args = array( $query_arg_name => $entry_slug );
704
		}
705
706
		/**
707
		 * @since 1.7.3
708
		 */
709 1
		if( $add_directory_args ) {
710
711 1
			if( !empty( $_GET['pagenum'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
712
				$args['pagenum'] = intval( $_GET['pagenum'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
713
			}
714
715
			/**
716
			 * @since 1.7
717
			 */
718 1
			if( $sort = rgget('sort') ) {
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...
719
				$args['sort'] = $sort;
720
				$args['dir'] = rgget('dir');
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...
721
			}
722
723
		}
724
725
		/**
726
		 * Check if we have multiple views embedded in the same page and in that case make sure the single entry link
727
		 * has the view id so that Advanced Filters can be applied correctly when rendering the single view
728
		 * @see GravityView_frontend::get_context_view_id()
729
		 */
730 1
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
731 1
			if ( gravityview()->views->count() > 1 ) {
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
732 1
				$args['gvid'] = gravityview_get_view_id();
733
			}
734
		} else {
735
			/** Deprecated, do not use has_multiple_views(), please. */
736
			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...
737
				$args['gvid'] = gravityview_get_view_id();
738
			}
739
		}
740
741 1
		return add_query_arg( $args, $directory_link );
742
743
	}
744
745
746
}
747
748
749
// inside loop functions
750
751
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...
752
	return GravityView_API::field_label( $field, $entry );
753
}
754
755
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...
756
	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...
757
}
758
759
/**
760
 * Generate a CSS class to be added to the wrapper <div> of a View
761
 *
762
 * @since 1.5.4
763
 * @since 1.16 Added $echo param
764
 *
765
 * @param string $passed_css_class Default: `gv-container gv-container-{view id}`. If View is hidden until search, adds ` hidden`
766
 * @param boolean $echo Whether to echo the output. Default: true
767
 *
768
 * @return string CSS class, sanitized by gravityview_sanitize_html_class()
769
 */
770
function gv_container_class( $passed_css_class = '', $echo = true ) {
771
772 1
	$passed_css_class = trim( $passed_css_class );
773
774 1
	$view_id = GravityView_View::getInstance()->getViewId();
775
776 1
	$default_css_class = ! empty( $view_id ) ? sprintf( 'gv-container gv-container-%d', $view_id ) : 'gv-container';
777
778 1
	if( GravityView_View::getInstance()->isHideUntilSearched() ) {
779 1
		$default_css_class .= ' hidden';
780
	}
781
782 1
	if( 0 === GravityView_View::getInstance()->getTotalEntries() ) {
783 1
		$default_css_class .= ' gv-container-no-results';
784
	}
785
786 1
	$css_class = trim( $passed_css_class . ' '. $default_css_class );
787
788
	/**
789
	 * @filter `gravityview/render/container/class` Modify the CSS class to be added to the wrapper <div> of a View
790
	 * @since 1.5.4
791
	 * @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`
792
	 */
793 1
	$css_class = apply_filters( 'gravityview/render/container/class', $css_class );
794
795 1
	$css_class = gravityview_sanitize_html_class( $css_class );
796
797 1
	if( $echo ) {
798 1
		echo $css_class;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$css_class'
Loading history...
799
	}
800
801 1
	return $css_class;
802
}
803
804
function gv_value( $entry, $field ) {
805
806
	$value = GravityView_API::field_value( $entry, $field );
807
808
	if( $value === '' ) {
809
		/**
810
		 * @filter `gravityview_empty_value` What to display when a field is empty
811
		 * @param string $value (empty string)
812
		 */
813
		$value = apply_filters( 'gravityview_empty_value', '' );
814
	}
815
816
	return $value;
817
}
818
819
function gv_directory_link( $post = NULL, $add_pagination = true ) {
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...
820
	return GravityView_API::directory_link( $post, $add_pagination );
821
}
822
823
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...
824
	return GravityView_API::entry_link( $entry, $post_id );
825
}
826
827
function gv_no_results($wpautop = true) {
828
	return GravityView_API::no_results( $wpautop );
829
}
830
831
/**
832
 * Generate HTML for the back link from single entry view
833
 * @since 1.0.1
834
 * @return string|null      If no GV post exists, null. Otherwise, HTML string of back link.
835
 */
836
function gravityview_back_link() {
837
838
	$href = gv_directory_link();
839
840
	/**
841
	 * @filter `gravityview_go_back_url` Modify the back link URL
842
	 * @since 1.17.5
843
	 * @see gv_directory_link() Generated the original back link
844
	 * @param string $href Existing label URL
845
	 */
846
	$href = apply_filters( 'gravityview_go_back_url', $href );
847
848
	if( empty( $href ) ) { return NULL; }
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
849
850
	// calculate link label
851
	$gravityview_view = GravityView_View::getInstance();
852
853
	$label = $gravityview_view->getBackLinkLabel() ? $gravityview_view->getBackLinkLabel() : __( '&larr; Go back', 'gravityview' );
854
855
	/**
856
	 * @filter `gravityview_go_back_label` Modify the back link text
857
	 * @since 1.0.9
858
	 * @param string $label Existing label text
859
	 */
860
	$label = apply_filters( 'gravityview_go_back_label', $label );
861
862
	$link = gravityview_get_link( $href, esc_html( $label ), array(
863
		'data-viewid' => $gravityview_view->getViewId()
864
	));
865
866
	return $link;
867
}
868
869
/**
870
 * Handle getting values for complex Gravity Forms fields
871
 *
872
 * If the field is complex, like a product, the field ID, for example, 11, won't exist. Instead,
873
 * it will be 11.1, 11.2, and 11.3. This handles being passed 11 and 11.2 with the same function.
874
 *
875
 * @since 1.0.4
876
 * @param  array      $entry    GF entry array
877
 * @param  string      $field_id [description]
878
 * @param  string 	$display_value The value generated by Gravity Forms
879
 * @return string                Value
880
 */
881
function gravityview_get_field_value( $entry, $field_id, $display_value ) {
882
883
	if( floatval( $field_id ) === floor( floatval( $field_id ) ) ) {
884
885
		// For the complete field value as generated by Gravity Forms
886
		return $display_value;
887
888
	} else {
889
890
		// For one part of the address (City, ZIP, etc.)
891
		return isset( $entry[ $field_id ] ) ? $entry[ $field_id ] : '';
892
893
	}
894
895
}
896
897
/**
898
 * Take a passed CSV of terms and generate a linked list of terms
899
 *
900
 * Gravity Forms passes categories as "Name:ID" so we handle that using the ID, which
901
 * is more accurate than checking the name, which is more likely to change.
902
 *
903
 * @param  string      $value    Existing value
904
 * @param  string      $taxonomy Type of term (`post_tag` or `category`)
905
 * @return string                CSV of linked terms
906
 */
907
function gravityview_convert_value_to_term_list( $value, $taxonomy = 'post_tag' ) {
908
909
	$output = array();
910
911
	if ( is_array( $value ) ) {
912
		$terms = array_filter( array_values( $value ), 'strlen' );
913
	} else {
914
		$terms = explode( ', ', $value );
915
	}
916
917
	foreach ($terms as $term_name ) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
918
919
		// If we're processing a category,
920
		if( $taxonomy === 'category' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
921
922
			// Use rgexplode to prevent errors if : doesn't exist
923
			list( $term_name, $term_id ) = rgexplode( ':', $term_name, 2 );
924
925
			// The explode was succesful; we have the category ID
926
			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...
927
				$term = get_term_by( 'id', $term_id, $taxonomy );
928
			} else {
929
			// We have to fall back to the name
930
				$term = get_term_by( 'name', $term_name, $taxonomy );
931
			}
932
933
		} else {
934
			// Use the name of the tag to get the full term information
935
			$term = get_term_by( 'name', $term_name, $taxonomy );
936
		}
937
938
		// There's still a tag/category here.
939
		if( $term ) {
940
941
			$term_link = get_term_link( $term, $taxonomy );
942
943
			// If there was an error, continue to the next term.
944
			if ( is_wp_error( $term_link ) ) {
945
			    continue;
946
			}
947
948
			$output[] = gravityview_get_link( $term_link, esc_html( $term->name ) );
949
		}
950
	}
951
952
	return implode(', ', $output );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
953
}
954
955
/**
956
 * Get the links for post_tags and post_category output based on post ID
957
 * @param  int      $post_id  The ID of the post
958
 * @param  boolean     $link     Add links or no?
959
 * @param  string      $taxonomy Taxonomy of term to fetch.
960
 * @return string                String with terms
961
 */
962
function gravityview_get_the_term_list( $post_id, $link = true, $taxonomy = 'post_tag' ) {
963
964
	$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...
965
966
	if( empty( $link ) ) {
967
		return strip_tags( $output);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
968
	}
969
970
	return $output;
971
972
}
973
974
975
/**
976
 * Get all views processed so far for the current page load
977
 *
978
 * @see  GravityView_View_Data::add_view()
979
 * @return array Array of View data, each View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
980
 */
981
function gravityview_get_current_views() {
982
983 1
	$fe = GravityView_frontend::getInstance();
984
985
	// Solve problem when loading content via admin-ajax.php
986 1
	if( ! $fe->getGvOutputData() ) {
987
988 1
		do_action( 'gravityview_log_debug', '[gravityview_get_current_views] gv_output_data not defined; parsing content.' );
989
990 1
		$fe->parse_content();
991
	}
992
993
	// Make 100% sure that we're dealing with a properly called situation
994 1
	if( !is_a( $fe->getGvOutputData(), 'GravityView_View_Data' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
995
996
		do_action( 'gravityview_log_debug', '[gravityview_get_current_views] gv_output_data not an object or get_view not callable.', $fe->getGvOutputData() );
997
998
		return array();
999
	}
1000
1001 1
	if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1002 1
		if ( ! gravityview()->views->count() ) {
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1003
			return array();
1004
		}
1005 1
		return array_combine(
1006
			array_map( function ( $view ) { return $view->ID; }, gravityview()->views->all() ),
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1007
			array_map( function ( $view ) { return $view->as_data(); }, gravityview()->views->all() )
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1008
		);
1009
	}
1010
	/** \GravityView_View_Data::get_views is deprecated. */
1011
	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...
1012
}
1013
1014
/**
1015
 * Get data for a specific view
1016
 *
1017
 * @see  GravityView_View_Data::get_view()
1018
 * @return array View data with `id`, `view_id`, `form_id`, `template_id`, `atts`, `fields`, `widgets`, `form` keys.
1019
 */
1020
function gravityview_get_current_view_data( $view_id = 0 ) {
1021
1022
	$fe = GravityView_frontend::getInstance();
1023
1024
	// If not set, grab the current view ID
1025
	if ( empty( $view_id ) ) {
1026
		$view_id = $fe->get_context_view_id();
1027
	}
1028
1029
	if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1030
		$view = gravityview()->views->get( $view_id );
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1031
		if ( ! $view ) {
1032
			/** Emulate the weird behavior of \GravityView_View_Data::get_view adding a view which wasn't there to begin with. */
1033
			gravityview()->views->add( \GV\View::by_id( $view_id ) );
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1034
			$view = gravityview()->views->get( $view_id );
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1035
		}
1036
		return $view ? $view->as_data() : array();
1037
	} else {
1038
		if ( ! $fe->getGvOutputData() ) { return array(); }
1039
1040
		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...
1041
	}
1042
}
1043
1044
// Templates' hooks
1045
function gravityview_before() {
1046
	/**
1047
	 * @action `gravityview_before` Display content before a View. Used to render widget areas. Rendered outside the View container `<div>`
1048
	 * @param int $view_id The ID of the View being displayed
1049
	 */
1050
	do_action( 'gravityview_before', gravityview_get_view_id() );
1051
}
1052
1053
function gravityview_header() {
1054
	/**
1055
	 * @action `gravityview_header` Prepend content to the View container `<div>`
1056
	 * @param int $view_id The ID of the View being displayed
1057
	 */
1058
	do_action( 'gravityview_header', gravityview_get_view_id() );
1059
}
1060
1061
function gravityview_footer() {
1062
	/**
1063
	 * @action `gravityview_after` Display content after a View. Used to render footer widget areas. Rendered outside the View container `<div>`
1064
	 * @param int $view_id The ID of the View being displayed
1065
	 */
1066
	do_action( 'gravityview_footer', gravityview_get_view_id() );
1067
}
1068
1069
function gravityview_after() {
1070
	/**
1071
	 * @action `gravityview_after` Append content to the View container `<div>`
1072
	 * @param int $view_id The ID of the View being displayed
1073
	 */
1074
	do_action( 'gravityview_after', gravityview_get_view_id() );
1075
}
1076
1077
/**
1078
 * Get the current View ID being rendered
1079
 *
1080
 * @global GravityView_View $gravityview_view
1081
 * @return string View context "directory" or "single"
1082
 */
1083
function gravityview_get_view_id() {
1084
	return GravityView_View::getInstance()->getViewId();
1085
}
1086
1087
/**
1088
 * @global GravityView_View $gravityview_view
1089
 * @return string View context "directory", "single", or "edit"
1090
 */
1091
function gravityview_get_context() {
1092
1093
	$context = '';
1094
1095
	/**
1096
	 * @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
1097
	 * The Edit Entry functionality overrides this value.
1098
	 * @param boolean $is_edit_entry
1099
	 */
1100
	$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );
1101
1102
	if( $is_edit_entry ) {
1103
		$context = 'edit';
1104
	} else if( class_exists( 'GravityView_frontend' ) && $single = GravityView_frontend::is_single_entry() ) {
1105
		$context = 'single';
1106
	} else if( class_exists( 'GravityView_View' ) ) {
1107
		$context = GravityView_View::getInstance()->getContext();
1108
	}
1109
1110
	return $context;
1111
}
1112
1113
1114
/**
1115
 * Return an array of files prepared for output. Wrapper for GravityView_Field_FileUpload::get_files_array()
1116
 *
1117
 * Processes files by file type and generates unique output for each.
1118
 *
1119
 * Returns array for each file, with the following keys:
1120
 *
1121
 * `file_path` => The file path of the file, with a line break
1122
 * `html` => The file output HTML formatted
1123
 *
1124
 * @see GravityView_Field_FileUpload::get_files_array()
1125
 *
1126
 * @since  1.2
1127
 * @param  string $value    Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
1128
 * @param  string $gv_class Field class to add to the output HTML
1129
 * @return array           Array of file output, with `file_path` and `html` keys (see comments above)
1130
 */
1131
function gravityview_get_files_array( $value, $gv_class = '' ) {
1132
	/** @define "GRAVITYVIEW_DIR" "../" */
1133
1134
	if( !class_exists( 'GravityView_Field' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1135
		include_once( GRAVITYVIEW_DIR .'includes/fields/class-gravityview-field.php' );
1136
	}
1137
1138
	if( !class_exists( 'GravityView_Field_FileUpload' ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1139
		include_once( GRAVITYVIEW_DIR .'includes/fields/fileupload.php' );
1140
	}
1141
1142
	return GravityView_Field_FileUpload::get_files_array( $value, $gv_class );
1143
}
1144
1145
/**
1146
 * Generate a mapping link from an address
1147
 *
1148
 * The address should be plain text with new line (`\n`) or `<br />` line breaks separating sections
1149
 *
1150
 * @todo use GF's field get_export_value() instead
1151
 *
1152
 * @see https://gravityview.co/support/documentation/201608159 Read how to modify the link
1153
 * @param  string $address Address
1154
 * @return string          URL of link to map of address
1155
 */
1156
function gravityview_get_map_link( $address ) {
1157
1158
	$address_qs = str_replace( array( '<br />', "\n" ), ' ', $address ); // Replace \n with spaces
1159
	$address_qs = urlencode( $address_qs );
1160
1161
	$url = "https://maps.google.com/maps?q={$address_qs}";
1162
1163
	$link_text = esc_html__( 'Map It', 'gravityview' );
1164
1165
	$link = gravityview_get_link( $url, $link_text, 'class=map-it-link' );
1166
1167
	/**
1168
	 * @filter `gravityview_map_link` Modify the map link generated. You can use a different mapping service, for example.
1169
	 * @param[in,out]  string $link Map link
1170
	 * @param[in] string $address Address to generate link for
1171
	 * @param[in] string $url URL generated by the function
1172
	 */
1173
	$link = apply_filters( 'gravityview_map_link', $link, $address, $url );
1174
1175
	return $link;
1176
}
1177
1178
1179
/**
1180
 * Output field based on a certain html markup
1181
 *
1182
 *   markup - string to be used on a sprintf statement.
1183
 *      Use:
1184
 *         {{label}} - field label
1185
 *         {{value}} - entry field value
1186
 *         {{class}} - field class
1187
 *
1188
 *   wpautop - true will filter the value using wpautop function
1189
 *
1190
 * @since  1.1.5
1191
 * @param  array $passed_args Associative array with field data. `field` and `form` are required.
1192
 * @return string Field output. If empty value and hide empty is true, return empty.
1193
 */
1194
function gravityview_field_output( $passed_args ) {
1195
	$defaults = array(
1196
		'entry' => null,
1197
		'field' => null,
1198
		'form' => null,
1199
		'hide_empty' => true,
1200
		'markup' => '<div id="{{ field_id }}" class="{{ class }}">{{label}}{{value}}</div>',
1201
		'label_markup' => '',
1202
		'wpautop' => false,
1203
		'zone_id' => null,
1204
	);
1205
1206
	$args = wp_parse_args( $passed_args, $defaults );
1207
1208
	/**
1209
	 * @filter `gravityview/field_output/args` Modify the args before generation begins
1210
	 * @since 1.7
1211
	 * @param array $args Associative array; `field` and `form` is required.
1212
	 * @param array $passed_args Original associative array with field data. `field` and `form` are required.
1213
	 */
1214
	$args = apply_filters( 'gravityview/field_output/args', $args, $passed_args );
1215
1216
	// Required fields.
1217
	if ( empty( $args['field'] ) || empty( $args['form'] ) ) {
1218
		do_action( 'gravityview_log_error', '[gravityview_field_output] Field or form are empty.', $args );
1219
		return '';
1220
	}
1221
1222
	$entry = empty( $args['entry'] ) ? array() : $args['entry'];
1223
1224
	/**
1225
	 * Create the content variables for replacing.
1226
	 * @since 1.11
1227
	 */
1228
	$context = array(
1229
		'value' => '',
1230
		'width' => '',
1231
		'width:style' => '',
1232
		'label' => '',
1233
		'label_value' => '',
1234
		'class' => '',
1235
		'field_id' => '',
1236
	);
1237
1238
	$context['value'] = gv_value( $entry, $args['field'] );
1239
1240
	// If the value is empty and we're hiding empty, return empty.
1241
	if ( $context['value'] === '' && ! empty( $args['hide_empty'] ) ) {
1242
		return '';
1243
	}
1244
1245
	if ( $context['value'] !== '' && ! empty( $args['wpautop'] ) ) {
1246
		$context['value'] = wpautop( $context['value'] );
1247
	}
1248
1249
	// Get width setting, if exists
1250
	$context['width'] = GravityView_API::field_width( $args['field'] );
1251
1252
	// If replacing with CSS inline formatting, let's do it.
1253
	$context['width:style'] = GravityView_API::field_width( $args['field'], 'width:' . $context['width'] . '%;' );
1254
1255
	// Grab the Class using `gv_class`
1256
	$context['class'] = gv_class( $args['field'], $args['form'], $entry );
1257
	$context['field_id'] = GravityView_API::field_html_attr_id( $args['field'], $args['form'], $entry );
1258
1259
	// Get field label if needed
1260
	if ( ! empty( $args['label_markup'] ) && ! empty( $args['field']['show_label'] ) ) {
1261
		$context['label'] = str_replace( array( '{{label}}', '{{ label }}' ), '<span class="gv-field-label">{{ label_value }}</span>', $args['label_markup'] );
1262
	}
1263
1264
	// Default Label value
1265
	$context['label_value'] = gv_label( $args['field'], $entry );
1266
1267
	if ( empty( $context['label'] ) && ! empty( $context['label_value'] ) ){
1268
		$context['label'] = '<span class="gv-field-label">{{ label_value }}</span>';
1269
	}
1270
1271
	/**
1272
	 * @filter `gravityview/field_output/pre_html` Allow Pre filtering of the HTML
1273
	 * @since 1.11
1274
	 * @param string $markup The HTML for the markup
1275
	 * @param array $args All args for the field output
1276
	 */
1277
	$html = apply_filters( 'gravityview/field_output/pre_html', $args['markup'], $args );
1278
1279
	/**
1280
	 * @filter `gravityview/field_output/open_tag` Modify the opening tags for the template content placeholders
1281
	 * @since 1.11
1282
	 * @param string $open_tag Open tag for template content placeholders. Default: `{{`
1283
	 */
1284
	$open_tag = apply_filters( 'gravityview/field_output/open_tag', '{{', $args );
1285
1286
	/**
1287
	 * @filter `gravityview/field_output/close_tag` Modify the closing tags for the template content placeholders
1288
	 * @since 1.11
1289
	 * @param string $close_tag Close tag for template content placeholders. Default: `}}`
1290
	 */
1291
	$close_tag = apply_filters( 'gravityview/field_output/close_tag', '}}', $args );
1292
1293
	/**
1294
	 * Loop through each of the tags to replace and replace both `{{tag}}` and `{{ tag }}` with the values
1295
	 * @since 1.11
1296
	 */
1297
	foreach ( $context as $tag => $value ) {
1298
1299
		// If the tag doesn't exist just skip it
1300
		if ( false === strpos( $html, $open_tag . $tag . $close_tag ) && false === strpos( $html, $open_tag . ' ' . $tag . ' ' . $close_tag ) ){
1301
			continue;
1302
		}
1303
1304
		// Array to search
1305
		$search = array(
1306
			$open_tag . $tag . $close_tag,
1307
			$open_tag . ' ' . $tag . ' ' . $close_tag,
1308
		);
1309
1310
		/**
1311
		 * `gravityview/field_output/context/{$tag}` Allow users to filter content on context
1312
		 * @since 1.11
1313
		 * @param string $value The content to be shown instead of the {{tag}} placeholder
1314
		 * @param array $args Arguments passed to the function
1315
		 */
1316
		$value = apply_filters( 'gravityview/field_output/context/' . $tag, $value, $args );
1317
1318
		// Finally do the replace
1319
		$html = str_replace( $search, $value, $html );
1320
	}
1321
1322
	/**
1323
	 * @todo  Depricate `gravityview_field_output`
1324
	 */
1325
	$html = apply_filters( 'gravityview_field_output', $html, $args );
1326
1327
	/**
1328
	 * @filter `gravityview/field_output/html` Modify field HTML output
1329
	 * @param string $html Existing HTML output
1330
	 * @param array $args Arguments passed to the function
1331
	 */
1332
	$html = apply_filters( 'gravityview/field_output/html', $html, $args );
1333
1334
	// Just free up a tiny amount of memory
1335
	unset( $value, $args, $passed_args, $entry, $context, $search, $open_tag, $tag, $close_tag );
1336
1337
	return $html;
1338
}
1339