Completed
Push — develop ( ded42b...4830a1 )
by Gennady
26:06 queued 16:56
created

GravityView_Edit_Entry_Render::setup_vars()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 18

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 13
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 18
ccs 13
cts 13
cp 1
crap 1
rs 9.6666
c 0
b 0
f 0
1
<?php
2
/**
3
 * GravityView Edit Entry - render frontend
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
12
if ( ! defined( 'WPINC' ) ) {
13
	die;
14
}
15
16
class GravityView_Edit_Entry_Render {
17
18
	/**
19
	 * @var GravityView_Edit_Entry
20
	 */
21
	protected $loader;
22
23
	/**
24
	 * @var string String used to generate unique nonce for the entry/form/view combination. Allows access to edit page.
25
	 */
26
	static $nonce_key;
27
28
	/**
29
	 * @since 1.9
30
	 * @var string String used for check valid edit entry form submission. Allows saving edit form values.
31
	 */
32
	private static $nonce_field = 'is_gv_edit_entry';
33
34
	/**
35
	 * @since 1.9
36
	 * @var bool Whether to allow save and continue functionality
37
	 */
38
	private static $supports_save_and_continue = false;
39
40
	/**
41
	 * Gravity Forms entry array
42
	 *
43
	 * @var array
44
	 */
45
	public $entry;
46
47
	/**
48
	 * The View.
49
	 *
50
	 * @var \GV\View.
51
	 * @since develop
52
	 */
53
	public $view;
54
55
	/**
56
	 * Gravity Forms entry array (it won't get changed during this class lifecycle)
57
	 * @since 1.17.2
58
	 * @var array
59
	 */
60
	private static $original_entry = array();
61
62
	/**
63
	 * Gravity Forms form array (GravityView modifies the content through this class lifecycle)
64
	 *
65
	 * @var array
66
	 */
67
	public $form;
68
69
	/**
70
	 * Gravity Forms form array (it won't get changed during this class lifecycle)
71
	 * @since 1.16.2.1
72
	 * @var array
73
	 */
74
	private static $original_form;
75
76
	/**
77
	 * Gravity Forms form array after the form validation process
78
	 * @since 1.13
79
	 * @var array
80
	 */
81
	public $form_after_validation = null;
82
83
	/**
84
	 * Hold an array of GF field objects that have calculation rules
85
	 * @var array
86
	 */
87
	public $fields_with_calculation = array();
88
89
	/**
90
	 * Gravity Forms form id
91
	 *
92
	 * @var int
93
	 */
94
	public $form_id;
95
96
	/**
97
	 * ID of the current view
98
	 *
99
	 * @var int
100
	 */
101
	public $view_id;
102
103
	/**
104
	 * ID of the current post. May also be ID of the current View.
105
     *
106
     * @since 2.0.13
107
     * 
108
     * @var int
109
	 */
110
	public $post_id;
111
112
	/**
113
	 * Updated entry is valid (GF Validation object)
114
	 *
115
	 * @var array
116
	 */
117
	public $is_valid = NULL;
118
119 17
	function __construct( GravityView_Edit_Entry $loader ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
120 17
		$this->loader = $loader;
121 17
	}
122
123 17
	function load() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
124
125
		/** @define "GRAVITYVIEW_DIR" "../../../" */
126 17
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
127
128
		// Don't display an embedded form when editing an entry
129 17
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
130 17
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
131
132
		// Stop Gravity Forms processing what is ours!
133 17
		add_filter( 'wp', array( $this, 'prevent_maybe_process_form'), 8 );
134
135 17
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
136
137 17
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
138
139
		// Disable conditional logic if needed (since 1.9)
140 17
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
141
142
		// Make sure GF doesn't validate max files (since 1.9)
143 17
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
144
145
		// Add fields expected by GFFormDisplay::validate()
146 17
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
147
148
		// Fix multiselect value for GF 2.2
149 17
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
150 17
	}
151
152
	/**
153
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
154
	 *
155
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
156
	 * And then removes it on the `wp_footer` action
157
	 *
158
	 * @since 1.16.1
159
	 *
160
	 * @return void
161
	 */
162 1
	public function prevent_render_form() {
163 1
		if( $this->is_edit_entry() ) {
164 1
			if( 'wp_head' === current_filter() ) {
165 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
166
			} else {
167 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
168
			}
169
		}
170 1
	}
171
172
	/**
173
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
174
	 * backend form, we need to prevent them from saving twice.
175
	 * @return void
176
	 */
177 1
	public function prevent_maybe_process_form() {
178
179 1
	    if( ! $this->is_edit_entry_submission() ) {
180 1
			return;
181
		}
182
183
		gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] Removing GFForms::maybe_process_form() action.' );
184
185
		remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
186
		remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
187
	}
188
189
	/**
190
	 * Is the current page an Edit Entry page?
191
	 * @return boolean
192
	 */
193 22
	public function is_edit_entry() {
194
195 22
		$is_edit_entry = GravityView_frontend::is_single_entry() && ! empty( $_GET['edit'] );
196
197 22
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
198
	}
199
200
	/**
201
	 * Is the current page an Edit Entry page?
202
	 * @since 1.9
203
	 * @return boolean
204
	 */
205 22
	public function is_edit_entry_submission() {
206 22
		return !empty( $_POST[ self::$nonce_field ] );
207
	}
208
209
	/**
210
	 * When Edit entry view is requested setup the vars
211
	 */
212 17
	private function setup_vars() {
213 17
        global $post;
214
215 17
		$gravityview_view = GravityView_View::getInstance();
216
217
218 17
		$entries = $gravityview_view->getEntries();
219 17
	    self::$original_entry = $entries[0];
220 17
	    $this->entry = $entries[0];
221
222 17
		self::$original_form = $gravityview_view->getForm();
223 17
		$this->form = $gravityview_view->getForm();
224 17
		$this->form_id = $this->entry['form_id'];
225 17
		$this->view_id = $gravityview_view->getViewId();
226 17
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
227
228 17
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
229 17
	}
230
231
232
	/**
233
	 * Load required files and trigger edit flow
234
	 *
235
	 * Run when the is_edit_entry returns true.
236
	 *
237
	 * @param \GravityView_View_Data $gv_data GravityView Data object
238
	 * @param \GV\Entry   $entry   The Entry.
239
	 * @param \GV\View    $view    The View.
240
	 * @param \GV\Request $request The Request.
241
	 *
242
	 * @since develop Added $entry, $view, $request adhocs.
243
	 *
244
	 * @return void
245
	 */
246 18
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
247
248 18
		require_once( GFCommon::get_base_path() . '/form_display.php' );
249 18
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
250
251 18
		$this->setup_vars();
252
253 18
		if ( ! $gv_data ) {
254
			$gv_data = GravityView_View_Data::getInstance();
255
		}
256
257
		// Multiple Views embedded, don't proceed if nonce fails
258 18
		if ( $gv_data->has_multiple_views() && ! $this->verify_nonce() ) {
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...
259
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
260
			return;
261
		}
262
263
		// Sorry, you're not allowed here.
264 18
		if ( false === $this->user_can_edit_entry( true ) ) {
265 1
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
266 1
			return;
267
		}
268
269 18
		$this->view = $view;
270
271 18
		$this->print_scripts();
272
273 18
		$this->process_save( $gv_data );
274
275 18
		$this->edit_entry_form();
276
277 18
	}
278
279
280
	/**
281
	 * Force Gravity Forms to output scripts as if it were in the admin
282
	 * @return void
283
	 */
284 17
	private function print_scripts() {
285 17
		$gravityview_view = GravityView_View::getInstance();
286
287 17
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
288
289 17
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
290
291 17
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
292
293
		// Sack is required for images
294 17
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
295 17
	}
296
297
298
	/**
299
	 * Process edit entry form save
300
	 *
301
	 * @param array $gv_data The View data.
302
	 */
303 18
	private function process_save( $gv_data ) {
304
305 18
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
306 5
			return;
307
		}
308
309
		// Make sure the entry, view, and form IDs are all correct
310 17
		$valid = $this->verify_nonce();
311
312 17
		if ( !$valid ) {
313
			gravityview()->log->error( 'Nonce validation failed.' );
314
			return;
315
		}
316
317 17
		if ( $this->entry['id'] !== $_POST['lid'] ) {
318
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
319
			return;
320
		}
321
322 17
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
323
324 17
		$this->process_save_process_files( $this->form_id );
325
326 17
		$this->validate();
327
328 17
		if( $this->is_valid ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->is_valid 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...
329
330 17
			gravityview()->log->debug( 'Submission is valid.' );
331
332
			/**
333
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
334
			 */
335 17
			$form = $this->form_prepare_for_save();
336
337
			/**
338
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
339
			 */
340 17
			unset( $_GET['page'] );
341
342 17
			$date_created = $this->entry['date_created'];
343
344
			/**
345
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
346
			 * @since 1.17.2
347
			 */
348 17
			unset( $this->entry['date_created'] );
349
350
			/**
351
			 * @action `gravityview/edit_entry/before_update` Perform an action after the entry has been updated using Edit Entry
352
			 * @since develop
353
			 * @param array $form Gravity Forms form array
354
			 * @param string $entry_id Numeric ID of the entry that is being updated
355
			 * @param GravityView_Edit_Entry_Render $this This object
356
			 * @param GravityView_View_Data $gv_data The View data
357
			 */
358 17
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
359
360 17
			GFFormsModel::save_lead( $form, $this->entry );
361
362
	        // Delete the values for hidden inputs
363 17
	        $this->unset_hidden_field_values();
364
			
365 17
			$this->entry['date_created'] = $date_created;
366
367
			// Process calculation fields
368 17
			$this->update_calculation_fields();
369
370
			// Perform actions normally performed after updating a lead
371 17
			$this->after_update();
372
373
	        /**
374
			 * Must be AFTER after_update()!
375
			 * @see https://github.com/gravityview/GravityView/issues/764
376
			 */
377 17
			$this->maybe_update_post_fields( $form );
378
379
			/**
380
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
381
             * @since 2.1 Added $gv_data parameter
382
			 * @param array $form Gravity Forms form array
383
			 * @param string $entry_id Numeric ID of the entry that was updated
384
			 * @param GravityView_Edit_Entry_Render $this This object
385
			 * @param GravityView_View_Data $gv_data The View data
386
			 */
387 17
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
388
389
		} else {
390
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
391
		}
392
393 17
	} // process_save
394
395
	/**
396
	 * Delete the value of fields hidden by conditional logic when the entry is edited
397
	 *
398
	 * @uses GFFormsModel::update_lead_field_value()
399
	 *
400
	 * @since 1.17.4
401
	 *
402
	 * @return void
403
	 */
404 16
	private function unset_hidden_field_values() {
405 16
	    global $wpdb;
406
407
		/**
408
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
409
		 * @since 1.22.2
410
		 * @param bool $unset_hidden_field_values Default: true
411
		 * @param GravityView_Edit_Entry_Render $this This object
412
		 */
413 16
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
414
415 16
		if( ! $unset_hidden_field_values ) {
416
			return;
417
		}
418
419 16
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
420 16
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
421 16
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
422
		} else {
423
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
424
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
425
		}
426
427 16
	    foreach ( $this->entry as $input_id => $field_value ) {
428
429 16
			if ( ! is_numeric( $input_id ) ) {
430 16
				continue;
431
			}
432
433 16
		    $field = RGFormsModel::get_field( $this->form, $input_id );
434
435
		    // Reset fields that are hidden
436
		    // Don't pass $entry as fourth parameter; force using $_POST values to calculate conditional logic
437 16
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), NULL ) ) {
438
439
				$empty_value = $field->get_value_save_entry(
440
					is_array( $field->get_entry_inputs() ) ? array() : '',
441
					$this->form, '', $this->entry['id'], $this->entry
442
				);
443
444
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
445
446
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
447
448
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
449
				// after submission
450
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
451
			    $_POST[ $post_input_id ] = '';
452
		    }
453
	    }
454 16
	}
455
456
	/**
457
	 * Have GF handle file uploads
458
	 *
459
	 * Copy of code from GFFormDisplay::process_form()
460
	 *
461
	 * @param int $form_id
462
	 */
463 16
	private function process_save_process_files( $form_id ) {
464
465
		//Loading files that have been uploaded to temp folder
466 16
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
467 16
		if ( ! is_array( $files ) ) {
468 15
			$files = array();
469
		}
470
471
		/**
472
		 * Make sure the fileuploads are not overwritten if no such request was done.
473
		 * @since 1.20.1
474
		 */
475 16
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
476
477 16
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
478 16
	}
479
480
	/**
481
	 * Make sure the fileuploads are not overwritten if no such request was done.
482
	 *
483
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
484
	 *
485
	 * @since 1.20.1
486
	 *
487
	 * @param string $value Field value
488
	 * @param array $entry GF entry array
489
	 * @param GF_Field_FileUpload $field
490
	 * @param array $form GF form array
491
	 * @param string $input_id ID of the input being saved
492
	 *
493
	 * @return string
494
	 */
495 16
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
496
497 16
		if ( ! $field || $field->type != 'fileupload' ) {
498 16
			return $value;
499
		}
500
501 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
502
503 1
		if ( $field->multipleFiles ) {
504
			if ( empty( $value ) ) {
505
				return json_decode( $entry[ $input_id ], true );
506
			}
507
			return $value;
508
		}
509
510
		/** No file is being uploaded. */
511 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
512
			/** So return the original upload */
513 1
			return $entry[ $input_id ];
514
		}
515
516 1
		return $value;
517
	}
518
519
	/**
520
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
521
	 * Late validation done on self::custom_validation
522
	 *
523
	 * @param $plupload_init array Plupload settings
524
	 * @param $form_id
525
	 * @param $instance
526
	 * @return mixed
527
	 */
528 2
	public function modify_fileupload_settings( $plupload_init, $form_id, $instance ) {
0 ignored issues
show
Unused Code introduced by
The parameter $form_id is not used and could be removed.

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

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

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

Loading history...
529 2
		if( ! $this->is_edit_entry() ) {
530
			return $plupload_init;
531
		}
532
533 2
		$plupload_init['gf_vars']['max_files'] = 0;
534
535 2
		return $plupload_init;
536
	}
537
538
539
	/**
540
	 * Set visibility to visible and convert field input key to string
541
	 * @return array $form
542
	 */
543 16
	private function form_prepare_for_save() {
544
545 16
		$form = $this->filter_conditional_logic( $this->form );
546
547
	    /** @var GF_Field $field */
548 16
		foreach( $form['fields'] as $k => &$field ) {
549
550
			/**
551
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
552
			 * @since 1.16.3
553
			 * @var GF_Field $field
554
			 */
555 16
			if( $field->has_calculation() ) {
556 3
				unset( $form['fields'][ $k ] );
557
			}
558
559 16
			$field->adminOnly = false;
560
561 16
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
562 2
				foreach( $field->inputs as $key => $input ) {
563 2
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
564
				}
565
			}
566
		}
567
568 16
		$form['fields'] = array_values( $form['fields'] );
569
570 16
		return $form;
571
	}
572
573 16
	private function update_calculation_fields() {
574 16
		global $wpdb;
575
576 16
		$form = self::$original_form;
577 16
		$update = false;
578
579
		// get the most up to date entry values
580 16
		$entry = GFAPI::get_entry( $this->entry['id'] );
581
582 16
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
583 16
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
584 16
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
585
		} else {
586
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
587
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
588
		}
589
590
591 16
		if ( ! empty( $this->fields_with_calculation ) ) {
592 4
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
593 4
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
594
595 4
			foreach ( $this->fields_with_calculation as $field ) {
596 4
				$inputs = $field->get_entry_inputs();
597 4
				if ( is_array( $inputs ) ) {
598 3
				    foreach ( $inputs as $input ) {
599 3
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
600
601 3
						if ( 'product' === $field->type ) {
602 3
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
603
604
							// Only allow quantity to be set if it's allowed to be edited
605 3
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
606
							} else { // otherwise set to what it previously was
607 3
								$_POST[ $input_name ] = $entry[ $input['id'] ];
608
							}
609
						} else {
610
							// Set to what it previously was if it's not editable
611
							if ( ! in_array( $field_id, $allowed_fields ) ) {
612
								$_POST[ $input_name ] = $entry[ $input['id'] ];
0 ignored issues
show
Bug introduced by
The variable $input_name does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
613
							}
614
						}
615
616 3
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
617
				    }
618
				} else {
619
					// Set to what it previously was if it's not editable
620 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
621 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
622
					}
623 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
624
				}
625
			}
626
627 4
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
628 4
				GFFormsModel::commit_batch_field_operations();
629
			}
630
		}
631 16
	}
632
633
	/**
634
	 * Handle updating the Post Image field
635
	 *
636
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
637
	 *
638
	 * @since 1.17
639
	 *
640
	 * @uses GFFormsModel::media_handle_upload
641
	 * @uses set_post_thumbnail
642
	 *
643
	 * @param array $form GF Form array
644
	 * @param GF_Field $field GF Field
645
	 * @param string $field_id Numeric ID of the field
646
	 * @param string $value
647
	 * @param array $entry GF Entry currently being edited
648
	 * @param int $post_id ID of the Post being edited
649
	 *
650
	 * @return mixed|string
651
	 */
652 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
653
654 1
		$input_name = 'input_' . $field_id;
655
656 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
657
658
			// We have a new image
659
660
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
661
662
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
663
	        $ary = stripslashes_deep( $ary );
664
			$img_url = \GV\Utils::get( $ary, 0 );
665
666
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
667
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
668
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
669
670
			$image_meta = array(
671
				'post_excerpt' => $img_caption,
672
				'post_content' => $img_description,
673
			);
674
675
			//adding title only if it is not empty. It will default to the file name if it is not in the array
676
			if ( ! empty( $img_title ) ) {
677
				$image_meta['post_title'] = $img_title;
678
			}
679
680
			/**
681
			 * todo: As soon as \GFFormsModel::media_handle_upload becomes a public method, move this call to \GFFormsModel::media_handle_upload and remove the hack from this class.
682
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
683
			 */
684
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
685
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
686
687
			// is this field set as featured image?
688
			if ( $media_id && $field->postFeaturedImage ) {
689
				set_post_thumbnail( $post_id, $media_id );
690
			}
691
692 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
693
694 1
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
695 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
696 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
697 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
698
699 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
700
701 1
			if ( $field->postFeaturedImage ) {
702
703
				$image_meta = array(
704 1
					'ID' => get_post_thumbnail_id( $post_id ),
705 1
					'post_title' => $img_title,
706 1
					'post_excerpt' => $img_caption,
707 1
					'post_content' => $img_description,
708
				);
709
710
				// update image title, caption or description
711 1
				wp_update_post( $image_meta );
712
			}
713
		} else {
714
715
			// if we get here, image was removed or not set.
716
			$value = '';
717
718
			if ( $field->postFeaturedImage ) {
719
				delete_post_thumbnail( $post_id );
720
			}
721
		}
722
723 1
		return $value;
724
	}
725
726
	/**
727
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
728
	 *
729
	 * @param array $form Gravity Forms form
730
	 *
731
	 * @return void
732
	 */
733 16
	private function maybe_update_post_fields( $form ) {
734
735 16
		if( empty( $this->entry['post_id'] ) ) {
736 15
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
737 15
			return;
738
		}
739
740 1
		$post_id = $this->entry['post_id'];
741
742
		// Security check
743 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
744
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
745
			return;
746
		}
747
748 1
		$update_entry = false;
749
750 1
		$updated_post = $original_post = get_post( $post_id );
751
752 1
		foreach ( $this->entry as $field_id => $value ) {
753
754 1
			$field = RGFormsModel::get_field( $form, $field_id );
755
756 1
			if( ! $field ) {
757 1
				continue;
758
			}
759
760 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
761
762
				// Get the value of the field, including $_POSTed value
763 1
				$value = RGFormsModel::get_field_value( $field );
764
765
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
766 1
				$entry_tmp = $this->entry;
767 1
				$entry_tmp["{$field_id}"] = $value;
768
769 1
				switch( $field->type ) {
770
771 1
				    case 'post_title':
772
				        $post_title = $value;
773
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
774
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
775
				        }
776
				        $updated_post->post_title = $post_title;
777
				        $updated_post->post_name  = $post_title;
778
				        unset( $post_title );
779
				        break;
780
781 1
				    case 'post_content':
782
				        $post_content = $value;
783
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
784
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
785
				        }
786
				        $updated_post->post_content = $post_content;
787
				        unset( $post_content );
788
				        break;
789 1
				    case 'post_excerpt':
790
				        $updated_post->post_excerpt = $value;
791
				        break;
792 1
				    case 'post_tags':
793
				        wp_set_post_tags( $post_id, $value, false );
794
				        break;
795 1
				    case 'post_category':
796
				        break;
797 1
				    case 'post_custom_field':
798
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
799
							$value = $value[ $field_id ];
800
						}
801
802
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
803
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
804
				        }
805
806
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
807
808
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
809
				        break;
810
811 1
				    case 'post_image':
812 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
813 1
				        break;
814
815
				}
816
817
				// update entry after
818 1
				$this->entry["{$field_id}"] = $value;
819
820 1
				$update_entry = true;
821
822 1
				unset( $entry_tmp );
823
			}
824
825
		}
826
827 1
		if( $update_entry ) {
828
829 1
			$return_entry = GFAPI::update_entry( $this->entry );
830
831 1
			if( is_wp_error( $return_entry ) ) {
832
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
833
			} else {
834 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
835
			}
836
837
		}
838
839 1
		$return_post = wp_update_post( $updated_post, true );
840
841 1
		if( is_wp_error( $return_post ) ) {
842
			$return_post->add_data( $updated_post, '$updated_post' );
843
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
844
		} else {
845 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
846
		}
847 1
	}
848
849
	/**
850
	 * Convert a field content template into prepared output
851
	 *
852
	 * @uses GravityView_GFFormsModel::get_post_field_images()
853
	 *
854
	 * @since 1.17
855
	 *
856
	 * @param string $template The content template for the field
857
	 * @param array $form Gravity Forms form
858
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
859
	 *
860
	 * @return string
861
	 */
862
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
863
864
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
865
866
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
867
868
		//replacing post image variables
869
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
870
871
		//replacing all other variables
872
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
873
874
		// replace conditional shortcodes
875
		if( $do_shortcode ) {
876
			$output = do_shortcode( $output );
877
		}
878
879
		return $output;
880
	}
881
882
883
	/**
884
	 * Perform actions normally performed after updating a lead
885
	 *
886
	 * @since 1.8
887
	 *
888
	 * @see GFEntryDetail::lead_detail_page()
889
	 *
890
	 * @return void
891
	 */
892 16
	private function after_update() {
893
894 16
		do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
895 16
		do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
896
897
		// Re-define the entry now that we've updated it.
898 16
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
899
900 16
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
901
902 16
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
903
			// We need to clear the cache because Gravity Forms caches the field values, which
904
			// we have just updated.
905
			foreach ($this->form['fields'] as $key => $field) {
906
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
907
			}
908
		}
909
910
		/**
911
		 * Maybe process feeds.
912
		 *
913
		 * @since develop
914
		 */
915 16
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
916 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
917 1
			if ( ! is_wp_error( $feeds ) ) {
918 1
				$registered_feeds = array();
919 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
920 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
921 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
922 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
923 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
924
						}
925
					}
926
				}
927 1
				foreach ( $feeds as $feed ) {
928 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
929 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
930 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
931 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
932
								$entry = $returned_entry;
933
							}
934
935 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
936 1
							$slug = $feed_object->get_slug();
937 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
938
						}
939
					}
940
				}
941
			}
942
		}
943
944 16
		$this->entry = $entry;
945 16
	}
946
947
948
	/**
949
	 * Display the Edit Entry form
950
	 *
951
	 * @return void
952
	 */
953 17
	public function edit_entry_form() {
954
955
		?>
956
957
		<div class="gv-edit-entry-wrapper"><?php
958
959 17
			$javascript = gravityview_ob_include( GravityView_Edit_Entry::$file .'/partials/inline-javascript.php', $this );
0 ignored issues
show
Bug introduced by
The property file cannot be accessed from this context as it is declared private in class GravityView_Edit_Entry.

This check looks for access to properties that are not accessible from the current context.

If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class.

Loading history...
960
961
			/**
962
			 * Fixes weird wpautop() issue
963
			 * @see https://github.com/katzwebservices/GravityView/issues/451
964
			 */
965 17
			echo gravityview_strip_whitespace( $javascript );
966
967
			?><h2 class="gv-edit-entry-title">
968
				<span><?php
969
970
				    /**
971
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
972
				     * @param string $edit_entry_title Modify the "Edit Entry" title
973
				     * @param GravityView_Edit_Entry_Render $this This object
974
				     */
975 17
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
976
977 17
				    echo esc_attr( $edit_entry_title );
978
			?></span>
979
			</h2>
980
981
			<?php $this->maybe_print_message(); ?>
982
983
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
984
985
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
986
987
				<?php
988
989 17
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
990
991 17
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
992
993
				// Print the actual form HTML
994 17
				$this->render_edit_form();
995
996
				?>
997 17
			</form>
998
999
			<script>
1000
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1001
				    return false;
1002
				});
1003
			</script>
1004
1005
		</div>
1006
1007
	<?php
1008 17
	}
1009
1010
	/**
1011
	 * Display success or error message if the form has been submitted
1012
	 *
1013
	 * @uses GVCommon::generate_notice
1014
	 *
1015
	 * @since 1.16.2.2
1016
	 *
1017
	 * @return void
1018
	 */
1019 17
	private function maybe_print_message() {
1020
1021 17
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
1022
1023 16
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1024
1025 16
			if( ! $this->is_valid ){
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->is_valid 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...
1026
1027
				// Keeping this compatible with Gravity Forms.
1028
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
1029
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
1030
1031
				echo GVCommon::generate_notice( $message , 'gv-error' );
1032
1033
			} else {
1034 16
				$view = \GV\View::by_id( $this->view_id );
1035 16
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1036 16
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1037
1038
				switch ( $edit_redirect ) {
1039
1040 16
                    case '0':
1041 1
	                    $redirect_url = $back_link;
1042 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to Entry%s', 'Replacements are HTML', 'gravityview'), '<a href="'. esc_url( $redirect_url ) .'">', '</a>' );
1043 1
                        break;
1044
1045 15
                    case '1':
1046 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1047 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to %s%s', 'Replacement 1 is HTML. Replacement 2 is the title of the page where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $view->post_title ), '</a>' );
0 ignored issues
show
Documentation introduced by
The property post_title does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1048 1
	                    break;
1049
1050 14
                    case '2':
1051 1
	                    $redirect_url = $edit_redirect_url;
1052 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1053 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sRedirecting to %s%s', 'Replacement 1 is HTML. Replacement 2 is the URL where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $edit_redirect_url ), '</a>' );
1054 1
                        break;
1055
1056 13
                    case '':
1057
                    default:
1058 13
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
1059 13
                        break;
1060
				}
1061
1062 16
				if ( isset( $redirect_url ) ) {
1063 3
					$entry_updated_message .= sprintf( '<script>window.location.href = %s;</script><noscript><meta http-equiv="refresh" content="0;URL=%s" /></noscript>', json_encode( $redirect_url ), esc_attr( $redirect_url ) );
1064
				}
1065
1066
				/**
1067
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1068
				 * @since 1.5.4
1069
				 * @param string $entry_updated_message Existing message
1070
				 * @param int $view_id View ID
1071
				 * @param array $entry Gravity Forms entry array
1072
				 * @param string $back_link URL to return to the original entry. @since 1.6
1073
				 */
1074 16
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1075
1076 16
				echo GVCommon::generate_notice( $message );
1077
			}
1078
1079
		}
1080 17
	}
1081
1082
	/**
1083
	 * Display the Edit Entry form in the original Gravity Forms format
1084
	 *
1085
	 * @since 1.9
1086
	 *
1087
	 * @return void
1088
	 */
1089 17
	private function render_edit_form() {
1090
1091
		/**
1092
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1093
		 * @since 1.17
1094
		 * @param GravityView_Edit_Entry_Render $this
1095
		 */
1096 17
		do_action( 'gravityview/edit-entry/render/before', $this );
1097
1098 17
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
1099 17
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
1100 17
		add_filter( 'gform_disable_view_counter', '__return_true' );
1101
1102 17
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1103 17
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1104
1105
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1106 17
		unset( $_GET['page'] );
1107
1108
		// TODO: Verify multiple-page forms
1109
1110 17
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1111
1112 17
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1113
1114 17
		ob_get_clean();
1115
1116 17
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1117 17
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1118 17
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1119 17
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1120 17
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1121
1122 17
		echo $html;
1123
1124
		/**
1125
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1126
		 * @since 1.17
1127
		 * @param GravityView_Edit_Entry_Render $this
1128
		 */
1129 17
		do_action( 'gravityview/edit-entry/render/after', $this );
1130 17
	}
1131
1132
	/**
1133
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1134
	 * @since 1.8
1135
	 * @return string
1136
	 */
1137 17
	public function render_form_buttons() {
1138 17
		return gravityview_ob_include( GravityView_Edit_Entry::$file .'/partials/form-buttons.php', $this );
0 ignored issues
show
Bug introduced by
The property file cannot be accessed from this context as it is declared private in class GravityView_Edit_Entry.

This check looks for access to properties that are not accessible from the current context.

If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class.

Loading history...
1139
	}
1140
1141
1142
	/**
1143
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1144
	 *
1145
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1146
	 *
1147
	 * @param array $form
1148
	 * @param boolean $ajax Whether in AJAX mode
1149
	 * @param array|string $field_values Passed parameters to the form
1150
	 *
1151
	 * @since 1.9
1152
	 *
1153
	 * @return array Modified form array
1154
	 */
1155 17
	public function filter_modify_form_fields( $form, $ajax = false, $field_values = '' ) {
0 ignored issues
show
Unused Code introduced by
The parameter $ajax is not used and could be removed.

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

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

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

Loading history...
1156
1157
		// In case we have validated the form, use it to inject the validation results into the form render
1158 17
		if( isset( $this->form_after_validation ) && $this->form_after_validation['id'] === $form['id'] ) {
1159 16
			$form = $this->form_after_validation;
1160
		} else {
1161 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1162
		}
1163
1164 17
		$form = $this->filter_conditional_logic( $form );
1165
1166 17
		$form = $this->prefill_conditional_logic( $form );
1167
1168
		// for now we don't support Save and Continue feature.
1169 17
		if( ! self::$supports_save_and_continue ) {
1170 17
	        unset( $form['save'] );
1171
		}
1172
1173 17
		$form = $this->unselect_default_values( $form );
1174
1175 17
		return $form;
1176
	}
1177
1178
	/**
1179
	 * When displaying a field, check if it's a Post Field, and if so, make sure the post exists and current user has edit rights.
1180
	 *
1181
	 * @since 1.16.2.2
1182
	 *
1183
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1184
	 * @param GF_Field $field
1185
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1186
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1187
	 * @param int $form_id Form ID
1188
	 *
1189
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1190
	 */
1191 17
	public function verify_user_can_edit_post( $field_content = '', $field, $value, $lead_id = 0, $form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $value is not used and could be removed.

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

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

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

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

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

Loading history...
1192
1193 17
		if( ! GFCommon::is_post_field( $field ) ) {
1194 17
			return $field_content;
1195
		}
1196
1197 2
        $message = null;
1198
1199
        // First, make sure they have the capability to edit the post.
1200 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1201
1202
            /**
1203
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1204
             * @param string $message The existing "You don't have permission..." text
1205
             */
1206 1
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
1207
1208 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1209
            /**
1210
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1211
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1212
             */
1213
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
1214
        }
1215
1216 2
        if( $message ) {
1217 1
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
1218
        }
1219
1220 2
        return $field_content;
1221
	}
1222
1223
	/**
1224
	 *
1225
	 * Fill-in the saved values into the form inputs
1226
	 *
1227
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1228
	 * @param GF_Field $field
1229
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1230
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1231
	 * @param int $form_id Form ID
1232
	 *
1233
	 * @return mixed
1234
	 */
1235 17
	public function modify_edit_field_input( $field_content = '', $field, $value, $lead_id = 0, $form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $value is not used and could be removed.

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

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

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

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

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

Loading history...
1236
1237 17
		$gv_field = GravityView_Fields::get_associated_field( $field );
1238
1239
		// If the form has been submitted, then we don't need to pre-fill the values,
1240
		// Except for fileupload type and when a field input is overridden- run always!!
1241
		if(
1242 17
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
1243 17
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1244
			&& ! GFCommon::is_product_field( $field->type )
1245 17
			|| ! empty( $field_content )
1246 17
			|| in_array( $field->type, array( 'honeypot' ) )
1247
		) {
1248 1
	        return $field_content;
1249
		}
1250
1251
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1252 17
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1253
1254 17
		$field_value = $this->get_field_value( $field );
1255
1256
	    // Prevent any PHP warnings, like undefined index
1257 17
	    ob_start();
1258
1259 17
	    $return = null;
1260
1261
		/** @var GravityView_Field $gv_field */
1262 17
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1263 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1264
		} else {
1265 17
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1266
	    }
1267
1268
	    // If there was output, it's an error
1269 17
	    $warnings = ob_get_clean();
1270
1271 17
	    if( !empty( $warnings ) ) {
1272
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1273
	    }
1274
1275 17
		return $return;
1276
	}
1277
1278
	/**
1279
	 * Modify the value for the current field input
1280
	 *
1281
	 * @param GF_Field $field
1282
	 *
1283
	 * @return array|mixed|string
1284
	 */
1285 17
	private function get_field_value( $field ) {
1286
1287
		/**
1288
		 * @filter `gravityview/edit_entry/pre_populate/override` Allow the pre-populated value to override saved value in Edit Entry form. By default, pre-populate mechanism only kicks on empty fields.
1289
		 * @param boolean True: override saved values; False: don't override (default)
1290
		 * @param $field GF_Field object Gravity Forms field object
1291
		 * @since 1.13
1292
		 */
1293 17
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1294
1295
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1296 17
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
1297
1298 3
			$field_value = array();
1299
1300
			// only accept pre-populated values if the field doesn't have any choice selected.
1301 3
			$allow_pre_populated = $field->allowsPrepopulate;
1302
1303 3
			foreach ( (array)$field->inputs as $input ) {
1304
1305 3
				$input_id = strval( $input['id'] );
1306
1307 3
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1308 3
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
1309 3
				    $allow_pre_populated = false;
1310
				}
1311
1312
			}
1313
1314 3
			$pre_value = $field->get_value_submission( array(), false );
1315
1316 3
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
1317
1318
		} else {
1319
1320 17
			$id = intval( $field->id );
1321
1322
			// get pre-populated value if exists
1323 17
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1324
1325
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1326
			// or pre-populated value if not empty and set to override saved value
1327 17
			$field_value = isset( $this->entry[ $id ] ) && ! gv_empty( $this->entry[ $id ], false, false ) && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $this->entry[ $id ] : $pre_value;
1328
1329
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1330 17
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
1331
				$categories = array();
1332
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1333
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1334
				}
1335
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1336
			}
1337
1338
		}
1339
1340
		// if value is empty get the default value if defined
1341 17
		$field_value = $field->get_value_default_if_empty( $field_value );
1342
1343
	    /**
1344
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1345
	     * @since 1.11
1346
	     * @since 1.20 Added third param
1347
	     * @param mixed $field_value field value used to populate the input
1348
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1349
	     * @param GravityView_Edit_Entry_Render $this Current object
1350
	     */
1351 17
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1352
1353
	    /**
1354
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1355
	     * @since 1.17
1356
	     * @since 1.20 Added third param
1357
	     * @param mixed $field_value field value used to populate the input
1358
	     * @param GF_Field $field Gravity Forms field object
1359
	     * @param GravityView_Edit_Entry_Render $this Current object
1360
	     */
1361 17
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1362
1363 17
		return $field_value;
1364
	}
1365
1366
1367
	// ---- Entry validation
1368
1369
	/**
1370
	 * Add field keys that Gravity Forms expects.
1371
	 *
1372
	 * @see GFFormDisplay::validate()
1373
	 * @param  array $form GF Form
1374
	 * @return array       Modified GF Form
1375
	 */
1376 16
	public function gform_pre_validation( $form ) {
1377
1378 16
		if( ! $this->verify_nonce() ) {
1379
			return $form;
1380
		}
1381
1382
		// Fix PHP warning regarding undefined index.
1383 16
		foreach ( $form['fields'] as &$field) {
1384
1385
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1386
			// expects certain field array items to be set.
1387 16
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1388 16
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
1389
			}
1390
1391 16
			switch( RGFormsModel::get_input_type( $field ) ) {
1392
1393
				/**
1394
				 * this whole fileupload hack is because in the admin, Gravity Forms simply doesn't update any fileupload field if it's empty, but it DOES in the frontend.
1395
				 *
1396
				 * What we have to do is set the value so that it doesn't get overwritten as empty on save and appears immediately in the Edit Entry screen again.
1397
				 *
1398
				 * @hack
1399
				 */
1400 16
				case 'fileupload':
1401
1402
				    // Set the previous value
1403 1
				    $entry = $this->get_entry();
1404
1405 1
				    $input_name = 'input_'.$field->id;
1406 1
				    $form_id = $form['id'];
1407
1408 1
				    $value = NULL;
1409
1410
				    // Use the previous entry value as the default.
1411 1
				    if( isset( $entry[ $field->id ] ) ) {
1412 1
				        $value = $entry[ $field->id ];
1413
				    }
1414
1415
				    // If this is a single upload file
1416 1
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
1417 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1418 1
				        $value = $file_path['url'];
1419
1420
				    } else {
1421
1422
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1423
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1424 1
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
1425
1426
				    }
1427
1428 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
1429
1430
				        // If there are fresh uploads, process and merge them.
1431
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1432 1
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
1433
				            $value = empty( $value ) ? '[]' : $value;
1434
				            $value = stripslashes_deep( $value );
1435 1
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
1436
				        }
1437
1438
				    } else {
1439
1440
				        // A file already exists when editing an entry
1441
				        // We set this to solve issue when file upload fields are required.
1442 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1443
1444
				    }
1445
1446 1
				    $this->entry[ $input_name ] = $value;
1447 1
				    $_POST[ $input_name ] = $value;
1448
1449 1
				    break;
1450
1451 16
				case 'number':
1452
				    // Fix "undefined index" issue at line 1286 in form_display.php
1453 11
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
1454 6
				        $_POST['input_'.$field->id ] = NULL;
1455
				    }
1456 11
				    break;
1457
			}
1458
1459
		}
1460
1461 16
		return $form;
1462
	}
1463
1464
1465
	/**
1466
	 * Process validation for a edit entry submission
1467
	 *
1468
	 * Sets the `is_valid` object var
1469
	 *
1470
	 * @return void
1471
	 */
1472 17
	private function validate() {
1473
1474
		/**
1475
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1476
		 * GF User Registration Add-on version > 3.x has a different class name
1477
		 * @since 1.16.2
1478
		 */
1479 17
		if ( class_exists( 'GF_User_Registration' ) ) {
1480 17
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1481
		} else  if ( class_exists( 'GFUser' ) ) {
1482
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1483
		}
1484
1485
1486
		/**
1487
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1488
		 * You can enter whatever you want!
1489
		 * We try validating, and customize the results using `self::custom_validation()`
1490
		 */
1491 17
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
1492
1493
		// Needed by the validate funtion
1494 17
		$failed_validation_page = NULL;
1495 17
		$field_values = RGForms::post( 'gform_field_values' );
1496
1497
		// Prevent entry limit from running when editing an entry, also
1498
		// prevent form scheduling from preventing editing
1499 17
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1500
1501
		// Hide fields depending on Edit Entry settings
1502 17
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1503
1504 17
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1505
1506 17
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1507 17
	}
1508
1509
1510
	/**
1511
	 * Make validation work for Edit Entry
1512
	 *
1513
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1514
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1515
	 * fields. This goes through all the fields and if they're an invalid post field, we
1516
	 * set them as valid. If there are still issues, we'll return false.
1517
	 *
1518
	 * @param  [type] $validation_results [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1519
	 * @return [type]                     [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1520
	 */
1521 17
	public function custom_validation( $validation_results ) {
1522
1523 17
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1524
1525 17
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
1526
1527 17
		$gv_valid = true;
1528
1529 17
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1530
1531 17
			$value = RGFormsModel::get_field_value( $field );
1532 17
			$field_type = RGFormsModel::get_input_type( $field );
1533
1534
			// Validate always
1535 17
			switch ( $field_type ) {
1536
1537
1538 17
				case 'fileupload' :
1539 17
				case 'post_image':
1540
1541
				    // in case nothing is uploaded but there are already files saved
1542 2
				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
1543
				        $field->failed_validation = false;
1544
				        unset( $field->validation_message );
1545
				    }
1546
1547
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1548 2
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
1549
1550
				        $input_name = 'input_' . $field->id;
1551
				        //uploaded
1552
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1553
1554
				        //existent
1555
				        $entry = $this->get_entry();
1556
				        $value = NULL;
1557
				        if( isset( $entry[ $field->id ] ) ) {
1558
				            $value = json_decode( $entry[ $field->id ], true );
1559
				        }
1560
1561
				        // count uploaded files and existent entry files
1562
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1563
						               ( is_array( $value ) ? count( $value ) : 0 );
1564
1565
				        if( $count_files > $field->maxFiles ) {
1566
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1567
				            $field->failed_validation = 1;
1568
				            $gv_valid = false;
1569
1570
				            // in case of error make sure the newest upload files are removed from the upload input
1571
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1572
				        }
1573
1574
				    }
1575
1576
1577 2
				    break;
1578
1579
			}
1580
1581
			// This field has failed validation.
1582 17
			if( !empty( $field->failed_validation ) ) {
1583
1584 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1585
1586 1
				switch ( $field_type ) {
1587
1588
				    // Captchas don't need to be re-entered.
1589 1
				    case 'captcha':
1590
1591
				        // Post Image fields aren't editable, so we un-fail them.
1592 1
				    case 'post_image':
1593
				        $field->failed_validation = false;
1594
				        unset( $field->validation_message );
1595
				        break;
1596
1597
				}
1598
1599
				// You can't continue inside a switch, so we do it after.
1600 1
				if( empty( $field->failed_validation ) ) {
1601
				    continue;
1602
				}
1603
1604
				// checks if the No Duplicates option is not validating entry against itself, since
1605
				// we're editing a stored entry, it would also assume it's a duplicate.
1606 1
				if( !empty( $field->noDuplicates ) ) {
1607
1608
				    $entry = $this->get_entry();
1609
1610
				    // If the value of the entry is the same as the stored value
1611
				    // Then we can assume it's not a duplicate, it's the same.
1612
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
1613
				        //if value submitted was not changed, then don't validate
1614
				        $field->failed_validation = false;
1615
1616
				        unset( $field->validation_message );
1617
1618
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1619
1620
				        continue;
1621
				    }
1622
				}
1623
1624
				// if here then probably we are facing the validation 'At least one field must be filled out'
1625 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
1626
				    unset( $field->validation_message );
1627
	                $field->validation_message = false;
1628
				    continue;
1629
				}
1630
1631 1
				$gv_valid = false;
1632
1633
			}
1634
1635
		}
1636
1637 17
		$validation_results['is_valid'] = $gv_valid;
1638
1639 17
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1640
1641
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1642 17
		$this->form_after_validation = $validation_results['form'];
1643
1644 17
		return $validation_results;
1645
	}
1646
1647
1648
	/**
1649
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1650
	 * Get the current entry and set it if it's not yet set.
1651
	 * @return array Gravity Forms entry array
1652
	 */
1653 2
	public function get_entry() {
1654
1655 2
		if( empty( $this->entry ) ) {
1656
			// Get the database value of the entry that's being edited
1657 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1658
		}
1659
1660 2
		return $this->entry;
1661
	}
1662
1663
1664
1665
	// --- Filters
1666
1667
	/**
1668
	 * Get the Edit Entry fields as configured in the View
1669
	 *
1670
	 * @since 1.8
1671
	 *
1672
	 * @param int $view_id
1673
	 *
1674
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1675
	 */
1676 18
	private function get_configured_edit_fields( $form, $view_id ) {
1677
1678
		// Get all fields for form
1679 18
		if ( \GV\View::exists( $view_id ) ) {
1680 18
			$view = \GV\View::by_id( $view_id );
1681 18
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1682
		} else {
1683
			$properties = null;
1684
		}
1685
1686
		// If edit tab not yet configured, show all fields
1687 18
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
1688
1689
		// Hide fields depending on admin settings
1690 18
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1691
1692
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1693 18
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1694
1695
		/**
1696
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1697
		 * @since 1.17
1698
		 * @param GF_Field[] $fields Gravity Forms form fields
1699
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1700
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1701
		 * @param int $view_id View ID
1702
		 */
1703 18
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1704
1705 18
		return $fields;
1706
	}
1707
1708
1709
	/**
1710
	 * Filter area fields based on specified conditions
1711
	 *  - This filter removes the fields that have calculation configured
1712
	 *  - Hides fields that are hidden, etc.
1713
	 *
1714
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1715
	 * @access private
1716
	 * @param GF_Field[] $fields
1717
	 * @param array $configured_fields
1718
	 * @since  1.5
1719
	 * @return array $fields
1720
	 */
1721 17
	private function filter_fields( $fields, $configured_fields ) {
1722
1723 17
		if( empty( $fields ) || !is_array( $fields ) ) {
1724
			return $fields;
1725
		}
1726
1727 17
		$edit_fields = array();
1728
1729 17
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1730
1731
		// First, remove blacklist or calculation fields
1732 17
		foreach ( $fields as $key => $field ) {
1733
1734
			// Remove the fields that have calculation properties and keep them to be used later
1735
			// @since 1.16.2
1736 17
			if( $field->has_calculation() ) {
1737 4
				$this->fields_with_calculation[] = $field;
1738
				// don't remove the calculation fields on form render.
1739
			}
1740
1741 17
			if( in_array( $field->type, $field_type_blacklist ) ) {
1742 2
				unset( $fields[ $key ] );
1743
			}
1744
		}
1745
1746
		// The Edit tab has not been configured, so we return all fields by default.
1747
		// But we do keep the hidden ones hidden please, for everyone :)
1748 17
		if ( empty( $configured_fields ) ) {
1749 14
			$out_fields = array();
1750 14
			foreach ( $fields as &$field ) {
1751 14
				if ( 'hidden' === $field->type ) {
1752 3
					continue; // A hidden field is just hidden
1753
				}
1754
1755 14
				if ( 'hidden' == $field->visibility ) {
1756 2
					continue; // Same
1757
				}
1758
1759 12
				$out_fields[] = $field;
1760
			}
1761
1762 14
			return array_values( $out_fields );
1763
		}
1764
1765
		// The edit tab has been configured, so we loop through to configured settings
1766 5
		foreach ( $configured_fields as $configured_field ) {
1767
1768
	        /** @var GF_Field $field */
1769 5
	        foreach ( $fields as $field ) {
1770 5
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1771 5
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1772 5
				    break;
1773
				}
1774
1775
			}
1776
1777
		}
1778
1779 5
		return $edit_fields;
1780
1781
	}
1782
1783
	/**
1784
	 * Override GF Form field properties with the ones defined on the View
1785
	 * @param  GF_Field $field GF Form field object
1786
	 * @param  array $field_setting  GV field options
1787
	 * @since  1.5
1788
	 * @return array|GF_Field
1789
	 */
1790 5
	private function merge_field_properties( $field, $field_setting ) {
1791
1792 5
		$return_field = $field;
1793
1794 5
		if( empty( $field_setting['show_label'] ) ) {
1795
			$return_field->label = '';
1796 5
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
1797
			$return_field->label = $field_setting['custom_label'];
1798
		}
1799
1800 5
		if( !empty( $field_setting['custom_class'] ) ) {
1801
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1802
		}
1803
1804
		/**
1805
		 * Normalize page numbers - avoid conflicts with page validation
1806
		 * @since 1.6
1807
		 */
1808 5
		$return_field->pageNumber = 1;
1809
1810 5
		return $return_field;
1811
1812
	}
1813
1814
	/**
1815
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1816
	 *
1817
	 * @since 1.9.1
1818
	 *
1819
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1820
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1821
	 * @param array $form GF Form array
1822
	 * @param int $view_id View ID
1823
	 *
1824
	 * @return array Possibly modified form array
1825
	 */
1826 17
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1827
1828
	    /**
1829
		 * @filter `gravityview/edit_entry/use_gf_admin_only_setting` When Edit tab isn't configured, should the Gravity Forms "Admin Only" field settings be used to control field display to non-admins? Default: true
1830
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1831
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1832
	     * @since 1.9.1
1833
	     * @param boolean $use_gf_adminonly_setting True: Hide field if set to Admin Only in GF and the user is not an admin. False: show field based on GV permissions, ignoring GF permissions.
1834
	     * @param array $form GF Form array
1835
	     * @param int $view_id View ID
1836
	     */
1837 17
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1838
1839 17
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1840 1
			foreach( $fields as $k => $field ) {
1841
				if( $field->adminOnly ) {
1842
				    unset( $fields[ $k ] );
1843
				}
1844
			}
1845 1
			return array_values( $fields );
1846
		}
1847
1848 17
	    foreach( $fields as &$field ) {
1849 17
		    $field->adminOnly = false;
1850
		}
1851
1852 17
		return $fields;
1853
	}
1854
1855
	/**
1856
	 * Checkboxes and other checkbox-based controls should not
1857
	 * display default checks in edit mode.
1858
	 *
1859
	 * https://github.com/gravityview/GravityView/1149
1860
	 *
1861
	 * @since 2.1
1862
	 *
1863
	 * @param array $form Gravity Forms array object
1864
	 *
1865
	 * @return array $form, modified to default checkboxes, radios from showing up.
1866
	 */
1867 17
	private function unselect_default_values( $form ) {
1868
1869 17
	    foreach ( $form['fields'] as &$field ) {
1870
1871 17
			if ( empty( $field->choices ) ) {
1872 17
                continue;
1873
			}
1874
1875 2
            foreach ( $field->choices as &$choice ) {
1876 2
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
1877 1
					$choice['isSelected'] = false;
1878
				}
1879
			}
1880
		}
1881
1882 17
		return $form;
1883
	}
1884
1885
	// --- Conditional Logic
1886
1887
	/**
1888
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1889
	 * the dependent fields will be blank.
1890
	 *
1891
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1892
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1893
	 *
1894
	 * @since 1.17.4
1895
	 *
1896
	 * @param array $form Gravity Forms array object
1897
	 *
1898
	 * @return array $form, modified to fix conditional
1899
	 */
1900 17
	function prefill_conditional_logic( $form ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1901
1902 17
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1903 16
			return $form;
1904
		}
1905
1906
		// Have Conditional Logic pre-fill fields as if the data were default values
1907
		/** @var GF_Field $field */
1908 1
		foreach ( $form['fields'] as &$field ) {
1909
1910 1
			if( 'checkbox' === $field->type ) {
1911
				foreach ( $field->get_entry_inputs() as $key => $input ) {
1912
				    $input_id = $input['id'];
1913
				    $choice = $field->choices[ $key ];
1914
				    $value = \GV\Utils::get( $this->entry, $input_id );
1915
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
1916
				    if( $match ) {
1917
				        $field->choices[ $key ]['isSelected'] = true;
1918
				    }
1919
				}
1920
			} else {
1921
1922
				// We need to run through each field to set the default values
1923 1
				foreach ( $this->entry as $field_id => $field_value ) {
1924
1925 1
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
1926
1927 1
				        if( 'list' === $field->type ) {
1928
				            $list_rows = maybe_unserialize( $field_value );
1929
1930
				            $list_field_value = array();
1931
				            foreach ( (array) $list_rows as $row ) {
1932
				                foreach ( (array) $row as $column ) {
1933
				                    $list_field_value[] = $column;
1934
				                }
1935
				            }
1936
1937
				            $field->defaultValue = serialize( $list_field_value );
1938
				        } else {
1939 1
				            $field->defaultValue = $field_value;
1940
				        }
1941
				    }
1942
				}
1943
			}
1944
		}
1945
1946 1
		return $form;
1947
	}
1948
1949
	/**
1950
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
1951
	 *
1952
	 * @todo Merge with caller method
1953
	 * @since 1.9
1954
	 *
1955
	 * @param array $form Gravity Forms form
1956
	 * @return array Modified form, if not using Conditional Logic
1957
	 */
1958 17
	private function filter_conditional_logic( $form ) {
1959
		/**
1960
		 * Fields that are tied to a conditional logic field that is not present in the view
1961
		 * have to still be displayed, if the condition is met.
1962
		 *
1963
		 * @see https://github.com/gravityview/GravityView/issues/840
1964
		 * @since develop
1965
		 */
1966 17
		$the_form = GFAPI::get_form( $form['id'] );
1967 17
		$editable_ids = array();
1968 17
		foreach ( $form['fields'] as $field ) {
1969 17
			$editable_ids[] = $field['id']; // wp_list_pluck is destructive in this context
1970
		}
1971 17
		$remove_conditions_rule = array();
1972 17
		foreach ( $the_form['fields'] as $field ) {
1973 17
			if ( ! empty( $field->conditionalLogic ) && ! empty( $field->conditionalLogic['rules'] ) ) {
1974 2
				foreach ( $field->conditionalLogic['rules'] as $i => $rule ) {
1975 2
					if ( ! in_array( $rule['fieldId'], $editable_ids ) ) {
1976
						/**
1977
						 * This conditional field is not editable in this View.
1978
						 * We need to remove the rule, but only if it matches.
1979
						 */
1980 2
						if ( $_field = GFAPI::get_field( $the_form, $rule['fieldId'] ) ) {
1981 2
							$value = $_field->get_value_export( $this->entry );
1982
						} elseif ( isset( $this->entry[ $rule['fieldId'] ] ) ) {
1983
							$value = $this->entry[ $rule['fieldId'] ];
1984
						} else {
1985
							$value = gform_get_meta( $this->entry['id'], $rule['fieldId'] );
1986
						}
1987
1988 2
						$match = GFFormsModel::matches_operation( $value, $rule['value'], $rule['operator'] );
1989
						
1990 2
						if ( $match ) {
1991 2
							$remove_conditions_rule[] = array( $field['id'], $i );
1992
						}
1993
					}
1994
				}
1995
			}
1996
		}
1997
1998 17
		if ( $remove_conditions_rule ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $remove_conditions_rule 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...
1999 2
			foreach ( $form['fields'] as &$field ) {
2000 2
				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
2001
2002 2
				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
2003
2004 2
					if ( $field['id'] == $rule_field_id ) {
2005 1
						unset( $field->conditionalLogic['rules'][ $rule_i ] );
2006 1
						gravityview()->log->debug( 'Removed conditional rule #{rule} for field {field_id}', array( 'rule' => $rule_i, 'field_id' => $field['id'] ) );
2007
					}
2008
				}
2009
			}
2010
		}
2011
2012
		/** Normalize the indices... */
2013 17
		$form['fields'] = array_values( $form['fields'] );
2014
2015
		/**
2016
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
2017
		 * @since 1.9
2018
		 * @param bool $use_conditional_logic True: Gravity Forms will show/hide fields just like in the original form; False: conditional logic will be disabled and fields will be shown based on configuration. Default: true
2019
		 * @param array $form Gravity Forms form
2020
		 */
2021 17
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
2022
2023 17
		if( $use_conditional_logic ) {
2024 17
			return $form;
2025
		}
2026
2027
		foreach( $form['fields'] as &$field ) {
2028
			/* @var GF_Field $field */
2029
			$field->conditionalLogic = null;
2030
		}
2031
2032
		unset( $form['button']['conditionalLogic'] );
2033
2034
		return $form;
2035
2036
	}
2037
2038
	/**
2039
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
2040
	 *
2041
	 * @since 1.9
2042
	 *
2043
	 * @param $has_conditional_logic
2044
	 * @param $form
2045
	 * @return mixed
2046
	 */
2047 17
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2048
2049 17
		if( ! $this->is_edit_entry() ) {
2050
			return $has_conditional_logic;
2051
		}
2052
2053
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2054 17
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2055
	}
2056
2057
2058
	// --- User checks and nonces
2059
2060
	/**
2061
	 * Check if the user can edit the entry
2062
	 *
2063
	 * - Is the nonce valid?
2064
	 * - Does the user have the right caps for the entry
2065
	 * - Is the entry in the trash?
2066
	 *
2067
	 * @todo Move to GVCommon
2068
	 *
2069
	 * @param  boolean $echo Show error messages in the form?
2070
	 * @return boolean        True: can edit form. False: nope.
2071
	 */
2072 18
	private function user_can_edit_entry( $echo = false ) {
2073
2074 18
		$error = NULL;
2075
2076
		/**
2077
		 *  1. Permalinks are turned off
2078
		 *  2. There are two entries embedded using oEmbed
2079
		 *  3. One of the entries has just been saved
2080
		 */
2081 18
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
2082
2083
			$error = true;
2084
2085
		}
2086
2087 18
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
2088
2089
			$error = true;
2090
2091 18
		} elseif( ! $this->verify_nonce() ) {
2092
2093
			/**
2094
			 * If the Entry is embedded, there may be two entries on the same page.
2095
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2096
			 */
2097
			if( GravityView_oEmbed::getInstance()->get_entry_id() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \GravityView_oEmbed::get...tance()->get_entry_id() of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
Deprecated Code introduced by
The method GravityView_oEmbed::getInstance() has been deprecated with message: Use \GV\oEmbed instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
Deprecated Code introduced by
The method GravityView_oEmbed::get_entry_id() has been deprecated with message: Use \GV\oEmbed instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2098
				$error = true;
2099
			} else {
2100
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
2101
			}
2102
2103
		}
2104
2105 18
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2106 1
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
2107
		}
2108
2109 18
		if( $this->entry['status'] === 'trash' ) {
2110
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
2111
		}
2112
2113
		// No errors; everything's fine here!
2114 18
		if( empty( $error ) ) {
2115 18
			return true;
2116
		}
2117
2118 1
		if( $echo && $error !== true ) {
2119
2120 1
	        $error = esc_html( $error );
2121
2122
	        /**
2123
	         * @since 1.9
2124
	         */
2125 1
	        if ( ! empty( $this->entry ) ) {
2126 1
		        $error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
2127
	        }
2128
2129 1
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
2130
		}
2131
2132 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2133
2134 1
		return false;
2135
	}
2136
2137
2138
	/**
2139
	 * Check whether a field is editable by the current user, and optionally display an error message
2140
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2141
	 * @param  array  $field Field or field settings array
2142
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2143
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2144
	 */
2145 5
	private function user_can_edit_field( $field, $echo = false ) {
2146
2147 5
		$error = NULL;
2148
2149 5
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2150 1
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
2151
		}
2152
2153
		// No errors; everything's fine here!
2154 5
		if( empty( $error ) ) {
2155 5
			return true;
2156
		}
2157
2158 1
		if( $echo ) {
2159
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
2160
		}
2161
2162 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2163
2164 1
		return false;
2165
2166
	}
2167
2168
2169
	/**
2170
	 * checks if user has permissions to edit a specific field
2171
	 *
2172
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2173
	 *
2174
	 * @param  [type] $field [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
2175
	 * @return bool
2176
	 */
2177 5
	private function check_user_cap_edit_field( $field ) {
2178
2179
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2180 5
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2181 4
			return true;
2182
		}
2183
2184 1
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2185
2186 1
		if( $field_cap ) {
2187 1
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2188
		}
2189
2190
		return false;
2191
	}
2192
2193
2194
	/**
2195
	 * Is the current nonce valid for editing the entry?
2196
	 * @return boolean
2197
	 */
2198 17
	public function verify_nonce() {
2199
2200
		// Verify form submitted for editing single
2201 17
		if( $this->is_edit_entry_submission() ) {
2202
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
2203
		}
2204
2205
		// Verify
2206 17
		else if( ! $this->is_edit_entry() ) {
2207
			$valid = false;
2208
		}
2209
2210
		else {
2211 17
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
2212
		}
2213
2214
		/**
2215
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2216
		 * @since 1.13
2217
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2218
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2219
		 */
2220 17
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2221
2222 17
		return $valid;
2223
	}
2224
2225
2226
	/**
2227
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2228
	 *
2229
	 * As a hack for now we'll implode it back.
2230
	 */
2231
	public function fix_multiselect_value_serialization( $field_value, $field, $_this ) {
0 ignored issues
show
Unused Code introduced by
The parameter $_this is not used and could be removed.

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

Loading history...
2232
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
2233
			return $field_value;
2234
		}
2235
2236
		$maybe_json = @json_decode( $field_value, true );
2237
2238
		if ( $maybe_json ) {
2239
			return implode( ',', $maybe_json );
2240
		}
2241
2242
		return $field_value;
2243
	}
2244
2245
2246
2247
} //end class
2248