GravityView  2.1.1
The best, easiest way to display Gravity Forms entries on your website.
class-common.php
Go to the documentation of this file.
1 <?php
2 /**
3  * Set of common functions to separate main plugin from Gravity Forms API and other cross-plugin methods
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.5.2
12  */
13 
14 /** If this file is called directly, abort. */
15 if ( ! defined( 'ABSPATH' ) ) {
16  die;
17 }
18 
19 class GVCommon {
20 
21  /**
22  * Returns the form object for a given Form ID.
23  *
24  * @access public
25  * @param mixed $form_id
26  * @return array|false Array: Form object returned from Gravity Forms; False: no form ID specified or Gravity Forms isn't active.
27  */
28  public static function get_form( $form_id ) {
29  if ( empty( $form_id ) ) {
30  return false;
31  }
32 
33  // Only get_form_meta is cached. ::facepalm::
34  if ( class_exists( 'GFFormsModel' ) ) {
35  return GFFormsModel::get_form_meta( $form_id );
36  }
37 
38  if ( class_exists( 'GFAPI' ) ) {
39  return GFAPI::get_form( $form_id );
40  }
41 
42  return false;
43  }
44 
45  /**
46  * Alias of GravityView_Roles_Capabilities::has_cap()
47  *
48  * @since 1.15
49  *
50  * @see GravityView_Roles_Capabilities::has_cap()
51  *
52  * @param string|array $caps Single capability or array of capabilities
53  * @param int $object_id (optional) Parameter can be used to check for capabilities against a specific object, such as a post or user
54  * @param int|null $user_id (optional) Check the capabilities for a user who is not necessarily the currently logged-in user
55  *
56  * @return bool True: user has at least one passed capability; False: user does not have any defined capabilities
57  */
58  public static function has_cap( $caps = '', $object_id = null, $user_id = null ) {
59  return GravityView_Roles_Capabilities::has_cap( $caps, $object_id, $user_id );
60  }
61 
62  /**
63  * Return a Gravity Forms field array, whether using GF 1.9 or not
64  *
65  * @since 1.7
66  *
67  * @param array|GF_Fields $field Gravity Forms field or array
68  * @return array Array version of $field
69  */
70  public static function get_field_array( $field ) {
71 
72  if ( class_exists( 'GF_Fields' ) ) {
73 
74  $field_object = GF_Fields::create( $field );
75 
76  // Convert the field object in 1.9 to an array for backward compatibility
77  $field_array = get_object_vars( $field_object );
78 
79  } else {
80  $field_array = $field;
81  }
82 
83  return $field_array;
84  }
85 
86  /**
87  * Get all existing Views
88  *
89  * @since 1.5.4 Added $args array
90  *
91  * @param array $args Pass custom array of args, formatted as if for `get_posts()`
92  *
93  * @return WP_Post[] Array of Views as `WP_Post`. Empty array if none found.
94  */
95  public static function get_all_views( $args = array() ) {
96 
97  $default_params = array(
98  'post_type' => 'gravityview',
99  'posts_per_page' => -1,
100  'post_status' => 'publish',
101  );
102 
103  $params = wp_parse_args( $args, $default_params );
104 
105  /**
106  * @filter `gravityview/get_all_views/params` Modify the parameters sent to get all views.
107  * @param[in,out] array $params Array of parameters to pass to `get_posts()`
108  */
109  $views_params = apply_filters( 'gravityview/get_all_views/params', $params );
110 
111  $views = get_posts( $views_params );
112 
113  return $views;
114  }
115 
116 
117  /**
118  * Get the form array for an entry based only on the entry ID
119  * @param int|string $entry_slug Entry slug
120  * @return array|false Array: Form object returned from Gravity Forms; False: form doesn't exist, or $entry didn't exist or $entry didn't specify form ID
121  */
122  public static function get_form_from_entry_id( $entry_slug ) {
123 
124  $entry = self::get_entry( $entry_slug, true, false );
125 
126  $form = false;
127 
128  if( $entry ) {
129  $form = GFAPI::get_form( $entry['form_id'] );
130  }
131 
132  return $form;
133  }
134 
135  /**
136  * Check whether a form has product fields
137  *
138  * @since 1.16
139  * @since 1.20 Refactored the field types to get_product_field_types() method
140  *
141  * @param array $form Gravity Forms form array
142  *
143  * @return bool|GF_Field[]
144  */
145  public static function has_product_field( $form = array() ) {
146 
147  $product_fields = self::get_product_field_types();
148 
149  $fields = GFAPI::get_fields_by_type( $form, $product_fields );
150 
151  return empty( $fields ) ? false : $fields;
152  }
153 
154  /**
155  * Return array of product field types
156  *
157  * Modify the value using the `gform_product_field_types` filter
158  *
159  * @since 1.20
160  *
161  * @return array
162  */
163  public static function get_product_field_types() {
164 
165  $product_fields = apply_filters( 'gform_product_field_types', array( 'option', 'quantity', 'product', 'total', 'shipping', 'calculation', 'price', 'hiddenproduct', 'singleproduct', 'singleshipping' ) );
166 
167  return $product_fields;
168  }
169 
170  /**
171  * Check if an entry has transaction data
172  *
173  * Checks the following keys to see if they are set: 'payment_status', 'payment_date', 'transaction_id', 'payment_amount', 'payment_method'
174  *
175  * @since 1.20
176  *
177  * @param array $entry Gravity Forms entry array
178  *
179  * @return bool True: Entry has metadata suggesting it has communicated with a payment gateway; False: it does not have that data.
180  */
181  public static function entry_has_transaction_data( $entry = array() ) {
182 
183  if ( ! is_array( $entry ) ) {
184  return false;
185  }
186 
187  $has_transaction_data = false;
188 
189  $payment_meta = array( 'payment_status', 'payment_date', 'transaction_id', 'payment_amount', 'payment_method' );
190 
191  foreach ( $payment_meta as $meta ) {
192 
193  $has_transaction_data = \GV\Utils::get( $entry, $meta, false );
194 
195  if ( is_numeric( $has_transaction_data ) && ( ! floatval( $has_transaction_data ) > 0 ) ) {
196  $has_transaction_data = false;
197  continue;
198  }
199 
200  if ( ! empty( $has_transaction_data ) ) {
201  break;
202  }
203  }
204 
205  return (bool) $has_transaction_data;
206  }
207 
208  /**
209  * Get the entry ID from the entry slug, which may or may not be the entry ID
210  *
211  * @since 1.5.2
212  * @param string $slug The entry slug, as returned by GravityView_API::get_entry_slug()
213  * @return int|null The entry ID, if exists; `NULL` if not
214  */
215  public static function get_entry_id_from_slug( $slug ) {
216  global $wpdb;
217 
218  $search_criteria = array(
219  'field_filters' => array(
220  array(
221  'key' => 'gravityview_unique_id', // Search the meta values
222  'value' => $slug,
223  'operator' => 'is',
224  'type' => 'meta',
225  ),
226  )
227  );
228 
229  // Limit to one for speed
230  $paging = array(
231  'page_size' => 1,
232  );
233 
234  /**
235  * @filter `gravityview/common/get_entry_id_from_slug/form_id` The form ID used to get the custom entry ID. Change this to avoid collisions with data from other forms with the same values and the same field ID.
236  * @since 1.17.2
237  * @param int $form_id ID of the form to search. Default: `0` (searches all forms)
238  */
239  $form_id = apply_filters( 'gravityview/common/get_entry_id_from_slug/form_id', 0 );
240 
241  $results = GFAPI::get_entries( intval( $form_id ), $search_criteria, null, $paging );
242 
243  $result = ( ! empty( $results ) && ! empty( $results[0]['id'] ) ) ? $results[0]['id'] : null;
244 
245  return $result;
246  }
247 
248  /**
249  * Alias of GFAPI::get_forms()
250  *
251  * @see GFAPI::get_forms()
252  *
253  * @since 1.19 Allow "any" $active status option
254  *
255  * @param bool|string $active Status of forms. Use `any` to get array of forms with any status. Default: `true`
256  * @param bool $trash Include forms in trash? Default: `false`
257  *
258  * @return array Empty array if GFAPI class isn't available or no forms. Otherwise, the array of Forms
259  */
260  public static function get_forms( $active = true, $trash = false ) {
261  $forms = array();
262  if ( class_exists( 'GFAPI' ) ) {
263  if( 'any' === $active ) {
264  $active_forms = GFAPI::get_forms( true, $trash );
265  $inactive_forms = GFAPI::get_forms( false, $trash );
266  $forms = array_merge( array_filter( $active_forms ), array_filter( $inactive_forms ) );
267  } else {
268  $forms = GFAPI::get_forms( $active, $trash );
269  }
270  }
271  return $forms;
272  }
273 
274  /**
275  * Return array of fields' id and label, for a given Form ID
276  *
277  * @access public
278  * @param string|array $form_id (default: '') or $form object
279  * @param bool $add_default_properties
280  * @param bool $include_parent_field
281  * @return array
282  */
283  public static function get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
284 
285  if ( ! is_array( $form ) ) {
286  $form = self::get_form( $form );
287  }
288 
289  $fields = array();
290  $has_product_fields = false;
291  $has_post_fields = false;
292 
293  if ( $form ) {
294  foreach ( $form['fields'] as $field ) {
295  if ( $include_parent_field || empty( $field['inputs'] ) ) {
296  $fields["{$field['id']}"] = array(
297  'label' => \GV\Utils::get( $field, 'label' ),
298  'parent' => null,
299  'type' => \GV\Utils::get( $field, 'type' ),
300  'adminLabel' => \GV\Utils::get( $field, 'adminLabel' ),
301  'adminOnly' => \GV\Utils::get( $field, 'adminOnly' ),
302  );
303  }
304 
305  if ( $add_default_properties && ! empty( $field['inputs'] ) ) {
306  foreach ( $field['inputs'] as $input ) {
307 
308  if( ! empty( $input['isHidden'] ) ) {
309  continue;
310  }
311 
312  /**
313  * @hack
314  * In case of email/email confirmation, the input for email has the same id as the parent field
315  */
316  if( 'email' === $field['type'] && false === strpos( $input['id'], '.' ) ) {
317  continue;
318  }
319  $fields["{$input['id']}"] = array(
320  'label' => \GV\Utils::get( $input, 'label' ),
321  'customLabel' => \GV\Utils::get( $input, 'customLabel' ),
322  'parent' => $field,
323  'type' => \GV\Utils::get( $field, 'type' ),
324  'adminLabel' => \GV\Utils::get( $field, 'adminLabel' ),
325  'adminOnly' => \GV\Utils::get( $field, 'adminOnly' ),
326  );
327  }
328  }
329 
330 
331  if( GFCommon::is_product_field( $field['type'] ) ){
332  $has_product_fields = true;
333  }
334 
335  if ( GFCommon::is_post_field( $field ) ) {
336  $has_post_fields = true;
337  }
338  }
339  }
340 
341  /**
342  * @since 1.7
343  */
344  if ( $has_post_fields ) {
345  $fields['post_id'] = array(
346  'label' => __( 'Post ID', 'gravityview' ),
347  'type' => 'post_id',
348  );
349  }
350 
351  if ( $has_product_fields ) {
352 
353  $payment_fields = GravityView_Fields::get_all( 'pricing' );
354 
355  foreach ( $payment_fields as $payment_field ) {
356 
357  // Either the field exists ($fields['shipping']) or the form explicitly contains a `shipping` field with numeric key
358  if( isset( $fields["{$payment_field->name}"] ) || GFCommon::get_fields_by_type( $form, $payment_field->name ) ) {
359  continue;
360  }
361 
362  $fields["{$payment_field->name}"] = array(
363  'label' => $payment_field->label,
364  'desc' => $payment_field->description,
365  'type' => $payment_field->name,
366  );
367  }
368  }
369 
370  /**
371  * @filter `gravityview/common/get_form_fields` Modify the form fields shown in the Add Field field picker.
372  * @since 1.17
373  * @param array $fields Associative array of fields, with keys as field type, values an array with the following keys: (string) `label` (required), (string) `type` (required), `desc`, (string) `customLabel`, (GF_Field) `parent`, (string) `adminLabel`, (bool)`adminOnly`
374  * @param array $form GF Form array
375  * @param bool $include_parent_field Whether to include the parent field when getting a field with inputs
376  */
377  $fields = apply_filters( 'gravityview/common/get_form_fields', $fields, $form, $include_parent_field );
378 
379  return $fields;
380 
381  }
382 
383  /**
384  * get extra fields from entry meta
385  * @param string $form_id (default: '')
386  * @return array
387  */
388  public static function get_entry_meta( $form_id, $only_default_column = true ) {
389 
390  $extra_fields = GFFormsModel::get_entry_meta( $form_id );
391 
392  $fields = array();
393 
394  foreach ( $extra_fields as $key => $field ){
395  if ( ! empty( $only_default_column ) && ! empty( $field['is_default_column'] ) ) {
396  $fields[ $key ] = array( 'label' => $field['label'], 'type' => 'entry_meta' );
397  }
398  }
399 
400  return $fields;
401  }
402 
403 
404  /**
405  * Wrapper for the Gravity Forms GFFormsModel::search_lead_ids() method
406  *
407  * @see GFEntryList::leads_page()
408  * @param int $form_id ID of the Gravity Forms form
409  * @since 1.1.6
410  * @return array|void Array of entry IDs. Void if Gravity Forms isn't active.
411  */
412  public static function get_entry_ids( $form_id, $search_criteria = array() ) {
413 
414  if ( ! class_exists( 'GFFormsModel' ) ) {
415  return;
416  }
417 
418  return GFFormsModel::search_lead_ids( $form_id, $search_criteria );
419  }
420 
421  /**
422  * Calculates the Search Criteria used on the self::get_entries / self::get_entry methods
423  *
424  * @since 1.7.4
425  *
426  * @param array $passed_criteria array Input Criteria (search_criteria, sorting, paging)
427  * @param array $form_ids array Gravity Forms form IDs
428  * @return array
429  */
430  public static function calculate_get_entries_criteria( $passed_criteria = array(), $form_ids = array() ) {
431 
432  $search_criteria_defaults = array(
433  'search_criteria' => null,
434  'sorting' => null,
435  'paging' => null,
436  'cache' => (isset( $passed_criteria['cache'] ) ? (bool) $passed_criteria['cache'] : true),
437  'context_view_id' => null,
438  );
439 
440  $criteria = wp_parse_args( $passed_criteria, $search_criteria_defaults );
441 
442  if ( ! empty( $criteria['search_criteria']['field_filters'] ) ) {
443  foreach ( $criteria['search_criteria']['field_filters'] as &$filter ) {
444 
445  if ( ! is_array( $filter ) ) {
446  continue;
447  }
448 
449  // By default, we want searches to be wildcard for each field.
450  $filter['operator'] = empty( $filter['operator'] ) ? 'contains' : $filter['operator'];
451 
452  /**
453  * @filter `gravityview_search_operator` Modify the search operator for the field (contains, is, isnot, etc)
454  * @param string $operator Existing search operator
455  * @param array $filter array with `key`, `value`, `operator`, `type` keys
456  */
457  $filter['operator'] = apply_filters( 'gravityview_search_operator', $filter['operator'], $filter );
458  }
459 
460  // don't send just the [mode] without any field filter.
461  if( count( $criteria['search_criteria']['field_filters'] ) === 1 && array_key_exists( 'mode' , $criteria['search_criteria']['field_filters'] ) ) {
462  unset( $criteria['search_criteria']['field_filters']['mode'] );
463  }
464 
465  }
466 
467 
468 
469  /**
470  * Prepare date formats to be in Gravity Forms DB format;
471  * $passed_criteria may include date formats incompatible with Gravity Forms.
472  */
473  foreach ( array('start_date', 'end_date' ) as $key ) {
474 
475  if ( ! empty( $criteria['search_criteria'][ $key ] ) ) {
476 
477  // Use date_create instead of new DateTime so it returns false if invalid date format.
478  $date = date_create( $criteria['search_criteria'][ $key ] );
479 
480  if ( $date ) {
481  // Gravity Forms wants dates in the `Y-m-d H:i:s` format.
482  $criteria['search_criteria'][ $key ] = $date->format( 'Y-m-d H:i:s' );
483  } else {
484  gravityview()->log->error( '{key} Date format not valid:', array( 'key' => $key, $criteria['search_criteria'][ $key ] ) );
485 
486  // If it's an invalid date, unset it. Gravity Forms freaks out otherwise.
487  unset( $criteria['search_criteria'][ $key ] );
488  }
489  }
490  }
491 
492  if ( empty( $criteria['context_view_id'] ) ) {
493  // Calculate the context view id and send it to the advanced filter
494  if ( GravityView_frontend::getInstance()->getSingleEntry() ) {
495  $criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
496  } else if ( class_exists( 'GravityView_View_Data' ) && GravityView_View_Data::getInstance() && GravityView_View_Data::getInstance()->has_multiple_views() ) {
497  $criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
498  } else if ( 'delete' === GFForms::get( 'action' ) ) {
499  $criteria['context_view_id'] = isset( $_GET['view_id'] ) ? intval( $_GET['view_id'] ) : null;
500  }
501  }
502 
503  /**
504  * @filter `gravityview_search_criteria` Apply final criteria filter (Used by the Advanced Filter extension)
505  * @param array $criteria Search criteria used by GravityView
506  * @param array $form_ids Forms to search
507  * @param int $view_id ID of the view being used to search
508  */
509  $criteria = apply_filters( 'gravityview_search_criteria', $criteria, $form_ids, $criteria['context_view_id'] );
510 
511  return (array)$criteria;
512  }
513 
514 
515  /**
516  * Retrieve entries given search, sort, paging criteria
517  *
518  * @see GFAPI::get_entries()
519  * @see GFFormsModel::get_field_filters_where()
520  * @access public
521  * @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
522  * @param mixed $passed_criteria (default: null)
523  * @param mixed &$total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate the total count. (default: null)
524  *
525  * @deprecated See \GV\View::get_entries.
526  *
527  * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
528  */
529  public static function get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
530 
531  gravityview()->log->notice( '\GVCommon::get_entries is deprecated. Use \GV\View::get_entries instead.' );
532 
533  // Filter the criteria before query (includes Adv Filter)
534  $criteria = self::calculate_get_entries_criteria( $passed_criteria, $form_ids );
535 
536  gravityview()->log->debug( '[gravityview_get_entries] Final Parameters', array( 'data' => $criteria ) );
537 
538  // Return value
539  $return = null;
540 
541  /** Reduce # of database calls */
542  add_filter( 'gform_is_encrypted_field', '__return_false' );
543 
544  if ( ! empty( $criteria['cache'] ) ) {
545 
546  $Cache = new GravityView_Cache( $form_ids, $criteria );
547 
548  if ( $entries = $Cache->get() ) {
549 
550  // Still update the total count when using cached results
551  if ( ! is_null( $total ) ) {
552  $total = GFAPI::count_entries( $form_ids, $criteria['search_criteria'] );
553  }
554 
555  $return = $entries;
556  }
557  }
558 
559  if ( is_null( $return ) && class_exists( 'GFAPI' ) && ( is_numeric( $form_ids ) || is_array( $form_ids ) ) ) {
560 
561  /**
562  * @filter `gravityview_pre_get_entries` Define entries to be used before GFAPI::get_entries() is called
563  * @since 1.14
564  * @param null $return If you want to override GFAPI::get_entries() and define entries yourself, tap in here.
565  * @param array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
566  * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
567  * @param int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
568  * @since 2.1 The $total parameter can now be overriden by reference.
569  * @deprecated
570  */
571  $entries = apply_filters_ref_array( 'gravityview_before_get_entries', array( null, $criteria, $passed_criteria, &$total ) );
572 
573  // No entries returned from gravityview_before_get_entries
574  if( is_null( $entries ) ) {
575 
576  $entries = GFAPI::get_entries( $form_ids, $criteria['search_criteria'], $criteria['sorting'], $criteria['paging'], $total );
577 
578  if ( is_wp_error( $entries ) ) {
579  gravityview()->log->error( '{error}', array( 'error' => $entries->get_error_message(), 'data' => $entries ) );
580 
581  /** Remove filter added above */
582  remove_filter( 'gform_is_encrypted_field', '__return_false' );
583  return false;
584  }
585  }
586 
587  if ( ! empty( $criteria['cache'] ) && isset( $Cache ) ) {
588 
589  // Cache results
590  $Cache->set( $entries, 'entries' );
591 
592  }
593 
594  $return = $entries;
595  }
596 
597  /** Remove filter added above */
598  remove_filter( 'gform_is_encrypted_field', '__return_false' );
599 
600  /**
601  * @filter `gravityview_entries` Modify the array of entries returned to GravityView after it has been fetched from the cache or from `GFAPI::get_entries()`.
602  * @param array|null $entries Array of entries as returned by the cache or by `GFAPI::get_entries()`
603  * @param array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
604  * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
605  * @param int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
606  * @since 2.1 The $total parameter can now be overriden by reference.
607  * @deprecated
608  */
609  $return = apply_filters_ref_array( 'gravityview_entries', array( $return, $criteria, $passed_criteria, &$total ) );
610 
611  return $return;
612  }
613 
614 
615  /**
616  * Get the entry ID from a string that may be the Entry ID or the Entry Slug
617  *
618  * @since 1.18
619  *
620  * @param string $entry_id_or_slug The ID or slug of an entry.
621  * @param bool $force_allow_ids Whether to force allowing getting the ID of an entry, even if custom slugs are enabled
622  *
623  * @return false|int|null Returns the ID of the entry found, if custom slugs is enabled. Returns original value if custom slugs is disabled. Returns false if not allowed to convert slug to ID. Returns NULL if entry not found for the passed slug.
624  */
625  public static function get_entry_id( $entry_id_or_slug = '', $force_allow_ids = false ) {
626 
627  $entry_id = false;
628 
629  /**
630  * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
631  * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
632  */
633  $custom_slug = apply_filters( 'gravityview_custom_entry_slug', false );
634 
635  /**
636  * @filter `gravityview_custom_entry_slug_allow_id` When using a custom slug, allow access to the entry using the original slug (the Entry ID).
637  * - If disabled (default), only allow access to an entry using the custom slug value. (example: `/entry/custom-slug/` NOT `/entry/123/`)
638  * - If enabled, you could access using the custom slug OR the entry id (example: `/entry/custom-slug/` OR `/entry/123/`)
639  * @param boolean $custom_slug_id_access True: allow accessing the slug by ID; False: only use the slug passed to the method.
640  */
641  $custom_slug_id_access = $force_allow_ids || apply_filters( 'gravityview_custom_entry_slug_allow_id', false );
642 
643  /**
644  * If we're using custom entry slugs, we do a meta value search
645  * instead of doing a straightup ID search.
646  */
647  if ( $custom_slug ) {
648  // Search for IDs matching $entry_id_or_slug
649  $entry_id = self::get_entry_id_from_slug( $entry_id_or_slug );
650  }
651 
652  // If custom slug is off, search using the entry ID
653  // ID allow ID access is on, also use entry ID as a backup
654  if ( false === $custom_slug || true === $custom_slug_id_access ) {
655  // Search for IDs matching $entry_slug
656  $entry_id = $entry_id_or_slug;
657  }
658 
659  return $entry_id;
660  }
661 
662  /**
663  * Return a single entry object
664  *
665  * Since 1.4, supports custom entry slugs. The way that GravityView fetches an entry based on the custom slug is by searching `gravityview_unique_id` meta. The `$entry_slug` is fetched by getting the current query var set by `is_single_entry()`
666  *
667  * @access public
668  * @param string|int $entry_slug Either entry ID or entry slug string
669  * @param boolean $force_allow_ids Force the get_entry() method to allow passed entry IDs, even if the `gravityview_custom_entry_slug_allow_id` filter returns false.
670  * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true. {@since 1.14}
671  * @return array|boolean
672  */
673  public static function get_entry( $entry_slug, $force_allow_ids = false, $check_entry_display = true ) {
674 
675  if ( ! class_exists( 'GFAPI' ) || empty( $entry_slug ) ) {
676  return false;
677  }
678 
679  $entry_id = self::get_entry_id( $entry_slug, $force_allow_ids );
680 
681  if ( empty( $entry_id ) ) {
682  return false;
683  }
684 
685  // fetch the entry
686  $entry = GFAPI::get_entry( $entry_id );
687 
688  /**
689  * @filter `gravityview/common/get_entry/check_entry_display` Override whether to check entry display rules against filters
690  * @since 1.16.2
691  * @param bool $check_entry_display Check whether the entry is visible for the current View configuration. Default: true.
692  * @param array $entry Gravity Forms entry array
693  */
694  $check_entry_display = apply_filters( 'gravityview/common/get_entry/check_entry_display', $check_entry_display, $entry );
695 
696  if( $check_entry_display ) {
697  // Is the entry allowed
698  $entry = self::check_entry_display( $entry );
699  }
700 
701  if( is_wp_error( $entry ) ) {
702  gravityview()->log->error( '{error}', array( 'error' => $entry->get_error_message() ) );
703  return false;
704  }
705 
706  return $entry;
707  }
708 
709  /**
710  * Wrapper for the GFFormsModel::matches_operation() method that adds additional comparisons, including:
711  * 'equals', 'greater_than_or_is', 'greater_than_or_equals', 'less_than_or_is', 'less_than_or_equals',
712  * 'not_contains', 'in', and 'not_in'
713  *
714  * @since 1.13 You can define context, which displays/hides based on what's being displayed (single, multiple, edit)
715  * @since 1.22.1 Added 'in' and 'not_in' for JSON-encoded array values, serialized non-strings
716  *
717  * @see https://docs.gravityview.co/article/252-gvlogic-shortcode
718  * @uses GFFormsModel::matches_operation
719  * @since 1.7.5
720  *
721  * @param mixed $val1 Left side of comparison
722  * @param mixed $val2 Right side of comparison
723  * @param string $operation Type of comparison
724  *
725  * @return bool True: matches, false: not matches
726  */
727  public static function matches_operation( $val1, $val2, $operation ) {
728 
729  // Only process strings
730  $val1 = ! is_string( $val1 ) ? wp_json_encode( $val1 ) : $val1;
731  $val2 = ! is_string( $val2 ) ? wp_json_encode( $val2 ) : $val2;
732 
733  $value = false;
734 
735  if( 'context' === $val1 ) {
736 
737  $matching_contexts = array( $val2 );
738 
739  // We allow for non-standard contexts.
740  switch( $val2 ) {
741  // Check for either single or edit
742  case 'singular':
743  $matching_contexts = array( 'single', 'edit' );
744  break;
745  // Use multiple as alias for directory for consistency
746  case 'multiple':
747  $matching_contexts = array( 'directory' );
748  break;
749  }
750 
751  $val1 = in_array( gravityview_get_context(), $matching_contexts ) ? $val2 : false;
752  }
753 
754  switch ( $operation ) {
755  case 'equals':
756  $value = self::matches_operation( $val1, $val2, 'is' );
757  break;
758  case 'greater_than_or_is':
759  case 'greater_than_or_equals':
760  $is = self::matches_operation( $val1, $val2, 'is' );
761  $gt = self::matches_operation( $val1, $val2, 'greater_than' );
762  $value = ( $is || $gt );
763  break;
764  case 'less_than_or_is':
765  case 'less_than_or_equals':
766  $is = self::matches_operation( $val1, $val2, 'is' );
767  $gt = self::matches_operation( $val1, $val2, 'less_than' );
768  $value = ( $is || $gt );
769  break;
770  case 'not_contains':
771  $contains = self::matches_operation( $val1, $val2, 'contains' );
772  $value = ! $contains;
773  break;
774  /**
775  * @since 1.22.1 Handle JSON-encoded comparisons
776  */
777  case 'in':
778  case 'not_in':
779 
780  $json_val_1 = json_decode( $val1, true );
781  $json_val_2 = json_decode( $val2, true );
782 
783  if( ! empty( $json_val_1 ) || ! empty( $json_val_2 ) ) {
784 
785  $json_in = false;
786  $json_val_1 = $json_val_1 ? (array) $json_val_1 : array( $val1 );
787  $json_val_2 = $json_val_2 ? (array) $json_val_2 : array( $val2 );
788 
789  // For JSON, we want to compare as "in" or "not in" rather than "contains"
790  foreach ( $json_val_1 as $item_1 ) {
791  foreach ( $json_val_2 as $item_2 ) {
792  $json_in = self::matches_operation( $item_1, $item_2, 'is' );
793 
794  if( $json_in ) {
795  break 2;
796  }
797  }
798  }
799 
800  $value = ( $operation === 'in' ) ? $json_in : ! $json_in;
801  }
802  break;
803 
804  case 'less_than':
805  case '<' :
806  if ( is_string( $val1 ) && is_string( $val2 ) ) {
807  $value = $val1 < $val2;
808  } else {
809  $value = GFFormsModel::matches_operation( $val1, $val2, $operation );
810  }
811  break;
812  case 'greater_than':
813  case '>' :
814  if ( is_string( $val1 ) && is_string( $val2 ) ) {
815  $value = $val1 > $val2;
816  } else {
817  $value = GFFormsModel::matches_operation( $val1, $val2, $operation );
818  }
819  break;
820  default:
821  $value = GFFormsModel::matches_operation( $val1, $val2, $operation );
822  }
823 
824  return $value;
825  }
826 
827  /**
828  *
829  * Checks if a certain entry is valid according to the View search filters (specially the Adv Filters)
830  *
831  * @uses GVCommon::calculate_get_entries_criteria();
832  * @see GFFormsModel::is_value_match()
833  *
834  * @since 1.7.4
835  *
836  * @param array $entry Gravity Forms Entry object
837  *
838  * @since 2.1
839  * @param \GV\View $view The View.
840  *
841  * @return WP_Error|array Returns WP_Error if entry is not valid according to the view search filters (Adv Filter). Returns original $entry value if passes.
842  */
843  public static function check_entry_display( $entry, $view = null ) {
844 
845  if ( ! $entry || is_wp_error( $entry ) ) {
846  return new WP_Error('entry_not_found', 'Entry was not found.', $entry );
847  }
848 
849  if ( empty( $entry['form_id'] ) ) {
850  return new WP_Error( 'form_id_not_set', '[apply_filters_to_entry] Entry is empty!', $entry );
851  }
852 
853  $criteria = self::calculate_get_entries_criteria( array(
854  'context_view_id' => $view ? $view->ID : null,
855  ) );
856 
857  if ( empty( $criteria['search_criteria'] ) || ! is_array( $criteria['search_criteria'] ) ) {
858  gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No search criteria found:', array( 'data' => $criteria ) );
859  return $entry;
860  }
861 
862  // Make sure the current View is connected to the same form as the Entry
863  if( ! empty( $criteria['context_view_id'] ) ) {
864  $context_view_id = intval( $criteria['context_view_id'] );
865  $context_form_id = gravityview_get_form_id( $context_view_id );
866  if( intval( $context_form_id ) !== intval( $entry['form_id'] ) ) {
867  return new WP_Error( 'view_id_not_match', sprintf( '[apply_filters_to_entry] Entry form ID does not match current View connected form ID:', $entry['form_id'] ), $criteria['context_view_id'] );
868  }
869  }
870 
871  $search_criteria = $criteria['search_criteria'];
872 
873  // check entry status
874  if ( array_key_exists( 'status', $search_criteria ) && $search_criteria['status'] != $entry['status'] ) {
875  return new WP_Error( 'status_not_valid', sprintf( '[apply_filters_to_entry] Entry status - %s - is not valid according to filter:', $entry['status'] ), $search_criteria );
876  }
877 
878  // check entry date
879  // @todo: Does it make sense to apply the Date create filters to the single entry?
880 
881  // field_filters
882  if ( empty( $search_criteria['field_filters'] ) || ! is_array( $search_criteria['field_filters'] ) ) {
883  gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No field filters criteria found:', array( 'data' => $search_criteria ) );
884  return $entry;
885  }
886 
887  $filters = $search_criteria['field_filters'];
888 
889  $mode = array_key_exists( 'mode', $filters ) ? strtolower( $filters['mode'] ) : 'all';
890 
891  $mode = $mode ? : 'all'; // If mode is an empty string, assume it's 'all'
892 
893  // Prevent the mode from being processed below
894  unset( $filters['mode'] );
895 
896  $form = self::get_form( $entry['form_id'] );
897 
898  foreach ( $filters as $filter ) {
899 
900  if ( ! isset( $filter['key'] ) ) {
901  gravityview()->log->debug( '[apply_filters_to_entry] Filter key not set: {filter}', array( 'filter' => $filter ) );
902  continue;
903  }
904 
905  $k = $filter['key'];
906 
907  $field = self::get_field( $form, $k );
908 
909  if ( is_null( $field ) ) {
910  $field_value = isset( $entry[ $k ] ) ? $entry[ $k ] : null;
911  $field = $k;
912  } else {
913  $field_value = GFFormsModel::get_lead_field_value( $entry, $field );
914  // If it's a complex field, then fetch the input's value, if exists at the current key. Otherwise, let GF handle it
915  $field_value = ( is_array( $field_value ) && isset( $field_value[ $k ] ) ) ? \GV\Utils::get( $field_value, $k ) : $field_value;
916  }
917 
918  $operator = isset( $filter['operator'] ) ? strtolower( $filter['operator'] ) : 'is';
919 
920  $is_value_match = GravityView_GFFormsModel::is_value_match( $field_value, $filter['value'], $operator, $field );
921 
922  // Any match is all we need to know
923  if ( $is_value_match && 'any' === $mode ) {
924  return $entry;
925  }
926 
927  // Any failed match is a total fail
928  if ( ! $is_value_match && 'all' === $mode ) {
929  return new WP_Error('failed_criteria', '[apply_filters_to_entry] Entry cannot be displayed. Failed a criterium for ALL mode', $filter );
930  }
931  }
932 
933  // at this point, if in ALL mode, then entry is approved - all conditions were met.
934  // Or, for ANY mode, means none of the conditions were satisfied, so entry is not approved
935  if ( 'all' === $mode ) {
936  gravityview()->log->debug( '[apply_filters_to_entry] Entry approved: all conditions were met' );
937  return $entry;
938  } else {
939  return new WP_Error('failed_any_criteria', '[apply_filters_to_entry] Entry cannot be displayed. Failed all the criteria for ANY mode', $filters );
940  }
941 
942  }
943 
944 
945  /**
946  * Allow formatting date and time based on GravityView standards
947  *
948  * @since 1.16
949  *
950  * @see GVCommon_Test::test_format_date for examples
951  *
952  * @param string $date_string The date as stored by Gravity Forms (`Y-m-d h:i:s` GMT)
953  * @param string|array $args Array or string of settings for output parsed by `wp_parse_args()`; Can use `raw=1` or `array('raw' => true)` \n
954  * - `raw` Un-formatted date string in original `Y-m-d h:i:s` format
955  * - `timestamp` Integer timestamp returned by GFCommon::get_local_timestamp()
956  * - `diff` "%s ago" format, unless other `format` is defined
957  * - `human` Set $is_human parameter to true for `GFCommon::format_date()`. Shows `diff` within 24 hours or date after. Format based on blog setting, unless `format` is defined.
958  * - `time` Include time in the `GFCommon::format_date()` output
959  * - `format` Define your own date format, or `diff` format
960  *
961  * @return int|null|string Formatted date based on the original date
962  */
963  public static function format_date( $date_string = '', $args = array() ) {
964 
965  $default_atts = array(
966  'raw' => false,
967  'timestamp' => false,
968  'diff' => false,
969  'human' => false,
970  'format' => '',
971  'time' => false,
972  );
973 
974  $atts = wp_parse_args( $args, $default_atts );
975 
976  /**
977  * Gravity Forms code to adjust date to locally-configured Time Zone
978  * @see GFCommon::format_date() for original code
979  */
980  $date_gmt_time = mysql2date( 'G', $date_string );
981  $date_local_timestamp = GFCommon::get_local_timestamp( $date_gmt_time );
982 
983  $format = \GV\Utils::get( $atts, 'format' );
984  $is_human = ! empty( $atts['human'] );
985  $is_diff = ! empty( $atts['diff'] );
986  $is_raw = ! empty( $atts['raw'] );
987  $is_timestamp = ! empty( $atts['timestamp'] );
988  $include_time = ! empty( $atts['time'] );
989 
990  // If we're using time diff, we want to have a different default format
991  if( empty( $format ) ) {
992  /* translators: %s: relative time from now, used for generic date comparisons. "1 day ago", or "20 seconds ago" */
993  $format = $is_diff ? esc_html__( '%s ago', 'gravityview' ) : get_option( 'date_format' );
994  }
995 
996  // If raw was specified, don't modify the stored value
997  if ( $is_raw ) {
998  $formatted_date = $date_string;
999  } elseif( $is_timestamp ) {
1000  $formatted_date = $date_local_timestamp;
1001  } elseif ( $is_diff ) {
1002  $formatted_date = sprintf( $format, human_time_diff( $date_gmt_time ) );
1003  } else {
1004  $formatted_date = GFCommon::format_date( $date_string, $is_human, $format, $include_time );
1005  }
1006 
1007  unset( $format, $is_diff, $is_human, $is_timestamp, $is_raw, $date_gmt_time, $date_local_timestamp, $default_atts );
1008 
1009  return $formatted_date;
1010  }
1011 
1012  /**
1013  * Retrieve the label of a given field id (for a specific form)
1014  *
1015  * @access public
1016  * @since 1.17 Added $field_value parameter
1017  *
1018  * @param array $form Gravity Forms form array
1019  * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
1020  * @param string|array $field_value Raw value of the field.
1021  * @return string
1022  */
1023  public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
1024 
1025  if ( empty( $form ) || empty( $field_id ) ) {
1026  return '';
1027  }
1028 
1029  $field = self::get_field( $form, $field_id );
1030 
1031  $label = \GV\Utils::get( $field, 'label' );
1032 
1033  if( floor( $field_id ) !== floatval( $field_id ) ) {
1034  $label = GFFormsModel::get_choice_text( $field, $field_value, $field_id );
1035  }
1036 
1037  return $label;
1038  }
1039 
1040 
1041  /**
1042  * Returns the field details array of a specific form given the field id
1043  *
1044  * Alias of GFFormsModel::get_field
1045  *
1046  * @since 1.19 Allow passing form ID as well as form array
1047  *
1048  * @uses GFFormsModel::get_field
1049  * @see GFFormsModel::get_field
1050  * @access public
1051  * @param array|int $form Form array or ID
1052  * @param string|int $field_id
1053  * @return GF_Field|null Gravity Forms field object, or NULL: Gravity Forms GFFormsModel does not exist or field at $field_id doesn't exist.
1054  */
1055  public static function get_field( $form, $field_id ) {
1056 
1057  if ( is_numeric( $form ) ) {
1058  $form = GFAPI::get_form( $form );
1059  }
1060 
1061  if ( class_exists( 'GFFormsModel' ) ){
1062  return GFFormsModel::get_field( $form, $field_id );
1063  } else {
1064  return null;
1065  }
1066  }
1067 
1068 
1069  /**
1070  * Check whether the post is GravityView
1071  *
1072  * - Check post type. Is it `gravityview`?
1073  * - Check shortcode
1074  *
1075  * @param WP_Post $post WordPress post object
1076  * @return boolean True: yep, GravityView; No: not!
1077  */
1078  public static function has_gravityview_shortcode( $post = null ) {
1079  if ( ! is_a( $post, 'WP_Post' ) ) {
1080  return false;
1081  }
1082 
1083  if ( 'gravityview' === get_post_type( $post ) ) {
1084  return true;
1085  }
1086 
1087  return self::has_shortcode_r( $post->post_content, 'gravityview' ) ? true : false;
1088 
1089  }
1090 
1091 
1092  /**
1093  * Placeholder until the recursive has_shortcode() patch is merged
1094  * @see https://core.trac.wordpress.org/ticket/26343#comment:10
1095  * @param string $content Content to check whether there's a shortcode
1096  * @param string $tag Current shortcode tag
1097  */
1098  public static function has_shortcode_r( $content, $tag = 'gravityview' ) {
1099  if ( false === strpos( $content, '[' ) ) {
1100  return false;
1101  }
1102 
1103  if ( shortcode_exists( $tag ) ) {
1104 
1105  $shortcodes = array();
1106 
1107  preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
1108  if ( empty( $matches ) ){
1109  return false;
1110  }
1111 
1112  foreach ( $matches as $shortcode ) {
1113  if ( $tag === $shortcode[2] ) {
1114 
1115  // Changed this to $shortcode instead of true so we get the parsed atts.
1116  $shortcodes[] = $shortcode;
1117 
1118  } else if ( isset( $shortcode[5] ) && $results = self::has_shortcode_r( $shortcode[5], $tag ) ) {
1119  foreach( $results as $result ) {
1120  $shortcodes[] = $result;
1121  }
1122  }
1123  }
1124 
1125  return $shortcodes;
1126  }
1127  return false;
1128  }
1129 
1130 
1131 
1132  /**
1133  * Get the views for a particular form
1134  *
1135  * @since 1.15.2 Add $args array and limit posts_per_page to 500
1136  *
1137  * @uses get_posts()
1138  *
1139  * @param int $form_id Gravity Forms form ID
1140  * @param array $args Pass args sent to get_posts()
1141  *
1142  * @return array Array with view details, as returned by get_posts()
1143  */
1144  public static function get_connected_views( $form_id, $args = array() ) {
1145 
1146  global $wpdb;
1147 
1148  $defaults = array(
1149  'post_type' => 'gravityview',
1150  'posts_per_page' => 100,
1151  'meta_key' => '_gravityview_form_id',
1152  'meta_value' => (int) $form_id,
1153  );
1154  $args = wp_parse_args( $args, $defaults );
1155  $views = get_posts( $args );
1156 
1157  $views_with_joins = $wpdb->get_results( "SELECT `post_id`, `meta_value` FROM $wpdb->postmeta WHERE `meta_key` = '_gravityview_form_joins'" );
1158 
1159  $joined_forms = array();
1160  foreach ( $views_with_joins as $view ) {
1161 
1162  $data = unserialize( $view->meta_value );
1163 
1164  if( ! $data || ! is_array( $data ) ) {
1165  continue;
1166  }
1167 
1168  foreach ( $data as $datum ) {
1169  if ( ! empty( $datum[2] ) && (int) $datum[2] === (int) $form_id ) {
1170  $joined_forms[] = $view->post_id;
1171  }
1172  }
1173  }
1174 
1175  if ( $joined_forms ) {
1176  $joined_args = array(
1177  'post_type' => 'gravityview',
1178  'posts_per_page' => $args['posts_per_page'],
1179  'post__in' => $joined_forms,
1180  );
1181  $views = array_merge( $views, get_posts( $joined_args ) );
1182  }
1183 
1184  return $views;
1185  }
1186 
1187  /**
1188  * Get the Gravity Forms form ID connected to a View
1189  *
1190  * @param int $view_id The ID of the View to get the connected form of
1191  *
1192  * @return false|string ID of the connected Form, if exists. Empty string if not. False if not the View ID isn't valid.
1193  */
1194  public static function get_meta_form_id( $view_id ) {
1195  return get_post_meta( $view_id, '_gravityview_form_id', true );
1196  }
1197 
1198  /**
1199  * Get the template ID (`list`, `table`, `datatables`, `map`) for a View
1200  *
1201  * @see GravityView_Template::template_id
1202  *
1203  * @param int $view_id The ID of the View to get the layout of
1204  *
1205  * @return string GravityView_Template::template_id value. Empty string if not.
1206  */
1207  public static function get_meta_template_id( $view_id ) {
1208  return get_post_meta( $view_id, '_gravityview_directory_template', true );
1209  }
1210 
1211 
1212  /**
1213  * Get all the settings for a View
1214  *
1215  * @uses \GV\View_Settings::defaults() Parses the settings with the plugin defaults as backups.
1216  * @param int $post_id View ID
1217  * @return array Associative array of settings with plugin defaults used if not set by the View
1218  */
1219  public static function get_template_settings( $post_id ) {
1220 
1221  $settings = get_post_meta( $post_id, '_gravityview_template_settings', true );
1222 
1223  if ( class_exists( '\GV\View_Settings' ) ) {
1224 
1225  return wp_parse_args( (array)$settings, \GV\View_Settings::defaults() );
1226 
1227  }
1228 
1229  // Backup, in case GravityView_View_Data isn't loaded yet.
1230  return $settings;
1231  }
1232 
1233  /**
1234  * Get the setting for a View
1235  *
1236  * If the setting isn't set by the View, it returns the plugin default.
1237  *
1238  * @param int $post_id View ID
1239  * @param string $key Key for the setting
1240  * @return mixed|null Setting value, or NULL if not set.
1241  */
1242  public static function get_template_setting( $post_id, $key ) {
1243 
1244  $settings = self::get_template_settings( $post_id );
1245 
1246  if ( isset( $settings[ $key ] ) ) {
1247  return $settings[ $key ];
1248  }
1249 
1250  return null;
1251  }
1252 
1253  /**
1254  * Get the field configuration for the View
1255  *
1256  * array(
1257  *
1258  * [other zones]
1259  *
1260  * 'directory_list-title' => array(
1261  *
1262  * [other fields]
1263  *
1264  * '5372653f25d44' => array(
1265  * 'id' => string '9' (length=1)
1266  * 'label' => string 'Screenshots' (length=11)
1267  * 'show_label' => string '1' (length=1)
1268  * 'custom_label' => string '' (length=0)
1269  * 'custom_class' => string 'gv-gallery' (length=10)
1270  * 'only_loggedin' => string '0' (length=1)
1271  * 'only_loggedin_cap' => string 'read' (length=4)
1272  * )
1273  *
1274  * [other fields]
1275  * )
1276  *
1277  * [other zones]
1278  * )
1279  *
1280  * @since 1.17.4 Added $apply_filter parameter
1281  *
1282  * @param int $post_id View ID
1283  * @param bool $apply_filter Whether to apply the `gravityview/configuration/fields` filter [Default: true]
1284  * @return array Multi-array of fields with first level being the field zones. See code comment.
1285  */
1286  public static function get_directory_fields( $post_id, $apply_filter = true ) {
1287  $fields = get_post_meta( $post_id, '_gravityview_directory_fields', true );
1288 
1289  if ( $apply_filter ) {
1290  /**
1291  * @filter `gravityview/configuration/fields` Filter the View fields' configuration array
1292  * @since 1.6.5
1293  *
1294  * @param $fields array Multi-array of fields with first level being the field zones
1295  * @param $post_id int Post ID
1296  */
1297  $fields = apply_filters( 'gravityview/configuration/fields', $fields, $post_id );
1298 
1299  /**
1300  * @filter `gravityview/view/configuration/fields` Filter the View fields' configuration array.
1301  * @since 2.0
1302  *
1303  * @param array $fields Multi-array of fields with first level being the field zones.
1304  * @param \GV\View $view The View the fields are being pulled for.
1305  */
1306  $fields = apply_filters( 'gravityview/view/configuration/fields', $fields, \GV\View::by_id( $post_id ) );
1307  }
1308 
1309  return $fields;
1310  }
1311 
1312  /**
1313  * Get the widget configuration for a View
1314  *
1315  * @param int $view_id View ID
1316  * @param bool $json_decode Whether to JSON-decode the widget values. Default: `false`
1317  *
1318  * @return array Multi-array of widgets, with the slug of each widget "zone" being the key ("header_top"), and each widget having their own "id"
1319  */
1320  public static function get_directory_widgets( $view_id, $json_decode = false ) {
1321 
1322  $view_widgets = get_post_meta( $view_id, '_gravityview_directory_widgets', true );
1323 
1324  $defaults = array(
1325  'header_top' => array(),
1326  'header_left' => array(),
1327  'header_right' => array(),
1328  'footer_left' => array(),
1329  'footer_right' => array(),
1330  );
1331 
1332  $directory_widgets = wp_parse_args( $view_widgets, $defaults );
1333 
1334  if( $json_decode ) {
1335  $directory_widgets = gv_map_deep( $directory_widgets, 'gv_maybe_json_decode' );
1336  }
1337 
1338  return $directory_widgets;
1339  }
1340 
1341 
1342  /**
1343  * Render dropdown (select) with the list of sortable fields from a form ID
1344  *
1345  * @access public
1346  * @param int $formid Form ID
1347  * @return string html
1348  */
1349  public static function get_sortable_fields( $formid, $current = '' ) {
1350  $output = '<option value="" ' . selected( '', $current, false ).'>' . esc_html__( 'Default', 'gravityview' ) .'</option>';
1351 
1352  if ( empty( $formid ) ) {
1353  return $output;
1354  }
1355 
1356  $fields = self::get_sortable_fields_array( $formid );
1357 
1358  if ( ! empty( $fields ) ) {
1359 
1360  $blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', array( 'list', 'textarea' ), null );
1361 
1362  foreach ( $fields as $id => $field ) {
1363  if ( in_array( $field['type'], $blacklist_field_types ) ) {
1364  continue;
1365  }
1366 
1367  $output .= '<option value="'. $id .'" '. selected( $id, $current, false ).'>'. esc_attr( $field['label'] ) .'</option>';
1368  }
1369  }
1370 
1371  return $output;
1372  }
1373 
1374  /**
1375  *
1376  * @param int $formid Gravity Forms form ID
1377  * @param array $blacklist Field types to exclude
1378  *
1379  * @since 1.8
1380  *
1381  * @todo Get all fields, check if sortable dynamically
1382  *
1383  * @return array
1384  */
1385  public static function get_sortable_fields_array( $formid, $blacklist = array( 'list', 'textarea' ) ) {
1386 
1387  // Get fields with sub-inputs and no parent
1388  $fields = self::get_form_fields( $formid, true, false );
1389 
1390  $date_created = array(
1391  'date_created' => array(
1392  'type' => 'date_created',
1393  'label' => __( 'Date Created', 'gravityview' ),
1394  ),
1395  );
1396 
1397  $fields = $date_created + $fields;
1398 
1399  $blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', $blacklist, NULL );
1400 
1401  // TODO: Convert to using array_filter
1402  foreach( $fields as $id => $field ) {
1403 
1404  if( in_array( $field['type'], $blacklist_field_types ) ) {
1405  unset( $fields[ $id ] );
1406  }
1407  }
1408 
1409  /**
1410  * @filter `gravityview/common/sortable_fields` Filter the sortable fields
1411  * @since 1.12
1412  * @param array $fields Sub-set of GF form fields that are sortable
1413  * @param int $formid The Gravity Forms form ID that the fields are from
1414  */
1415  $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
1416 
1417  return $fields;
1418  }
1419 
1420  /**
1421  * Returns the GF Form field type for a certain field(id) of a form
1422  * @param object $form Gravity Forms form
1423  * @param mixed $field_id Field ID or Field array
1424  * @return string field type
1425  */
1426  public static function get_field_type( $form = null, $field_id = '' ) {
1427 
1428  if ( ! empty( $field_id ) && ! is_array( $field_id ) ) {
1429  $field = self::get_field( $form, $field_id );
1430  } else {
1431  $field = $field_id;
1432  }
1433 
1434  return class_exists( 'RGFormsModel' ) ? RGFormsModel::get_input_type( $field ) : '';
1435 
1436  }
1437 
1438 
1439  /**
1440  * Checks if the field type is a 'numeric' field type (e.g. to be used when sorting)
1441  * @param int|array $form form ID or form array
1442  * @param int|array $field field key or field array
1443  * @return boolean
1444  */
1445  public static function is_field_numeric( $form = null, $field = '' ) {
1446 
1447  if ( ! is_array( $form ) && ! is_array( $field ) ) {
1448  $form = self::get_form( $form );
1449  }
1450 
1451  // If entry meta, it's a string. Otherwise, numeric
1452  if( ! is_numeric( $field ) && is_string( $field ) ) {
1453  $type = $field;
1454  } else {
1455  $type = self::get_field_type( $form, $field );
1456  }
1457 
1458  /**
1459  * @filter `gravityview/common/numeric_types` What types of fields are numeric?
1460  * @since 1.5.2
1461  * @param array $numeric_types Fields that are numeric. Default: `[ number, time ]`
1462  */
1463  $numeric_types = apply_filters( 'gravityview/common/numeric_types', array( 'number', 'time' ) );
1464 
1465  // Defer to GravityView_Field setting, if the field type is registered and `is_numeric` is true
1466  if( $gv_field = GravityView_Fields::get( $type ) ) {
1467  if( true === $gv_field->is_numeric ) {
1468  $numeric_types[] = $gv_field->is_numeric;
1469  }
1470  }
1471 
1472  $return = in_array( $type, $numeric_types );
1473 
1474  return $return;
1475  }
1476 
1477  /**
1478  * Encrypt content using Javascript so that it's hidden when JS is disabled.
1479  *
1480  * This is mostly used to hide email addresses from scraper bots.
1481  *
1482  * @param string $content Content to encrypt
1483  * @param string $message Message shown if Javascript is disabled
1484  *
1485  * @see https://github.com/katzwebservices/standalone-phpenkoder StandalonePHPEnkoder on Github
1486  *
1487  * @since 1.7
1488  *
1489  * @return string Content, encrypted
1490  */
1491  public static function js_encrypt( $content, $message = '' ) {
1492 
1493  $output = $content;
1494 
1495  if ( ! class_exists( 'StandalonePHPEnkoder' ) ) {
1496  include_once( GRAVITYVIEW_DIR . 'includes/lib/StandalonePHPEnkoder.php' );
1497  }
1498 
1499  if ( class_exists( 'StandalonePHPEnkoder' ) ) {
1500 
1501  $enkoder = new StandalonePHPEnkoder;
1502 
1503  $message = empty( $message ) ? __( 'Email hidden; Javascript is required.', 'gravityview' ) : $message;
1504 
1505  /**
1506  * @filter `gravityview/phpenkoder/msg` Modify the message shown when Javascript is disabled and an encrypted email field is displayed
1507  * @since 1.7
1508  * @param string $message Existing message
1509  * @param string $content Content to encrypt
1510  */
1511  $enkoder->enkode_msg = apply_filters( 'gravityview/phpenkoder/msg', $message, $content );
1512 
1513  $output = $enkoder->enkode( $content );
1514  }
1515 
1516  return $output;
1517  }
1518 
1519  /**
1520  *
1521  * Do the same than parse_str without max_input_vars limitation:
1522  * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
1523  * @param $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
1524  * @param $result array If the second parameter is present, variables are stored in this variable as array elements
1525  * @return bool true or false if $string is an empty string
1526  * @since 1.5.3
1527  *
1528  * @author rubo77 at https://gist.github.com/rubo77/6821632
1529  **/
1530  public static function gv_parse_str( $string, &$result ) {
1531  if ( empty( $string ) ) {
1532  return false;
1533  }
1534 
1535  $result = array();
1536 
1537  // find the pairs "name=value"
1538  $pairs = explode( '&', $string );
1539 
1540  foreach ( $pairs as $pair ) {
1541  // use the original parse_str() on each element
1542  parse_str( $pair, $params );
1543 
1544  $k = key( $params );
1545  if ( ! isset( $result[ $k ] ) ) {
1546  $result += $params;
1547  } elseif ( array_key_exists( $k, $params ) && is_array( $params[ $k ] ) ) {
1548  $result[ $k ] = self::array_merge_recursive_distinct( $result[ $k ], $params[ $k ] );
1549  }
1550  }
1551  return true;
1552  }
1553 
1554 
1555  /**
1556  * Generate an HTML anchor tag with a list of supported attributes
1557  *
1558  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a Supported attributes defined here
1559  * @uses esc_url_raw() to sanitize $href
1560  * @uses esc_attr() to sanitize $atts
1561  *
1562  * @since 1.6
1563  *
1564  * @param string $href URL of the link. Sanitized using `esc_url_raw()`
1565  * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1566  * @param array|string $atts Attributes to be added to the anchor tag. Parsed by `wp_parse_args()`, sanitized using `esc_attr()`
1567  *
1568  * @return string HTML output of anchor link. If empty $href, returns NULL
1569  */
1570  public static function get_link_html( $href = '', $anchor_text = '', $atts = array() ) {
1571 
1572  // Supported attributes for anchor tags. HREF left out intentionally.
1573  $allowed_atts = array(
1574  'href' => null, // Will override the $href argument if set
1575  'title' => null,
1576  'rel' => null,
1577  'id' => null,
1578  'class' => null,
1579  'target' => null,
1580  'style' => null,
1581 
1582  // Used by GravityView
1583  'data-viewid' => null,
1584 
1585  // Not standard
1586  'hreflang' => null,
1587  'type' => null,
1588  'tabindex' => null,
1589 
1590  // Deprecated HTML4 but still used
1591  'name' => null,
1592  'onclick' => null,
1593  'onchange' => null,
1594  'onkeyup' => null,
1595 
1596  // HTML5 only
1597  'download' => null,
1598  'media' => null,
1599  'ping' => null,
1600  );
1601 
1602  /**
1603  * @filter `gravityview/get_link/allowed_atts` Modify the attributes that are allowed to be used in generating links
1604  * @param array $allowed_atts Array of attributes allowed
1605  */
1606  $allowed_atts = apply_filters( 'gravityview/get_link/allowed_atts', $allowed_atts );
1607 
1608  // Make sure the attributes are formatted as array
1609  $passed_atts = wp_parse_args( $atts );
1610 
1611  // Make sure the allowed attributes are only the ones in the $allowed_atts list
1612  $final_atts = shortcode_atts( $allowed_atts, $passed_atts );
1613 
1614  // Remove attributes with empty values
1615  $final_atts = array_filter( $final_atts );
1616 
1617  // If the href wasn't passed as an attribute, use the value passed to the function
1618  if ( empty( $final_atts['href'] ) && ! empty( $href ) ) {
1619  $final_atts['href'] = $href;
1620  }
1621 
1622  $final_atts['href'] = esc_url_raw( $href );
1623 
1624  /**
1625  * Fix potential security issue with target=_blank
1626  * @see https://dev.to/ben/the-targetblank-vulnerability-by-example
1627  */
1628  if( '_blank' === \GV\Utils::get( $final_atts, 'target' ) ) {
1629  $final_atts['rel'] = trim( \GV\Utils::get( $final_atts, 'rel', '' ) . ' noopener noreferrer' );
1630  }
1631 
1632  // Sort the attributes alphabetically, to help testing
1633  ksort( $final_atts );
1634 
1635  // For each attribute, generate the code
1636  $output = '';
1637  foreach ( $final_atts as $attr => $value ) {
1638  $output .= sprintf( ' %s="%s"', $attr, esc_attr( $value ) );
1639  }
1640 
1641  if( '' !== $output ) {
1642  $output = '<a' . $output . '>' . $anchor_text . '</a>';
1643  }
1644 
1645  return $output;
1646  }
1647 
1648  /**
1649  * array_merge_recursive does indeed merge arrays, but it converts values with duplicate
1650  * keys to arrays rather than overwriting the value in the first array with the duplicate
1651  * value in the second array, as array_merge does.
1652  *
1653  * @see http://php.net/manual/en/function.array-merge-recursive.php
1654  *
1655  * @since 1.5.3
1656  * @param array $array1
1657  * @param array $array2
1658  * @return array
1659  * @author Daniel <daniel (at) danielsmedegaardbuus (dot) dk>
1660  * @author Gabriel Sobrinho <gabriel (dot) sobrinho (at) gmail (dot) com>
1661  */
1662  public static function array_merge_recursive_distinct( array &$array1, array &$array2 ) {
1663  $merged = $array1;
1664  foreach ( $array2 as $key => $value ) {
1665  if ( is_array( $value ) && isset( $merged[ $key ] ) && is_array( $merged[ $key ] ) ) {
1666  $merged[ $key ] = self::array_merge_recursive_distinct( $merged[ $key ], $value );
1667  } else if ( is_numeric( $key ) && isset( $merged[ $key ] ) ) {
1668  $merged[] = $value;
1669  } else {
1670  $merged[ $key ] = $value;
1671  }
1672  }
1673 
1674  return $merged;
1675  }
1676 
1677  /**
1678  * Get WordPress users with reasonable limits set
1679  *
1680  * @param string $context Where are we using this information (e.g. change_entry_creator, search_widget ..)
1681  * @param array $args Arguments to modify the user query. See get_users() {@since 1.14}
1682  * @return array Array of WP_User objects.
1683  */
1684  public static function get_users( $context = 'change_entry_creator', $args = array() ) {
1685 
1686  $default_args = array(
1687  'number' => 2000,
1688  'orderby' => 'display_name',
1689  'order' => 'ASC',
1690  'fields' => array( 'ID', 'display_name', 'user_login', 'user_nicename' )
1691  );
1692 
1693  // Merge in the passed arg
1694  $get_users_settings = wp_parse_args( $args, $default_args );
1695 
1696  /**
1697  * @filter `gravityview/get_users/{$context}` There are issues with too many users using [get_users()](http://codex.wordpress.org/Function_Reference/get_users) where it breaks the select. We try to keep it at a reasonable number. \n
1698  * `$context` is where are we using this information (e.g. change_entry_creator, search_widget ..)
1699  * @param array $settings Settings array, with `number` key defining the # of users to display
1700  */
1701  $get_users_settings = apply_filters( 'gravityview/get_users/'. $context, apply_filters( 'gravityview_change_entry_creator_user_parameters', $get_users_settings ) );
1702 
1703  return get_users( $get_users_settings );
1704  }
1705 
1706 
1707  /**
1708  * Display updated/error notice
1709  *
1710  * @since 1.19.2 Added $cap and $object_id parameters
1711  *
1712  * @param string $notice text/HTML of notice
1713  * @param string $class CSS class for notice (`updated` or `error`)
1714  * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
1715  *
1716  * @return string
1717  */
1718  public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
1719 
1720  // If $cap is defined, only show notice if user has capability
1721  if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
1722  return '';
1723  }
1724 
1725  return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
1726  }
1727 
1728  /**
1729  * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets
1730  * @since 1.16.5
1731  * @param string $string Input string to decode
1732  * @return string $string Output string
1733  */
1734  public static function decode_shortcodes( $string ) {
1735  $replace = array( '[', ']', '"' );
1736  $find = array( '&#91;', '&#93;', '&quot;' );
1737  $string = str_replace( $find, $replace, $string );
1738 
1739  return $string;
1740  }
1741 
1742 
1743  /**
1744  * Send email using GFCommon::send_email()
1745  *
1746  * @since 1.17
1747  *
1748  * @see GFCommon::send_email This just makes the method public
1749  *
1750  * @param string $from Sender address (required)
1751  * @param string $to Recipient address (required)
1752  * @param string $bcc BCC recipients (required)
1753  * @param string $reply_to Reply-to address (required)
1754  * @param string $subject Subject line (required)
1755  * @param string $message Message body (required)
1756  * @param string $from_name Displayed name of the sender
1757  * @param string $message_format If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
1758  * @param string|array $attachments Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
1759  * @param array|false $entry Gravity Forms entry array, related to the email. Default: false.
1760  * @param array|false $notification Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
1761  */
1762  public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
1763 
1764  $SendEmail = new ReflectionMethod( 'GFCommon', 'send_email' );
1765 
1766  // It was private; let's make it public
1767  $SendEmail->setAccessible( true );
1768 
1769  // Required: $from, $to, $bcc, $replyTo, $subject, $message
1770  // Optional: $from_name, $message_format, $attachments, $lead, $notification
1771  $SendEmail->invoke( new GFCommon, $from, $to, $bcc, $reply_to, $subject, $message, $from_name, $message_format, $attachments, $entry, $notification );
1772  }
1773 
1774 
1775 } //end class
1776 
1777 
1778 /**
1779  * Generate an HTML anchor tag with a list of supported attributes
1780  *
1781  * @see GVCommon::get_link_html()
1782  *
1783  * @since 1.6
1784  *
1785  * @param string $href URL of the link.
1786  * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1787  * @param array|string $atts Attributes to be added to the anchor tag
1788  *
1789  * @return string HTML output of anchor link. If empty $href, returns NULL
1790  */
1791 function gravityview_get_link( $href = '', $anchor_text = '', $atts = array() ) {
1792  return GVCommon::get_link_html( $href, $anchor_text, $atts );
1793 }
const GRAVITYVIEW_DIR
"GRAVITYVIEW_DIR" "./" The absolute path to the plugin directory, with trailing slash ...
Definition: gravityview.php:40
static get_entry_meta( $form_id, $only_default_column=true)
get extra fields from entry meta
static has_product_field( $form=array())
Check whether a form has product fields.
static has_shortcode_r( $content, $tag='gravityview')
Placeholder until the recursive has_shortcode() patch is merged.
static js_encrypt( $content, $message='')
Encrypt content using Javascript so that it&#39;s hidden when JS is disabled.
$forms
Definition: data-source.php:19
static get_entry_id_from_slug( $slug)
Get the entry ID from the entry slug, which may or may not be the entry ID.
static array_merge_recursive_distinct(array &$array1, array &$array2)
array_merge_recursive does indeed merge arrays, but it converts values with duplicate keys to arrays ...
static get_directory_widgets( $view_id, $json_decode=false)
Get the widget configuration for a View.
static get_connected_views( $form_id, $args=array())
Get the views for a particular form.
static get_form_fields( $form='', $add_default_properties=false, $include_parent_field=true)
Return array of fields&#39; id and label, for a given Form ID.
static entry_has_transaction_data( $entry=array())
Check if an entry has transaction data.
static calculate_get_entries_criteria( $passed_criteria=array(), $form_ids=array())
Calculates the Search Criteria used on the self::get_entries / self::get_entry methods.
new GravityView_Cache
static get_form_from_entry_id( $entry_slug)
Get the form array for an entry based only on the entry ID.
static getInstance( $passed_post=NULL)
Definition: class-data.php:120
static get_template_setting( $post_id, $key)
Get the setting for a View.
if(gv_empty( $field['value'], false, false)) $format
static get( $field_name)
Alias for get_instance()
If this file is called directly, abort.
static get_meta_form_id( $view_id)
Get the Gravity Forms form ID connected to a View.
static get_entry( $entry_slug, $force_allow_ids=false, $check_entry_display=true)
Return a single entry object.
static get_forms( $active=true, $trash=false)
Alias of GFAPI::get_forms()
static has_cap( $caps_to_check='', $object_id=null, $user_id=null)
Check whether the current user has a capability.
static get_directory_fields( $post_id, $apply_filter=true)
Get the field configuration for the View.
static decode_shortcodes( $string)
Inspired on ::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortc...
$class
static generate_notice( $notice, $class='', $cap='', $object_id=null)
Display updated/error notice.
$entries
gravityview_get_link( $href='', $anchor_text='', $atts=array())
Generate an HTML anchor tag with a list of supported attributes.
static get_sortable_fields( $formid, $current='')
Render dropdown (select) with the list of sortable fields from a form ID.
static is_value_match( $field_value, $target_value, $operation='is', $source_field=null, $rule=null, $form=null)
Determines if the field value matches the conditional logic rule value.
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 ...
gravityview()
Definition: _stubs.php:26
get( $key, $default=null)
Retrieve a setting.
static matches_operation( $val1, $val2, $operation)
Wrapper for the GFFormsModel::matches_operation() method that adds additional comparisons, including: &#39;equals&#39;, &#39;greater_than_or_is&#39;, &#39;greater_than_or_equals&#39;, &#39;less_than_or_is&#39;, &#39;less_than_or_equals&#39;, &#39;not_contains&#39;, &#39;in&#39;, and &#39;not_in&#39;.
$criteria['paging']
Modify the search parameters before the entries are fetched.
static get_template_settings( $post_id)
Get all the settings for a View.
if(empty( $field_settings['content'])) $content
Definition: custom.php:37
static get_entry_id( $entry_id_or_slug='', $force_allow_ids=false)
Get the entry ID from a string that may be the Entry ID or the Entry Slug.
static get_entry_ids( $form_id, $search_criteria=array())
Wrapper for the Gravity Forms GFFormsModel::search_lead_ids() method.
gv_map_deep( $value, $callback)
Maps a function to all non-iterable elements of an array or an object.
static get_field_type( $form=null, $field_id='')
Returns the GF Form field type for a certain field(id) of a form.
static get_field_array( $field)
Return a Gravity Forms field array, whether using GF 1.9 or not.
static check_entry_display( $entry, $view=null)
Checks if a certain entry is valid according to the View search filters (specially the Adv Filters) ...
if(empty( $created_by)) $search_criteria
There was no logged in user who created this entry.
static get_product_field_types()
Return array of product field types.
static get_field( $form, $field_id)
Returns the field details array of a specific form given the field id.
$gv_field
Definition: time.php:11
static send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name='', $message_format='html', $attachments='', $entry=false, $notification=false)
Send email using GFCommon::send_email()
static get_all( $group='')
Get all fields.
static is_field_numeric( $form=null, $field='')
Checks if the field type is a &#39;numeric&#39; field type (e.g.
static get_users( $context='change_entry_creator', $args=array())
Get WordPress users with reasonable limits set.
gravityview_get_form_id( $view_id)
Get the connected form ID from a View ID.
static format_date( $date_string='', $args=array())
Allow formatting date and time based on GravityView standards.
defaults()
Default settings.
$field_id
Definition: time.php:17
static get_entries( $form_ids=null, $passed_criteria=null, &$total=null)
Retrieve entries given search, sort, paging criteria.
static has_gravityview_shortcode( $post=null)
Check whether the post is GravityView.
if(empty( $created_by)) $form_id
static get_sortable_fields_array( $formid, $blacklist=array( 'list', 'textarea'))
static get( $array, $key, $default=null)
Grab a value from an array or an object or default.
global $post
static get_field_label( $form=array(), $field_id='', $field_value='')
Retrieve the label of a given field id (for a specific form)
gravityview_get_context()
Returns the current GravityView context, or empty string if not GravityView.
Definition: class-api.php:1158
$entry_slug
Definition: notes.php:30
static has_cap( $caps='', $object_id=null, $user_id=null)
Alias of GravityView_Roles_Capabilities::has_cap()
static get_meta_template_id( $view_id)
Get the template ID (list, table, datatables, map) for a View.
$entry
Definition: notes.php:27
static get_all_views( $args=array())
Get all existing Views.
static get_link_html( $href='', $anchor_text='', $atts=array())
Generate an HTML anchor tag with a list of supported attributes.
static get_form( $form_id)
Returns the form object for a given Form ID.
$field_value
Definition: checkbox.php:24
$field
Definition: gquiz_grade.php:11
static getInstance()
Get the one true instantiated self.