Completed
Push — develop ( 5b5c67...50c7f0 )
by Gennady
06:16
created

GVCommon::check_entry_display()   C

Complexity

Conditions 14
Paths 22

Size

Total Lines 98

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 43
CRAP Score 14.1207

Importance

Changes 0
Metric Value
cc 14
nc 22
nop 2
dl 0
loc 98
ccs 43
cts 47
cp 0.9149
crap 14.1207
rs 5.0569
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
2
/**
3
 * 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 32
	public static function get_form( $form_id ) {
29 32
		if ( empty( $form_id ) ) {
30
			return false;
31
		}
32
33
		// Only get_form_meta is cached. ::facepalm::
34 32
		if ( class_exists( 'GFFormsModel' ) ) {
35 32
			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 48
	public static function has_cap( $caps = '', $object_id = null, $user_id = null ) {
59 48
		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 3
	public static function get_all_views( $args = array() ) {
96
97
		$default_params = array(
98 3
			'post_type' => 'gravityview',
99
			'posts_per_page' => -1,
100
			'post_status' => 'publish',
101
		);
102
103 3
		$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 3
		$views_params = apply_filters( 'gravityview/get_all_views/params', $params );
110
111 3
		$views = get_posts( $views_params );
112
113 3
		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 6
	public static function has_product_field( $form = array() ) {
146
147 6
		$product_fields = self::get_product_field_types();
148
149 6
		$fields = GFAPI::get_fields_by_type( $form, $product_fields );
150
151 6
		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 23
	public static function get_product_field_types() {
164
165 23
		$product_fields = apply_filters( 'gform_product_field_types', array( 'option', 'quantity', 'product', 'total', 'shipping', 'calculation', 'price', 'hiddenproduct', 'singleproduct', 'singleshipping' ) );
166
167 23
		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 23
	public static function entry_has_transaction_data( $entry = array() ) {
182
183 23
		if ( ! is_array( $entry ) ) {
184 1
			return false;
185
		}
186
187 23
		$has_transaction_data = false;
188
189 23
		$payment_meta = array( 'payment_status', 'payment_date', 'transaction_id', 'payment_amount', 'payment_method' );
190
191 23
		foreach ( $payment_meta as $meta ) {
192
193 23
			$has_transaction_data = \GV\Utils::get( $entry, $meta, false );
194
195 23
			if ( is_numeric( $has_transaction_data ) && ( ! floatval( $has_transaction_data ) > 0 ) ) {
196 3
				$has_transaction_data = false;
197 3
				continue;
198
			}
199
200 23
			if ( ! empty( $has_transaction_data ) ) {
201 17
				break;
202
			}
203
		}
204
205 23
		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 1
	public static function get_forms(  $active = true, $trash = false ) {
261 1
		$forms = array();
262 1
		if ( class_exists( 'GFAPI' ) ) {
263 1
			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 1
				$forms = GFAPI::get_forms( $active, $trash );
269
			}
270
		}
271 1
		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
0 ignored issues
show
Bug introduced by
There is no parameter named $form_id. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
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 72
	public static function calculate_get_entries_criteria( $passed_criteria = array(), $form_ids = array() ) {
431
432
		$search_criteria_defaults = array(
433 72
			'search_criteria' => null,
434
			'sorting' => null,
435
			'paging' => null,
436 72
			'cache' => (isset( $passed_criteria['cache'] ) ? (bool) $passed_criteria['cache'] : true),
437
			'context_view_id' => null,
438
		);
439
440 72
		$criteria = wp_parse_args( $passed_criteria, $search_criteria_defaults );
441
442 72
		if ( ! empty( $criteria['search_criteria']['field_filters'] ) && is_array( $criteria['search_criteria']['field_filters'] ) ) {
443 15
			foreach ( $criteria['search_criteria']['field_filters'] as &$filter ) {
444
445 15
				if ( ! is_array( $filter ) ) {
446 14
					continue;
447
				}
448
449
				// By default, we want searches to be wildcard for each field.
450 15
				$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 15
				$filter['operator'] = apply_filters( 'gravityview_search_operator', $filter['operator'], $filter );
458
			}
459
460
			// don't send just the [mode] without any field filter.
461 15
			if( count( $criteria['search_criteria']['field_filters'] ) === 1 && array_key_exists( 'mode' , $criteria['search_criteria']['field_filters'] ) ) {
462 1
				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 72
		foreach ( array('start_date', 'end_date' ) as $key ) {
474
475 72
			if ( ! empty( $criteria['search_criteria'][ $key ] ) ) {
476
477
				// Use date_create instead of new DateTime so it returns false if invalid date format.
478 2
				$date = date_create( $criteria['search_criteria'][ $key ] );
479
480 2
				if ( $date ) {
481
					// Gravity Forms wants dates in the `Y-m-d H:i:s` format.
482 2
					$criteria['search_criteria'][ $key ] = $date->format( 'Y-m-d H:i:s' );
483
				} else {
484 1
					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 1
					unset( $criteria['search_criteria'][ $key ] );
488
				}
489
			}
490
		}
491
492 72
		if ( empty( $criteria['context_view_id'] ) ) {
493
			// Calculate the context view id and send it to the advanced filter
494 2
			if ( GravityView_frontend::getInstance()->getSingleEntry() ) {
495 1
				$criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
496 2
			} else if ( class_exists( 'GravityView_View_Data' ) && GravityView_View_Data::getInstance() && GravityView_View_Data::getInstance()->has_multiple_views() ) {
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
497 1
				$criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
498 2
			} else if ( 'delete' === GFForms::get( 'action' ) ) {
499 1
				$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 72
		$criteria = apply_filters( 'gravityview_search_criteria', $criteria, $form_ids, $criteria['context_view_id'] );
510
511 72
		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 3
	public static function get_entry_id( $entry_id_or_slug = '', $force_allow_ids = false ) {
626
627 3
		$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 3
		$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 3
		$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 3
		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 3
		if ( false === $custom_slug || true === $custom_slug_id_access ) {
655
			// Search for IDs matching $entry_slug
656 3
			$entry_id = $entry_id_or_slug;
657
		}
658
659 3
		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 32
	public static function get_entry( $entry_slug, $force_allow_ids = false, $check_entry_display = true ) {
674
675 32
		if ( ! class_exists( 'GFAPI' ) || empty( $entry_slug ) ) {
676 30
			return false;
677
		}
678
679 3
		$entry_id = self::get_entry_id( $entry_slug, $force_allow_ids );
680
681 3
		if ( empty( $entry_id ) ) {
682
			return false;
683
		}
684
685
		// fetch the entry
686 3
		$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 3
		$check_entry_display = apply_filters( 'gravityview/common/get_entry/check_entry_display', $check_entry_display, $entry );
695
696 3
		if( $check_entry_display ) {
697
			// Is the entry allowed
698 1
			$entry = self::check_entry_display( $entry );
699
		}
700
701 3
		if( is_wp_error( $entry ) ) {
702 2
			gravityview()->log->error( '{error}', array( 'error' => $entry->get_error_message() ) );
703 2
			return false;
704
		}
705
706 2
		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 25
	public static function matches_operation( $val1, $val2, $operation ) {
728
729
		// Only process strings
730 25
		$val1 = ! is_string( $val1 ) ? wp_json_encode( $val1 ) : $val1;
731 25
		$val2 = ! is_string( $val2 ) ? wp_json_encode( $val2 ) : $val2;
732
733 25
		$value = false;
734
735 25
		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;
0 ignored issues
show
Deprecated Code introduced by
The function gravityview_get_context() has been deprecated with message: since 2.0.6.2 Use `gravityview()->request`

This function has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead.

Loading history...
752
		}
753
754 25
		switch ( $operation ) {
755 25
			case 'equals':
756 7
				$value = self::matches_operation( $val1, $val2, 'is' );
757 7
				break;
758 25
			case 'greater_than_or_is':
759 25
			case 'greater_than_or_equals':
760 5
				$is    = self::matches_operation( $val1, $val2, 'is' );
761 5
				$gt    = self::matches_operation( $val1, $val2, 'greater_than' );
762 5
				$value = ( $is || $gt );
763 5
				break;
764 25
			case 'less_than_or_is':
765 25
			case 'less_than_or_equals':
766 3
				$is    = self::matches_operation( $val1, $val2, 'is' );
767 3
				$gt    = self::matches_operation( $val1, $val2, 'less_than' );
768 3
				$value = ( $is || $gt );
769 3
				break;
770 25
			case 'not_contains':
771 1
				$contains = self::matches_operation( $val1, $val2, 'contains' );
772 1
				$value    = ! $contains;
773 1
				break;
774
			/**
775
			 * @since 1.22.1 Handle JSON-encoded comparisons
776
			 */
777 25
			case 'in':
778 25
			case 'not_in':
779
780 1
				$json_val_1 = json_decode( $val1, true );
781 1
				$json_val_2 = json_decode( $val2, true );
782
783 1
				if( ! empty( $json_val_1 ) || ! empty( $json_val_2 ) ) {
784
785 1
					$json_in = false;
786 1
					$json_val_1 = $json_val_1 ? (array) $json_val_1 : array( $val1 );
787 1
					$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 1
					foreach ( $json_val_1 as $item_1 ) {
791 1
						foreach ( $json_val_2 as $item_2 ) {
792 1
							$json_in = self::matches_operation( $item_1, $item_2, 'is' );
793
794 1
							if( $json_in ) {
795 1
								break 2;
796
							}
797
						}
798
					}
799
800 1
					$value = ( $operation === 'in' ) ? $json_in : ! $json_in;
801
				}
802 1
				break;
803
804 25
			case 'less_than':
805 23
			case '<' :
806 5
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
807 5
					$value = $val1 < $val2;
808
				} else {
809
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
810
				}
811 5
				break;
812 23
			case 'greater_than':
813 21
			case '>' :
814 9
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
815 9
					$value = $val1 > $val2;
816
				} else {
817
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
818
				}
819 9
				break;
820
			default:
821 21
				$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
822
		}
823
824 25
		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 11
	public static function check_entry_display( $entry, $view = null ) {
844
845 11
		if ( ! $entry || is_wp_error( $entry ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $entry of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
846 1
			return new WP_Error('entry_not_found', 'Entry was not found.', $entry );
847
		}
848
849 11
		if ( empty( $entry['form_id'] ) ) {
850 1
			return new WP_Error( 'form_id_not_set', '[apply_filters_to_entry] Entry is empty!', $entry );
851
		}
852
853 11
		if ( is_null( $view ) ) {
854 2
			gravityview()->log->warning( '$view was not supplied to check_entry_display, results will be non-typical.' );
855 2
			return new WP_Error( 'view_not_supplied', 'View is not supplied!', $entry );
856
		}
857
858 10
		if ( ! gravityview()->plugin->supports( \GV\Plugin::FEATURE_GFQUERY ) ) {
859
			return new WP_Error( 'no_gf_query', 'GF_Query is missing.', $entry );
860
		}
861
862 10
		$view_form_id = $view->form->ID;
863
864 10
		if ( $view->joins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $view->joins of type GV\Join[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
865 1
			if ( in_array( (int)$entry['form_id'], array_keys( $view::get_joined_forms( $view->ID ) ), true ) ) {
866 1
				$view_form_id = $entry['form_id'];
867
			}
868
		}
869
870 10
		if ( $view_form_id != $entry['form_id'] ) {
871 1
			return new WP_Error( 'view_id_not_match', 'View form source does not match entry form source ID.', $entry );
872
		}
873
874
		/**
875
		 * Check whether the entry is in the entries subset by running a modified query.
876
		 */
877 10
		add_action( 'gravityview/view/query', $entry_subset_callback = function( &$query, $view, $request ) use ( $entry, $view_form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $view is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
878 10
			$_tmp_query       = new \GF_Query( $view_form_id, array(
879
				'field_filters' => array(
880 10
					'mode' => 'all',
881
					array(
882 10
						'key' => 'id',
883 10
						'operation' => 'is',
884 10
						'value' => $entry['id']
885
					)
886
				)
887
			) );
888
889 10
			$_tmp_query_parts = $_tmp_query->_introspect();
890
891
			/** @var \GF_Query $query */
892 10
			$query_parts      = $query->_introspect();
893
894 10
			$query->where( \GF_Query_Condition::_and( $_tmp_query_parts['where'], $query_parts['where'] ) );
895
896 10
		}, 10, 3 );
897
898
		// Prevent page offset from being applied to the single entry query; it's used to return to the referring page number
899 10
		add_filter( 'gravityview_search_criteria', $remove_pagenum = function( $criteria ) {
900
901 10
			$criteria['paging'] = array(
902
				'offset' => 0,
903
				'page_size' => 25
904
			);
905
906 10
			return $criteria;
907 10
		} );
908
909 10
		$entries = $view->get_entries()->all();
910
911
		// Remove the modifying filter
912 10
		remove_filter( 'gravityview_search_criteria', $remove_pagenum );
913
914 10
		if ( ! $entries ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $entries of type GV\Entry[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
915 7
			remove_action( 'gravityview/view/query', $entry_subset_callback );
916 7
			return new \WP_Error( 'failed_criteria', 'Entry failed search_criteria and field_filters' );
917
		}
918
919
		// This entry is on a View with joins
920 9
		if ( $entries[0]->is_multi() ) {
921
922 1
			$multi_entry_ids = array();
923
924 1
			foreach ( $entries[0]->entries as $multi_entry ) {
0 ignored issues
show
Bug introduced by
The property entries does not seem to exist in GV\Entry.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
925 1
				$multi_entry_ids[] = (int) $multi_entry->ID;
926
			}
927
928 1
			if ( ! in_array( (int) $entry['id'], $multi_entry_ids, true ) ) {
929
				remove_action( 'gravityview/view/query', $entry_subset_callback );
930 1
				return new \WP_Error( 'failed_criteria', 'Entry failed search_criteria and field_filters' );
931
			}
932
933 8
		} elseif ( (int) $entries[0]->ID !== (int) $entry['id'] ) {
934
			remove_action( 'gravityview/view/query', $entry_subset_callback );
935
			return new \WP_Error( 'failed_criteria', 'Entry failed search_criteria and field_filters' );
936
		}
937
938 9
		remove_action( 'gravityview/view/query', $entry_subset_callback );
939 9
		return $entry;
940
	}
941
942
943
	/**
944
	 * Allow formatting date and time based on GravityView standards
945
	 *
946
	 * @since 1.16
947
	 *
948
	 * @see GVCommon_Test::test_format_date for examples
949
	 *
950
	 * @param string $date_string The date as stored by Gravity Forms (`Y-m-d h:i:s` GMT)
951
	 * @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
952
	 * - `raw` Un-formatted date string in original `Y-m-d h:i:s` format
953
	 * - `timestamp` Integer timestamp returned by GFCommon::get_local_timestamp()
954
	 * - `diff` "%s ago" format, unless other `format` is defined
955
	 * - `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.
956
	 * - `time` Include time in the `GFCommon::format_date()` output
957
	 * - `format` Define your own date format, or `diff` format
958
	 *
959
	 * @return int|null|string Formatted date based on the original date
960
	 */
961 6
	public static function format_date( $date_string = '', $args = array() ) {
962
963
		$default_atts = array(
964 6
			'raw' => false,
965
			'timestamp' => false,
966
			'diff' => false,
967
			'human' => false,
968
			'format' => '',
969
			'time' => false,
970
		);
971
972 6
		$atts = wp_parse_args( $args, $default_atts );
973
974
		/**
975
		 * Gravity Forms code to adjust date to locally-configured Time Zone
976
		 * @see GFCommon::format_date() for original code
977
		 */
978 6
		$date_gmt_time   = mysql2date( 'G', $date_string );
979 6
		$date_local_timestamp = GFCommon::get_local_timestamp( $date_gmt_time );
980
981 6
		$format  = \GV\Utils::get( $atts, 'format' );
982 6
		$is_human  = ! empty( $atts['human'] );
983 6
		$is_diff  = ! empty( $atts['diff'] );
984 6
		$is_raw = ! empty( $atts['raw'] );
985 6
		$is_timestamp = ! empty( $atts['timestamp'] );
986 6
		$include_time = ! empty( $atts['time'] );
987
988
		// If we're using time diff, we want to have a different default format
989 6
		if( empty( $format ) ) {
990
			/* translators: %s: relative time from now, used for generic date comparisons. "1 day ago", or "20 seconds ago" */
991 5
			$format = $is_diff ? esc_html__( '%s ago', 'gravityview' ) : get_option( 'date_format' );
992
		}
993
994
		// If raw was specified, don't modify the stored value
995 6
		if ( $is_raw ) {
996 2
			$formatted_date = $date_string;
997 6
		} elseif( $is_timestamp ) {
998 3
			$formatted_date = $date_local_timestamp;
999 5
		} elseif ( $is_diff ) {
1000 2
			$formatted_date = sprintf( $format, human_time_diff( $date_gmt_time ) );
1001
		} else {
1002 5
			$formatted_date = GFCommon::format_date( $date_string, $is_human, $format, $include_time );
1003
		}
1004
1005 6
		unset( $format, $is_diff, $is_human, $is_timestamp, $is_raw, $date_gmt_time, $date_local_timestamp, $default_atts );
1006
1007 6
		return $formatted_date;
1008
	}
1009
1010
	/**
1011
	 * Retrieve the label of a given field id (for a specific form)
1012
	 *
1013
	 * @access public
1014
	 * @since 1.17 Added $field_value parameter
1015
	 *
1016
	 * @param array $form Gravity Forms form array
1017
	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
1018
	 * @param string|array $field_value Raw value of the field.
1019
	 * @return string
1020
	 */
1021 1
	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
1022
1023 1
		if ( empty( $form ) || empty( $field_id ) ) {
1024
			return '';
1025
		}
1026
1027 1
		$field = self::get_field( $form, $field_id );
1028
1029 1
		$label = \GV\Utils::get( $field, 'label' );
1030
1031 1
		if( floor( $field_id ) !== floatval( $field_id ) ) {
1032 1
			$label = GFFormsModel::get_choice_text( $field, $field_value, $field_id );
1033
		}
1034
1035 1
		return $label;
1036
	}
1037
1038
1039
	/**
1040
	 * Returns the field details array of a specific form given the field id
1041
	 *
1042
	 * Alias of GFFormsModel::get_field
1043
	 *
1044
	 * @since 1.19 Allow passing form ID as well as form array
1045
	 *
1046
	 * @uses GFFormsModel::get_field
1047
	 * @see GFFormsModel::get_field
1048
	 * @access public
1049
	 * @param array|int $form Form array or ID
1050
	 * @param string|int $field_id
1051
	 * @return GF_Field|null Gravity Forms field object, or NULL: Gravity Forms GFFormsModel does not exist or field at $field_id doesn't exist.
1052
	 */
1053 9
	public static function get_field( $form, $field_id ) {
1054
1055 9
		if ( is_numeric( $form ) ) {
1056
			$form = GFAPI::get_form( $form );
1057
		}
1058
1059 9
		if ( class_exists( 'GFFormsModel' ) ){
1060 9
			return GFFormsModel::get_field( $form, $field_id );
1061
		} else {
1062
			return null;
1063
		}
1064
	}
1065
1066
1067
	/**
1068
	 * Check whether the post is GravityView
1069
	 *
1070
	 * - Check post type. Is it `gravityview`?
1071
	 * - Check shortcode
1072
	 *
1073
	 * @param  WP_Post      $post WordPress post object
1074
	 * @return boolean           True: yep, GravityView; No: not!
1075
	 */
1076 2
	public static function has_gravityview_shortcode( $post = null ) {
1077 2
		if ( ! is_a( $post, 'WP_Post' ) ) {
1078 1
			return false;
1079
		}
1080
1081 2
		if ( 'gravityview' === get_post_type( $post ) ) {
1082 2
			return true;
1083
		}
1084
1085 2
		return self::has_shortcode_r( $post->post_content, 'gravityview' ) ? true : false;
1086
1087
	}
1088
1089
1090
	/**
1091
	 * Placeholder until the recursive has_shortcode() patch is merged
1092
	 * @see https://core.trac.wordpress.org/ticket/26343#comment:10
1093
	 * @param string $content Content to check whether there's a shortcode
1094
	 * @param string $tag Current shortcode tag
1095
	 */
1096 4
	public static function has_shortcode_r( $content, $tag = 'gravityview' ) {
1097 4
		if ( false === strpos( $content, '[' ) ) {
1098 2
			return false;
1099
		}
1100
1101 4
		if ( shortcode_exists( $tag ) ) {
1102
1103 4
			$shortcodes = array();
1104
1105 4
			preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
1106 4
			if ( empty( $matches ) ){
1107 1
				return false;
1108
			}
1109
1110 4
			foreach ( $matches as $shortcode ) {
1111 4
				if ( $tag === $shortcode[2] ) {
1112
1113
					// Changed this to $shortcode instead of true so we get the parsed atts.
1114 4
					$shortcodes[] = $shortcode;
1115
1116 1
				} else if ( isset( $shortcode[5] ) && $results = self::has_shortcode_r( $shortcode[5], $tag ) ) {
1117 1
					foreach( $results as $result ) {
1118 1
						$shortcodes[] = $result;
1119
					}
1120
				}
1121
			}
1122
1123 4
			return $shortcodes;
1124
		}
1125
		return false;
1126
	}
1127
1128
1129
1130
	/**
1131
	 * Get the views for a particular form
1132
	 *
1133
	 * @since 1.15.2 Add $args array and limit posts_per_page to 500
1134
	 *
1135
	 * @uses get_posts()
1136
	 *
1137
	 * @param  int $form_id Gravity Forms form ID
1138
	 * @param  array $args Pass args sent to get_posts()
1139
	 *
1140
	 * @return array          Array with view details, as returned by get_posts()
1141
	 */
1142 1
	public static function get_connected_views( $form_id, $args = array() ) {
1143
1144 1
		global $wpdb;
1145
1146
		$defaults = array(
1147 1
			'post_type'      => 'gravityview',
1148 1
			'posts_per_page' => 100,
1149 1
			'meta_key'       => '_gravityview_form_id',
1150 1
			'meta_value'     => (int) $form_id,
1151
		);
1152 1
		$args     = wp_parse_args( $args, $defaults );
1153 1
		$views    = get_posts( $args );
1154
1155 1
		$views_with_joins = $wpdb->get_results( "SELECT `post_id`, `meta_value` FROM $wpdb->postmeta WHERE `meta_key` = '_gravityview_form_joins'" );
1156
1157 1
		$joined_forms = array();
1158 1
		foreach ( $views_with_joins as $view ) {
1159
1160 1
			$data = unserialize( $view->meta_value );
1161
1162 1
			if( ! $data || ! is_array( $data ) ) {
1163 1
				continue;
1164
			}
1165
1166
			foreach ( $data as $datum ) {
1167
				if ( ! empty( $datum[2] ) && (int) $datum[2] === (int) $form_id ) {
1168
					$joined_forms[] = $view->post_id;
1169
				}
1170
			}
1171
		}
1172
1173 1
		if ( $joined_forms ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $joined_forms of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1174
			$joined_args  = array(
1175
				'post_type'      => 'gravityview',
1176
				'posts_per_page' => $args['posts_per_page'],
1177
				'post__in'       => $joined_forms,
1178
			);
1179
			$views = array_merge( $views, get_posts( $joined_args ) );
1180
		}
1181
1182 1
		return $views;
1183
	}
1184
1185
	/**
1186
	 * Get the Gravity Forms form ID connected to a View
1187
	 *
1188
	 * @param int $view_id The ID of the View to get the connected form of
1189
	 *
1190
	 * @return false|string ID of the connected Form, if exists. Empty string if not. False if not the View ID isn't valid.
1191
	 */
1192 1
	public static function get_meta_form_id( $view_id ) {
1193 1
		return get_post_meta( $view_id, '_gravityview_form_id', true );
1194
	}
1195
1196
	/**
1197
	 * Get the template ID (`list`, `table`, `datatables`, `map`) for a View
1198
	 *
1199
	 * @see GravityView_Template::template_id
1200
	 *
1201
	 * @param int $view_id The ID of the View to get the layout of
1202
	 *
1203
	 * @return string GravityView_Template::template_id value. Empty string if not.
1204
	 */
1205 180
	public static function get_meta_template_id( $view_id ) {
1206 180
		return get_post_meta( $view_id, '_gravityview_directory_template', true );
1207
	}
1208
1209
1210
	/**
1211
	 * Get all the settings for a View
1212
	 *
1213
	 * @uses  \GV\View_Settings::defaults() Parses the settings with the plugin defaults as backups.
1214
	 * @param  int $post_id View ID
1215
	 * @return array          Associative array of settings with plugin defaults used if not set by the View
1216
	 */
1217 179
	public static function get_template_settings( $post_id ) {
1218
1219 179
		$settings = get_post_meta( $post_id, '_gravityview_template_settings', true );
1220
1221 179
		if ( class_exists( '\GV\View_Settings' ) ) {
1222
1223 179
			return wp_parse_args( (array)$settings, \GV\View_Settings::defaults() );
1224
1225
		}
1226
1227
		// Backup, in case GravityView_View_Data isn't loaded yet.
1228
		return $settings;
1229
	}
1230
1231
	/**
1232
	 * Get the setting for a View
1233
	 *
1234
	 * If the setting isn't set by the View, it returns the plugin default.
1235
	 *
1236
	 * @param  int $post_id View ID
1237
	 * @param  string $key     Key for the setting
1238
	 * @return mixed|null          Setting value, or NULL if not set.
1239
	 */
1240 1
	public static function get_template_setting( $post_id, $key ) {
1241
1242 1
		$settings = self::get_template_settings( $post_id );
1243
1244 1
		if ( isset( $settings[ $key ] ) ) {
1245 1
			return $settings[ $key ];
1246
		}
1247
1248
		return null;
1249
	}
1250
1251
	/**
1252
	 * Get the field configuration for the View
1253
	 *
1254
	 * array(
1255
	 *
1256
	 * 	[other zones]
1257
	 *
1258
	 * 	'directory_list-title' => array(
1259
	 *
1260
	 *   	[other fields]
1261
	 *
1262
	 *  	'5372653f25d44' => array(
1263
	 *  		'id' => string '9' (length=1)
1264
	 *  		'label' => string 'Screenshots' (length=11)
1265
	 *			'show_label' => string '1' (length=1)
1266
	 *			'custom_label' => string '' (length=0)
1267
	 *			'custom_class' => string 'gv-gallery' (length=10)
1268
	 * 			'only_loggedin' => string '0' (length=1)
1269
	 *			'only_loggedin_cap' => string 'read' (length=4)
1270
	 *  	)
1271
	 *
1272
	 * 		[other fields]
1273
	 *  )
1274
	 *
1275
	 * 	[other zones]
1276
	 * )
1277
	 *
1278
	 * @since 1.17.4 Added $apply_filter parameter
1279
	 *
1280
	 * @param  int $post_id View ID
1281
	 * @param  bool $apply_filter Whether to apply the `gravityview/configuration/fields` filter [Default: true]
1282
	 * @return array          Multi-array of fields with first level being the field zones. See code comment.
1283
	 */
1284 1
	public static function get_directory_fields( $post_id, $apply_filter = true ) {
1285 1
		$fields = get_post_meta( $post_id, '_gravityview_directory_fields', true );
1286
1287 1
		if ( $apply_filter ) {
1288
			/**
1289
			 * @filter `gravityview/configuration/fields` Filter the View fields' configuration array
1290
			 * @since 1.6.5
1291
			 *
1292
			 * @param $fields array Multi-array of fields with first level being the field zones
1293
			 * @param $post_id int Post ID
1294
			 */
1295 1
			$fields = apply_filters( 'gravityview/configuration/fields', $fields, $post_id );
1296
1297
			/**
1298
			 * @filter `gravityview/view/configuration/fields` Filter the View fields' configuration array.
1299
			 * @since 2.0
1300
			 *
1301
			 * @param array $fields Multi-array of fields with first level being the field zones.
1302
			 * @param \GV\View $view The View the fields are being pulled for.
1303
			 */
1304 1
			$fields = apply_filters( 'gravityview/view/configuration/fields', $fields, \GV\View::by_id( $post_id ) );
1305
		}
1306
1307 1
		return $fields;
1308
	}
1309
1310
	/**
1311
	 * Get the widget configuration for a View
1312
	 *
1313
	 * @param int $view_id View ID
1314
	 * @param bool $json_decode Whether to JSON-decode the widget values. Default: `false`
1315
	 *
1316
	 * @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"
1317
	 */
1318
	public static function get_directory_widgets( $view_id, $json_decode = false ) {
1319
1320
		$view_widgets = get_post_meta( $view_id, '_gravityview_directory_widgets', true );
1321
1322
		$defaults = array(
1323
			'header_top' => array(),
1324
			'header_left' => array(),
1325
			'header_right' => array(),
1326
			'footer_left' => array(),
1327
			'footer_right' => array(),
1328
		);
1329
1330
		$directory_widgets = wp_parse_args( $view_widgets, $defaults );
1331
1332
		if( $json_decode ) {
1333
			$directory_widgets = gv_map_deep( $directory_widgets, 'gv_maybe_json_decode' );
1334
		}
1335
1336
		return $directory_widgets;
1337
	}
1338
1339
1340
	/**
1341
	 * Render dropdown (select) with the list of sortable fields from a form ID
1342
	 *
1343
	 * @access public
1344
	 * @param  int $formid Form ID
1345
	 * @return string         html
1346
	 */
1347
	public static function get_sortable_fields( $formid, $current = '' ) {
1348
		$output = '<option value="" ' . selected( '', $current, false ).'>' . esc_html__( 'Default', 'gravityview' ) .'</option>';
1349
1350
		if ( empty( $formid ) ) {
1351
			return $output;
1352
		}
1353
1354
		$fields = self::get_sortable_fields_array( $formid );
1355
1356
		if ( ! empty( $fields ) ) {
1357
1358
			$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', array( 'list', 'textarea' ), null );
1359
1360
			foreach ( $fields as $id => $field ) {
1361
				if ( in_array( $field['type'], $blacklist_field_types ) ) {
1362
					continue;
1363
				}
1364
1365
				$output .= '<option value="'. $id .'" '. selected( $id, $current, false ).'>'. esc_attr( $field['label'] ) .'</option>';
1366
			}
1367
		}
1368
1369
		return $output;
1370
	}
1371
1372
	/**
1373
	 *
1374
	 * @param int $formid Gravity Forms form ID
1375
	 * @param array $blacklist Field types to exclude
1376
	 *
1377
	 * @since 1.8
1378
	 *
1379
	 * @todo Get all fields, check if sortable dynamically
1380
	 *
1381
	 * @return array
1382
	 */
1383
	public static function get_sortable_fields_array( $formid, $blacklist = array( 'list', 'textarea' ) ) {
1384
1385
		// Get fields with sub-inputs and no parent
1386
		$fields = self::get_form_fields( $formid, true, false );
1387
1388
		$date_created = array(
1389
			'date_created' => array(
1390
				'type' => 'date_created',
1391
				'label' => __( 'Date Created', 'gravityview' ),
1392
			),
1393
		);
1394
1395
        $fields = $date_created + $fields;
1396
1397
		$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', $blacklist, NULL );
1398
1399
		// TODO: Convert to using array_filter
1400
		foreach( $fields as $id => $field ) {
1401
1402
			if( in_array( $field['type'], $blacklist_field_types ) ) {
1403
				unset( $fields[ $id ] );
1404
			}
1405
1406
			/**
1407
			 * Merge date and time subfields.
1408
			 */
1409
			if ( in_array( $field['type'], array( 'date', 'time' ) ) && ! empty( $field['parent'] ) ) {
1410
				$fields[ intval( $id ) ] = array(
1411
					'label' => \GV\Utils::get( $field, 'parent/label' ),
1412
					'parent' => null,
1413
					'type' => \GV\Utils::get( $field, 'parent/type' ),
1414
					'adminLabel' => \GV\Utils::get( $field, 'parent/adminLabel' ),
1415
					'adminOnly' => \GV\Utils::get( $field, 'parent/adminOnly' ),
1416
				);
1417
1418
				unset( $fields[ $id ] );
1419
			}
1420
1421
		}
1422
1423
        /**
1424
         * @filter `gravityview/common/sortable_fields` Filter the sortable fields
1425
         * @since 1.12
1426
         * @param array $fields Sub-set of GF form fields that are sortable
1427
         * @param int $formid The Gravity Forms form ID that the fields are from
1428
         */
1429
        $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
1430
1431
		return $fields;
1432
	}
1433
1434
	/**
1435
	 * Returns the GF Form field type for a certain field(id) of a form
1436
	 * @param  object $form     Gravity Forms form
1437
	 * @param  mixed $field_id Field ID or Field array
1438
	 * @return string field type
1439
	 */
1440 4
	public static function get_field_type( $form = null, $field_id = '' ) {
1441
1442 4
		if ( ! empty( $field_id ) && ! is_array( $field_id ) ) {
1443 4
			$field = self::get_field( $form, $field_id );
1444
		} else {
1445
			$field = $field_id;
1446
		}
1447
1448 4
		return class_exists( 'RGFormsModel' ) ? RGFormsModel::get_input_type( $field ) : '';
1449
1450
	}
1451
1452
1453
	/**
1454
	 * Checks if the field type is a 'numeric' field type (e.g. to be used when sorting)
1455
	 * @param  int|array  $form  form ID or form array
1456
	 * @param  int|array  $field field key or field array
1457
	 * @return boolean
1458
	 */
1459 5
	public static function is_field_numeric(  $form = null, $field = '' ) {
1460
1461 5
		if ( ! is_array( $form ) && ! is_array( $field ) ) {
1462 5
			$form = self::get_form( $form );
1463
		}
1464
1465
		// If entry meta, it's a string. Otherwise, numeric
1466 5
		if( ! is_numeric( $field ) && is_string( $field ) ) {
1467 1
			$type = $field;
1468
		} else {
1469 4
			$type = self::get_field_type( $form, $field );
1470
		}
1471
1472
		/**
1473
		 * @filter `gravityview/common/numeric_types` What types of fields are numeric?
1474
		 * @since 1.5.2
1475
		 * @param array $numeric_types Fields that are numeric. Default: `[ number, time ]`
1476
		 */
1477 5
		$numeric_types = apply_filters( 'gravityview/common/numeric_types', array( 'number', 'time' ) );
1478
1479
		// Defer to GravityView_Field setting, if the field type is registered and `is_numeric` is true
1480 5
		if( $gv_field = GravityView_Fields::get( $type ) ) {
1481 4
			if( true === $gv_field->is_numeric ) {
1482
				$numeric_types[] = $gv_field->is_numeric;
1483
			}
1484
		}
1485
1486 5
		$return = in_array( $type, $numeric_types );
1487
1488 5
		return $return;
1489
	}
1490
1491
	/**
1492
	 * Encrypt content using Javascript so that it's hidden when JS is disabled.
1493
	 *
1494
	 * This is mostly used to hide email addresses from scraper bots.
1495
	 *
1496
	 * @param string $content Content to encrypt
1497
	 * @param string $message Message shown if Javascript is disabled
1498
	 *
1499
	 * @see  https://github.com/katzwebservices/standalone-phpenkoder StandalonePHPEnkoder on Github
1500
	 *
1501
	 * @since 1.7
1502
	 *
1503
	 * @return string Content, encrypted
1504
	 */
1505
	public static function js_encrypt( $content, $message = '' ) {
1506
1507
		$output = $content;
1508
1509
		if ( ! class_exists( 'StandalonePHPEnkoder' ) ) {
1510
			include_once( GRAVITYVIEW_DIR . 'includes/lib/StandalonePHPEnkoder.php' );
1511
		}
1512
1513
		if ( class_exists( 'StandalonePHPEnkoder' ) ) {
1514
1515
			$enkoder = new StandalonePHPEnkoder;
1516
1517
			$message = empty( $message ) ? __( 'Email hidden; Javascript is required.', 'gravityview' ) : $message;
1518
1519
			/**
1520
			 * @filter `gravityview/phpenkoder/msg` Modify the message shown when Javascript is disabled and an encrypted email field is displayed
1521
			 * @since 1.7
1522
			 * @param string $message Existing message
1523
			 * @param string $content Content to encrypt
1524
			 */
1525
			$enkoder->enkode_msg = apply_filters( 'gravityview/phpenkoder/msg', $message, $content );
1526
1527
			$output = $enkoder->enkode( $content );
1528
		}
1529
1530
		return $output;
1531
	}
1532
1533
	/**
1534
	 *
1535
	 * Do the same than parse_str without max_input_vars limitation:
1536
	 * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
1537
	 * @param $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
1538
	 * @param $result array  If the second parameter is present, variables are stored in this variable as array elements
1539
	 * @return bool true or false if $string is an empty string
1540
	 * @since  1.5.3
1541
	 *
1542
	 * @author rubo77 at https://gist.github.com/rubo77/6821632
1543
	 **/
1544
	public static function gv_parse_str( $string, &$result ) {
1545
		if ( empty( $string ) ) {
1546
			return false;
1547
		}
1548
1549
		$result = array();
1550
1551
		// find the pairs "name=value"
1552
		$pairs = explode( '&', $string );
1553
1554
		foreach ( $pairs as $pair ) {
1555
			// use the original parse_str() on each element
1556
			parse_str( $pair, $params );
1557
1558
			$k = key( $params );
1559
			if ( ! isset( $result[ $k ] ) ) {
1560
				$result += $params;
1561
			} elseif ( array_key_exists( $k, $params ) && is_array( $params[ $k ] ) ) {
1562
				$result[ $k ] = self::array_merge_recursive_distinct( $result[ $k ], $params[ $k ] );
1563
			}
1564
		}
1565
		return true;
1566
	}
1567
1568
1569
	/**
1570
	 * Generate an HTML anchor tag with a list of supported attributes
1571
	 *
1572
	 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a Supported attributes defined here
1573
	 * @uses esc_url_raw() to sanitize $href
1574
	 * @uses esc_attr() to sanitize $atts
1575
	 *
1576
	 * @since 1.6
1577
	 *
1578
	 * @param string $href URL of the link. Sanitized using `esc_url_raw()`
1579
	 * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1580
	 * @param array|string $atts Attributes to be added to the anchor tag. Parsed by `wp_parse_args()`, sanitized using `esc_attr()`
1581
	 *
1582
	 * @return string HTML output of anchor link. If empty $href, returns NULL
1583
	 */
1584 56
	public static function get_link_html( $href = '', $anchor_text = '', $atts = array() ) {
1585
1586
		// Supported attributes for anchor tags. HREF left out intentionally.
1587
		$allowed_atts = array(
1588 56
			'href' => null, // Will override the $href argument if set
1589
			'title' => null,
1590
			'rel' => null,
1591
			'id' => null,
1592
			'class' => null,
1593
			'target' => null,
1594
			'style' => null,
1595
1596
			// Used by GravityView
1597
			'data-viewid' => null,
1598
1599
			// Not standard
1600
			'hreflang' => null,
1601
			'type' => null,
1602
			'tabindex' => null,
1603
1604
			// Deprecated HTML4 but still used
1605
			'name' => null,
1606
			'onclick' => null,
1607
			'onchange' => null,
1608
			'onkeyup' => null,
1609
1610
			// HTML5 only
1611
			'download' => null,
1612
			'media' => null,
1613
			'ping' => null,
1614
		);
1615
1616
		/**
1617
		 * @filter `gravityview/get_link/allowed_atts` Modify the attributes that are allowed to be used in generating links
1618
		 * @param array $allowed_atts Array of attributes allowed
1619
		 */
1620 56
		$allowed_atts = apply_filters( 'gravityview/get_link/allowed_atts', $allowed_atts );
1621
1622
		// Make sure the attributes are formatted as array
1623 56
		$passed_atts = wp_parse_args( $atts );
1624
1625
		// Make sure the allowed attributes are only the ones in the $allowed_atts list
1626 56
		$final_atts = shortcode_atts( $allowed_atts, $passed_atts );
1627
1628
		// Remove attributes with empty values
1629 56
		$final_atts = array_filter( $final_atts );
1630
1631
		// If the href wasn't passed as an attribute, use the value passed to the function
1632 56
		if ( empty( $final_atts['href'] ) && ! empty( $href ) ) {
1633 56
			$final_atts['href'] = $href;
1634
		}
1635
1636 56
		$final_atts['href'] = esc_url_raw( $href );
1637
1638
		/**
1639
		 * Fix potential security issue with target=_blank
1640
		 * @see https://dev.to/ben/the-targetblank-vulnerability-by-example
1641
		 */
1642 56
		if( '_blank' === \GV\Utils::get( $final_atts, 'target' ) ) {
1643 4
			$final_atts['rel'] = trim( \GV\Utils::get( $final_atts, 'rel', '' ) . ' noopener noreferrer' );
1644
		}
1645
1646
		// Sort the attributes alphabetically, to help testing
1647 56
		ksort( $final_atts );
1648
1649
		// For each attribute, generate the code
1650 56
		$output = '';
1651 56
		foreach ( $final_atts as $attr => $value ) {
1652 56
			$output .= sprintf( ' %s="%s"', $attr, esc_attr( $value ) );
1653
		}
1654
1655 56
		if( '' !== $output ) {
1656 56
			$output = '<a' . $output . '>' . $anchor_text . '</a>';
1657
		}
1658
1659 56
		return $output;
1660
	}
1661
1662
	/**
1663
	 * array_merge_recursive does indeed merge arrays, but it converts values with duplicate
1664
	 * keys to arrays rather than overwriting the value in the first array with the duplicate
1665
	 * value in the second array, as array_merge does.
1666
	 *
1667
	 * @see http://php.net/manual/en/function.array-merge-recursive.php
1668
	 *
1669
	 * @since  1.5.3
1670
	 * @param array $array1
1671
	 * @param array $array2
1672
	 * @return array
1673
	 * @author Daniel <daniel (at) danielsmedegaardbuus (dot) dk>
1674
	 * @author Gabriel Sobrinho <gabriel (dot) sobrinho (at) gmail (dot) com>
1675
	 */
1676
	public static function array_merge_recursive_distinct( array &$array1, array &$array2 ) {
1677
		$merged = $array1;
1678
		foreach ( $array2 as $key => $value ) {
1679
			if ( is_array( $value ) && isset( $merged[ $key ] ) && is_array( $merged[ $key ] ) ) {
1680
				$merged[ $key ] = self::array_merge_recursive_distinct( $merged[ $key ], $value );
1681
			} else if ( is_numeric( $key ) && isset( $merged[ $key ] ) ) {
1682
				$merged[] = $value;
1683
			} else {
1684
				$merged[ $key ] = $value;
1685
			}
1686
		}
1687
1688
		return $merged;
1689
	}
1690
1691
	/**
1692
	 * Get WordPress users with reasonable limits set
1693
	 *
1694
	 * @param string $context Where are we using this information (e.g. change_entry_creator, search_widget ..)
1695
	 * @param array $args Arguments to modify the user query. See get_users() {@since 1.14}
1696
	 * @return array Array of WP_User objects.
1697
	 */
1698 1
	public static function get_users( $context = 'change_entry_creator', $args = array() ) {
1699
1700
		$default_args = array(
1701 1
			'number' => 2000,
1702
			'orderby' => 'display_name',
1703
			'order' => 'ASC',
1704
			'fields' => array( 'ID', 'display_name', 'user_login', 'user_nicename' )
1705
		);
1706
1707
		// Merge in the passed arg
1708 1
		$get_users_settings = wp_parse_args( $args, $default_args );
1709
1710
		/**
1711
		 * @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
1712
		 * `$context` is where are we using this information (e.g. change_entry_creator, search_widget ..)
1713
		 * @param array $settings Settings array, with `number` key defining the # of users to display
1714
		 */
1715 1
		$get_users_settings = apply_filters( 'gravityview/get_users/'. $context, apply_filters( 'gravityview_change_entry_creator_user_parameters', $get_users_settings ) );
1716
1717 1
		return get_users( $get_users_settings );
1718
	}
1719
1720
1721
    /**
1722
     * Display updated/error notice
1723
     *
1724
     * @since 1.19.2 Added $cap and $object_id parameters
1725
     *
1726
     * @param string $notice text/HTML of notice
1727
     * @param string $class CSS class for notice (`updated` or `error`)
1728
     * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
1729
     *
1730
     * @return string
1731
     */
1732 29
    public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
1733
1734
    	// If $cap is defined, only show notice if user has capability
1735 29
    	if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
1736 8
    		return '';
1737
	    }
1738
1739 23
        return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
1740
    }
1741
1742
	/**
1743
	 * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets
1744
	 * @since 1.16.5
1745
	 * @param string $string Input string to decode
1746
	 * @return string $string Output string
1747
	 */
1748
	public static function decode_shortcodes( $string ) {
1749
		$replace = array( '[', ']', '"' );
1750
		$find = array( '&#91;', '&#93;', '&quot;' );
1751
		$string = str_replace( $find, $replace, $string );
1752
1753
		return $string;
1754
	}
1755
1756
1757
	/**
1758
	 * Send email using GFCommon::send_email()
1759
	 *
1760
	 * @since 1.17
1761
	 *
1762
	 * @see GFCommon::send_email This just makes the method public
1763
	 *
1764
	 * @param string $from               Sender address (required)
1765
	 * @param string $to                 Recipient address (required)
1766
	 * @param string $bcc                BCC recipients (required)
1767
	 * @param string $reply_to           Reply-to address (required)
1768
	 * @param string $subject            Subject line (required)
1769
	 * @param string $message            Message body (required)
1770
	 * @param string $from_name          Displayed name of the sender
1771
	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
1772
	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
1773
	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
1774
	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
1775
	 */
1776
	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
1777
1778
		$SendEmail = new ReflectionMethod( 'GFCommon', 'send_email' );
1779
1780
		// It was private; let's make it public
1781
		$SendEmail->setAccessible( true );
1782
1783
		// Required: $from, $to, $bcc, $replyTo, $subject, $message
1784
		// Optional: $from_name, $message_format, $attachments, $lead, $notification
1785
		$SendEmail->invoke( new GFCommon, $from, $to, $bcc, $reply_to, $subject, $message, $from_name, $message_format, $attachments, $entry, $notification );
1786
	}
1787
1788
1789
} //end class
1790
1791
1792
/**
1793
 * Generate an HTML anchor tag with a list of supported attributes
1794
 *
1795
 * @see GVCommon::get_link_html()
1796
 *
1797
 * @since 1.6
1798
 *
1799
 * @param string $href URL of the link.
1800
 * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1801
 * @param array|string $atts Attributes to be added to the anchor tag
1802
 *
1803
 * @return string HTML output of anchor link. If empty $href, returns NULL
1804
 */
1805
function gravityview_get_link( $href = '', $anchor_text = '', $atts = array() ) {
1806 55
	return GVCommon::get_link_html( $href, $anchor_text, $atts );
1807
}
1808