Completed
Push — develop ( ad3c06...5160a1 )
by Zack
06:19
created

GravityView_Edit_Entry_Render   F

Complexity

Total Complexity 327

Size/Duplication

Total Lines 2442
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 12

Test Coverage

Coverage 74.45%

Importance

Changes 0
Metric Value
dl 0
loc 2442
ccs 606
cts 814
cp 0.7445
rs 0.8
c 0
b 0
f 0
wmc 327
lcom 1
cbo 12

47 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A load() 0 29 1
A prevent_render_form() 0 9 3
A prevent_maybe_process_form() 0 14 2
A is_edit_entry() 0 8 4
A is_edit_entry_submission() 0 3 1
A setup_vars() 0 18 1
A init() 0 32 5
A print_scripts() 0 12 1
B process_save() 0 94 6
B unset_hidden_field_values() 0 59 10
B preset_approval_fields() 0 29 7
A prevent_update_unapproved_meta() 0 13 2
A process_save_process_files() 0 16 2
B save_field_value() 0 23 6
A modify_fileupload_settings() 0 9 2
B form_prepare_for_save() 0 29 6
C update_calculation_fields() 0 64 14
C update_post_image() 0 73 14
F maybe_update_post_fields() 0 115 22
A fill_post_template() 0 19 2
C after_update() 0 54 13
B edit_entry_form() 0 65 1
C maybe_print_message() 0 97 11
C render_edit_form() 0 105 13
A render_form_buttons() 0 3 1
A filter_modify_form_fields() 0 26 5
A verify_user_can_edit_post() 0 31 5
B modify_edit_field_input() 0 42 11
D get_field_value() 0 80 20
C gform_pre_validation() 0 87 14
A validate() 0 36 3
F custom_validation() 0 125 23
A get_entry() 0 9 2
A get_configured_edit_fields() 0 31 4
C filter_fields() 0 65 16
A merge_field_properties() 0 23 4
B filter_admin_only_fields() 0 28 6
A unselect_default_values() 0 17 5
B prefill_conditional_logic() 0 48 11
D filter_conditional_logic() 0 79 16
A manage_conditional_logic() 0 9 2
C user_can_edit_entry() 0 64 14
A user_can_edit_field() 0 22 4
A check_user_cap_edit_field() 0 15 4
A verify_nonce() 0 26 3
A fix_multiselect_value_serialization() 0 13 4

How to fix   Complexity   

Complex Class

Complex classes like GravityView_Edit_Entry_Render often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use GravityView_Edit_Entry_Render, and based on these observations, apply Extract Interface, too.

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 $nonce_key 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 $nonce_field 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
	/**
120
	 * Internal page button states.
121
	 *
122
	 * @var bool
123
	 *
124
	 * @since develop
125
	 */
126
	public $show_previous_button;
127
	public $show_next_button;
128
	public $show_update_button;
129
	public $is_paged_submitted;
130
131 22
	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...
132 22
		$this->loader = $loader;
133 22
	}
134
135 22
	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...
136
137
		/** @define "GRAVITYVIEW_DIR" "../../../" */
138 22
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
139
140
		// Don't display an embedded form when editing an entry
141 22
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
142 22
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
143
144
		// Stop Gravity Forms processing what is ours!
145 22
		add_action( 'wp', array( $this, 'prevent_maybe_process_form' ), 8 );
146 22
		add_action( 'admin_init', array( $this, 'prevent_maybe_process_form' ), 8 );
147
148 22
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
149
150 22
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
151
152
		// Disable conditional logic if needed (since 1.9)
153 22
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
154
155
		// Make sure GF doesn't validate max files (since 1.9)
156 22
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
157
158
		// Add fields expected by GFFormDisplay::validate()
159 22
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
160
161
		// Fix multiselect value for GF 2.2
162 22
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
163 22
	}
164
165
	/**
166
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
167
	 *
168
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
169
	 * And then removes it on the `wp_footer` action
170
	 *
171
	 * @since 1.16.1
172
	 *
173
	 * @return void
174
	 */
175 1
	public function prevent_render_form() {
176 1
		if( $this->is_edit_entry() ) {
177 1
			if( 'wp_head' === current_filter() ) {
178 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
179
			} else {
180 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
181
			}
182
		}
183 1
	}
184
185
	/**
186
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
187
	 * backend form, we need to prevent them from saving twice.
188
	 * @return void
189
	 */
190 2
	public function prevent_maybe_process_form() {
191
192 2
	    if( ! $this->is_edit_entry_submission() ) {
193 2
			return;
194
		}
195
196
		gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] Removing GFForms::maybe_process_form() action.' );
197
198
		remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
199
		remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
200
201
		remove_action( 'admin_init',  array( 'GFForms', 'maybe_process_form'), 9 );
202
		remove_action( 'admin_init',  array( 'RGForms', 'maybe_process_form'), 9 );
203
	}
204
205
	/**
206
	 * Is the current page an Edit Entry page?
207
	 * @return boolean
208
	 */
209 27
	public function is_edit_entry() {
210
211
		$is_edit_entry =
212 27
			( GravityView_frontend::is_single_entry() || ( ! empty( gravityview()->request->is_entry() ) ) )
213 27
			&& ( ! empty( $_GET['edit'] ) );
214
215 27
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
216
	}
217
218
	/**
219
	 * Is the current page an Edit Entry page?
220
	 * @since 1.9
221
	 * @return boolean
222
	 */
223 28
	public function is_edit_entry_submission() {
224 28
		return !empty( $_POST[ self::$nonce_field ] );
225
	}
226
227
	/**
228
	 * When Edit entry view is requested setup the vars
229
	 */
230 22
	private function setup_vars() {
231 22
        global $post;
232
233 22
		$gravityview_view = GravityView_View::getInstance();
234
235
236 22
		$entries = $gravityview_view->getEntries();
237 22
	    self::$original_entry = $entries[0];
238 22
	    $this->entry = $entries[0];
239
240 22
		self::$original_form = $gravityview_view->getForm();
241 22
		$this->form = $gravityview_view->getForm();
242 22
		$this->form_id = $this->entry['form_id'];
243 22
		$this->view_id = $gravityview_view->getViewId();
244 22
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
245
246 22
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
247 22
	}
248
249
250
	/**
251
	 * Load required files and trigger edit flow
252
	 *
253
	 * Run when the is_edit_entry returns true.
254
	 *
255
	 * @param \GravityView_View_Data $gv_data GravityView Data object
256
	 * @param \GV\Entry   $entry   The Entry.
257
	 * @param \GV\View    $view    The View.
258
	 * @param \GV\Request $request The Request.
259
	 *
260
	 * @since develop Added $entry, $view, $request adhocs.
261
	 *
262
	 * @return void
263
	 */
264 23
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
265
266 23
		require_once( GFCommon::get_base_path() . '/form_display.php' );
267 23
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
268
269 23
		$this->setup_vars();
270
271 23
		if ( ! $gv_data ) {
272
			$gv_data = GravityView_View_Data::getInstance();
273
		}
274
275
		// Multiple Views embedded, don't proceed if nonce fails
276 23
		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...
277
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
278
			return;
279
		}
280
281
		// Sorry, you're not allowed here.
282 23
		if ( false === $this->user_can_edit_entry( true ) ) {
283 2
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
284 2
			return;
285
		}
286
287 23
		$this->view = $view;
288
289 23
		$this->print_scripts();
290
291 23
		$this->process_save( $gv_data );
292
293 23
		$this->edit_entry_form();
294
295 23
	}
296
297
298
	/**
299
	 * Force Gravity Forms to output scripts as if it were in the admin
300
	 * @return void
301
	 */
302 22
	private function print_scripts() {
303 22
		$gravityview_view = GravityView_View::getInstance();
304
305 22
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
306
307 22
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
308
309 22
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
310
311
		// Sack is required for images
312 22
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
313 22
	}
314
315
316
	/**
317
	 * Process edit entry form save
318
	 *
319
	 * @param array $gv_data The View data.
320
	 */
321 23
	private function process_save( $gv_data ) {
322
323 23
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
324 5
			return;
325
		}
326
327
		// Make sure the entry, view, and form IDs are all correct
328 22
		$valid = $this->verify_nonce();
329
330 22
		if ( !$valid ) {
331
			gravityview()->log->error( 'Nonce validation failed.' );
332
			return;
333
		}
334
335 22
		if ( $this->entry['id'] !== $_POST['lid'] ) {
336
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
337
			return;
338
		}
339
340 22
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
341
342 22
		$this->process_save_process_files( $this->form_id );
343
344 22
		$this->validate();
345
346 22
		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...
347
348 22
			gravityview()->log->debug( 'Submission is valid.' );
349
350
			/**
351
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
352
			 */
353 22
			$form = $this->form_prepare_for_save();
354
355
			/**
356
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
357
			 */
358 22
			unset( $_GET['page'] );
359
360 22
			$date_created = $this->entry['date_created'];
361
362
			/**
363
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
364
			 * @since 1.17.2
365
			 */
366 22
			unset( $this->entry['date_created'] );
367
368
			/**
369
			 * @action `gravityview/edit_entry/before_update` Perform an action after the entry has been updated using Edit Entry
370
			 * @since develop
371
			 * @param array $form Gravity Forms form array
372
			 * @param string $entry_id Numeric ID of the entry that is being updated
373
			 * @param GravityView_Edit_Entry_Render $this This object
374
			 * @param GravityView_View_Data $gv_data The View data
375
			 */
376 22
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
377
378 22
			GFFormsModel::save_lead( $form, $this->entry );
379
380
	        // Delete the values for hidden inputs
381 22
	        $this->unset_hidden_field_values();
382
383 22
			$this->entry['date_created'] = $date_created;
384
385
			// Process calculation fields
386 22
			$this->update_calculation_fields();
387
388
			// Handle hidden approval fields (or their absense)
389 22
			$this->preset_approval_fields();
390
391
			// Perform actions normally performed after updating a lead
392 22
			$this->after_update();
393
394
	        /**
395
			 * Must be AFTER after_update()!
396
			 * @see https://github.com/gravityview/GravityView/issues/764
397
			 */
398 22
			$this->maybe_update_post_fields( $form );
399
400
			/**
401
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
402
             * @since 2.1 Added $gv_data parameter
403
			 * @param array $form Gravity Forms form array
404
			 * @param string $entry_id Numeric ID of the entry that was updated
405
			 * @param GravityView_Edit_Entry_Render $this This object
406
			 * @param GravityView_View_Data $gv_data The View data
407
			 */
408 22
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
409
410
		} else {
411
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
412
		}
413
414 22
	} // process_save
415
416
	/**
417
	 * Delete the value of fields hidden by conditional logic when the entry is edited
418
	 *
419
	 * @uses GFFormsModel::update_lead_field_value()
420
	 *
421
	 * @since 1.17.4
422
	 *
423
	 * @return void
424
	 */
425 21
	private function unset_hidden_field_values() {
426 21
	    global $wpdb;
427
428
		/**
429
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
430
		 * @since 1.22.2
431
		 * @param bool $unset_hidden_field_values Default: true
432
		 * @param GravityView_Edit_Entry_Render $this This object
433
		 */
434 21
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
435
436 21
		$this->unset_hidden_calculations = array();
0 ignored issues
show
Bug introduced by
The property unset_hidden_calculations does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
437
438 21
		if ( ! $unset_hidden_field_values ) {
439
			return;
440
		}
441
442 21
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
443 21
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
444 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
445
		} else {
446
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
447
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
448
		}
449
450 21
	    foreach ( $this->entry as $input_id => $field_value ) {
451
452 21
			if ( ! is_numeric( $input_id ) ) {
453 21
				continue;
454
			}
455
456 21
			if ( ! $field = RGFormsModel::get_field( $this->form, $input_id ) ) {
457 7
				continue;
458
			}
459
460
		    // Reset fields that are or would be hidden
461 21
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
462
463 3
				$empty_value = $field->get_value_save_entry(
464 3
					is_array( $field->get_entry_inputs() ) ? array() : '',
465 3
					$this->form, '', $this->entry['id'], $this->entry
466
				);
467
468 3
				if ( $field->has_calculation() ) {
469 1
					$this->unset_hidden_calculations[] = $field->id; // Unset
470 1
					$empty_value = '';
471
				}
472
473 3
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
474
475 3
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
476
477
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
478
				// after submission
479 3
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
480 3
			    $_POST[ $post_input_id ] = '';
481
		    }
482
	    }
483 21
	}
484
485
	/**
486
	 * Leverage `gravityview/approve_entries/update_unapproved_meta` to prevent
487
	 * the missing/empty approval field to affect is_approved meta at all.
488
	 *
489
	 * Called before the Gravity Forms after_update triggers.
490
	 *
491
	 * @since 2.5
492
	 *
493
	 * @return void
494
	 */
495 21
	private function preset_approval_fields() {
496 21
		$has_approved_field = false;
497
498 21
		foreach ( self::$original_form['fields'] as $field ) {
499 21
			if ( $field->gravityview_approved ) {
500 1
				$has_approved_field = true;
501 1
				break;
502
			}
503
		}
504
505 21
		if ( ! $has_approved_field ) {
506 20
			return;
507
		}
508
509 1
		$is_field_hidden = true;
510
511 1
		foreach ( $this->form['fields'] as $field ) {
512 1
			if ( $field->gravityview_approved ) {
513 1
				$is_field_hidden = false;
514 1
				break;
515
			}
516
		}
517
518 1
		if ( ! $is_field_hidden ) {
519 1
			return;
520
		}
521
522 1
		add_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9, 3 );
523 1
	}
524
525
	/**
526
	 * Done once from self::preset_approval_fields
527
	 *
528
	 * @since 2.5
529
	 *
530
	 * @return string UNAPPROVED unless something else is inside the entry.
531
	 */
532 1
	public function prevent_update_unapproved_meta( $value, $form, $entry ) {
533
534 1
		remove_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9 );
535
536 1
		if ( ! $value = gform_get_meta( $entry['id'], 'is_approved' ) ) {
537
538
			$value = GravityView_Entry_Approval_Status::UNAPPROVED;
539
540
			$value = apply_filters( 'gravityview/approve_entries/after_submission/default_status', $value );
541
		}
542
543 1
		return $value;
544
	}
545
546
	/**
547
	 * Have GF handle file uploads
548
	 *
549
	 * Copy of code from GFFormDisplay::process_form()
550
	 *
551
	 * @param int $form_id
552
	 */
553 21
	private function process_save_process_files( $form_id ) {
554
555
		//Loading files that have been uploaded to temp folder
556 21
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
557 21
		if ( ! is_array( $files ) ) {
558 20
			$files = array();
559
		}
560
561
		/**
562
		 * Make sure the fileuploads are not overwritten if no such request was done.
563
		 * @since 1.20.1
564
		 */
565 21
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
566
567 21
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
568 21
	}
569
570
	/**
571
	 * Make sure the fileuploads are not overwritten if no such request was done.
572
	 *
573
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
574
	 *
575
	 * @since 1.20.1
576
	 *
577
	 * @param string $value Field value
578
	 * @param array $entry GF entry array
579
	 * @param GF_Field_FileUpload $field
580
	 * @param array $form GF form array
581
	 * @param string $input_id ID of the input being saved
582
	 *
583
	 * @return string
584
	 */
585 21
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
586
587 21
		if ( ! $field || $field->type != 'fileupload' ) {
588 21
			return $value;
589
		}
590
591 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
592
593 1
		if ( $field->multipleFiles ) {
594
			if ( empty( $value ) ) {
595
				return json_decode( $entry[ $input_id ], true );
596
			}
597
			return $value;
598
		}
599
600
		/** No file is being uploaded. */
601 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
602
			/** So return the original upload, with $value as backup (it can be empty during edit form rendering) */
603 1
			return rgar( $entry, $input_id, $value );
604
		}
605
606 1
		return $value;
607
	}
608
609
	/**
610
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
611
	 * Late validation done on self::custom_validation
612
	 *
613
	 * @param $plupload_init array Plupload settings
614
	 * @param $form_id
615
	 * @param $instance
616
	 * @return mixed
617
	 */
618 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...
619 2
		if( ! $this->is_edit_entry() ) {
620
			return $plupload_init;
621
		}
622
623 2
		$plupload_init['gf_vars']['max_files'] = 0;
624
625 2
		return $plupload_init;
626
	}
627
628
629
	/**
630
	 * Set visibility to visible and convert field input key to string
631
	 * @return array $form
632
	 */
633 21
	private function form_prepare_for_save() {
634
635 21
		$form = $this->filter_conditional_logic( $this->form );
636
637
	    /** @var GF_Field $field */
638 21
		foreach( $form['fields'] as $k => &$field ) {
639
640
			/**
641
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
642
			 * @since 1.16.3
643
			 * @var GF_Field $field
644
			 */
645 21
			if( $field->has_calculation() ) {
646 4
				unset( $form['fields'][ $k ] );
647
			}
648
649 21
			$field->adminOnly = false;
650
651 21
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
652 3
				foreach( $field->inputs as $key => $input ) {
653 3
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
654
				}
655
			}
656
		}
657
658 21
		$form['fields'] = array_values( $form['fields'] );
659
660 21
		return $form;
661
	}
662
663 21
	private function update_calculation_fields() {
664 21
		global $wpdb;
665
666 21
		$form = self::$original_form;
667 21
		$update = false;
668
669
		// get the most up to date entry values
670 21
		$entry = GFAPI::get_entry( $this->entry['id'] );
671
672 21
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
673 21
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
674 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
675
		} else {
676
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
677
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
678
		}
679
680
681 21
		if ( ! empty( $this->fields_with_calculation ) ) {
682 5
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
683 5
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
684
685 5
			foreach ( $this->fields_with_calculation as $field ) {
686
687 5
				if ( in_array( $field->id, $this->unset_hidden_calculations, true ) ) {
688 1
					continue;
689
				}
690
691 5
				$inputs = $field->get_entry_inputs();
692 5
				if ( is_array( $inputs ) ) {
693 4
				    foreach ( $inputs as $input ) {
694 4
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
695
696 4
						if ( 'product' === $field->type ) {
697 4
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
698
699
							// Only allow quantity to be set if it's allowed to be edited
700 4
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
701
							} else { // otherwise set to what it previously was
702 4
								$_POST[ $input_name ] = $entry[ $input['id'] ];
703
							}
704
						} else {
705
							// Set to what it previously was if it's not editable
706
							if ( ! in_array( $field_id, $allowed_fields ) ) {
707
								$_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...
708
							}
709
						}
710
711 4
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
712
				    }
713
				} else {
714
					// Set to what it previously was if it's not editable
715 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
716 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
717
					}
718 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
719
				}
720
			}
721
722 5
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
723 5
				GFFormsModel::commit_batch_field_operations();
724
			}
725
		}
726 21
	}
727
728
	/**
729
	 * Handle updating the Post Image field
730
	 *
731
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
732
	 *
733
	 * @since 1.17
734
	 *
735
	 * @uses GFFormsModel::media_handle_upload
736
	 * @uses set_post_thumbnail
737
	 *
738
	 * @param array $form GF Form array
739
	 * @param GF_Field $field GF Field
740
	 * @param string $field_id Numeric ID of the field
741
	 * @param string $value
742
	 * @param array $entry GF Entry currently being edited
743
	 * @param int $post_id ID of the Post being edited
744
	 *
745
	 * @return mixed|string
746
	 */
747 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
748
749 1
		$input_name = 'input_' . $field_id;
750
751 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
752
753
			// We have a new image
754
755
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
756
757
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
758
	        $ary = stripslashes_deep( $ary );
759
			$img_url = \GV\Utils::get( $ary, 0 );
760
761
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
762
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
763
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
764
765
			$image_meta = array(
766
				'post_excerpt' => $img_caption,
767
				'post_content' => $img_description,
768
			);
769
770
			//adding title only if it is not empty. It will default to the file name if it is not in the array
771
			if ( ! empty( $img_title ) ) {
772
				$image_meta['post_title'] = $img_title;
773
			}
774
775
			/**
776
			 * 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.
777
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
778
			 */
779
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
780
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
781
782
			// is this field set as featured image?
783
			if ( $media_id && $field->postFeaturedImage ) {
784
				set_post_thumbnail( $post_id, $media_id );
785
			}
786
787 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
788
789 1
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
790 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
791 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
792 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
793
794 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
795
796 1
			if ( $field->postFeaturedImage ) {
797
798
				$image_meta = array(
799 1
					'ID' => get_post_thumbnail_id( $post_id ),
800 1
					'post_title' => $img_title,
801 1
					'post_excerpt' => $img_caption,
802 1
					'post_content' => $img_description,
803
				);
804
805
				// update image title, caption or description
806 1
				wp_update_post( $image_meta );
807
			}
808
		} else {
809
810
			// if we get here, image was removed or not set.
811
			$value = '';
812
813
			if ( $field->postFeaturedImage ) {
814
				delete_post_thumbnail( $post_id );
815
			}
816
		}
817
818 1
		return $value;
819
	}
820
821
	/**
822
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
823
	 *
824
	 * @param array $form Gravity Forms form
825
	 *
826
	 * @return void
827
	 */
828 21
	private function maybe_update_post_fields( $form ) {
829
830 21
		if( empty( $this->entry['post_id'] ) ) {
831 20
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
832 20
			return;
833
		}
834
835 1
		$post_id = $this->entry['post_id'];
836
837
		// Security check
838 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
839
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
840
			return;
841
		}
842
843 1
		$update_entry = false;
844
845 1
		$updated_post = $original_post = get_post( $post_id );
846
847 1
		foreach ( $this->entry as $field_id => $value ) {
848
849 1
			$field = RGFormsModel::get_field( $form, $field_id );
850
851 1
			if( ! $field ) {
852 1
				continue;
853
			}
854
855 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
856
857
				// Get the value of the field, including $_POSTed value
858 1
				$value = RGFormsModel::get_field_value( $field );
859
860
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
861 1
				$entry_tmp = $this->entry;
862 1
				$entry_tmp["{$field_id}"] = $value;
863
864 1
				switch( $field->type ) {
865
866 1
				    case 'post_title':
867
				        $post_title = $value;
868
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
869
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
870
				        }
871
				        $updated_post->post_title = $post_title;
872
				        $updated_post->post_name  = $post_title;
873
				        unset( $post_title );
874
				        break;
875
876 1
				    case 'post_content':
877
				        $post_content = $value;
878
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
879
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
880
				        }
881
				        $updated_post->post_content = $post_content;
882
				        unset( $post_content );
883
				        break;
884 1
				    case 'post_excerpt':
885
				        $updated_post->post_excerpt = $value;
886
				        break;
887 1
				    case 'post_tags':
888
				        wp_set_post_tags( $post_id, $value, false );
889
				        break;
890 1
				    case 'post_category':
891
				        break;
892 1
				    case 'post_custom_field':
893
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
894
							$value = $value[ $field_id ];
895
						}
896
897
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
898
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
899
				        }
900
901
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
902
903
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
904
				        break;
905
906 1
				    case 'post_image':
907 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
908 1
				        break;
909
910
				}
911
912
				// update entry after
913 1
				$this->entry["{$field_id}"] = $value;
914
915 1
				$update_entry = true;
916
917 1
				unset( $entry_tmp );
918
			}
919
920
		}
921
922 1
		if( $update_entry ) {
923
924 1
			$return_entry = GFAPI::update_entry( $this->entry );
925
926 1
			if( is_wp_error( $return_entry ) ) {
927
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
928
			} else {
929 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
930
			}
931
932
		}
933
934 1
		$return_post = wp_update_post( $updated_post, true );
935
936 1
		if( is_wp_error( $return_post ) ) {
937
			$return_post->add_data( $updated_post, '$updated_post' );
938
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
939
		} else {
940 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
941
		}
942 1
	}
943
944
	/**
945
	 * Convert a field content template into prepared output
946
	 *
947
	 * @uses GravityView_GFFormsModel::get_post_field_images()
948
	 *
949
	 * @since 1.17
950
	 *
951
	 * @param string $template The content template for the field
952
	 * @param array $form Gravity Forms form
953
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
954
	 *
955
	 * @return string
956
	 */
957
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
958
959
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
960
961
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
962
963
		//replacing post image variables
964
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
965
966
		//replacing all other variables
967
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
968
969
		// replace conditional shortcodes
970
		if( $do_shortcode ) {
971
			$output = do_shortcode( $output );
972
		}
973
974
		return $output;
975
	}
976
977
978
	/**
979
	 * Perform actions normally performed after updating a lead
980
	 *
981
	 * @since 1.8
982
	 *
983
	 * @see GFEntryDetail::lead_detail_page()
984
	 *
985
	 * @return void
986
	 */
987 21
	private function after_update() {
988
989 21
		do_action( 'gform_after_update_entry', self::$original_form, $this->entry['id'], self::$original_entry );
990 21
		do_action( "gform_after_update_entry_{$this->form['id']}", self::$original_form, $this->entry['id'], self::$original_entry );
991
992
		// Re-define the entry now that we've updated it.
993 21
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
994
995 21
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
996
997 21
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
998
			// We need to clear the cache because Gravity Forms caches the field values, which
999
			// we have just updated.
1000
			foreach ($this->form['fields'] as $key => $field) {
1001
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
1002
			}
1003
		}
1004
1005
		/**
1006
		 * Maybe process feeds.
1007
		 *
1008
		 * @since develop
1009
		 */
1010 21
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
1011 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
1012 1
			if ( ! is_wp_error( $feeds ) ) {
1013 1
				$registered_feeds = array();
1014 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
1015 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
1016 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
1017 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
1018 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
1019
						}
1020
					}
1021
				}
1022 1
				foreach ( $feeds as $feed ) {
1023 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
1024 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
1025 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
1026 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
1027
								$entry = $returned_entry;
1028
							}
1029
1030 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
1031 1
							$slug = $feed_object->get_slug();
1032 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
1033
						}
1034
					}
1035
				}
1036
			}
1037
		}
1038
1039 21
		$this->entry = $entry;
1040 21
	}
1041
1042
1043
	/**
1044
	 * Display the Edit Entry form
1045
	 *
1046
	 * @return void
1047
	 */
1048 22
	public function edit_entry_form() {
1049
1050 22
		$locking = new GravityView_Edit_Entry_Locking();
1051 22
		$locking->maybe_lock_object( $this->entry['id'] );
1052
1053
		?>
1054
1055
		<div id="wpfooter"></div><!-- used for locking message -->
1056
		<script>
1057
			var ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>';
1058
		</script>
1059
		?>
1060
1061
		<div class="gv-edit-entry-wrapper"><?php
1062
1063 22
			$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...
1064
1065
			/**
1066
			 * Fixes weird wpautop() issue
1067
			 * @see https://github.com/katzwebservices/GravityView/issues/451
1068
			 */
1069 22
			echo gravityview_strip_whitespace( $javascript );
1070
1071
			?><h2 class="gv-edit-entry-title">
1072
				<span><?php
1073
1074
				    /**
1075
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
1076
				     * @param string $edit_entry_title Modify the "Edit Entry" title
1077
				     * @param GravityView_Edit_Entry_Render $this This object
1078
				     */
1079 22
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
1080
1081 22
				    echo esc_attr( $edit_entry_title );
1082
			?></span>
1083
			</h2>
1084
1085
			<?php $this->maybe_print_message(); ?>
1086
1087
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
1088
1089
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
1090
1091
				<?php
1092
1093 22
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
1094
1095 22
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
1096
1097
				// Print the actual form HTML
1098 22
				$this->render_edit_form();
1099
1100
				?>
1101 22
			</form>
1102
1103
			<script>
1104
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1105
				    return false;
1106
				});
1107
			</script>
1108
1109
		</div>
1110
1111
	<?php
1112 22
	}
1113
1114
	/**
1115
	 * Display success or error message if the form has been submitted
1116
	 *
1117
	 * @uses GVCommon::generate_notice
1118
	 *
1119
	 * @since 1.16.2.2
1120
	 *
1121
	 * @return void
1122
	 */
1123 22
	private function maybe_print_message() {
1124
1125 22
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
1126
1127 21
			if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1128
				$labels = array(
1129
					'cancel'   => __( 'Cancel', 'gravityview' ),
1130
					'submit'   => __( 'Update', 'gravityview' ),
1131
					'next'     => __( 'Next', 'gravityview' ),
1132
					'previous' => __( 'Previous', 'gravityview' ),
1133
				);
1134
1135
				/**
1136
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1137
				* @since 1.16.3
1138
				* @param array $labels Default button labels associative array
1139
				* @param array $form The Gravity Forms form
1140
				* @param array $entry The Gravity Forms entry
1141
				* @param int $view_id The current View ID
1142
				*/
1143
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1144
1145
				$this->is_paged_submitted = \GV\Utils::_POST( 'save' ) === $labels['submit'];
1146
			}
1147
1148 21
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1149
1150 21
			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...
1151
1152
				// Keeping this compatible with Gravity Forms.
1153
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
1154
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
1155
1156
				echo GVCommon::generate_notice( $message , 'gv-error' );
1157
1158 21
			} elseif ( false === $this->is_paged_submitted ) {
1159
				// Paged form that hasn't been submitted on the last page yet
1160
				$entry_updated_message = sprintf( esc_attr__( 'Entry Updated.', 'gravityview' ), '<a href="' . esc_url( $back_link ) . '">', '</a>' );
1161
1162
				/**
1163
				 * @filter `gravityview/edit_entry/page/success` Modify the edit entry success message on pages
1164
				 * @since develop
1165
				 * @param string $entry_updated_message Existing message
1166
				 * @param int $view_id View ID
1167
				 * @param array $entry Gravity Forms entry array
1168
				 */
1169
				$message = apply_filters( 'gravityview/edit_entry/page/success', $entry_updated_message , $this->view_id, $this->entry );
1170
1171
				echo GVCommon::generate_notice( $message );
1172
			} else {
1173 21
				$view = \GV\View::by_id( $this->view_id );
1174 21
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1175 21
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1176
1177
				switch ( $edit_redirect ) {
1178
1179 21
                    case '0':
1180 1
	                    $redirect_url = $back_link;
1181 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>' );
1182 1
                        break;
1183
1184 20
                    case '1':
1185 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1186 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...
1187 1
	                    break;
1188
1189 19
                    case '2':
1190 1
	                    $redirect_url = $edit_redirect_url;
1191 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1192 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>' );
1193 1
                        break;
1194
1195 18
                    case '':
1196
                    default:
1197 18
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
1198 18
                        break;
1199
				}
1200
1201 21
				if ( isset( $redirect_url ) ) {
1202 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 ) );
1203
				}
1204
1205
				/**
1206
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1207
				 * @since 1.5.4
1208
				 * @param string $entry_updated_message Existing message
1209
				 * @param int $view_id View ID
1210
				 * @param array $entry Gravity Forms entry array
1211
				 * @param string $back_link URL to return to the original entry. @since 1.6
1212
				 */
1213 21
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1214
1215 21
				echo GVCommon::generate_notice( $message );
1216
			}
1217
1218
		}
1219 22
	}
1220
1221
	/**
1222
	 * Display the Edit Entry form in the original Gravity Forms format
1223
	 *
1224
	 * @since 1.9
1225
	 *
1226
	 * @return void
1227
	 */
1228 22
	private function render_edit_form() {
1229
1230
		/**
1231
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1232
		 * @since 1.17
1233
		 * @param GravityView_Edit_Entry_Render $this
1234
		 */
1235 22
		do_action( 'gravityview/edit-entry/render/before', $this );
1236
1237 22
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
1238 22
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
1239 22
		add_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1240 22
		add_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1241 22
		add_filter( 'gform_disable_view_counter', '__return_true' );
1242
1243 22
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1244 22
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1245
1246
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1247 22
		unset( $_GET['page'] );
1248
1249 22
		$this->show_next_button = false;
1250 22
		$this->show_previous_button = false;
1251
1252
		// TODO: Verify multiple-page forms
1253 22
		if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1254
			if ( intval( $page_number = \GV\Utils::_POST( 'gform_source_page_number_' . $this->form['id'], 0 ) ) ) {
1255
1256
				$labels = array(
1257
					'cancel'   => __( 'Cancel', 'gravityview' ),
1258
					'submit'   => __( 'Update', 'gravityview' ),
1259
					'next'     => __( 'Next', 'gravityview' ),
1260
					'previous' => __( 'Previous', 'gravityview' ),
1261
				);
1262
1263
				/**
1264
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1265
				* @since 1.16.3
1266
				* @param array $labels Default button labels associative array
1267
				* @param array $form The Gravity Forms form
1268
				* @param array $entry The Gravity Forms entry
1269
				* @param int $view_id The current View ID
1270
				*/
1271
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1272
1273
				GFFormDisplay::$submission[ $this->form['id'] ][ 'form' ] = $this->form;
1274
				GFFormDisplay::$submission[ $this->form['id'] ][ 'is_valid' ] = true;
1275
1276
				if ( \GV\Utils::_POST( 'save' ) === $labels['next'] ) {
1277
					$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1278
1279
					while ( ++$page_number < $last_page && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1280
					} // Advance to next visible page
1281
				} elseif ( \GV\Utils::_POST( 'save' ) === $labels['previous'] ) {
1282
					while ( --$page_number > 1 && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1283
					} // Advance to next visible page
1284
				}
1285
1286
				GFFormDisplay::$submission[ $this->form['id'] ]['page_number'] = $page_number;
1287
			}
1288
1289
			if ( ( $page_number = intval( $page_number ) ) < 2 ) {
1290
				$this->show_next_button = true; // First page
1291
			}
1292
1293
			$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1294
1295
			$has_more_pages = $page_number < $last_page;
1296
1297
			if ( $has_more_pages ) {
1298
				$this->show_next_button = true; // Not the last page
1299
			} else {
1300
				$this->show_update_button = true; // The last page
1301
			}
1302
1303
			if ( $page_number > 1 ) {
1304
				$this->show_previous_button = true; // Not the first page
1305
			}
1306
		} else {
1307 22
			$this->show_update_button = true;
1308
		}
1309
1310 22
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1311
1312 22
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1313
1314 22
		ob_get_clean();
1315
1316 22
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1317 22
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1318 22
		remove_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1319 22
		remove_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1320 22
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1321 22
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1322 22
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1323
1324 22
		echo $html;
1325
1326
		/**
1327
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1328
		 * @since 1.17
1329
		 * @param GravityView_Edit_Entry_Render $this
1330
		 */
1331 22
		do_action( 'gravityview/edit-entry/render/after', $this );
1332 22
	}
1333
1334
	/**
1335
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1336
	 * @since 1.8
1337
	 * @return string
1338
	 */
1339 22
	public function render_form_buttons() {
1340 22
		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...
1341
	}
1342
1343
1344
	/**
1345
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1346
	 *
1347
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1348
	 *
1349
	 * @param array $form
1350
	 * @param boolean $ajax Whether in AJAX mode
1351
	 * @param array|string $field_values Passed parameters to the form
1352
	 *
1353
	 * @since 1.9
1354
	 *
1355
	 * @return array Modified form array
1356
	 */
1357 22
	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...
1358
1359 22
		if( $form['id'] != $this->form_id ) {
1360
			return $form;
1361
		}
1362
1363
		// In case we have validated the form, use it to inject the validation results into the form render
1364 22
		if( isset( $this->form_after_validation ) && $this->form_after_validation['id'] === $form['id'] ) {
1365 21
			$form = $this->form_after_validation;
1366
		} else {
1367 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1368
		}
1369
1370 22
		$form = $this->filter_conditional_logic( $form );
1371
1372 22
		$form = $this->prefill_conditional_logic( $form );
1373
1374
		// for now we don't support Save and Continue feature.
1375 22
		if( ! self::$supports_save_and_continue ) {
1376 22
	        unset( $form['save'] );
1377
		}
1378
1379 22
		$form = $this->unselect_default_values( $form );
1380
1381 22
		return $form;
1382
	}
1383
1384
	/**
1385
	 * 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.
1386
	 *
1387
	 * @since 1.16.2.2
1388
	 *
1389
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1390
	 * @param GF_Field $field
1391
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1392
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1393
	 * @param int $form_id Form ID
1394
	 *
1395
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1396
	 */
1397 22
	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...
1398
1399 22
		if( ! GFCommon::is_post_field( $field ) ) {
1400 22
			return $field_content;
1401
		}
1402
1403 2
        $message = null;
1404
1405
        // First, make sure they have the capability to edit the post.
1406 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1407
1408
            /**
1409
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1410
             * @param string $message The existing "You don't have permission..." text
1411
             */
1412 1
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
1413
1414 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1415
            /**
1416
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1417
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1418
             */
1419
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
1420
        }
1421
1422 2
        if( $message ) {
1423 1
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
1424
        }
1425
1426 2
        return $field_content;
1427
	}
1428
1429
	/**
1430
	 *
1431
	 * Fill-in the saved values into the form inputs
1432
	 *
1433
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1434
	 * @param GF_Field $field
1435
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1436
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1437
	 * @param int $form_id Form ID
1438
	 *
1439
	 * @return mixed
1440
	 */
1441 22
	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...
1442
1443 22
		$gv_field = GravityView_Fields::get_associated_field( $field );
1444
1445
		// If the form has been submitted, then we don't need to pre-fill the values,
1446
		// Except for fileupload type and when a field input is overridden- run always!!
1447
		if(
1448 22
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
1449 22
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1450
			&& ! GFCommon::is_product_field( $field->type )
1451 22
			|| ! empty( $field_content )
1452 22
			|| in_array( $field->type, array( 'honeypot' ) )
1453
		) {
1454 1
	        return $field_content;
1455
		}
1456
1457
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1458 22
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1459
1460 22
		$field_value = $this->get_field_value( $field );
1461
1462
	    // Prevent any PHP warnings, like undefined index
1463 22
	    ob_start();
1464
1465 22
	    $return = null;
1466
1467
		/** @var GravityView_Field $gv_field */
1468 22
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1469 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1470
		} else {
1471 22
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1472
	    }
1473
1474
	    // If there was output, it's an error
1475 22
	    $warnings = ob_get_clean();
1476
1477 22
	    if( !empty( $warnings ) ) {
1478
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1479
	    }
1480
1481 22
		return $return;
1482
	}
1483
1484
	/**
1485
	 * Modify the value for the current field input
1486
	 *
1487
	 * @param GF_Field $field
1488
	 *
1489
	 * @return array|mixed|string
1490
	 */
1491 22
	private function get_field_value( $field ) {
1492
1493
		/**
1494
		 * @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.
1495
		 * @param boolean True: override saved values; False: don't override (default)
1496
		 * @param $field GF_Field object Gravity Forms field object
1497
		 * @since 1.13
1498
		 */
1499 22
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1500
1501
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1502 22
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
1503
1504 4
			$field_value = array();
1505
1506
			// only accept pre-populated values if the field doesn't have any choice selected.
1507 4
			$allow_pre_populated = $field->allowsPrepopulate;
1508
1509 4
			foreach ( (array)$field->inputs as $input ) {
1510
1511 4
				$input_id = strval( $input['id'] );
1512
1513 4
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1514 4
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
1515 4
				    $allow_pre_populated = false;
1516
				}
1517
1518
			}
1519
1520 4
			$pre_value = $field->get_value_submission( array(), false );
1521
1522 4
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
1523
1524
		} else {
1525
1526 22
			$id = intval( $field->id );
1527
1528
			// get pre-populated value if exists
1529 22
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1530
1531
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1532
			// or pre-populated value if not empty and set to override saved value
1533 22
			$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;
1534
1535
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1536 22
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
1537
				$categories = array();
1538
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1539
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1540
				}
1541
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1542
			}
1543
1544
		}
1545
1546
		// if value is empty get the default value if defined
1547 22
		$field_value = $field->get_value_default_if_empty( $field_value );
1548
1549
	    /**
1550
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1551
	     * @since 1.11
1552
	     * @since 1.20 Added third param
1553
	     * @param mixed $field_value field value used to populate the input
1554
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1555
	     * @param GravityView_Edit_Entry_Render $this Current object
1556
	     */
1557 22
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1558
1559
	    /**
1560
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1561
	     * @since 1.17
1562
	     * @since 1.20 Added third param
1563
	     * @param mixed $field_value field value used to populate the input
1564
	     * @param GF_Field $field Gravity Forms field object
1565
	     * @param GravityView_Edit_Entry_Render $this Current object
1566
	     */
1567 22
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1568
1569 22
		return $field_value;
1570
	}
1571
1572
1573
	// ---- Entry validation
1574
1575
	/**
1576
	 * Add field keys that Gravity Forms expects.
1577
	 *
1578
	 * @see GFFormDisplay::validate()
1579
	 * @param  array $form GF Form
1580
	 * @return array       Modified GF Form
1581
	 */
1582 21
	public function gform_pre_validation( $form ) {
1583
1584 21
		if( ! $this->verify_nonce() ) {
1585
			return $form;
1586
		}
1587
1588
		// Fix PHP warning regarding undefined index.
1589 21
		foreach ( $form['fields'] as &$field) {
1590
1591
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1592
			// expects certain field array items to be set.
1593 21
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1594 21
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
1595
			}
1596
1597 21
			switch( RGFormsModel::get_input_type( $field ) ) {
1598
1599
				/**
1600
				 * 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.
1601
				 *
1602
				 * 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.
1603
				 *
1604
				 * @hack
1605
				 */
1606 21
				case 'fileupload':
1607
1608
				    // Set the previous value
1609 1
				    $entry = $this->get_entry();
1610
1611 1
				    $input_name = 'input_'.$field->id;
1612 1
				    $form_id = $form['id'];
1613
1614 1
				    $value = NULL;
1615
1616
				    // Use the previous entry value as the default.
1617 1
				    if( isset( $entry[ $field->id ] ) ) {
1618 1
				        $value = $entry[ $field->id ];
1619
				    }
1620
1621
				    // If this is a single upload file
1622 1
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
1623 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1624 1
				        $value = $file_path['url'];
1625
1626
				    } else {
1627
1628
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1629
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1630 1
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
1631
1632
				    }
1633
1634 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
1635
1636
				        // If there are fresh uploads, process and merge them.
1637
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1638 1
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
1639
				            $value = empty( $value ) ? '[]' : $value;
1640
				            $value = stripslashes_deep( $value );
1641 1
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
1642
				        }
1643
1644
				    } else {
1645
1646
				        // A file already exists when editing an entry
1647
				        // We set this to solve issue when file upload fields are required.
1648 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1649
1650
				    }
1651
1652 1
				    $this->entry[ $input_name ] = $value;
1653 1
				    $_POST[ $input_name ] = $value;
1654
1655 1
				    break;
1656
1657 21
				case 'number':
1658
				    // Fix "undefined index" issue at line 1286 in form_display.php
1659 12
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
1660 7
				        $_POST['input_'.$field->id ] = NULL;
1661
				    }
1662 12
				    break;
1663
			}
1664
1665
		}
1666
1667 21
		return $form;
1668
	}
1669
1670
1671
	/**
1672
	 * Process validation for a edit entry submission
1673
	 *
1674
	 * Sets the `is_valid` object var
1675
	 *
1676
	 * @return void
1677
	 */
1678 22
	private function validate() {
1679
1680
		/**
1681
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1682
		 * GF User Registration Add-on version > 3.x has a different class name
1683
		 * @since 1.16.2
1684
		 */
1685 22
		if ( class_exists( 'GF_User_Registration' ) ) {
1686 22
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1687
		} else  if ( class_exists( 'GFUser' ) ) {
1688
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1689
		}
1690
1691
1692
		/**
1693
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1694
		 * You can enter whatever you want!
1695
		 * We try validating, and customize the results using `self::custom_validation()`
1696
		 */
1697 22
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
1698
1699
		// Needed by the validate funtion
1700 22
		$failed_validation_page = NULL;
1701 22
		$field_values = RGForms::post( 'gform_field_values' );
1702
1703
		// Prevent entry limit from running when editing an entry, also
1704
		// prevent form scheduling from preventing editing
1705 22
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1706
1707
		// Hide fields depending on Edit Entry settings
1708 22
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1709
1710 22
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1711
1712 22
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1713 22
	}
1714
1715
1716
	/**
1717
	 * Make validation work for Edit Entry
1718
	 *
1719
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1720
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1721
	 * fields. This goes through all the fields and if they're an invalid post field, we
1722
	 * set them as valid. If there are still issues, we'll return false.
1723
	 *
1724
	 * @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...
1725
	 * @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...
1726
	 */
1727 22
	public function custom_validation( $validation_results ) {
1728
1729 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1730
1731 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
1732
1733 22
		$gv_valid = true;
1734
1735 22
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1736
1737 22
			$value = RGFormsModel::get_field_value( $field );
1738 22
			$field_type = RGFormsModel::get_input_type( $field );
1739
1740
			// Validate always
1741 22
			switch ( $field_type ) {
1742
1743
1744 22
				case 'fileupload' :
1745 22
				case 'post_image':
1746
1747
				    // in case nothing is uploaded but there are already files saved
1748 2
				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
1749
				        $field->failed_validation = false;
1750
				        unset( $field->validation_message );
1751
				    }
1752
1753
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1754 2
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
1755
1756
				        $input_name = 'input_' . $field->id;
1757
				        //uploaded
1758
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1759
1760
				        //existent
1761
				        $entry = $this->get_entry();
1762
				        $value = NULL;
1763
				        if( isset( $entry[ $field->id ] ) ) {
1764
				            $value = json_decode( $entry[ $field->id ], true );
1765
				        }
1766
1767
				        // count uploaded files and existent entry files
1768
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1769
						               ( is_array( $value ) ? count( $value ) : 0 );
1770
1771
				        if( $count_files > $field->maxFiles ) {
1772
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1773
				            $field->failed_validation = 1;
1774
				            $gv_valid = false;
1775
1776
				            // in case of error make sure the newest upload files are removed from the upload input
1777
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1778
				        }
1779
1780
				    }
1781
1782
1783 2
				    break;
1784
1785
			}
1786
1787
			// This field has failed validation.
1788 22
			if( !empty( $field->failed_validation ) ) {
1789
1790 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1791
1792 1
				switch ( $field_type ) {
1793
1794
				    // Captchas don't need to be re-entered.
1795 1
				    case 'captcha':
1796
1797
				        // Post Image fields aren't editable, so we un-fail them.
1798 1
				    case 'post_image':
1799
				        $field->failed_validation = false;
1800
				        unset( $field->validation_message );
1801
				        break;
1802
1803
				}
1804
1805
				// You can't continue inside a switch, so we do it after.
1806 1
				if( empty( $field->failed_validation ) ) {
1807
				    continue;
1808
				}
1809
1810
				// checks if the No Duplicates option is not validating entry against itself, since
1811
				// we're editing a stored entry, it would also assume it's a duplicate.
1812 1
				if( !empty( $field->noDuplicates ) ) {
1813
1814
				    $entry = $this->get_entry();
1815
1816
				    // If the value of the entry is the same as the stored value
1817
				    // Then we can assume it's not a duplicate, it's the same.
1818
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
1819
				        //if value submitted was not changed, then don't validate
1820
				        $field->failed_validation = false;
1821
1822
				        unset( $field->validation_message );
1823
1824
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1825
1826
				        continue;
1827
				    }
1828
				}
1829
1830
				// if here then probably we are facing the validation 'At least one field must be filled out'
1831 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
1832
				    unset( $field->validation_message );
1833
	                $field->validation_message = false;
1834
				    continue;
1835
				}
1836
1837 1
				$gv_valid = false;
1838
1839
			}
1840
1841
		}
1842
1843 22
		$validation_results['is_valid'] = $gv_valid;
1844
1845 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1846
1847
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1848 22
		$this->form_after_validation = $validation_results['form'];
1849
1850 22
		return $validation_results;
1851
	}
1852
1853
1854
	/**
1855
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1856
	 * Get the current entry and set it if it's not yet set.
1857
	 * @return array Gravity Forms entry array
1858
	 */
1859 2
	public function get_entry() {
1860
1861 2
		if( empty( $this->entry ) ) {
1862
			// Get the database value of the entry that's being edited
1863 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1864
		}
1865
1866 2
		return $this->entry;
1867
	}
1868
1869
1870
1871
	// --- Filters
1872
1873
	/**
1874
	 * Get the Edit Entry fields as configured in the View
1875
	 *
1876
	 * @since 1.8
1877
	 *
1878
	 * @param int $view_id
1879
	 *
1880
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1881
	 */
1882 23
	private function get_configured_edit_fields( $form, $view_id ) {
1883
1884
		// Get all fields for form
1885 23
		if ( \GV\View::exists( $view_id ) ) {
1886 23
			$view = \GV\View::by_id( $view_id );
1887 23
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1888
		} else {
1889
			$properties = null;
1890
		}
1891
1892
		// If edit tab not yet configured, show all fields
1893 23
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
1894
1895
		// Hide fields depending on admin settings
1896 23
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1897
1898
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1899 23
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1900
1901
		/**
1902
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1903
		 * @since 1.17
1904
		 * @param GF_Field[] $fields Gravity Forms form fields
1905
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1906
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1907
		 * @param int $view_id View ID
1908
		 */
1909 23
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1910
1911 23
		return $fields;
1912
	}
1913
1914
1915
	/**
1916
	 * Filter area fields based on specified conditions
1917
	 *  - This filter removes the fields that have calculation configured
1918
	 *  - Hides fields that are hidden, etc.
1919
	 *
1920
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1921
	 * @access private
1922
	 * @param GF_Field[] $fields
1923
	 * @param array $configured_fields
1924
	 * @since  1.5
1925
	 * @return array $fields
1926
	 */
1927 22
	private function filter_fields( $fields, $configured_fields ) {
1928
1929 22
		if( empty( $fields ) || !is_array( $fields ) ) {
1930
			return $fields;
1931
		}
1932
1933 22
		$edit_fields = array();
1934
1935 22
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1936
1937 22
		if ( empty( $configured_fields ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1938
			$field_type_blacklist = array_diff( $field_type_blacklist, array( 'page' ) );
1939
		}
1940
1941
		// First, remove blacklist or calculation fields
1942 22
		foreach ( $fields as $key => $field ) {
1943
1944
			// Remove the fields that have calculation properties and keep them to be used later
1945
			// @since 1.16.2
1946 22
			if( $field->has_calculation() ) {
1947 5
				$this->fields_with_calculation[] = $field;
1948
				// don't remove the calculation fields on form render.
1949
			}
1950
1951 22
			if( in_array( $field->type, $field_type_blacklist ) ) {
1952 3
				unset( $fields[ $key ] );
1953
			}
1954
		}
1955
1956
		// The Edit tab has not been configured, so we return all fields by default.
1957
		// But we do keep the hidden ones hidden please, for everyone :)
1958 22
		if ( empty( $configured_fields ) ) {
1959 17
			$out_fields = array();
1960 17
			foreach ( $fields as &$field ) {
1961 17
				if ( 'hidden' === $field->type ) {
1962 3
					continue; // A hidden field is just hidden
1963
				}
1964
1965 17
				if ( 'hidden' == $field->visibility ) {
1966 2
					continue; // Same
1967
				}
1968
1969 15
				$out_fields[] = $field;
1970
			}
1971
1972 17
			return array_values( $out_fields );
1973
		}
1974
1975
		// The edit tab has been configured, so we loop through to configured settings
1976 8
		foreach ( $configured_fields as $configured_field ) {
1977
1978
	        /** @var GF_Field $field */
1979 8
	        foreach ( $fields as $field ) {
1980 8
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1981 8
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1982 8
				    break;
1983
				}
1984
1985
			}
1986
1987
		}
1988
1989 8
		return $edit_fields;
1990
1991
	}
1992
1993
	/**
1994
	 * Override GF Form field properties with the ones defined on the View
1995
	 * @param  GF_Field $field GF Form field object
1996
	 * @param  array $field_setting  GV field options
1997
	 * @since  1.5
1998
	 * @return array|GF_Field
1999
	 */
2000 8
	private function merge_field_properties( $field, $field_setting ) {
2001
2002 8
		$return_field = $field;
2003
2004 8
		if( empty( $field_setting['show_label'] ) ) {
2005
			$return_field->label = '';
2006 8
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
2007
			$return_field->label = $field_setting['custom_label'];
2008
		}
2009
2010 8
		if( !empty( $field_setting['custom_class'] ) ) {
2011
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
2012
		}
2013
2014
		/**
2015
		 * Normalize page numbers - avoid conflicts with page validation
2016
		 * @since 1.6
2017
		 */
2018 8
		$return_field->pageNumber = 1;
2019
2020 8
		return $return_field;
2021
2022
	}
2023
2024
	/**
2025
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
2026
	 *
2027
	 * @since 1.9.1
2028
	 *
2029
	 * @param array|GF_Field[] $fields Gravity Forms form fields
2030
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
2031
	 * @param array $form GF Form array
2032
	 * @param int $view_id View ID
2033
	 *
2034
	 * @return array Possibly modified form array
2035
	 */
2036 22
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
2037
2038
	    /**
2039
		 * @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
2040
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
2041
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
2042
	     * @since 1.9.1
2043
	     * @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.
2044
	     * @param array $form GF Form array
2045
	     * @param int $view_id View ID
2046
	     */
2047 22
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
2048
2049 22
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
2050 1
			foreach( $fields as $k => $field ) {
2051
				if( $field->adminOnly ) {
2052
				    unset( $fields[ $k ] );
2053
				}
2054
			}
2055 1
			return array_values( $fields );
2056
		}
2057
2058 22
	    foreach( $fields as &$field ) {
2059 22
		    $field->adminOnly = false;
2060
		}
2061
2062 22
		return $fields;
2063
	}
2064
2065
	/**
2066
	 * Checkboxes and other checkbox-based controls should not
2067
	 * display default checks in edit mode.
2068
	 *
2069
	 * https://github.com/gravityview/GravityView/1149
2070
	 *
2071
	 * @since 2.1
2072
	 *
2073
	 * @param array $form Gravity Forms array object
2074
	 *
2075
	 * @return array $form, modified to default checkboxes, radios from showing up.
2076
	 */
2077 22
	private function unselect_default_values( $form ) {
2078
2079 22
	    foreach ( $form['fields'] as &$field ) {
2080
2081 22
			if ( empty( $field->choices ) ) {
2082 19
                continue;
2083
			}
2084
2085 6
            foreach ( $field->choices as &$choice ) {
2086 6
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
2087 2
					$choice['isSelected'] = false;
2088
				}
2089
			}
2090
		}
2091
2092 22
		return $form;
2093
	}
2094
2095
	// --- Conditional Logic
2096
2097
	/**
2098
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
2099
	 * the dependent fields will be blank.
2100
	 *
2101
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
2102
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
2103
	 *
2104
	 * @since 1.17.4
2105
	 *
2106
	 * @param array $form Gravity Forms array object
2107
	 *
2108
	 * @return array $form, modified to fix conditional
2109
	 */
2110 22
	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...
2111
2112 22
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
2113 19
			return $form;
2114
		}
2115
2116
		// Have Conditional Logic pre-fill fields as if the data were default values
2117
		/** @var GF_Field $field */
2118 3
		foreach ( $form['fields'] as &$field ) {
2119
2120 3
			if( 'checkbox' === $field->type ) {
2121
				foreach ( $field->get_entry_inputs() as $key => $input ) {
2122
				    $input_id = $input['id'];
2123
				    $choice = $field->choices[ $key ];
2124
				    $value = \GV\Utils::get( $this->entry, $input_id );
2125
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
2126
				    if( $match ) {
2127
				        $field->choices[ $key ]['isSelected'] = true;
2128
				    }
2129
				}
2130
			} else {
2131
2132
				// We need to run through each field to set the default values
2133 3
				foreach ( $this->entry as $field_id => $field_value ) {
2134
2135 3
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
2136
2137 3
				        if( 'list' === $field->type ) {
2138
				            $list_rows = maybe_unserialize( $field_value );
2139
2140
				            $list_field_value = array();
2141
				            foreach ( (array) $list_rows as $row ) {
2142
				                foreach ( (array) $row as $column ) {
2143
				                    $list_field_value[] = $column;
2144
				                }
2145
				            }
2146
2147
				            $field->defaultValue = serialize( $list_field_value );
2148
				        } else {
2149 3
				            $field->defaultValue = $field_value;
2150
				        }
2151
				    }
2152
				}
2153
			}
2154
		}
2155
2156 3
		return $form;
2157
	}
2158
2159
	/**
2160
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
2161
	 *
2162
	 * @todo Merge with caller method
2163
	 * @since 1.9
2164
	 *
2165
	 * @param array $form Gravity Forms form
2166
	 * @return array Modified form, if not using Conditional Logic
2167
	 */
2168 22
	private function filter_conditional_logic( $form ) {
2169
		/**
2170
		 * Fields that are tied to a conditional logic field that is not present in the view
2171
		 * have to still be displayed, if the condition is met.
2172
		 *
2173
		 * @see https://github.com/gravityview/GravityView/issues/840
2174
		 * @since develop
2175
		 */
2176 22
		$the_form = GFAPI::get_form( $form['id'] );
2177 22
		$editable_ids = array();
2178 22
		foreach ( $form['fields'] as $field ) {
2179 22
			$editable_ids[] = $field['id']; // wp_list_pluck is destructive in this context
2180
		}
2181 22
		$remove_conditions_rule = array();
2182 22
		foreach ( $the_form['fields'] as $field ) {
2183 22
			if ( ! empty( $field->conditionalLogic ) && ! empty( $field->conditionalLogic['rules'] ) ) {
2184 6
				foreach ( $field->conditionalLogic['rules'] as $i => $rule ) {
2185 6
					if ( ! in_array( $rule['fieldId'], $editable_ids ) ) {
2186
						/**
2187
						 * This conditional field is not editable in this View.
2188
						 * We need to remove the rule, but only if it matches.
2189
						 */
2190 4
						if ( $_field = GFAPI::get_field( $the_form, $rule['fieldId'] ) ) {
2191 4
							$value = $_field->get_value_export( $this->entry );
2192
						} elseif ( isset( $this->entry[ $rule['fieldId'] ] ) ) {
2193
							$value = $this->entry[ $rule['fieldId'] ];
2194
						} else {
2195
							$value = gform_get_meta( $this->entry['id'], $rule['fieldId'] );
2196
						}
2197
2198 4
						$match = GFFormsModel::matches_operation( $value, $rule['value'], $rule['operator'] );
2199
2200 4
						if ( $match ) {
2201 4
							$remove_conditions_rule[] = array( $field['id'], $i );
2202
						}
2203
					}
2204
				}
2205
			}
2206
		}
2207
2208 22
		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...
2209 4
			foreach ( $form['fields'] as &$field ) {
2210 4
				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
2211
2212 4
				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
2213
2214 4
					if ( $field['id'] == $rule_field_id ) {
2215 1
						unset( $field->conditionalLogic['rules'][ $rule_i ] );
2216 1
						gravityview()->log->debug( 'Removed conditional rule #{rule} for field {field_id}', array( 'rule' => $rule_i, 'field_id' => $field['id'] ) );
2217
					}
2218
				}
2219
			}
2220
		}
2221
2222
		/** Normalize the indices... */
2223 22
		$form['fields'] = array_values( $form['fields'] );
2224
2225
		/**
2226
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
2227
		 * @since 1.9
2228
		 * @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
2229
		 * @param array $form Gravity Forms form
2230
		 */
2231 22
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
2232
2233 22
		if( $use_conditional_logic ) {
2234 22
			return $form;
2235
		}
2236
2237
		foreach( $form['fields'] as &$field ) {
2238
			/* @var GF_Field $field */
2239
			$field->conditionalLogic = null;
2240
		}
2241
2242
		unset( $form['button']['conditionalLogic'] );
2243
2244
		return $form;
2245
2246
	}
2247
2248
	/**
2249
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
2250
	 *
2251
	 * @since 1.9
2252
	 *
2253
	 * @param $has_conditional_logic
2254
	 * @param $form
2255
	 * @return mixed
2256
	 */
2257 22
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2258
2259 22
		if( ! $this->is_edit_entry() ) {
2260
			return $has_conditional_logic;
2261
		}
2262
2263
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2264 22
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2265
	}
2266
2267
2268
	// --- User checks and nonces
2269
2270
	/**
2271
	 * Check if the user can edit the entry
2272
	 *
2273
	 * - Is the nonce valid?
2274
	 * - Does the user have the right caps for the entry
2275
	 * - Is the entry in the trash?
2276
	 *
2277
	 * @todo Move to GVCommon
2278
	 *
2279
	 * @param  boolean $echo Show error messages in the form?
2280
	 * @return boolean        True: can edit form. False: nope.
2281
	 */
2282 23
	private function user_can_edit_entry( $echo = false ) {
2283
2284 23
		$error = NULL;
2285
2286
		/**
2287
		 *  1. Permalinks are turned off
2288
		 *  2. There are two entries embedded using oEmbed
2289
		 *  3. One of the entries has just been saved
2290
		 */
2291 23
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
2292
2293
			$error = true;
2294
2295
		}
2296
2297 23
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
2298
2299
			$error = true;
2300
2301 23
		} elseif( ! $this->verify_nonce() ) {
2302
2303
			/**
2304
			 * If the Entry is embedded, there may be two entries on the same page.
2305
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2306
			 */
2307
			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...
2308
				$error = true;
2309
			} else {
2310
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
2311
			}
2312
2313
		}
2314
2315 23
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2316 2
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
2317
		}
2318
2319 23
		if( $this->entry['status'] === 'trash' ) {
2320
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
2321
		}
2322
2323
		// No errors; everything's fine here!
2324 23
		if( empty( $error ) ) {
2325 23
			return true;
2326
		}
2327
2328 2
		if( $echo && $error !== true ) {
2329
2330 2
	        $error = esc_html( $error );
2331
2332
	        /**
2333
	         * @since 1.9
2334
	         */
2335 2
	        if ( ! empty( $this->entry ) ) {
2336 2
		        $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;" ) );
2337
	        }
2338
2339 2
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
2340
		}
2341
2342 2
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2343
2344 2
		return false;
2345
	}
2346
2347
2348
	/**
2349
	 * Check whether a field is editable by the current user, and optionally display an error message
2350
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2351
	 * @param  array  $field Field or field settings array
2352
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2353
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2354
	 */
2355 8
	private function user_can_edit_field( $field, $echo = false ) {
2356
2357 8
		$error = NULL;
2358
2359 8
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2360 1
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
2361
		}
2362
2363
		// No errors; everything's fine here!
2364 8
		if( empty( $error ) ) {
2365 8
			return true;
2366
		}
2367
2368 1
		if( $echo ) {
2369
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
2370
		}
2371
2372 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2373
2374 1
		return false;
2375
2376
	}
2377
2378
2379
	/**
2380
	 * checks if user has permissions to edit a specific field
2381
	 *
2382
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2383
	 *
2384
	 * @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...
2385
	 * @return bool
2386
	 */
2387 8
	private function check_user_cap_edit_field( $field ) {
2388
2389
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2390 8
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2391 7
			return true;
2392
		}
2393
2394 1
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2395
2396 1
		if( $field_cap ) {
2397 1
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2398
		}
2399
2400
		return false;
2401
	}
2402
2403
2404
	/**
2405
	 * Is the current nonce valid for editing the entry?
2406
	 * @return boolean
2407
	 */
2408 22
	public function verify_nonce() {
2409
2410
		// Verify form submitted for editing single
2411 22
		if( $this->is_edit_entry_submission() ) {
2412
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
2413
		}
2414
2415
		// Verify
2416 22
		else if( ! $this->is_edit_entry() ) {
2417
			$valid = false;
2418
		}
2419
2420
		else {
2421 22
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
2422
		}
2423
2424
		/**
2425
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2426
		 * @since 1.13
2427
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2428
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2429
		 */
2430 22
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2431
2432 22
		return $valid;
2433
	}
2434
2435
2436
	/**
2437
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2438
	 *
2439
	 * As a hack for now we'll implode it back.
2440
	 */
2441
	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...
2442
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
2443
			return $field_value;
2444
		}
2445
2446
		$maybe_json = @json_decode( $field_value, true );
2447
2448
		if ( $maybe_json ) {
2449
			return implode( ',', $maybe_json );
2450
		}
2451
2452
		return $field_value;
2453
	}
2454
2455
2456
2457
} //end class
2458