Completed
Push — develop ( 4e47eb...d09b3b )
by Zack
14:47
created

GVCommon::get_users()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 2
dl 0
loc 21
ccs 0
cts 5
cp 0
crap 2
rs 9.584
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 28
	public static function get_form( $form_id ) {
29 28
		if ( empty( $form_id ) ) {
30
			return false;
31
		}
32
33
		// Only get_form_meta is cached. ::facepalm::
34 28
		if ( class_exists( 'GFFormsModel' ) ) {
35 28
			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 21
	public static function has_cap( $caps = '', $object_id = null, $user_id = null ) {
59 21
		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 4
	public static function get_product_field_types() {
164
165 4
		$product_fields = apply_filters( 'gform_product_field_types', array( 'option', 'quantity', 'product', 'total', 'shipping', 'calculation', 'price', 'hiddenproduct', 'singleproduct', 'singleshipping' ) );
166
167 4
		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 4
	public static function entry_has_transaction_data( $entry = array() ) {
182
183 4
		if ( ! is_array( $entry ) ) {
184 1
			return false;
185
		}
186
187 4
		$has_transaction_data = false;
188
189 4
		$payment_meta = array( 'payment_status', 'payment_date', 'transaction_id', 'payment_amount', 'payment_method' );
190
191 4
		foreach ( $payment_meta as $meta ) {
192
193 4
			$has_transaction_data = \GV\Utils::get( $entry, $meta, false );
194
195 4
			if( ! empty( $has_transaction_data ) ) {
196 4
				break;
197
			}
198
		}
199
200 4
		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 2
	public static function get_entry_id_from_slug( $slug ) {
211 2
		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 2
					'key' => 'gravityview_unique_id', // Search the meta values
217 2
					'value' => $slug,
218 2
					'operator' => 'is',
219 2
					'type' => 'meta',
220
				),
221
			)
222
		);
223
224
		// Limit to one for speed
225
		$paging = array(
226 2
			'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 2
		$form_id = apply_filters( 'gravityview/common/get_entry_id_from_slug/form_id', 0 );
235
236 2
		$results = GFAPI::get_entries( intval( $form_id ), $search_criteria, null, $paging );
237
238 2
		$result = ( ! empty( $results ) && ! empty( $results[0]['id'] ) ) ? $results[0]['id'] : null;
239
240 2
		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 34
	public static function calculate_get_entries_criteria( $passed_criteria = array(), $form_ids = array() ) {
426
427
		$search_criteria_defaults = array(
428 34
			'search_criteria' => null,
429
			'sorting' => null,
430
			'paging' => null,
431 34
			'cache' => (isset( $passed_criteria['cache'] ) ? (bool) $passed_criteria['cache'] : true),
432
			'context_view_id' => null,
433
		);
434
435 34
		$criteria = wp_parse_args( $passed_criteria, $search_criteria_defaults );
436
437 34
		if ( ! empty( $criteria['search_criteria']['field_filters'] ) ) {
438 5
			foreach ( $criteria['search_criteria']['field_filters'] as &$filter ) {
439
440 5
				if ( ! is_array( $filter ) ) {
441 5
					continue;
442
				}
443
444
				// By default, we want searches to be wildcard for each field.
445 5
				$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 5
				$filter['operator'] = apply_filters( 'gravityview_search_operator', $filter['operator'], $filter );
453
			}
454
455
			// don't send just the [mode] without any field filter.
456 5
			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 34
		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 34
			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 34
					unset( $criteria['search_criteria'][ $key ] );
483
				}
484
			}
485
		}
486
487 34
		if ( empty( $criteria['context_view_id'] ) ) {
488
			// Calculate the context view id and send it to the advanced filter
489 22
			if ( GravityView_frontend::getInstance()->getSingleEntry() ) {
490 21
				$criteria['context_view_id'] = GravityView_frontend::getInstance()->get_context_view_id();
491 4
			} 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 4
			} 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 34
		$criteria = apply_filters( 'gravityview_search_criteria', $criteria, $form_ids, $criteria['context_view_id'] );
505
506 34
		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
	 * @return mixed False: Error fetching entries. Array: Multi-dimensional array of Gravity Forms entry arrays
520
	 */
521
	public static function get_entries( $form_ids = null, $passed_criteria = null, &$total = null ) {
522
523
		// Filter the criteria before query (includes Adv Filter)
524
		$criteria = self::calculate_get_entries_criteria( $passed_criteria, $form_ids );
525
526
		gravityview()->log->debug( '[gravityview_get_entries] Final Parameters', array( 'data' => $criteria ) );
527
528
		// Return value
529
		$return = null;
530
531
		/** Reduce # of database calls */
532
		add_filter( 'gform_is_encrypted_field', '__return_false' );
533
534
		if ( ! empty( $criteria['cache'] ) ) {
535
536
			$Cache = new GravityView_Cache( $form_ids, $criteria );
537
538
			if ( $entries = $Cache->get() ) {
539
540
				// Still update the total count when using cached results
541
				if ( ! is_null( $total ) ) {
542
					$total = GFAPI::count_entries( $form_ids, $criteria['search_criteria'] );
543
				}
544
545
				$return = $entries;
546
			}
547
		}
548
549
		if ( is_null( $return ) && class_exists( 'GFAPI' ) && ( is_numeric( $form_ids ) || is_array( $form_ids ) ) ) {
550
551
			/**
552
			 * @filter `gravityview_pre_get_entries` Define entries to be used before GFAPI::get_entries() is called
553
			 * @since 1.14
554
			 * @param  null $return If you want to override GFAPI::get_entries() and define entries yourself, tap in here.
555
			 * @param  array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
556
			 * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
557
			 * @param  int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
558
			 * @deprecated
559
			 */
560
			$entries = apply_filters( 'gravityview_before_get_entries', null, $criteria, $passed_criteria, $total );
561
562
			// No entries returned from gravityview_before_get_entries
563
			if( is_null( $entries ) ) {
564
565
				$entries = GFAPI::get_entries( $form_ids, $criteria['search_criteria'], $criteria['sorting'], $criteria['paging'], $total );
566
567
				if ( is_wp_error( $entries ) ) {
568
					gravityview()->log->error( '{error}', array( 'error' => $entries->get_error_message(), 'data' => $entries ) );
569
570
					/** Remove filter added above */
571
					remove_filter( 'gform_is_encrypted_field', '__return_false' );
572
					return false;
573
				}
574
			}
575
576
			if ( ! empty( $criteria['cache'] ) && isset( $Cache ) ) {
577
578
				// Cache results
579
				$Cache->set( $entries, 'entries' );
580
581
			}
582
583
			$return = $entries;
584
		}
585
586
		/** Remove filter added above */
587
		remove_filter( 'gform_is_encrypted_field', '__return_false' );
588
589
		/**
590
		 * @filter `gravityview_entries` Modify the array of entries returned to GravityView after it has been fetched from the cache or from `GFAPI::get_entries()`.
591
		 * @param  array|null $entries Array of entries as returned by the cache or by `GFAPI::get_entries()`
592
		 * @param  array $criteria The final search criteria used to generate the request to `GFAPI::get_entries()`
593
		 * @param array $passed_criteria The original search criteria passed to `GVCommon::get_entries()`
594
		 * @param  int|null $total Optional. An output parameter containing the total number of entries. Pass a non-null value to generate
595
		 */
596
		$return = apply_filters( 'gravityview_entries', $return, $criteria, $passed_criteria, $total );
597
598
		return $return;
599
	}
600
601
602
	/**
603
	 * Get the entry ID from a string that may be the Entry ID or the Entry Slug
604
	 *
605
	 * @since 1.18
606
	 *
607
	 * @param string $entry_id_or_slug The ID or slug of an entry.
608
	 * @param bool $force_allow_ids Whether to force allowing getting the ID of an entry, even if custom slugs are enabled
609
	 *
610
	 * @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.
611
	 */
612 21
	public static function get_entry_id( $entry_id_or_slug = '', $force_allow_ids = false ) {
613
614 21
		$entry_id = false;
615
616
		/**
617
		 * @filter `gravityview_custom_entry_slug` Whether to enable and use custom entry slugs.
618
		 * @param boolean True: Allow for slugs based on entry values. False: always use entry IDs (default)
619
		 */
620 21
		$custom_slug = apply_filters( 'gravityview_custom_entry_slug', false );
621
622
		/**
623
		 * @filter `gravityview_custom_entry_slug_allow_id` When using a custom slug, allow access to the entry using the original slug (the Entry ID).
624
		 * - If disabled (default), only allow access to an entry using the custom slug value.  (example: `/entry/custom-slug/` NOT `/entry/123/`)
625
		 * - If enabled, you could access using the custom slug OR the entry id (example: `/entry/custom-slug/` OR `/entry/123/`)
626
		 * @param boolean $custom_slug_id_access True: allow accessing the slug by ID; False: only use the slug passed to the method.
627
		 */
628 21
		$custom_slug_id_access = $force_allow_ids || apply_filters( 'gravityview_custom_entry_slug_allow_id', false );
629
630
		/**
631
		 * If we're using custom entry slugs, we do a meta value search
632
		 * instead of doing a straightup ID search.
633
		 */
634 21
		if ( $custom_slug ) {
635
			// Search for IDs matching $entry_id_or_slug
636 2
			$entry_id = self::get_entry_id_from_slug( $entry_id_or_slug );
637
		}
638
639
		// If custom slug is off, search using the entry ID
640
		// ID allow ID access is on, also use entry ID as a backup
641 21
		if ( false === $custom_slug || true === $custom_slug_id_access ) {
642
			// Search for IDs matching $entry_slug
643 21
			$entry_id = $entry_id_or_slug;
644
		}
645
646 21
		return $entry_id;
647
	}
648
649
	/**
650
	 * Return a single entry object
651
	 *
652
	 * 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()`
653
	 *
654
	 * @access public
655
	 * @param string|int $entry_slug Either entry ID or entry slug string
656
	 * @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.
657
	 * @param boolean $check_entry_display Check whether the entry is visible for the current View configuration. Default: true. {@since 1.14}
658
	 * @return array|boolean
659
	 */
660 27
	public static function get_entry( $entry_slug, $force_allow_ids = false, $check_entry_display = true ) {
661
662 27
		if ( ! class_exists( 'GFAPI' ) || empty( $entry_slug ) ) {
663 20
			return false;
664
		}
665
666 21
		$entry_id = self::get_entry_id( $entry_slug, $force_allow_ids );
667
668 21
		if ( empty( $entry_id ) ) {
669 2
			return false;
670
		}
671
672
		// fetch the entry
673 21
		$entry = GFAPI::get_entry( $entry_id );
674
675
		/**
676
		 * @filter `gravityview/common/get_entry/check_entry_display` Override whether to check entry display rules against filters
677
		 * @since 1.16.2
678
		 * @param bool $check_entry_display Check whether the entry is visible for the current View configuration. Default: true.
679
		 * @param array $entry Gravity Forms entry array
680
		 */
681 21
		$check_entry_display = apply_filters( 'gravityview/common/get_entry/check_entry_display', $check_entry_display, $entry );
682
683 21
		if( $check_entry_display ) {
684
			// Is the entry allowed
685 21
			$entry = self::check_entry_display( $entry );
686
		}
687
688 21
		if( is_wp_error( $entry ) ) {
689
			gravityview()->log->error( '{error}', array( 'error' => $entry->get_error_message() ) );
690
			return false;
691
		}
692
693 21
		return $entry;
694
	}
695
696
	/**
697
	 * Wrapper for the GFFormsModel::matches_operation() method that adds additional comparisons, including:
698
	 * 'equals', 'greater_than_or_is', 'greater_than_or_equals', 'less_than_or_is', 'less_than_or_equals',
699
	 * 'not_contains', 'in', and 'not_in'
700
	 *
701
	 * @since 1.13 You can define context, which displays/hides based on what's being displayed (single, multiple, edit)
702
	 * @since 1.22.1 Added 'in' and 'not_in' for JSON-encoded array values, serialized non-strings
703
	 *
704
	 * @see https://docs.gravityview.co/article/252-gvlogic-shortcode
705
	 * @uses GFFormsModel::matches_operation
706
	 * @since 1.7.5
707
	 *
708
	 * @param mixed $val1 Left side of comparison
709
	 * @param mixed $val2 Right side of comparison
710
	 * @param string $operation Type of comparison
711
	 *
712
	 * @return bool True: matches, false: not matches
713
	 */
714 4
	public static function matches_operation( $val1, $val2, $operation ) {
715
716
		// Only process strings
717 4
		$val1 = ! is_string( $val1 ) ? wp_json_encode( $val1 ) : $val1;
718 4
		$val2 = ! is_string( $val2 ) ? wp_json_encode( $val2 ) : $val2;
719
720 4
		$value = false;
721
722 4
		if( 'context' === $val1 ) {
723
724
			$matching_contexts = array( $val2 );
725
726
			// We allow for non-standard contexts.
727
			switch( $val2 ) {
728
				// Check for either single or edit
729
				case 'singular':
730
					$matching_contexts = array( 'single', 'edit' );
731
					break;
732
				// Use multiple as alias for directory for consistency
733
				case 'multiple':
734
					$matching_contexts = array( 'directory' );
735
					break;
736
			}
737
738
			$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...
739
		}
740
741 4
		switch ( $operation ) {
742 4
			case 'equals':
743 2
				$value = self::matches_operation( $val1, $val2, 'is' );
744 2
				break;
745 4
			case 'greater_than_or_is':
746 4
			case 'greater_than_or_equals':
747 2
				$is    = self::matches_operation( $val1, $val2, 'is' );
748 2
				$gt    = self::matches_operation( $val1, $val2, 'greater_than' );
749 2
				$value = ( $is || $gt );
750 2
				break;
751 4
			case 'less_than_or_is':
752 4
			case 'less_than_or_equals':
753 1
				$is    = self::matches_operation( $val1, $val2, 'is' );
754 1
				$gt    = self::matches_operation( $val1, $val2, 'less_than' );
755 1
				$value = ( $is || $gt );
756 1
				break;
757 4
			case 'not_contains':
758 1
				$contains = self::matches_operation( $val1, $val2, 'contains' );
759 1
				$value    = ! $contains;
760 1
				break;
761
			/**
762
			 * @since 1.22.1 Handle JSON-encoded comparisons
763
			 */
764 4
			case 'in':
765 4
			case 'not_in':
766
767 1
				$json_val_1 = json_decode( $val1, true );
768 1
				$json_val_2 = json_decode( $val2, true );
769
770 1
				if( ! empty( $json_val_1 ) || ! empty( $json_val_2 ) ) {
771
772 1
					$json_in = false;
773 1
					$json_val_1 = $json_val_1 ? (array) $json_val_1 : array( $val1 );
774 1
					$json_val_2 = $json_val_2 ? (array) $json_val_2 : array( $val2 );
775
776
					// For JSON, we want to compare as "in" or "not in" rather than "contains"
777 1
					foreach ( $json_val_1 as $item_1 ) {
778 1
						foreach ( $json_val_2 as $item_2 ) {
779 1
							$json_in = self::matches_operation( $item_1, $item_2, 'is' );
780
781 1
							if( $json_in ) {
782 1
								break 2;
783
							}
784
						}
785
					}
786
787 1
					$value = ( $operation === 'in' ) ? $json_in : ! $json_in;
788
				}
789 1
				break;
790
791 4
			case 'less_than':
792 4
			case '<' :
793 1
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
794 1
					$value = $val1 < $val2;
795
				} else {
796
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
797
				}
798 1
				break;
799 4
			case 'greater_than':
800 4
			case '>' :
801 2
				if ( is_string( $val1 ) && is_string( $val2 ) ) {
802 2
					$value = $val1 > $val2;
803
				} else {
804
					$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
805
				}
806 2
				break;
807
			default:
808 4
				$value = GFFormsModel::matches_operation( $val1, $val2, $operation );
809
		}
810
811 4
		return $value;
812
	}
813
814
	/**
815
	 *
816
	 * Checks if a certain entry is valid according to the View search filters (specially the Adv Filters)
817
	 *
818
	 * @uses GVCommon::calculate_get_entries_criteria();
819
	 * @see GFFormsModel::is_value_match()
820
	 *
821
	 * @since 1.7.4
822
	 *
823
	 * @param array $entry Gravity Forms Entry object
824
	 * @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.
825
	 */
826 22
	public static function check_entry_display( $entry ) {
827
828 22
		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...
829 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...
830
		}
831
832 22
		if ( empty( $entry['form_id'] ) ) {
833 1
			return new WP_Error( 'form_id_not_set', '[apply_filters_to_entry] Entry is empty!', $entry );
834
		}
835
836 22
		$criteria = self::calculate_get_entries_criteria();
837
838 22
		if ( empty( $criteria['search_criteria'] ) || ! is_array( $criteria['search_criteria'] ) ) {
839 22
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No search criteria found:', array( 'data' => $criteria ) );
840 22
			return $entry;
841
		}
842
843
		// Make sure the current View is connected to the same form as the Entry
844 2
		if( ! empty( $criteria['context_view_id'] ) ) {
845 2
			$context_view_id = intval( $criteria['context_view_id'] );
846 2
			$context_form_id = gravityview_get_form_id( $context_view_id );
847 2
			if( intval( $context_form_id ) !== intval( $entry['form_id'] ) ) {
848 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'] );
849
			}
850
		}
851
852 2
		$search_criteria = $criteria['search_criteria'];
853
854
		// check entry status
855 2
		if ( array_key_exists( 'status', $search_criteria ) && $search_criteria['status'] != $entry['status'] ) {
856 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 );
857
		}
858
859
		// check entry date
860
		// @todo: Does it make sense to apply the Date create filters to the single entry?
861
862
		// field_filters
863 2
		if ( empty( $search_criteria['field_filters'] ) || ! is_array( $search_criteria['field_filters'] ) ) {
864 1
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved! No field filters criteria found:', array( 'data' => $search_criteria ) );
865 1
			return $entry;
866
		}
867
868 2
		$filters = $search_criteria['field_filters'];
869
870 2
		$mode = array_key_exists( 'mode', $filters ) ? strtolower( $filters['mode'] ) : 'all';
871
872 2
		$mode = $mode ? : 'all'; // If mode is an empty string, assume it's 'all'
873
874
		// Prevent the mode from being processed below
875 2
		unset( $filters['mode'] );
876
877 2
		$form = self::get_form( $entry['form_id'] );
878
879 2
		foreach ( $filters as $filter ) {
880
881 2
			if ( ! isset( $filter['key'] ) ) {
882
				gravityview()->log->debug( '[apply_filters_to_entry] Filter key not set: {filter}', array( 'filter' => $filter ) );
883
				continue;
884
			}
885
886 2
			$k = $filter['key'];
887
888 2
			$field = self::get_field( $form, $k );
889
890 2
			if ( is_null( $field ) ) {
891 2
				$field_value = isset( $entry[ $k ] ) ? $entry[ $k ] : null;
892 2
				$field = $k;
893
			} else {
894
				$field_value  = GFFormsModel::get_lead_field_value( $entry, $field );
895
				 // If it's a complex field, then fetch the input's value, if exists at the current key. Otherwise, let GF handle it
896
				$field_value = ( is_array( $field_value ) && isset( $field_value[ $k ] ) ) ? \GV\Utils::get( $field_value, $k ) : $field_value;
897
			}
898
899 2
			$operator = isset( $filter['operator'] ) ? strtolower( $filter['operator'] ) : 'is';
900
901 2
			$is_value_match = GravityView_GFFormsModel::is_value_match( $field_value, $filter['value'], $operator, $field );
902
903
			// Any match is all we need to know
904 2
			if ( $is_value_match && 'any' === $mode ) {
905 1
				return $entry;
906
			}
907
908
			// Any failed match is a total fail
909 2
			if ( ! $is_value_match && 'all' === $mode ) {
910 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...
911
			}
912
		}
913
914
		// at this point, if in ALL mode, then entry is approved - all conditions were met.
915
		// Or, for ANY mode, means none of the conditions were satisfied, so entry is not approved
916 2
		if ( 'all' === $mode ) {
917 2
			gravityview()->log->debug( '[apply_filters_to_entry] Entry approved: all conditions were met' );
918 2
			return $entry;
919
		} else {
920
			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...
921
		}
922
923
	}
924
925
926
	/**
927
	 * Allow formatting date and time based on GravityView standards
928
	 *
929
	 * @since 1.16
930
	 *
931
	 * @see GVCommon_Test::test_format_date for examples
932
	 *
933
	 * @param string $date_string The date as stored by Gravity Forms (`Y-m-d h:i:s` GMT)
934
	 * @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
935
	 * - `raw` Un-formatted date string in original `Y-m-d h:i:s` format
936
	 * - `timestamp` Integer timestamp returned by GFCommon::get_local_timestamp()
937
	 * - `diff` "%s ago" format, unless other `format` is defined
938
	 * - `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.
939
	 * - `time` Include time in the `GFCommon::format_date()` output
940
	 * - `format` Define your own date format, or `diff` format
941
	 *
942
	 * @return int|null|string Formatted date based on the original date
943
	 */
944 3
	public static function format_date( $date_string = '', $args = array() ) {
945
946
		$default_atts = array(
947 3
			'raw' => false,
948
			'timestamp' => false,
949
			'diff' => false,
950
			'human' => false,
951
			'format' => '',
952
			'time' => false,
953
		);
954
955 3
		$atts = wp_parse_args( $args, $default_atts );
956
957
		/**
958
		 * Gravity Forms code to adjust date to locally-configured Time Zone
959
		 * @see GFCommon::format_date() for original code
960
		 */
961 3
		$date_gmt_time   = mysql2date( 'G', $date_string );
962 3
		$date_local_timestamp = GFCommon::get_local_timestamp( $date_gmt_time );
963
964 3
		$format  = \GV\Utils::get( $atts, 'format' );
965 3
		$is_human  = ! empty( $atts['human'] );
966 3
		$is_diff  = ! empty( $atts['diff'] );
967 3
		$is_raw = ! empty( $atts['raw'] );
968 3
		$is_timestamp = ! empty( $atts['timestamp'] );
969 3
		$include_time = ! empty( $atts['time'] );
970
971
		// If we're using time diff, we want to have a different default format
972 3
		if( empty( $format ) ) {
973
			/* translators: %s: relative time from now, used for generic date comparisons. "1 day ago", or "20 seconds ago" */
974 3
			$format = $is_diff ? esc_html__( '%s ago', 'gravityview' ) : get_option( 'date_format' );
975
		}
976
977
		// If raw was specified, don't modify the stored value
978 3
		if ( $is_raw ) {
979 1
			$formatted_date = $date_string;
980 3
		} elseif( $is_timestamp ) {
981 1
			$formatted_date = $date_local_timestamp;
982 3
		} elseif ( $is_diff ) {
983 1
			$formatted_date = sprintf( $format, human_time_diff( $date_gmt_time ) );
984
		} else {
985 3
			$formatted_date = GFCommon::format_date( $date_string, $is_human, $format, $include_time );
986
		}
987
988 3
		unset( $format, $is_diff, $is_human, $is_timestamp, $is_raw, $date_gmt_time, $date_local_timestamp, $default_atts );
989
990 3
		return $formatted_date;
991
	}
992
993
	/**
994
	 * Retrieve the label of a given field id (for a specific form)
995
	 *
996
	 * @access public
997
	 * @since 1.17 Added $field_value parameter
998
	 *
999
	 * @param array $form Gravity Forms form array
1000
	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
1001
	 * @param string|array $field_value Raw value of the field.
1002
	 * @return string
1003
	 */
1004 1
	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
1005
1006 1
		if ( empty( $form ) || empty( $field_id ) ) {
1007
			return '';
1008
		}
1009
1010 1
		$field = self::get_field( $form, $field_id );
1011
1012 1
		$label = \GV\Utils::get( $field, 'label' );
1013
1014 1
		if( floor( $field_id ) !== floatval( $field_id ) ) {
1015 1
			$label = GFFormsModel::get_choice_text( $field, $field_value, $field_id );
1016
		}
1017
1018 1
		return $label;
1019
	}
1020
1021
1022
	/**
1023
	 * Returns the field details array of a specific form given the field id
1024
	 *
1025
	 * Alias of GFFormsModel::get_field
1026
	 *
1027
	 * @since 1.19 Allow passing form ID as well as form array
1028
	 *
1029
	 * @uses GFFormsModel::get_field
1030
	 * @see GFFormsModel::get_field
1031
	 * @access public
1032
	 * @param array|int $form Form array or ID
1033
	 * @param string|int $field_id
1034
	 * @return GF_Field|null Gravity Forms field object, or NULL: Gravity Forms GFFormsModel does not exist or field at $field_id doesn't exist.
1035
	 */
1036 4
	public static function get_field( $form, $field_id ) {
1037
1038 4
		if ( is_numeric( $form ) ) {
1039
			$form = GFAPI::get_form( $form );
1040
		}
1041
1042 4
		if ( class_exists( 'GFFormsModel' ) ){
1043 4
			return GFFormsModel::get_field( $form, $field_id );
1044
		} else {
1045
			return null;
1046
		}
1047
	}
1048
1049
1050
	/**
1051
	 * Check whether the post is GravityView
1052
	 *
1053
	 * - Check post type. Is it `gravityview`?
1054
	 * - Check shortcode
1055
	 *
1056
	 * @param  WP_Post      $post WordPress post object
1057
	 * @return boolean           True: yep, GravityView; No: not!
1058
	 */
1059 2
	public static function has_gravityview_shortcode( $post = null ) {
1060 2
		if ( ! is_a( $post, 'WP_Post' ) ) {
1061 1
			return false;
1062
		}
1063
1064 2
		if ( 'gravityview' === get_post_type( $post ) ) {
1065 2
			return true;
1066
		}
1067
1068 2
		return self::has_shortcode_r( $post->post_content, 'gravityview' ) ? true : false;
1069
1070
	}
1071
1072
1073
	/**
1074
	 * Placeholder until the recursive has_shortcode() patch is merged
1075
	 * @see https://core.trac.wordpress.org/ticket/26343#comment:10
1076
	 * @param string $content Content to check whether there's a shortcode
1077
	 * @param string $tag Current shortcode tag
1078
	 */
1079 2
	public static function has_shortcode_r( $content, $tag = 'gravityview' ) {
1080 2
		if ( false === strpos( $content, '[' ) ) {
1081 1
			return false;
1082
		}
1083
1084 2
		if ( shortcode_exists( $tag ) ) {
1085
1086 2
			$shortcodes = array();
1087
1088 2
			preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
1089 2
			if ( empty( $matches ) ){
1090 1
				return false;
1091
			}
1092
1093 2
			foreach ( $matches as $shortcode ) {
1094 2
				if ( $tag === $shortcode[2] ) {
1095
1096
					// Changed this to $shortcode instead of true so we get the parsed atts.
1097 2
					$shortcodes[] = $shortcode;
1098
1099 1
				} else if ( isset( $shortcode[5] ) && $results = self::has_shortcode_r( $shortcode[5], $tag ) ) {
1100 1
					foreach( $results as $result ) {
1101 2
						$shortcodes[] = $result;
1102
					}
1103
				}
1104
			}
1105
1106 2
			return $shortcodes;
1107
		}
1108
		return false;
1109
	}
1110
1111
1112
1113
	/**
1114
	 * Get the views for a particular form
1115
	 *
1116
	 * @since 1.15.2 Add $args array and limit posts_per_page to 500
1117
	 *
1118
	 * @uses get_posts()
1119
	 *
1120
	 * @param  int $form_id Gravity Forms form ID
1121
	 * @param  array $args Pass args sent to get_posts()
1122
	 *
1123
	 * @return array          Array with view details, as returned by get_posts()
1124
	 */
1125 1
	public static function get_connected_views( $form_id, $args = array() ) {
1126
1127 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...
1128
1129
		$defaults = array(
1130 1
			'post_type'      => 'gravityview',
1131 1
			'posts_per_page' => 100,
0 ignored issues
show
introduced by
Detected high pagination limit, posts_per_page is set to 100
Loading history...
1132 1
			'meta_key'       => '_gravityview_form_id',
0 ignored issues
show
introduced by
Detected usage of meta_key, possible slow query.
Loading history...
1133 1
			'meta_value'     => (int) $form_id,
0 ignored issues
show
introduced by
Detected usage of meta_value, possible slow query.
Loading history...
1134
		);
1135 1
		$args     = wp_parse_args( $args, $defaults );
1136 1
		$views    = get_posts( $args );
1137
1138 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...
1139
1140 1
		$joined_forms = array();
1141 1
		foreach ( $views_with_joins as $view ) {
1142
1143 1
			$data = unserialize( $view->meta_value );
1144
1145 1
			if( ! $data || ! is_array( $data ) ) {
1146 1
				continue;
1147
			}
1148
1149
			foreach ( $data as $datum ) {
1150
				if ( ! empty( $datum[2] ) && (int) $datum[2] === (int) $form_id ) {
1151
					$joined_forms[] = $view->post_id;
1152
				}
1153
			}
1154
		}
1155
1156 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...
1157
			$joined_args  = array(
1158
				'post_type'      => 'gravityview',
1159
				'posts_per_page' => $args['posts_per_page'],
1160
				'post__in'       => $joined_forms,
1161
			);
1162
			$views = array_merge( $views, get_posts( $joined_args ) );
1163
		}
1164
1165 1
		return $views;
1166
	}
1167
1168
	/**
1169
	 * Get the Gravity Forms form ID connected to a View
1170
	 *
1171
	 * @param int $view_id The ID of the View to get the connected form of
1172
	 *
1173
	 * @return false|string ID of the connected Form, if exists. Empty string if not. False if not the View ID isn't valid.
1174
	 */
1175 2
	public static function get_meta_form_id( $view_id ) {
1176 2
		return get_post_meta( $view_id, '_gravityview_form_id', true );
1177
	}
1178
1179
	/**
1180
	 * Get the template ID (`list`, `table`, `datatables`, `map`) for a View
1181
	 *
1182
	 * @see GravityView_Template::template_id
1183
	 *
1184
	 * @param int $view_id The ID of the View to get the layout of
1185
	 *
1186
	 * @return string GravityView_Template::template_id value. Empty string if not.
1187
	 */
1188 72
	public static function get_meta_template_id( $view_id ) {
1189 72
		return get_post_meta( $view_id, '_gravityview_directory_template', true );
1190
	}
1191
1192
1193
	/**
1194
	 * Get all the settings for a View
1195
	 *
1196
	 * @uses  \GV\View_Settings::defaults() Parses the settings with the plugin defaults as backups.
1197
	 * @param  int $post_id View ID
1198
	 * @return array          Associative array of settings with plugin defaults used if not set by the View
1199
	 */
1200 71
	public static function get_template_settings( $post_id ) {
1201
1202 71
		$settings = get_post_meta( $post_id, '_gravityview_template_settings', true );
1203
1204 71
		if ( class_exists( '\GV\View_Settings' ) ) {
1205
1206 71
			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...
1207
1208
		}
1209
1210
		// Backup, in case GravityView_View_Data isn't loaded yet.
1211
		return $settings;
1212
	}
1213
1214
	/**
1215
	 * Get the setting for a View
1216
	 *
1217
	 * If the setting isn't set by the View, it returns the plugin default.
1218
	 *
1219
	 * @param  int $post_id View ID
1220
	 * @param  string $key     Key for the setting
1221
	 * @return mixed|null          Setting value, or NULL if not set.
1222
	 */
1223 1
	public static function get_template_setting( $post_id, $key ) {
1224
1225 1
		$settings = self::get_template_settings( $post_id );
1226
1227 1
		if ( isset( $settings[ $key ] ) ) {
1228 1
			return $settings[ $key ];
1229
		}
1230
1231
		return null;
1232
	}
1233
1234
	/**
1235
	 * Get the field configuration for the View
1236
	 *
1237
	 * array(
1238
	 *
1239
	 * 	[other zones]
1240
	 *
1241
	 * 	'directory_list-title' => array(
1242
	 *
1243
	 *   	[other fields]
1244
	 *
1245
	 *  	'5372653f25d44' => array(
1246
	 *  		'id' => string '9' (length=1)
1247
	 *  		'label' => string 'Screenshots' (length=11)
1248
	 *			'show_label' => string '1' (length=1)
1249
	 *			'custom_label' => string '' (length=0)
1250
	 *			'custom_class' => string 'gv-gallery' (length=10)
1251
	 * 			'only_loggedin' => string '0' (length=1)
1252
	 *			'only_loggedin_cap' => string 'read' (length=4)
1253
	 *  	)
1254
	 *
1255
	 * 		[other fields]
1256
	 *  )
1257
	 *
1258
	 * 	[other zones]
1259
	 * )
1260
	 *
1261
	 * @since 1.17.4 Added $apply_filter parameter
1262
	 *
1263
	 * @param  int $post_id View ID
1264
	 * @param  bool $apply_filter Whether to apply the `gravityview/configuration/fields` filter [Default: true]
1265
	 * @return array          Multi-array of fields with first level being the field zones. See code comment.
1266
	 */
1267 1
	public static function get_directory_fields( $post_id, $apply_filter = true ) {
1268 1
		$fields = get_post_meta( $post_id, '_gravityview_directory_fields', true );
1269
1270 1
		if ( $apply_filter ) {
1271
			/**
1272
			 * @filter `gravityview/configuration/fields` Filter the View fields' configuration array
1273
			 * @since 1.6.5
1274
			 *
1275
			 * @param $fields array Multi-array of fields with first level being the field zones
1276
			 * @param $post_id int Post ID
1277
			 */
1278 1
			$fields = apply_filters( 'gravityview/configuration/fields', $fields, $post_id );
1279
1280
			/**
1281
			 * @filter `gravityview/view/configuration/fields` Filter the View fields' configuration array.
1282
			 * @since 2.0
1283
			 *
1284
			 * @param array $fields Multi-array of fields with first level being the field zones.
1285
			 * @param \GV\View $view The View the fields are being pulled for.
1286
			 */
1287 1
			$fields = apply_filters( 'gravityview/view/configuration/fields', $fields, \GV\View::by_id( $post_id ) );
1288
		}
1289
1290 1
		return $fields;
1291
	}
1292
1293
	/**
1294
	 * Get the widget configuration for a View
1295
	 *
1296
	 * @param int $view_id View ID
1297
	 * @param bool $json_decode Whether to JSON-decode the widget values. Default: `false`
1298
	 *
1299
	 * @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"
1300
	 */
1301
	public static function get_directory_widgets( $view_id, $json_decode = false ) {
1302
1303
		$view_widgets = get_post_meta( $view_id, '_gravityview_directory_widgets', true );
1304
1305
		$defaults = array(
1306
			'header_top' => array(),
1307
			'header_left' => array(),
1308
			'header_right' => array(),
1309
			'footer_left' => array(),
1310
			'footer_right' => array(),
1311
		);
1312
1313
		$directory_widgets = wp_parse_args( $view_widgets, $defaults );
1314
1315
		if( $json_decode ) {
1316
			$directory_widgets = gv_map_deep( $directory_widgets, 'gv_maybe_json_decode' );
1317
		}
1318
1319
		return $directory_widgets;
1320
	}
1321
1322
1323
	/**
1324
	 * Render dropdown (select) with the list of sortable fields from a form ID
1325
	 *
1326
	 * @access public
1327
	 * @param  int $formid Form ID
1328
	 * @return string         html
1329
	 */
1330
	public static function get_sortable_fields( $formid, $current = '' ) {
1331
		$output = '<option value="" ' . selected( '', $current, false ).'>' . esc_html__( 'Default', 'gravityview' ) .'</option>';
1332
1333
		if ( empty( $formid ) ) {
1334
			return $output;
1335
		}
1336
1337
		$fields = self::get_sortable_fields_array( $formid );
1338
1339
		if ( ! empty( $fields ) ) {
1340
1341
			$blacklist_field_types = apply_filters( 'gravityview_blacklist_field_types', array( 'list', 'textarea' ), null );
1342
1343
			foreach ( $fields as $id => $field ) {
1344
				if ( in_array( $field['type'], $blacklist_field_types ) ) {
1345
					continue;
1346
				}
1347
1348
				$output .= '<option value="'. $id .'" '. selected( $id, $current, false ).'>'. esc_attr( $field['label'] ) .'</option>';
1349
			}
1350
		}
1351
1352
		return $output;
1353
	}
1354
1355
	/**
1356
	 *
1357
	 * @param int $formid Gravity Forms form ID
1358
	 * @param array $blacklist Field types to exclude
1359
	 *
1360
	 * @since 1.8
1361
	 *
1362
	 * @todo Get all fields, check if sortable dynamically
1363
	 *
1364
	 * @return array
1365
	 */
1366
	public static function get_sortable_fields_array( $formid, $blacklist = array( 'list', 'textarea' ) ) {
1367
1368
		// Get fields with sub-inputs and no parent
1369
		$fields = self::get_form_fields( $formid, true, false );
1370
1371
		$date_created = array(
1372
			'date_created' => array(
1373
				'type' => 'date_created',
1374
				'label' => __( 'Date Created', 'gravityview' ),
1375
			),
1376
		);
1377
1378
        $fields = $date_created + $fields;
1379
1380
		$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...
1381
1382
		// TODO: Convert to using array_filter
1383
		foreach( $fields as $id => $field ) {
1384
1385
			if( in_array( $field['type'], $blacklist_field_types ) ) {
1386
				unset( $fields[ $id ] );
1387
			}
1388
		}
1389
1390
        /**
1391
         * @filter `gravityview/common/sortable_fields` Filter the sortable fields
1392
         * @since 1.12
1393
         * @param array $fields Sub-set of GF form fields that are sortable
1394
         * @param int $formid The Gravity Forms form ID that the fields are from
1395
         */
1396
        $fields = apply_filters( 'gravityview/common/sortable_fields', $fields, $formid );
1397
1398
		return $fields;
1399
	}
1400
1401
	/**
1402
	 * Returns the GF Form field type for a certain field(id) of a form
1403
	 * @param  object $form     Gravity Forms form
1404
	 * @param  mixed $field_id Field ID or Field array
1405
	 * @return string field type
1406
	 */
1407
	public static function get_field_type( $form = null, $field_id = '' ) {
1408
1409
		if ( ! empty( $field_id ) && ! is_array( $field_id ) ) {
1410
			$field = self::get_field( $form, $field_id );
1411
		} else {
1412
			$field = $field_id;
1413
		}
1414
1415
		return class_exists( 'RGFormsModel' ) ? RGFormsModel::get_input_type( $field ) : '';
1416
1417
	}
1418
1419
1420
	/**
1421
	 * Checks if the field type is a 'numeric' field type (e.g. to be used when sorting)
1422
	 * @param  int|array  $form  form ID or form array
1423
	 * @param  int|array  $field field key or field array
1424
	 * @return boolean
1425
	 */
1426
	public static function is_field_numeric(  $form = null, $field = '' ) {
1427
1428
		if ( ! is_array( $form ) && ! is_array( $field ) ) {
1429
			$form = self::get_form( $form );
1430
		}
1431
1432
		// If entry meta, it's a string. Otherwise, numeric
1433
		if( ! is_numeric( $field ) && is_string( $field ) ) {
1434
			$type = $field;
1435
		} else {
1436
			$type = self::get_field_type( $form, $field );
1437
		}
1438
1439
		/**
1440
		 * @filter `gravityview/common/numeric_types` What types of fields are numeric?
1441
		 * @since 1.5.2
1442
		 * @param array $numeric_types Fields that are numeric. Default: `[ number, time ]`
1443
		 */
1444
		$numeric_types = apply_filters( 'gravityview/common/numeric_types', array( 'number', 'time' ) );
1445
1446
		// Defer to GravityView_Field setting, if the field type is registered and `is_numeric` is true
1447
		if( $gv_field = GravityView_Fields::get( $type ) ) {
1448
			if( true === $gv_field->is_numeric ) {
1449
				$numeric_types[] = $gv_field->is_numeric;
1450
			}
1451
		}
1452
1453
		$return = in_array( $type, $numeric_types );
1454
1455
		return $return;
1456
	}
1457
1458
	/**
1459
	 * Encrypt content using Javascript so that it's hidden when JS is disabled.
1460
	 *
1461
	 * This is mostly used to hide email addresses from scraper bots.
1462
	 *
1463
	 * @param string $content Content to encrypt
1464
	 * @param string $message Message shown if Javascript is disabled
1465
	 *
1466
	 * @see  https://github.com/katzwebservices/standalone-phpenkoder StandalonePHPEnkoder on Github
1467
	 *
1468
	 * @since 1.7
1469
	 *
1470
	 * @return string Content, encrypted
1471
	 */
1472
	public static function js_encrypt( $content, $message = '' ) {
1473
1474
		$output = $content;
1475
1476
		if ( ! class_exists( 'StandalonePHPEnkoder' ) ) {
1477
			include_once( GRAVITYVIEW_DIR . 'includes/lib/StandalonePHPEnkoder.php' );
1478
		}
1479
1480
		if ( class_exists( 'StandalonePHPEnkoder' ) ) {
1481
1482
			$enkoder = new StandalonePHPEnkoder;
1483
1484
			$message = empty( $message ) ? __( 'Email hidden; Javascript is required.', 'gravityview' ) : $message;
1485
1486
			/**
1487
			 * @filter `gravityview/phpenkoder/msg` Modify the message shown when Javascript is disabled and an encrypted email field is displayed
1488
			 * @since 1.7
1489
			 * @param string $message Existing message
1490
			 * @param string $content Content to encrypt
1491
			 */
1492
			$enkoder->enkode_msg = apply_filters( 'gravityview/phpenkoder/msg', $message, $content );
1493
1494
			$output = $enkoder->enkode( $content );
1495
		}
1496
1497
		return $output;
1498
	}
1499
1500
	/**
1501
	 *
1502
	 * Do the same than parse_str without max_input_vars limitation:
1503
	 * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
1504
	 * @param $string array string to parse (not altered like in the original parse_str(), use the second parameter!)
1505
	 * @param $result array  If the second parameter is present, variables are stored in this variable as array elements
1506
	 * @return bool true or false if $string is an empty string
1507
	 * @since  1.5.3
1508
	 *
1509
	 * @author rubo77 at https://gist.github.com/rubo77/6821632
1510
	 **/
1511
	public static function gv_parse_str( $string, &$result ) {
1512
		if ( empty( $string ) ) {
1513
			return false;
1514
		}
1515
1516
		$result = array();
1517
1518
		// find the pairs "name=value"
1519
		$pairs = explode( '&', $string );
1520
1521
		foreach ( $pairs as $pair ) {
1522
			// use the original parse_str() on each element
1523
			parse_str( $pair, $params );
1524
1525
			$k = key( $params );
1526
			if ( ! isset( $result[ $k ] ) ) {
1527
				$result += $params;
1528
			} elseif ( array_key_exists( $k, $params ) && is_array( $params[ $k ] ) ) {
1529
				$result[ $k ] = self::array_merge_recursive_distinct( $result[ $k ], $params[ $k ] );
1530
			}
1531
		}
1532
		return true;
1533
	}
1534
1535
1536
	/**
1537
	 * Generate an HTML anchor tag with a list of supported attributes
1538
	 *
1539
	 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a Supported attributes defined here
1540
	 * @uses esc_url_raw() to sanitize $href
1541
	 * @uses esc_attr() to sanitize $atts
1542
	 *
1543
	 * @since 1.6
1544
	 *
1545
	 * @param string $href URL of the link. Sanitized using `esc_url_raw()`
1546
	 * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1547
	 * @param array|string $atts Attributes to be added to the anchor tag. Parsed by `wp_parse_args()`, sanitized using `esc_attr()`
1548
	 *
1549
	 * @return string HTML output of anchor link. If empty $href, returns NULL
1550
	 */
1551 25
	public static function get_link_html( $href = '', $anchor_text = '', $atts = array() ) {
1552
1553
		// Supported attributes for anchor tags. HREF left out intentionally.
1554
		$allowed_atts = array(
1555 25
			'href' => null, // Will override the $href argument if set
1556
			'title' => null,
1557
			'rel' => null,
1558
			'id' => null,
1559
			'class' => null,
1560
			'target' => null,
1561
			'style' => null,
1562
1563
			// Used by GravityView
1564
			'data-viewid' => null,
1565
1566
			// Not standard
1567
			'hreflang' => null,
1568
			'type' => null,
1569
			'tabindex' => null,
1570
1571
			// Deprecated HTML4 but still used
1572
			'name' => null,
1573
			'onclick' => null,
1574
			'onchange' => null,
1575
			'onkeyup' => null,
1576
1577
			// HTML5 only
1578
			'download' => null,
1579
			'media' => null,
1580
			'ping' => null,
1581
		);
1582
1583
		/**
1584
		 * @filter `gravityview/get_link/allowed_atts` Modify the attributes that are allowed to be used in generating links
1585
		 * @param array $allowed_atts Array of attributes allowed
1586
		 */
1587 25
		$allowed_atts = apply_filters( 'gravityview/get_link/allowed_atts', $allowed_atts );
1588
1589
		// Make sure the attributes are formatted as array
1590 25
		$passed_atts = wp_parse_args( $atts );
1591
1592
		// Make sure the allowed attributes are only the ones in the $allowed_atts list
1593 25
		$final_atts = shortcode_atts( $allowed_atts, $passed_atts );
1594
1595
		// Remove attributes with empty values
1596 25
		$final_atts = array_filter( $final_atts );
1597
1598
		// If the href wasn't passed as an attribute, use the value passed to the function
1599 25
		if ( empty( $final_atts['href'] ) && ! empty( $href ) ) {
1600 25
			$final_atts['href'] = $href;
1601
		}
1602
1603 25
		$final_atts['href'] = esc_url_raw( $href );
1604
1605
		/**
1606
		 * Fix potential security issue with target=_blank
1607
		 * @see https://dev.to/ben/the-targetblank-vulnerability-by-example
1608
		 */
1609 25
		if( '_blank' === \GV\Utils::get( $final_atts, 'target' ) ) {
1610 4
			$final_atts['rel'] = trim( \GV\Utils::get( $final_atts, 'rel', '' ) . ' noopener noreferrer' );
1611
		}
1612
1613
		// Sort the attributes alphabetically, to help testing
1614 25
		ksort( $final_atts );
1615
1616
		// For each attribute, generate the code
1617 25
		$output = '';
1618 25
		foreach ( $final_atts as $attr => $value ) {
1619 25
			$output .= sprintf( ' %s="%s"', $attr, esc_attr( $value ) );
1620
		}
1621
1622 25
		if( '' !== $output ) {
1623 25
			$output = '<a' . $output . '>' . $anchor_text . '</a>';
1624
		}
1625
1626 25
		return $output;
1627
	}
1628
1629
	/**
1630
	 * array_merge_recursive does indeed merge arrays, but it converts values with duplicate
1631
	 * keys to arrays rather than overwriting the value in the first array with the duplicate
1632
	 * value in the second array, as array_merge does.
1633
	 *
1634
	 * @see http://php.net/manual/en/function.array-merge-recursive.php
1635
	 *
1636
	 * @since  1.5.3
1637
	 * @param array $array1
1638
	 * @param array $array2
1639
	 * @return array
1640
	 * @author Daniel <daniel (at) danielsmedegaardbuus (dot) dk>
1641
	 * @author Gabriel Sobrinho <gabriel (dot) sobrinho (at) gmail (dot) com>
1642
	 */
1643
	public static function array_merge_recursive_distinct( array &$array1, array &$array2 ) {
1644
		$merged = $array1;
1645
		foreach ( $array2 as $key => $value ) {
1646
			if ( is_array( $value ) && isset( $merged[ $key ] ) && is_array( $merged[ $key ] ) ) {
1647
				$merged[ $key ] = self::array_merge_recursive_distinct( $merged[ $key ], $value );
1648
			} else if ( is_numeric( $key ) && isset( $merged[ $key ] ) ) {
1649
				$merged[] = $value;
1650
			} else {
1651
				$merged[ $key ] = $value;
1652
			}
1653
		}
1654
1655
		return $merged;
1656
	}
1657
1658
	/**
1659
	 * Get WordPress users with reasonable limits set
1660
	 *
1661
	 * @param string $context Where are we using this information (e.g. change_entry_creator, search_widget ..)
1662
	 * @param array $args Arguments to modify the user query. See get_users() {@since 1.14}
1663
	 * @return array Array of WP_User objects.
1664
	 */
1665
	public static function get_users( $context = 'change_entry_creator', $args = array() ) {
1666
1667
		$default_args = array(
1668
			'number' => 2000,
1669
			'orderby' => 'display_name',
1670
			'order' => 'ASC',
1671
			'fields' => array( 'ID', 'display_name', 'user_login', 'user_nicename' )
1672
		);
1673
1674
		// Merge in the passed arg
1675
		$get_users_settings = wp_parse_args( $args, $default_args );
1676
1677
		/**
1678
		 * @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
1679
		 * `$context` is where are we using this information (e.g. change_entry_creator, search_widget ..)
1680
		 * @param array $settings Settings array, with `number` key defining the # of users to display
1681
		 */
1682
		$get_users_settings = apply_filters( 'gravityview/get_users/'. $context, apply_filters( 'gravityview_change_entry_creator_user_parameters', $get_users_settings ) );
1683
1684
		return get_users( $get_users_settings );
1685
	}
1686
1687
1688
    /**
1689
     * Display updated/error notice
1690
     *
1691
     * @since 1.19.2 Added $cap and $object_id parameters
1692
     *
1693
     * @param string $notice text/HTML of notice
1694
     * @param string $class CSS class for notice (`updated` or `error`)
1695
     * @param string $cap [Optional] Define a capability required to show a notice. If not set, displays to all caps.
1696
     *
1697
     * @return string
1698
     */
1699 4
    public static function generate_notice( $notice, $class = '', $cap = '', $object_id = null ) {
1700
1701
    	// If $cap is defined, only show notice if user has capability
1702 4
    	if( $cap && ! GVCommon::has_cap( $cap, $object_id ) ) {
1703 4
    		return '';
1704
	    }
1705
1706 1
        return '<div class="gv-notice '.gravityview_sanitize_html_class( $class ) .'">'. $notice .'</div>';
1707
    }
1708
1709
	/**
1710
	 * Inspired on \GFCommon::encode_shortcodes, reverse the encoding by replacing the ascii characters by the shortcode brackets
1711
	 * @since 1.16.5
1712
	 * @param string $string Input string to decode
1713
	 * @return string $string Output string
1714
	 */
1715
	public static function decode_shortcodes( $string ) {
1716
		$replace = array( '[', ']', '"' );
1717
		$find = array( '&#91;', '&#93;', '&quot;' );
1718
		$string = str_replace( $find, $replace, $string );
1719
1720
		return $string;
1721
	}
1722
1723
1724
	/**
1725
	 * Send email using GFCommon::send_email()
1726
	 *
1727
	 * @since 1.17
1728
	 *
1729
	 * @see GFCommon::send_email This just makes the method public
1730
	 *
1731
	 * @param string $from               Sender address (required)
1732
	 * @param string $to                 Recipient address (required)
1733
	 * @param string $bcc                BCC recipients (required)
1734
	 * @param string $reply_to           Reply-to address (required)
1735
	 * @param string $subject            Subject line (required)
1736
	 * @param string $message            Message body (required)
1737
	 * @param string $from_name          Displayed name of the sender
1738
	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
1739
	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
1740
	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
1741
	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
1742
	 */
1743
	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
1744
1745
		$SendEmail = new ReflectionMethod( 'GFCommon', 'send_email' );
1746
1747
		// It was private; let's make it public
1748
		$SendEmail->setAccessible( true );
1749
1750
		// 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...
1751
		// 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...
1752
		$SendEmail->invoke( new GFCommon, $from, $to, $bcc, $reply_to, $subject, $message, $from_name, $message_format, $attachments, $entry, $notification );
1753
	}
1754
1755
1756
} //end class
1757
1758
1759
/**
1760
 * Generate an HTML anchor tag with a list of supported attributes
1761
 *
1762
 * @see GVCommon::get_link_html()
1763
 *
1764
 * @since 1.6
1765
 *
1766
 * @param string $href URL of the link.
1767
 * @param string $anchor_text The text or HTML inside the anchor. This is not sanitized in the function.
1768
 * @param array|string $atts Attributes to be added to the anchor tag
1769
 *
1770
 * @return string HTML output of anchor link. If empty $href, returns NULL
1771
 */
1772
function gravityview_get_link( $href = '', $anchor_text = '', $atts = array() ) {
1773 24
	return GVCommon::get_link_html( $href, $anchor_text, $atts );
1774
}
1775