GravityView  1.19.4
The best, easiest way to display Gravity Forms entries on your website.
helper-functions.php
Go to the documentation of this file.
1 <?php
2 /**
3  * Functions that don't require GravityView or Gravity Forms API access but are used in the plugin to extend PHP and WP functions
4  * @since 1.12
5  */
6 
7 
8 /**
9  * Get the URL for a CSS file
10  *
11  * If there's a CSS file with the same name as a GravityView CSS file in the current theme directory, it will be used.
12  * Place the CSS file in a `/gravityview/css/` sub-directory.
13  *
14  * Example: /twentysixteen/gravityview/css/gv-default-styles.css
15  *
16  * Will use, in order:
17  * 1) [theme directory]/gravityview/css/
18  * 2) [gravityview plugin]/css/ (no check performed)
19  *
20  * @since 1.17
21  *
22  * @uses get_stylesheet_directory()
23  * @uses get_stylesheet_directory_uri()
24  *
25  * @param string $css_file Filename of the CSS file (like gv-default-styles.css)
26  * @param string $dir_path Absolute path to the directory where the CSS file is stored. If empty, uses default GravityView templates CSS folder.
27  *
28  * @return string URL path to the file.
29  */
30 function gravityview_css_url( $css_file = '', $dir_path = '' ) {
31 
32  // If there's an overriding CSS file in the current template folder, use it.
33  $template_css_path = trailingslashit( get_stylesheet_directory() ) . 'gravityview/css/' . $css_file;
34 
35  if( file_exists( $template_css_path ) ) {
36  $path = trailingslashit( get_stylesheet_directory_uri() ) . 'gravityview/css/' . $css_file;
37  do_action( 'gravityview_log_debug', __FUNCTION__ . ': Stylesheet override ('. esc_attr( $css_file ) .')' );
38  } else {
39  // Default: use GravityView CSS file
40 
41  // If no path is provided, assume default plugin templates CSS folder
42  if( '' === $dir_path ) {
43  $dir_path = GRAVITYVIEW_DIR . 'templates/css/';
44  }
45 
46  // plugins_url() expects a path to a file, not directory. We append a file to be stripped.
47  $path = plugins_url( $css_file, trailingslashit( $dir_path ) . 'stripped-by-plugin_basename.php' );
48  }
49 
50  return $path;
51 }
52 
53 /**
54  * Check whether a variable is not an empty string
55  *
56  * @see /templates/fields/product.php Used to check whether the product array is empty or not
57  *
58  * @since 1.12
59  *
60  * @param mixed $mixed Variable to check
61  *
62  * @return bool true: $mixed is *not* an empty string; false: $mixed *is* an empty string
63  */
64 function gravityview_is_not_empty_string( $mixed = '' ) {
65  return ( $mixed !== '' );
66 }
67 
68 /**
69  * Get `get_permalink()` without the home_url() prepended to it.
70  *
71  * get_permalink() does a lot of good stuff: it gets the correct permalink structure for custom post types, pages,
72  * posts, etc. Instead of using `?p={id}`, `?page_id={id}`, or `?p={id}&post_type={post_type}`, by using
73  * get_permalink(), we can use `?p=slug` or `?gravityview={slug}`
74  *
75  * We could do this in a cleaner fashion, but this prevents a lot of code duplication, checking for URL structure, etc.
76  *
77  * @param int|WP_Post $id Optional. Post ID or post object. Default current post.
78  *
79  * @return array URL args, if exists. Empty array if not.
80  */
82 
83  $parsed_permalink = parse_url( get_permalink( $id ) );
84 
85  $permalink_args = isset( $parsed_permalink['query'] ) ? $parsed_permalink['query'] : false;
86 
87  if( empty( $permalink_args ) ) {
88  return array();
89  }
90 
91  parse_str( $permalink_args, $args );
92 
93  return $args;
94 }
95 
96 
97 /**
98  * Similar to the WordPress `selected()`, `checked()`, and `disabled()` functions, except it allows arrays to be passed as current value
99  *
100  * @see selected() WordPress core function
101  *
102  * @param string $value One of the values to compare
103  * @param mixed $current (true) The other value to compare if not just true
104  * @param bool $echo Whether to echo or just return the string
105  * @param string $type The type of checked|selected|disabled we are doing
106  *
107  * @return string html attribute or empty string
108  */
109 function gv_selected( $value, $current, $echo = true, $type = 'selected' ) {
110 
111  $output = '';
112  if( is_array( $current ) ) {
113  if( in_array( $value, $current ) ) {
114  $output = __checked_selected_helper( true, true, false, $type );
115  }
116  } else {
117  $output = __checked_selected_helper( $value, $current, false, $type );
118  }
119 
120  if( $echo ) {
121  echo $output;
122  }
123 
124  return $output;
125 }
126 
127 
128 if( ! function_exists( 'gravityview_sanitize_html_class' ) ) {
129 
130  /**
131  * sanitize_html_class doesn't handle spaces (multiple classes). We remedy that.
132  *
133  * @uses sanitize_html_class
134  *
135  * @param string|array $classes Text or array of classes to sanitize
136  *
137  * @return string Sanitized CSS string
138  */
139  function gravityview_sanitize_html_class( $classes ) {
140 
141  if ( is_string( $classes ) ) {
142  $classes = explode( ' ', $classes );
143  }
144 
145  // If someone passes something not string or array, we get outta here.
146  if ( ! is_array( $classes ) ) {
147  return $classes;
148  }
149 
150  $classes = array_map( 'trim', $classes );
151  $classes = array_map( 'sanitize_html_class', $classes );
152  $classes = array_filter( $classes );
153 
154  return implode( ' ', $classes );
155  }
156 }
157 
158 /**
159  * Replace multiple newlines, tabs, and spaces with a single space
160  *
161  * First, runs normalize_whitespace() on a string. This replaces multiple lines with a single line, and tabs with spaces.
162  * We then strip any tabs or newlines and replace *those* with a single space.
163  *
164  * @see normalize_whitespace()
165  * @see GravityView_Helper_Functions_Test::test_gravityview_strip_whitespace
166  * @since 1.13
167  *
168  * @param string $string String to strip whitespace from
169  *
170  * @return string Stripped string!
171  */
172 function gravityview_strip_whitespace( $string ) {
173  $string = normalize_whitespace( $string );
174  return preg_replace('/[\r\n\t ]+/', ' ', $string );
175 }
176 
177 /**
178  * Get the contents of a file using `include()` and `ob_start()`
179  *
180  * @since 1.13
181  * @since 1.15 Added $object param
182  *
183  * @param string $file_path Full path to a file
184  * @param mixed $object Pass pseudo-global to the included file
185  * @return string Included file contents
186  */
187 function gravityview_ob_include( $file_path, $object = NULL ) {
188  if( ! file_exists( $file_path ) ) {
189  do_action( 'gravityview_log_error', __FUNCTION__ . ': File path does not exist. ', $file_path );
190  return '';
191  }
192  ob_start();
193  include( $file_path );
194  return ob_get_clean();
195 }
196 
197 /**
198  * Get an image of our intrepid explorer friend
199  * @since 1.12
200  * @return string HTML image tag with floaty's cute mug on it
201  */
202 function gravityview_get_floaty( $height = 87 ) {
203 
204  $width = $height * 0.7586206897;
205 
206  if( function_exists('is_rtl') && is_rtl() ) {
207  $style = 'margin:10px 10px 10px 0;';
208  $class = 'alignright';
209  } else {
210  $style = 'margin:10px 10px 10px 0;';
211  $class = 'alignleft';
212  }
213 
214  return '<img src="'.plugins_url( 'assets/images/astronaut-200x263.png', GRAVITYVIEW_FILE ).'" class="'.$class.'" height="'.intval( $height ).'" width="'.round( $width, 2 ).'" alt="The GravityView Astronaut Says:" style="'.$style.'" />';
215 }
216 
217 /**
218  * Intelligently format a number
219  *
220  * If you don't define the number of decimal places, then it will use the existing number of decimal places. This is done
221  * in a way that respects the localization of the site.
222  *
223  * If you do define decimals, it uses number_format_i18n()
224  *
225  * @see number_format_i18n()
226  *
227  * @since 1.13
228  *
229  * @param int|float|string|double $number A number to format
230  * @param int|string $decimals Optional. Precision of the number of decimal places. Default '' (use existing number of decimals)
231  *
232  * @return string Converted number in string format.
233  */
234 function gravityview_number_format( $number, $decimals = '' ) {
235  global $wp_locale;
236 
237  if( '' === $decimals ) {
238 
239  $decimal_point = isset( $wp_locale ) ? $wp_locale->number_format['decimal_point'] : '.';
240 
241  /**
242  * Calculate the position of the decimal point in the number
243  * @see http://stackoverflow.com/a/2430144/480856
244  */
245  $decimals = strlen( substr( strrchr( $number, $decimal_point ), 1 ) );
246  }
247 
248  $number = number_format_i18n( $number, (int)$decimals );
249 
250  return $number;
251 }
252 
253 
254 /**
255  * Convert a whole link into a shorter link for display
256  *
257  * @since 1.1
258  *
259  * @param string $value Existing URL
260  * @return string If parse_url doesn't find a 'host', returns original value. Otherwise, returns formatted link.
261  */
262 function gravityview_format_link( $value = null ) {
263 
264 
265  $parts = parse_url( $value );
266 
267  // No domain? Strange...show the original text.
268  if( empty( $parts['host'] ) ) {
269  return $value;
270  }
271 
272  // Start with empty value for the return URL
273  $return = '';
274 
275  /**
276  * @filter `gravityview_anchor_text_striphttp` Strip scheme from the displayed URL?
277  * @since 1.5.1
278  * @param boolean $enable Whether to strip the scheme. Return false to show scheme. (default: true)\n
279  * If true: `http://example.com => example.com`
280  */
281  if( false === apply_filters('gravityview_anchor_text_striphttp', true) ) {
282 
283  if( isset( $parts['scheme'] ) ) {
284  $return .= $parts['scheme'];
285  }
286 
287  }
288 
289  // The domain, which may contain a subdomain
290  $domain = $parts['host'];
291 
292  /**
293  * @filter `gravityview_anchor_text_stripwww` Strip www from the domain?
294  * @since 1.5.1
295  * @param boolean $enable Whether to strip www. Return false to show www. (default: true)\n
296  * If true: `www.example.com => example.com`
297  */
298  $strip_www = apply_filters('gravityview_anchor_text_stripwww', true );
299 
300  if( $strip_www ) {
301  $domain = str_replace('www.', '', $domain );
302  }
303 
304  /**
305  * @filter `gravityview_anchor_text_nosubdomain` Strip subdomains from the domain?
306  * @since 1.5.1
307  * @param boolean $enable Whether to strip subdomains. Return false to show subdomains. (default: true)\n
308  * If true: `http://demo.example.com => example.com` \n
309  * If false: `http://demo.example.com => demo.example.com`
310  */
311  $strip_subdomains = apply_filters('gravityview_anchor_text_nosubdomain', true);
312 
313  if( $strip_subdomains ) {
314 
315  $domain = _gravityview_strip_subdomain( $parts['host'] );
316 
317  }
318 
319  // Add the domain
320  $return .= $domain;
321 
322  /**
323  * @filter `gravityview_anchor_text_rootonly` Display link path going only to the base directory, not a sub-directory or file?
324  * @since 1.5.1
325  * @param boolean $enable Whether to enable "root only". Return false to show full path. (default: true)\n
326  * If true: `http://example.com/sub/directory/page.html => example.com` \n
327  * If false: `http://example.com/sub/directory/page.html => example.com/sub/directory/page.html`
328  */
329  $root_only = apply_filters('gravityview_anchor_text_rootonly', true);
330 
331  if( empty( $root_only ) ) {
332 
333  if( isset( $parts['path'] ) ) {
334  $return .= $parts['path'];
335  }
336  }
337 
338  /**
339  * @filter `gravityview_anchor_text_noquerystring` Strip the query string from the end of the URL?
340  * @since 1.5.1
341  * @param boolean $enable Whether to enable "root only". Return false to show full path. (default: true)\n
342  * If true: `http://example.com/?query=example => example.com`
343  */
344  $strip_query_string = apply_filters('gravityview_anchor_text_noquerystring', true );
345 
346  if( empty( $strip_query_string ) ) {
347 
348  if( isset( $parts['query'] ) ) {
349  $return .= '?'.$parts['query'];
350  }
351 
352  }
353 
354  return $return;
355 }
356 
357 /**
358  * Do a _very_ basic match for second-level TLD domains, like `.co.uk`
359  *
360  * Ideally, we'd use https://github.com/jeremykendall/php-domain-parser to check for this, but it's too much work for such a basic functionality. Maybe if it's needed more in the future. So instead, we use [Basic matching regex](http://stackoverflow.com/a/12372310).
361  * @param string $domain Domain to check if it's a TLD or subdomain
362  * @return string Extracted domain if it has a subdomain
363  */
364 function _gravityview_strip_subdomain( $string_maybe_has_subdomain ) {
365 
366  if( preg_match("/(?P<domain>[a-z0-9][a-z0-9\-]{1,63}\.(?:com\.|co\.|net\.|org\.|firm\.|me\.|school\.|law\.|gov\.|mod\.|msk\.|irkutsks\.|sa\.|act\.|police\.|plc\.|ac\.|tm\.|asso\.|biz\.|pro\.|cg\.|telememo\.)?[a-z\.]{2,6})$/i", $string_maybe_has_subdomain, $matches ) ) {
367  return $matches['domain'];
368  } else {
369  return $string_maybe_has_subdomain;
370  }
371 }
372 
373 /**
374  * Is the value empty?
375  *
376  * Allows you to pass a function instead of just a variable, like the empty() function insists upon (until PHP 5.5)
377  *
378  * Checks whether `false`, `null`, empty string, empty array, object with no vars defined
379  *
380  * @since 1.15.1
381  * @param mixed $value Check whether this is empty
382  * @param boolean $zero_is_empty Should the number zero be treated as an empty value?
383  * @param boolean $allow_string_booleans Whether to check if 'yes', 'true' => `true` and 'no', 'false' => `false`
384  * @return boolean True: empty; false: not empty
385  */
386 function gv_empty( $value, $zero_is_empty = true, $allow_string_booleans = true ) {
387 
388  if(
389  ! isset( $value ) // If it's not set, it's empty!
390  || false === $value
391  || null === $value
392  || '' === $value // Empty string
393  || array() === $value // Empty array
394  || ( is_object( $value ) && ! get_object_vars( $value ) ) // Empty object
395  ) {
396  return true;
397  }
398 
399  if( is_string( $value ) && $allow_string_booleans ) {
400 
401  $value = trim( $value );
402  $value = strtolower( $value );
403 
404  if ( in_array( $value, array( 'yes', 'true' ), true ) ) {
405  $value = true;
406  } else if( in_array( $value, array( 'no', 'false' ), true ) ) {
407  $value = false;
408  }
409  }
410 
411  // If zero isn't empty, then if $value is a number and it's empty, it's zero. Thus, return false.
412  if( ! $zero_is_empty && is_numeric( $value ) && empty( $value ) ) {
413  return false;
414  }
415 
416  return empty( $value );
417 }
418 
419 
420 /**
421  * Maps a function to all non-iterable elements of an array or an object.
422  *
423  * @see map_deep() This is an alias of the WP core function `map_deep()`, added in 4.4. Here for legacy purposes.
424  * @since 1.16.3
425  *
426  * @param mixed $value The array, object, or scalar.
427  * @param callable $callback The function to map onto $value.
428  *
429  * @return mixed The value with the callback applied to all non-arrays and non-objects inside it.
430  */
431 function gv_map_deep( $value, $callback ) {
432 
433  // Use the original function, if exists.
434  // Requires WP 4.4+
435  if( function_exists( 'map_deep') ) {
436  return map_deep( $value, $callback );
437  }
438 
439  // Exact copy of map_deep() code below:
440  if ( is_array( $value ) ) {
441  foreach ( $value as $index => $item ) {
442  $value[ $index ] = gv_map_deep( $item, $callback );
443  }
444  } elseif ( is_object( $value ) ) {
445  $object_vars = get_object_vars( $value );
446  foreach ( $object_vars as $property_name => $property_value ) {
447  $value->$property_name = gv_map_deep( $property_value, $callback );
448  }
449  } else {
450  $value = call_user_func( $callback, $value );
451  }
452 
453  return $value;
454 }
455 
456 /**
457  * Check whether a string is a expected date format
458  *
459  * @since 1.15.2
460  *
461  * @param string $datetime The date to check
462  * @param string $expected_format Check whether the date is formatted as expected. Default: Y-m-d
463  *
464  * @return bool True: it's a valid datetime, formatted as expected. False: it's not a date formatted as expected.
465  */
466 function gravityview_is_valid_datetime( $datetime, $expected_format = 'Y-m-d' ) {
467 
468  /**
469  * @var bool|DateTime False if not a valid date, (like a relative date). DateTime if a date was created.
470  */
471  $formatted_date = DateTime::createFromFormat( $expected_format, $datetime );
472 
473  /**
474  * @see http://stackoverflow.com/a/19271434/480856
475  */
476  return ( $formatted_date && $formatted_date->format( $expected_format ) === $datetime );
477 }
478 
479 /**
480  * Very commonly needed: get the # of the input based on a full field ID.
481  *
482  * Example: 12.3 => field #12, input #3. Returns: 3
483  * Example: 7 => field #7, no input. Returns: 0
484  *
485  * @since 1.16.4
486  *
487  * @param string $field_id Full ID of field, with or without input ID, like "12.3" or "7".
488  *
489  * @return int If field ID has an input, returns that input number. Otherwise, returns false.
490  */
492 
493  if ( ! is_numeric( $field_id ) ) {
494  do_action( 'gravityview_log_error', __FUNCTION__ . ': $field_id not numeric', $field_id );
495  return false;
496  }
497 
498  $exploded = explode( '.', "{$field_id}" );
499 
500  return isset( $exploded[1] ) ? intval( $exploded[1] ) : false;
501 }
502 
503 /**
504  * Get categories formatted in a way used by GravityView and Gravity Forms input choices
505  *
506  * @since 1.15.3
507  *
508  * @see get_terms()
509  *
510  * @param array $args Arguments array as used by the get_terms() function. Filtered using `gravityview_get_terms_choices_args` filter. Defaults: { \n
511  * @type string $taxonomy Used as first argument in get_terms(). Default: "category"
512  * @type string $fields Default: 'id=>name' to only fetch term ID and Name \n
513  * @type int $number Limit the total number of terms to fetch. Default: 1000 \n
514  * }
515  *
516  * @return array Multidimensional array with `text` (Category Name) and `value` (Category ID) keys.
517  */
518 function gravityview_get_terms_choices( $args = array() ) {
519 
520  $defaults = array(
521  'type' => 'post',
522  'child_of' => 0,
523  'number' => 1000, // Set a reasonable max limit
524  'orderby' => 'name',
525  'order' => 'ASC',
526  'hide_empty' => 0,
527  'hierarchical' => 1,
528  'taxonomy' => 'category',
529  'fields' => 'id=>name',
530  );
531 
532  $args = wp_parse_args( $args, $defaults );
533 
534  /**
535  * @filter `gravityview_get_terms_choices_args` Modify the arguments passed to `get_terms()`
536  * @see get_terms()
537  * @since 1.15.3
538  */
539  $args = apply_filters( 'gravityview_get_terms_choices_args', $args );
540 
541  $terms = get_terms( $args['taxonomy'], $args );
542 
543  $choices = array();
544 
545  if ( is_array( $terms ) ) {
546  foreach ( $terms as $term_id => $term_name ) {
547  $choices[] = array(
548  'text' => $term_name,
549  'value' => $term_id
550  );
551  }
552  }
553 
554  return $choices;
555 }
556 
557 /**
558  * Maybe convert jQuery-serialized fields into array, otherwise return $_POST['fields'] array
559  *
560  * Fields are passed as a jQuery-serialized array, created in admin-views.js in the serializeForm method.
561  *
562  * @since 1.16.5
563  *
564  * @uses GVCommon::gv_parse_str
565  *
566  * @return array Array of fields
567  */
569  $fields = array();
570 
571  if( !empty( $_POST['gv_fields'] ) ) {
572  if ( ! is_array( $_POST['gv_fields'] ) ) {
573 
574  // We are not using parse_str() due to max_input_vars limitation with large View configurations
575  $fields_holder = array();
576  GVCommon::gv_parse_str( $_POST['gv_fields'], $fields_holder );
577 
578  if ( isset( $fields_holder['fields'] ) ) {
579  $fields = $fields_holder['fields'];
580  } else {
581  do_action( 'gravityview_log_error', '[save_postdata] No `fields` key was found after parsing $fields string', $fields_holder );
582  }
583 
584  } else {
585  $fields = $_POST['gv_fields'];
586  }
587  }
588 
589  return $fields;
590 }
const GRAVITYVIEW_DIR
"GRAVITYVIEW_DIR" "./" The absolute path to the plugin directory
Definition: gravityview.php:35
gravityview_css_url($css_file= '', $dir_path= '')
Functions that don&#39;t require GravityView or Gravity Forms API access but are used in the plugin to ex...
gravityview_get_input_id_from_id($field_id= '')
Very commonly needed: get the # of the input based on a full field ID.
gv_empty($value, $zero_is_empty=true, $allow_string_booleans=true)
Is the value empty?
gravityview_get_permalink_query_args($id=0)
Get get_permalink() without the home_url() prepended to it.
$class
gravityview_number_format($number, $decimals= '')
Intelligently format a number.
const GRAVITYVIEW_FILE(!defined( 'ABSPATH'))
Plugin Name: GravityView Plugin URI: https://gravityview.co Description: The best, easiest way to display Gravity Forms entries on your website.
Definition: gravityview.php:26
_gravityview_strip_subdomain($string_maybe_has_subdomain)
Do a very basic match for second-level TLD domains, like .co.uk
gravityview_is_not_empty_string($mixed= '')
Check whether a variable is not an empty string.
gravityview_get_floaty($height=87)
Get an image of our intrepid explorer friend.
gravityview_get_terms_choices($args=array())
Get categories formatted in a way used by GravityView and Gravity Forms input choices.
gravityview_ob_include($file_path, $object=NULL)
Get the contents of a file using include() and ob_start()
$field_id
Definition: time.php:17
if(!function_exists( 'gravityview_sanitize_html_class')) gravityview_strip_whitespace($string)
Replace multiple newlines, tabs, and spaces with a single space.
static gv_parse_str($string, &$result)
Do the same than parse_str without max_input_vars limitation: Parses $string as if it were the query ...
gv_selected($value, $current, $echo=true, $type= 'selected')
Similar to the WordPress selected(), checked(), and disabled() functions, except it allows arrays to ...
_gravityview_process_posted_fields()
Maybe convert jQuery-serialized fields into array, otherwise return $_POST[&#39;fields&#39;] array...
gravityview_format_link($value=null)
Convert a whole link into a shorter link for display.
gv_map_deep($value, $callback)
Maps a function to all non-iterable elements of an array or an object.