Completed
Push — develop ( c9e655...a000d1 )
by Gennady
16:53
created

GVCommon::get_template_setting()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 2.032

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 2
dl 0
loc 10
ccs 4
cts 5
cp 0.8
crap 2.032
rs 9.9332
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 19 and the first side effect is on line 16.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
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 35
	public static function get_form( $form_id ) {
29 35
		if ( empty( $form_id ) ) {
30
			return false;
31
		}
32
33
		// Only get_form_meta is cached. ::facepalm::
34 35
		if ( class_exists( 'GFFormsModel' ) ) {
35 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 26
	public static function has_cap( $caps = '', $object_id = null, $user_id = null ) {
59 26
		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,
0 ignored issues
show
introduced by
Disabling pagination is prohibited in VIP context, do not set posts_per_page to -1 ever.
Loading history...
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 3
	public static function has_product_field( $form = array() ) {
146
147 3
		$product_fields = self::get_product_field_types();
148
149 3
		$fields = GFAPI::get_fields_by_type( $form, $product_fields );
150
151 3
		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 5
	public static function get_product_field_types() {
164
165 5
		$product_fields = apply_filters( 'gform_product_field_types', array( 'option', 'quantity', 'product', 'total', 'shipping', 'calculation', 'price', 'hiddenproduct', 'singleproduct', 'singleshipping' ) );
166
167 5
		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 5
	public static function entry_has_transaction_data( $entry = array() ) {
182
183 5
		if ( ! is_array( $entry ) ) {
184 1
			return false;
185
		}
186
187 5
		$has_transaction_data = false;
188
189 5
		$payment_meta = array( 'payment_status', 'payment_date', 'transaction_id', 'payment_amount', 'payment_method' );
190
191 5
		foreach ( $payment_meta as $meta ) {
192
193 5
			$has_transaction_data = \GV\Utils::get( $entry, $meta, false );
194
195 5
			if( ! empty( $has_transaction_data ) ) {
196 5
				break;
197
			}
198
		}
199
200 5
		return (bool) $has_transaction_data;
201
	}
202
203
	/**
204
	 * Get the entry ID from the entry slug, which may or may not be the entry ID
205
	 *
206
	 * @since  1.5.2
207
	 * @param  string $slug The entry slug, as returned by GravityView_API::get_entry_slug()
208
	 * @return int|null       The entry ID, if exists; `NULL` if not
209
	 */
210
	public static function get_entry_id_from_slug( $slug ) {
211
		global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
212
213
		$search_criteria = array(
214
			'field_filters' => array(
215
				array(
216
					'key' => 'gravityview_unique_id', // Search the meta values
217
					'value' => $slug,
218
					'operator' => 'is',
219
					'type' => 'meta',
220
				),
221
			)
222
		);
223
224
		// Limit to one for speed
225
		$paging = array(
226
			'page_size' => 1,
227
		);
228
229
		/**
230
		 * @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.
231
		 * @since 1.17.2
232
		 * @param int $form_id ID of the form to search. Default: `0` (searches all forms)
233
		 */
234
		$form_id = apply_filters( 'gravityview/common/get_entry_id_from_slug/form_id', 0 );
235
236
		$results = GFAPI::get_entries( intval( $form_id ), $search_criteria, null, $paging );
237
238
		$result = ( ! empty( $results ) && ! empty( $results[0]['id'] ) ) ? $results[0]['id'] : null;
239
240
		return $result;
241
	}
242
243
	/**
244
	 * Alias of GFAPI::get_forms()
245
	 *
246
	 * @see GFAPI::get_forms()
247
	 *
248
	 * @since 1.19 Allow "any" $active status option
249
	 *
250
	 * @param bool|string $active Status of forms. Use `any` to get array of forms with any status. Default: `true`
251
	 * @param bool $trash Include forms in trash? Default: `false`
252
	 *
253
	 * @return array Empty array if GFAPI class isn't available or no forms. Otherwise, the array of Forms
254
	 */
255 1
	public static function get_forms(  $active = true, $trash = false ) {
256 1
		$forms = array();
257 1
		if ( class_exists( 'GFAPI' ) ) {
258 1
			if( 'any' === $active ) {
259
				$active_forms = GFAPI::get_forms( true, $trash );
260
				$inactive_forms = GFAPI::get_forms( false, $trash );
261
				$forms = array_merge( array_filter( $active_forms ), array_filter( $inactive_forms ) );
262
			} else {
263 1
				$forms = GFAPI::get_forms( $active, $trash );
264
			}
265
		}
266 1
		return $forms;
267
	}
268
269
	/**
270
	 * Return array of fields' id and label, for a given Form ID
271
	 *
272
	 * @access public
273
	 * @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...
274
	 * @param bool $add_default_properties
275
	 * @param bool $include_parent_field
276
	 * @return array
277
	 */
278
	public static function get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
279
280
		if ( ! is_array( $form ) ) {
281
			$form = self::get_form( $form );
282
		}
283
284
		$fields = array();
285
		$has_product_fields = false;
286
		$has_post_fields = false;
287
288
		if ( $form ) {
289
			foreach ( $form['fields'] as $field ) {
290
				if ( $include_parent_field || empty( $field['inputs'] ) ) {
291
					$fields["{$field['id']}"] = array(
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
292
						'label' => \GV\Utils::get( $field, 'label' ),
293
						'parent' => null,
294
						'type' => \GV\Utils::get( $field, 'type' ),
295
						'adminLabel' => \GV\Utils::get( $field, 'adminLabel' ),
296
						'adminOnly' => \GV\Utils::get( $field, 'adminOnly' ),
297
					);
298
				}
299
300
				if ( $add_default_properties && ! empty( $field['inputs'] ) ) {
301
					foreach ( $field['inputs'] as $input ) {
302
303
						if( ! empty( $input['isHidden'] ) ) {
304
							continue;
305
						}
306
307
						/**
308
                         * @hack
309
                         * In case of email/email confirmation, the input for email has the same id as the parent field
310
                         */
311
						if( 'email' === $field['type'] && false === strpos( $input['id'], '.' ) ) {
312
                            continue;
313
                        }
314
						$fields["{$input['id']}"] = array(
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
315
							'label' => \GV\Utils::get( $input, 'label' ),
316
							'customLabel' => \GV\Utils::get( $input, 'customLabel' ),
317
							'parent' => $field,
318
							'type' => \GV\Utils::get( $field, 'type' ),
319
							'adminLabel' => \GV\Utils::get( $field, 'adminLabel' ),
320
							'adminOnly' => \GV\Utils::get( $field, 'adminOnly' ),
321
						);
322
					}
323
				}
324
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
325
326
				if( GFCommon::is_product_field( $field['type'] ) ){
327
					$has_product_fields = true;
328
				}
329
330
				if ( GFCommon::is_post_field( $field ) ) {
331
					$has_post_fields = true;
332
				}
333
			}
334
		}
335
336
		/**
337
		 * @since 1.7
338
		 */
339
		if ( $has_post_fields ) {
340
			$fields['post_id'] = array(
341
				'label' => __( 'Post ID', 'gravityview' ),
342
				'type' => 'post_id',
343
			);
344
		}
345
346
		if ( $has_product_fields ) {
347
348
			$payment_fields = GravityView_Fields::get_all( 'pricing' );
349
350
			foreach ( $payment_fields as $payment_field ) {
351
352
				// Either the field exists ($fields['shipping']) or the form explicitly contains a `shipping` field with numeric key
353
				if( isset( $fields["{$payment_field->name}"] ) || GFCommon::get_fields_by_type( $form, $payment_field->name ) ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
354
					continue;
355
				}
356
357
				$fields["{$payment_field->name}"] = array(
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
358
					'label' => $payment_field->label,
359
					'desc' => $payment_field->description,
360
					'type' => $payment_field->name,
361
				);
362
			}
363
		}
364
365
		/**
366
		 * @filter `gravityview/common/get_form_fields` Modify the form fields shown in the Add Field field picker.
367
		 * @since 1.17
368
		 * @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`
369
		 * @param array $form GF Form array
370
		 * @param bool $include_parent_field Whether to include the parent field when getting a field with inputs
371
		 */
372
		$fields = apply_filters( 'gravityview/common/get_form_fields', $fields, $form, $include_parent_field );
373
374
		return $fields;
375
376
	}
377
378
	/**
379
	 * get extra fields from entry meta
380
	 * @param  string $form_id (default: '')
381
	 * @return array
382
	 */
383
	public static function get_entry_meta( $form_id, $only_default_column = true ) {
384
385
		$extra_fields = GFFormsModel::get_entry_meta( $form_id );
386
387
		$fields = array();
388
389
		foreach ( $extra_fields as $key => $field ){
390
			if ( ! empty( $only_default_column ) && ! empty( $field['is_default_column'] ) ) {
391
				$fields[ $key ] = array( 'label' => $field['label'], 'type' => 'entry_meta' );
392
			}
393
		}
394
395
		return $fields;
396
	}
397
398
399
	/**
400
	 * Wrapper for the Gravity Forms GFFormsModel::search_lead_ids() method
401
	 *
402
	 * @see  GFEntryList::leads_page()
403
	 * @param  int $form_id ID of the Gravity Forms form
404
	 * @since  1.1.6
405
	 * @return array|void          Array of entry IDs. Void if Gravity Forms isn't active.
406
	 */
407
	public static function get_entry_ids( $form_id, $search_criteria = array() ) {
408
409
		if ( ! class_exists( 'GFFormsModel' ) ) {
410
			return;
411
		}
412
413
		return GFFormsModel::search_lead_ids( $form_id, $search_criteria );
414
	}
415
416
	/**
417
	 * Calculates the Search Criteria used on the self::get_entries / self::get_entry methods
418
	 *
419
	 * @since 1.7.4
420
	 *
421
	 * @param array $passed_criteria array Input Criteria (search_criteria, sorting, paging)
422
	 * @param array $form_ids array Gravity Forms form IDs
423
	 * @return array
424
	 */
425 32
	public static function calculate_get_entries_criteria( $passed_criteria = array(), $form_ids = array() ) {
426
427
		$search_criteria_defaults = array(
428 32
			'search_criteria' => null,
429
			'sorting' => null,
430
			'paging' => null,
431 32
			'cache' => (isset( $passed_criteria['cache'] ) ? (bool) $passed_criteria['cache'] : true),
432
			'context_view_id' => null,
433
		);
434
435 32
		$criteria = wp_parse_args( $passed_criteria, $search_criteria_defaults );
436
437 32
		if ( ! empty( $criteria['search_criteria']['field_filters'] ) ) {
438 4
			foreach ( $criteria['search_criteria']['field_filters'] as &$filter ) {
439
440 4
				if ( ! is_array( $filter ) ) {
441 4
					continue;
442
				}
443
444
				// By default, we want searches to be wildcard for each field.
445 4
				$filter['operator'] = empty( $filter['operator'] ) ? 'contains' : $filter['operator'];
446
447
				/**
448
				 * @filter `gravityview_search_operator` Modify the search operator for the field (contains, is, isnot, etc)
449
				 * @param string $operator Existing search operator
450
				 * @param array $filter array with `key`, `value`, `operator`, `type` keys
451
				 */
452 4
				$filter['operator'] = apply_filters( 'gravityview_search_operator', $filter['operator'], $filter );
453
			}
454
455
			// don't send just the [mode] without any field filter.
456 4
			if( count( $criteria['search_criteria']['field_filters'] ) === 1 && array_key_exists( 'mode' , $criteria['search_criteria']['field_filters'] ) ) {
0 ignored issues
show
introduced by
Found "=== 1". Use Yoda Condition checks, you must
Loading history...
457 1
				unset( $criteria['search_criteria']['field_filters']['mode'] );
458
			}
459
460
		}
461
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 3 empty lines
Loading history...
462
463
464
		/**
465
		 * Prepare date formats to be in Gravity Forms DB format;
466
		 * $passed_criteria may include date formats incompatible with Gravity Forms.
467
		 */
468 32
		foreach ( array('start_date', 'end_date' ) as $key ) {
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
469
470 32
			if ( ! empty( $criteria['search_criteria'][ $key ] ) ) {
471
472
				// Use date_create instead of new DateTime so it returns false if invalid date format.
473 1
				$date = date_create( $criteria['search_criteria'][ $key ] );
474
475 1
				if ( $date ) {
476
					// Gravity Forms wants dates in the `Y-m-d H:i:s` format.
477 1
					$criteria['search_criteria'][ $key ] = $date->format( 'Y-m-d H:i:s' );
478
				} else {
479 1
					gravityview()->log->error( '{key} Date format not valid:', array( 'key' => $key, $criteria['search_criteria'][ $key ] ) );
480
481
					// If it's an invalid date, unset it. Gravity Forms freaks out otherwise.
482 32
					unset( $criteria['search_criteria'][ $key ] );
483
				}
484
			}
485
		}
486
487 32
		if ( empty( $criteria['context_view_id'] ) ) {
488
			// Calculate the context view id and send it to the advanced filter
489 3
			if ( GravityView_frontend::getInstance()->getSingleEntry() ) {
490 1
				$criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
491 3
			} 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...
492 1
				$criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
493 3
			} else if ( 'delete' === GFForms::get( 'action' ) ) {
494 1
				$criteria['context_view_id'] = isset( $_GET['view_id'] ) ? intval( $_GET['view_id'] ) : null;
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
495
			}
496
		}
497
498
		/**
499
		 * @filter `gravityview_search_criteria` Apply final criteria filter (Used by the Advanced Filter extension)
500
		 * @param array $criteria Search criteria used by GravityView
501
		 * @param array $form_ids Forms to search
502
		 * @param int $view_id ID of the view being used to search
503
		 */
504 32
		$criteria = apply_filters( 'gravityview_search_criteria', $criteria, $form_ids, $criteria['context_view_id'] );
505
506 32
		return (array)$criteria;
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
507
	}
508
509
510
	/**
511
	 * Retrieve entries given search, sort, paging criteria
512
	 *
513
	 * @see  GFAPI::get_entries()
514
	 * @see GFFormsModel::get_field_filters_where()
515
	 * @access public
516
	 * @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
517
	 * @param mixed $passed_criteria (default: null)
518
	 * @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)
519
	 *
520
	 * @deprecated See \GV\View::get_entries.
521
	 *
522
	 * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
523
	 */
524
	public static function get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
525
526
		gravityview()->log->notice( '\GVCommon::get_entries is deprecated. Use \GV\View::get_entries instead.' );
527
528
		// Filter the criteria before query (includes Adv Filter)
529
		$criteria = self::calculate_get_entries_criteria( $passed_criteria, $form_ids );
530
531
		gravityview()->log->debug( '[gravityview_get_entries] Final Parameters', array( 'data' => $criteria ) );
532
533
		// Return value
534
		$return = null;
535
536
		/** Reduce # of database calls */
537
		add_filter( 'gform_is_encrypted_field', '__return_false' );
538
539
		if ( ! empty( $criteria['cache'] ) ) {
540
541
			$Cache = new GravityView_Cache( $form_ids, $criteria );
542
543
			if ( $entries = $Cache->get() ) {
544
545
				// Still update the total count when using cached results
546
				if ( ! is_null( $total ) ) {
547
					$total = GFAPI::count_entries( $form_ids, $criteria['search_criteria'] );
548
				}
549
550
				$return = $entries;
551
			}
552
		}
553
554
		if ( is_null( $return ) && class_exists( 'GFAPI' ) && ( is_numeric( $form_ids ) || is_array( $form_ids ) ) ) {
555
556
			/**
557
			 * @filter `gravityview_pre_get_entries` Define entries to be used before GFAPI::get_entries() is called
558
			 * @since 1.14
559
			 * @param  null $return If you want to override GFAPI::get_entries() and define entries yourself, tap in here.
560
			 * @param  array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
561
			 * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
562
			 * @param  int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
563
			 * @since 2.1 The $total parameter can now be overriden by reference.
564
			 * @deprecated
565
			 */
566
			$entries = apply_filters_ref_array( 'gravityview_before_get_entries', array( null, $criteria, $passed_criteria, &$total ) );
567
568
			// No entries returned from gravityview_before_get_entries
569
			if( is_null( $entries ) ) {
570
571
				$entries = GFAPI::get_entries( $form_ids, $criteria['search_criteria'], $criteria['sorting'], $criteria['paging'], $total );
572
573
				if ( is_wp_error( $entries ) ) {
574
					gravityview()->log->error( '{error}', array( 'error' => $entries->get_error_message(), 'data' => $entries ) );
575
576
					/** Remove filter added above */
577
					remove_filter( 'gform_is_encrypted_field', '__return_false' );
578
					return false;
579
				}
580
			}
581
582
			if ( ! empty( $criteria['cache'] ) && isset( $Cache ) ) {
583
584
				// Cache results
585
				$Cache->set( $entries, 'entries' );
586
587
			}
588
589
			$return = $entries;
590
		}
591
592
		/** Remove filter added above */
593
		remove_filter( 'gform_is_encrypted_field', '__return_false' );
594
595
		/**
596
		 * @filter `gravityview_entries` Modify the array of entries returned to GravityView after it has been fetched from the cache or from `GFAPI::get_entries()`.
597
		 * @param  array|null $entries Array of entries as returned by the cache or by `GFAPI::get_entries()`
598
		 * @param  array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
599
		 * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
600
		 * @param  int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
601
		 * @since 2.1 The $total parameter can now be overriden by reference.
602
		 * @deprecated
603
		 */
604
		$return = apply_filters_ref_array( 'gravityview_entries', array( $return, $criteria, $passed_criteria, &$total ) );
605
606
		return $return;
607
	}
608
609
610
	/**
611
	 * Get the entry ID from a string that may be the Entry ID or the Entry Slug
612
	 *
613
	 * @since 1.18
614
	 *
615
	 * @param string $entry_id_or_slug The ID or slug of an entry.
616
	 * @param bool $force_allow_ids Whether to force allowing getting the ID of an entry, even if custom slugs are enabled
617
	 *
618
	 * @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.
619
	 */
620 2
	public static function get_entry_id( $entry_id_or_slug = '', $force_allow_ids = false ) {
621
622 2
		$entry_id = false;
623
624
		/**
625
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
626
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
627
		 */
628 2
		$custom_slug = apply_filters( 'gravityview_custom_entry_slug', false );
629
630
		/**
631
		 * @filter `gravityview_custom_entry_slug_allow_id` When using a custom slug, allow access to the entry using the original slug (the Entry ID).
632
		 * - If disabled (default), only allow access to an entry using the custom slug value.  (example: `/entry/custom-slug/` NOT `/entry/123/`)
633
		 * - If enabled, you could access using the custom slug OR the entry id (example: `/entry/custom-slug/` OR `/entry/123/`)
634
		 * @param boolean $custom_slug_id_access True: allow accessing the slug by ID; False: only use the slug passed to the method.
635
		 */
636 2
		$custom_slug_id_access = $force_allow_ids || apply_filters( 'gravityview_custom_entry_slug_allow_id', false );
637
638
		/**
639
		 * If we're using custom entry slugs, we do a meta value search
640
		 * instead of doing a straightup ID search.
641
		 */
642 2
		if ( $custom_slug ) {
643
			// Search for IDs matching $entry_id_or_slug
644
			$entry_id = self::get_entry_id_from_slug( $entry_id_or_slug );
645
		}
646
647
		// If custom slug is off, search using the entry ID
648
		// ID allow ID access is on, also use entry ID as a backup
649 2
		if ( false === $custom_slug || true === $custom_slug_id_access ) {
650
			// Search for IDs matching $entry_slug
651 2
			$entry_id = $entry_id_or_slug;
652
		}
653
654 2
		return $entry_id;
655
	}
656
657
	/**
658
	 * Return a single entry object
659
	 *
660
	 * 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()`
661
	 *
662
	 * @access public
663
	 * @param string|int $entry_slug Either entry ID or entry slug string
664
	 * @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.
665
	 * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true. {@since 1.14}
666
	 * @return array|boolean
667
	 */
668 24
	public static function get_entry( $entry_slug, $force_allow_ids = false, $check_entry_display = true ) {
669
670 24
		if ( ! class_exists( 'GFAPI' ) || empty( $entry_slug ) ) {
671 23
			return false;
672
		}
673
674 2
		$entry_id = self::get_entry_id( $entry_slug, $force_allow_ids );
675
676 2
		if ( empty( $entry_id ) ) {
677
			return false;
678
		}
679
680
		// fetch the entry
681 2
		$entry = GFAPI::get_entry( $entry_id );
682
683
		/**
684
		 * @filter `gravityview/common/get_entry/check_entry_display` Override whether to check entry display rules against filters
685
		 * @since 1.16.2
686
		 * @param bool $check_entry_display Check whether the entry is visible for the current View configuration. Default: true.
687
		 * @param array $entry Gravity Forms entry array
688
		 */
689 2
		$check_entry_display = apply_filters( 'gravityview/common/get_entry/check_entry_display', $check_entry_display, $entry );
690
691 2
		if( $check_entry_display ) {
692
			// Is the entry allowed
693 1
			$entry = self::check_entry_display( $entry );
694
		}
695
696 2
		if( is_wp_error( $entry ) ) {
697
			gravityview()->log->error( '{error}', array( 'error' => $entry->get_error_message() ) );
698
			return false;
699
		}
700
701 2
		return $entry;
702
	}
703
704
	/**
705
	 * Wrapper for the GFFormsModel::matches_operation() method that adds additional comparisons, including:
706
	 * 'equals', 'greater_than_or_is', 'greater_than_or_equals', 'less_than_or_is', 'less_than_or_equals',
707
	 * 'not_contains', 'in', and 'not_in'
708
	 *
709
	 * @since 1.13 You can define context, which displays/hides based on what's being displayed (single, multiple, edit)
710
	 * @since 1.22.1 Added 'in' and 'not_in' for JSON-encoded array values, serialized non-strings
711
	 *
712
	 * @see https://docs.gravityview.co/article/252-gvlogic-shortcode
713
	 * @uses GFFormsModel::matches_operation
714
	 * @since 1.7.5
715
	 *
716
	 * @param mixed $val1 Left side of comparison
717
	 * @param mixed $val2 Right side of comparison
718
	 * @param string $operation Type of comparison
719
	 *
720
	 * @return bool True: matches, false: not matches
721
	 */
722 5
	public static function matches_operation( $val1, $val2, $operation ) {
723
724
		// Only process strings
725 5
		$val1 = ! is_string( $val1 ) ? wp_json_encode( $val1 ) : $val1;
726 5
		$val2 = ! is_string( $val2 ) ? wp_json_encode( $val2 ) : $val2;
727
728 5
		$value = false;
729
730 5
		if( 'context' === $val1 ) {
731
732
			$matching_contexts = array( $val2 );
733
734
			// We allow for non-standard contexts.
735
			switch( $val2 ) {
736
				// Check for either single or edit
737
				case 'singular':
738
					$matching_contexts = array( 'single', 'edit' );
739
					break;
740
				// Use multiple as alias for directory for consistency
741
				case 'multiple':
742
					$matching_contexts = array( 'directory' );
743
					break;
744
			}
745
746
			$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...
747
		}
748
749 5
		switch ( $operation ) {
750 5
			case 'equals':
751 2
				$value = self::matches_operation( $val1, $val2, 'is' );
752 2
				break;
753 5
			case 'greater_than_or_is':
754 5
			case 'greater_than_or_equals':
755 2
				$is    = self::matches_operation( $val1, $val2, 'is' );
756 2
				$gt    = self::matches_operation( $val1, $val2, 'greater_than' );
757 2
				$value = ( $is || $gt );
758 2
				break;
759 5
			case 'less_than_or_is':
760 5
			case 'less_than_or_equals':
761 1
				$is    = self::matches_operation( $val1, $val2, 'is' );
762 1
				$gt    = self::matches_operation( $val1, $val2, 'less_than' );
763 1
				$value = ( $is || $gt );
764 1
				break;
765 5
			case 'not_contains':
766 1
				$contains = self::matches_operation( $val1, $val2, 'contains' );
767 1
				$value    = ! $contains;
768 1
				break;
769
			/**
770
			 * @since 1.22.1 Handle JSON-encoded comparisons
771
			 */
772 5
			case 'in':
773 5
			case 'not_in':
774
775 1
				$json_val_1 = json_decode( $val1, true );
776 1
				$json_val_2 = json_decode( $val2, true );
777
778 1
				if( ! empty( $json_val_1 ) || ! empty( $json_val_2 ) ) {
779
780 1
					$json_in = false;
781 1
					$json_val_1 = $json_val_1 ? (array) $json_val_1 : array( $val1 );
782 1
					$json_val_2 = $json_val_2 ? (array) $json_val_2 : array( $val2 );
783
784
					// For JSON, we want to compare as "in" or "not in" rather than "contains"
785 1
					foreach ( $json_val_1 as $item_1 ) {
786 1
						foreach ( $json_val_2 as $item_2 ) {
787 1
							$json_in = self::matches_operation( $item_1, $item_2, 'is' );
788
789 1
							if( $json_in ) {
790 1
								break 2;
791
							}
792
						}
793
					}
794
795 1
					$value = ( $operation === 'in' ) ? $json_in : ! $json_in;
796
				}
797 1
				break;
798
799 5
			case 'less_than':
800 5
			case '<' :
801 1
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
802 1
					$value = $val1 < $val2;
803
				} else {
804
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
805
				}
806 1
				break;
807 5
			case 'greater_than':
808 5
			case '>' :
809 3
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
810 3
					$value = $val1 > $val2;
811
				} else {
812
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
813
				}
814 3
				break;
815
			default:
816 5
				$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
817
		}
818
819 5
		return $value;
820
	}
821
822
	/**
823
	 *
824
	 * Checks if a certain entry is valid according to the View search filters (specially the Adv Filters)
825
	 *
826
	 * @uses GVCommon::calculate_get_entries_criteria();
827
	 * @see GFFormsModel::is_value_match()
828
	 *
829
	 * @since 1.7.4
830
	 *
831
	 * @param array $entry Gravity Forms Entry object
832
	 *
833
	 * @since 2.1
834
	 * @param \GV\View $view The View.
835
	 *
836
	 * @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.
837
	 */
838 6
	public static function check_entry_display( $entry, $view = null ) {
839
840 6
		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...
841 1
			return new WP_Error('entry_not_found', 'Entry was not found.', $entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
842
		}
843
844 6
		if ( empty( $entry['form_id'] ) ) {
845 1
			return new WP_Error( 'form_id_not_set', '[apply_filters_to_entry] Entry is empty!', $entry );
846
		}
847
848 6
		$criteria = self::calculate_get_entries_criteria( array(
849 6
			'context_view_id' => $view ? $view->ID : null,
850
		) );
851
852 6
		if ( empty( $criteria['search_criteria'] ) || ! is_array( $criteria['search_criteria'] ) ) {
853 6
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No search criteria found:', array( 'data' => $criteria ) );
854 6
			return $entry;
855
		}
856
857
		// Make sure the current View is connected to the same form as the Entry
858 2
		if( ! empty( $criteria['context_view_id'] ) ) {
859 2
			$context_view_id = intval( $criteria['context_view_id'] );
860 2
			$context_form_id = gravityview_get_form_id( $context_view_id );
861 2
			if( intval( $context_form_id ) !== intval( $entry['form_id'] ) ) {
862 1
				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'] );
863
			}
864
		}
865
866 2
		$search_criteria = $criteria['search_criteria'];
867
868
		// check entry status
869 2
		if ( array_key_exists( 'status', $search_criteria ) && $search_criteria['status'] != $entry['status'] ) {
870 1
			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 );
871
		}
872
873
		// check entry date
874
		// @todo: Does it make sense to apply the Date create filters to the single entry?
875
876
		// field_filters
877 2
		if ( empty( $search_criteria['field_filters'] ) || ! is_array( $search_criteria['field_filters'] ) ) {
878 1
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No field filters criteria found:', array( 'data' => $search_criteria ) );
879 1
			return $entry;
880
		}
881
882 2
		$filters = $search_criteria['field_filters'];
883
884 2
		$mode = array_key_exists( 'mode', $filters ) ? strtolower( $filters['mode'] ) : 'all';
885
886 2
		$mode = $mode ? : 'all'; // If mode is an empty string, assume it's 'all'
887
888
		// Prevent the mode from being processed below
889 2
		unset( $filters['mode'] );
890
891 2
		$form = self::get_form( $entry['form_id'] );
892
893 2
		foreach ( $filters as $filter ) {
894
895 2
			if ( ! isset( $filter['key'] ) ) {
896
				gravityview()->log->debug( '[apply_filters_to_entry] Filter key not set: {filter}', array( 'filter' => $filter ) );
897
				continue;
898
			}
899
900 2
			$k = $filter['key'];
901
902 2
			$field = self::get_field( $form, $k );
903
904 2
			if ( is_null( $field ) ) {
905 2
				$field_value = isset( $entry[ $k ] ) ? $entry[ $k ] : null;
906 2
				$field = $k;
907
			} else {
908
				$field_value  = GFFormsModel::get_lead_field_value( $entry, $field );
909
				 // If it's a complex field, then fetch the input's value, if exists at the current key. Otherwise, let GF handle it
910
				$field_value = ( is_array( $field_value ) && isset( $field_value[ $k ] ) ) ? \GV\Utils::get( $field_value, $k ) : $field_value;
911
			}
912
913 2
			$operator = isset( $filter['operator'] ) ? strtolower( $filter['operator'] ) : 'is';
914
915 2
			$is_value_match = GravityView_GFFormsModel::is_value_match( $field_value, $filter['value'], $operator, $field );
916
917
			// Any match is all we need to know
918 2
			if ( $is_value_match && 'any' === $mode ) {
919 1
				return $entry;
920
			}
921
922
			// Any failed match is a total fail
923 2
			if ( ! $is_value_match && 'all' === $mode ) {
924 2
				return new WP_Error('failed_criteria', '[apply_filters_to_entry] Entry cannot be displayed. Failed a criterium for ALL mode', $filter );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
925
			}
926
		}
927
928
		// at this point, if in ALL mode, then entry is approved - all conditions were met.
929
		// Or, for ANY mode, means none of the conditions were satisfied, so entry is not approved
930 2
		if ( 'all' === $mode ) {
931 2
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved: all conditions were met' );
932 2
			return $entry;
933
		} else {
934
			return new WP_Error('failed_any_criteria', '[apply_filters_to_entry] Entry cannot be displayed. Failed all the criteria for ANY mode', $filters );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
935
		}
936
937
	}
938
939
940
	/**
941
	 * Allow formatting date and time based on GravityView standards
942
	 *
943
	 * @since 1.16
944
	 *
945
	 * @see GVCommon_Test::test_format_date for examples
946
	 *
947
	 * @param string $date_string The date as stored by Gravity Forms (`Y-m-d h:i:s` GMT)
948
	 * @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
949
	 * - `raw` Un-formatted date string in original `Y-m-d h:i:s` format
950
	 * - `timestamp` Integer timestamp returned by GFCommon::get_local_timestamp()
951
	 * - `diff` "%s ago" format, unless other `format` is defined
952
	 * - `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.
953
	 * - `time` Include time in the `GFCommon::format_date()` output
954
	 * - `format` Define your own date format, or `diff` format
955
	 *
956
	 * @return int|null|string Formatted date based on the original date
957
	 */
958 4
	public static function format_date( $date_string = '', $args = array() ) {
959
960
		$default_atts = array(
961 4
			'raw' => false,
962
			'timestamp' => false,
963
			'diff' => false,
964
			'human' => false,
965
			'format' => '',
966
			'time' => false,
967
		);
968
969 4
		$atts = wp_parse_args( $args, $default_atts );
970
971
		/**
972
		 * Gravity Forms code to adjust date to locally-configured Time Zone
973
		 * @see GFCommon::format_date() for original code
974
		 */
975 4
		$date_gmt_time   = mysql2date( 'G', $date_string );
976 4
		$date_local_timestamp = GFCommon::get_local_timestamp( $date_gmt_time );
977
978 4
		$format  = \GV\Utils::get( $atts, 'format' );
979 4
		$is_human  = ! empty( $atts['human'] );
980 4
		$is_diff  = ! empty( $atts['diff'] );
981 4
		$is_raw = ! empty( $atts['raw'] );
982 4
		$is_timestamp = ! empty( $atts['timestamp'] );
983 4
		$include_time = ! empty( $atts['time'] );
984
985
		// If we're using time diff, we want to have a different default format
986 4
		if( empty( $format ) ) {
987
			/* translators: %s: relative time from now, used for generic date comparisons. "1 day ago", or "20 seconds ago" */
988 4
			$format = $is_diff ? esc_html__( '%s ago', 'gravityview' ) : get_option( 'date_format' );
989
		}
990
991
		// If raw was specified, don't modify the stored value
992 4
		if ( $is_raw ) {
993 1
			$formatted_date = $date_string;
994 4
		} elseif( $is_timestamp ) {
995 2
			$formatted_date = $date_local_timestamp;
996 3
		} elseif ( $is_diff ) {
997 1
			$formatted_date = sprintf( $format, human_time_diff( $date_gmt_time ) );
998
		} else {
999 3
			$formatted_date = GFCommon::format_date( $date_string, $is_human, $format, $include_time );
1000
		}
1001
1002 4
		unset( $format, $is_diff, $is_human, $is_timestamp, $is_raw, $date_gmt_time, $date_local_timestamp, $default_atts );
1003
1004 4
		return $formatted_date;
1005
	}
1006
1007
	/**
1008
	 * Retrieve the label of a given field id (for a specific form)
1009
	 *
1010
	 * @access public
1011
	 * @since 1.17 Added $field_value parameter
1012
	 *
1013
	 * @param array $form Gravity Forms form array
1014
	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
1015
	 * @param string|array $field_value Raw value of the field.
1016
	 * @return string
1017
	 */
1018 1
	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
1019
1020 1
		if ( empty( $form ) || empty( $field_id ) ) {
1021
			return '';
1022
		}
1023
1024 1
		$field = self::get_field( $form, $field_id );
1025
1026 1
		$label = \GV\Utils::get( $field, 'label' );
1027
1028 1
		if( floor( $field_id ) !== floatval( $field_id ) ) {
1029 1
			$label = GFFormsModel::get_choice_text( $field, $field_value, $field_id );
1030
		}
1031
1032 1
		return $label;
1033
	}
1034
1035
1036
	/**
1037
	 * Returns the field details array of a specific form given the field id
1038
	 *
1039
	 * Alias of GFFormsModel::get_field
1040
	 *
1041
	 * @since 1.19 Allow passing form ID as well as form array
1042
	 *
1043
	 * @uses GFFormsModel::get_field
1044
	 * @see GFFormsModel::get_field
1045
	 * @access public
1046
	 * @param array|int $form Form array or ID
1047
	 * @param string|int $field_id
1048
	 * @return GF_Field|null Gravity Forms field object, or NULL: Gravity Forms GFFormsModel does not exist or field at $field_id doesn't exist.
1049
	 */
1050 6
	public static function get_field( $form, $field_id ) {
1051
1052 6
		if ( is_numeric( $form ) ) {
1053
			$form = GFAPI::get_form( $form );
1054
		}
1055
1056 6
		if ( class_exists( 'GFFormsModel' ) ){
1057 6
			return GFFormsModel::get_field( $form, $field_id );
1058
		} else {
1059
			return null;
1060
		}
1061
	}
1062
1063
1064
	/**
1065
	 * Check whether the post is GravityView
1066
	 *
1067
	 * - Check post type. Is it `gravityview`?
1068
	 * - Check shortcode
1069
	 *
1070
	 * @param  WP_Post      $post WordPress post object
1071
	 * @return boolean           True: yep, GravityView; No: not!
1072
	 */
1073 2
	public static function has_gravityview_shortcode( $post = null ) {
1074 2
		if ( ! is_a( $post, 'WP_Post' ) ) {
1075 1
			return false;
1076
		}
1077
1078 2
		if ( 'gravityview' === get_post_type( $post ) ) {
1079 2
			return true;
1080
		}
1081
1082 2
		return self::has_shortcode_r( $post->post_content, 'gravityview' ) ? true : false;
1083
1084
	}
1085
1086
1087
	/**
1088
	 * Placeholder until the recursive has_shortcode() patch is merged
1089
	 * @see https://core.trac.wordpress.org/ticket/26343#comment:10
1090
	 * @param string $content Content to check whether there's a shortcode
1091
	 * @param string $tag Current shortcode tag
1092
	 */
1093 3
	public static function has_shortcode_r( $content, $tag = 'gravityview' ) {
1094 3
		if ( false === strpos( $content, '[' ) ) {
1095 1
			return false;
1096
		}
1097
1098 3
		if ( shortcode_exists( $tag ) ) {
1099
1100 3
			$shortcodes = array();
1101
1102 3
			preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
1103 3
			if ( empty( $matches ) ){
1104 1
				return false;
1105
			}
1106
1107 3
			foreach ( $matches as $shortcode ) {
1108 3
				if ( $tag === $shortcode[2] ) {
1109
1110
					// Changed this to $shortcode instead of true so we get the parsed atts.
1111 3
					$shortcodes[] = $shortcode;
1112
1113 1
				} else if ( isset( $shortcode[5] ) && $results = self::has_shortcode_r( $shortcode[5], $tag ) ) {
1114 1
					foreach( $results as $result ) {
1115 3
						$shortcodes[] = $result;
1116
					}
1117
				}
1118
			}
1119
1120 3
			return $shortcodes;
1121
		}
1122
		return false;
1123
	}
1124
1125
1126
1127
	/**
1128
	 * Get the views for a particular form
1129
	 *
1130
	 * @since 1.15.2 Add $args array and limit posts_per_page to 500
1131
	 *
1132
	 * @uses get_posts()
1133
	 *
1134
	 * @param  int $form_id Gravity Forms form ID
1135
	 * @param  array $args Pass args sent to get_posts()
1136
	 *
1137
	 * @return array          Array with view details, as returned by get_posts()
1138
	 */
1139 1
	public static function get_connected_views( $form_id, $args = array() ) {
1140
1141 1
		global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

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

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

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

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

Loading history...
1765
		// Optional: $from_name, $message_format, $attachments, $lead, $notification
0 ignored issues
show
Unused Code Comprehensibility introduced by
57% of this comment could be valid code. Did you maybe forget this after debugging?

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

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

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

Loading history...
1766
		$SendEmail->invoke( new GFCommon, $from, $to, $bcc, $reply_to, $subject, $message, $from_name, $message_format, $attachments, $entry, $notification );
1767
	}
1768
1769
1770
} //end class
1771
1772
1773
/**
1774
 * Generate an HTML anchor tag with a list of supported attributes
1775
 *
1776
 * @see GVCommon::get_link_html()
1777
 *
1778
 * @since 1.6
1779
 *
1780
 * @param string $href URL of the link.
1781
 * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1782
 * @param array|string $atts Attributes to be added to the anchor tag
1783
 *
1784
 * @return string HTML output of anchor link. If empty $href, returns NULL
1785
 */
1786
function gravityview_get_link( $href = '', $anchor_text = '', $atts = array() ) {
1787 29
	return GVCommon::get_link_html( $href, $anchor_text, $atts );
1788
}
1789