Completed
Pull Request — master (#1313)
by Zack
45:51 queued 36:57
created

GravityView_Edit_Entry_Render::print_scripts()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 1

Importance

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

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

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

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

Loading history...
2
/**
3
 * GravityView Edit Entry - render frontend
4
 *
5
 * @package   GravityView
6
 * @license   GPL2+
7
 * @author    Katz Web Services, Inc.
8
 * @link      http://gravityview.co
9
 * @copyright Copyright 2014, Katz Web Services, Inc.
10
 */
11
12
if ( ! defined( 'WPINC' ) ) {
13
	die;
14
}
15
16
class GravityView_Edit_Entry_Render {
17
18
	/**
19
	 * @var GravityView_Edit_Entry
20
	 */
21
	protected $loader;
22
23
	/**
24
	 * @var string String used to generate unique nonce for the entry/form/view combination. Allows access to edit page.
25
	 */
26
	static $nonce_key;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $nonce_key.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
27
28
	/**
29
	 * @since 1.9
30
	 * @var string String used for check valid edit entry form submission. Allows saving edit form values.
31
	 */
32
	private static $nonce_field = 'is_gv_edit_entry';
33
34
	/**
35
	 * @since 1.9
36
	 * @var bool Whether to allow save and continue functionality
37
	 */
38
	private static $supports_save_and_continue = false;
39
40
	/**
41
	 * Gravity Forms entry array
42
	 *
43
	 * @var array
44
	 */
45
	public $entry;
46
47
	/**
48
	 * The View.
49
	 *
50
	 * @var \GV\View.
51
	 * @since develop
52
	 */
53
	public $view;
54
55
	/**
56
	 * Gravity Forms entry array (it won't get changed during this class lifecycle)
57
	 * @since 1.17.2
58
	 * @var array
59
	 */
60
	private static $original_entry = array();
61
62
	/**
63
	 * Gravity Forms form array (GravityView modifies the content through this class lifecycle)
64
	 *
65
	 * @var array
66
	 */
67
	public $form;
68
69
	/**
70
	 * Gravity Forms form array (it won't get changed during this class lifecycle)
71
	 * @since 1.16.2.1
72
	 * @var array
73
	 */
74
	private static $original_form;
75
76
	/**
77
	 * Gravity Forms form array after the form validation process
78
	 * @since 1.13
79
	 * @var array
80
	 */
81
	public $form_after_validation = null;
82
83
	/**
84
	 * Hold an array of GF field objects that have calculation rules
85
	 * @var array
86
	 */
87
	public $fields_with_calculation = array();
88
89
	/**
90
	 * Gravity Forms form id
91
	 *
92
	 * @var int
93
	 */
94
	public $form_id;
95
96
	/**
97
	 * ID of the current view
98
	 *
99
	 * @var int
100
	 */
101
	public $view_id;
102
103
	/**
104
	 * ID of the current post. May also be ID of the current View.
105
     *
106
     * @since 2.0.13
107
     * 
108
     * @var int
109
	 */
110
	public $post_id;
111
112
	/**
113
	 * Updated entry is valid (GF Validation object)
114
	 *
115
	 * @var array
116
	 */
117
	public $is_valid = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
118
119 15
	function __construct( GravityView_Edit_Entry $loader ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

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

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

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

Loading history...
124
125
		/** @define "GRAVITYVIEW_DIR" "../../../" */
126 15
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
127
128
		// Don't display an embedded form when editing an entry
129 15
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
130 15
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
131
132
		// Stop Gravity Forms processing what is ours!
133 15
		add_filter( 'wp', array( $this, 'prevent_maybe_process_form'), 8 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
134
135 15
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
136
137 15
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
138
139
		// Disable conditional logic if needed (since 1.9)
140 15
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
141
142
		// Make sure GF doesn't validate max files (since 1.9)
143 15
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
144
145
		// Add fields expected by GFFormDisplay::validate()
146 15
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
147
148
		// Fix multiselect value for GF 2.2
149 15
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
150 15
	}
151
152
	/**
153
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
154
	 *
155
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
156
	 * And then removes it on the `wp_footer` action
157
	 *
158
	 * @since 1.16.1
159
	 *
160
	 * @return void
161
	 */
162 1
	public function prevent_render_form() {
163 1
		if( $this->is_edit_entry() ) {
164 1
			if( 'wp_head' === current_filter() ) {
165 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
166
			} else {
167 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
168
			}
169
		}
170 1
	}
171
172
	/**
173
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
174
	 * backend form, we need to prevent them from saving twice.
175
	 * @return void
176
	 */
177 1
	public function prevent_maybe_process_form() {
178
179 1
		if( ! empty( $_POST ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
180
	        gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
0 ignored issues
show
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
181
		}
182
183 1
		if( $this->is_edit_entry_submission() ) {
184
			remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
185
	        remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
186
		}
187 1
	}
188
189
	/**
190
	 * Is the current page an Edit Entry page?
191
	 * @return boolean
192
	 */
193 19
	public function is_edit_entry() {
194
195 19
		$is_edit_entry = GravityView_frontend::is_single_entry() && ! empty( $_GET['edit'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
196
197 19
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
198
	}
199
200
	/**
201
	 * Is the current page an Edit Entry page?
202
	 * @since 1.9
203
	 * @return boolean
204
	 */
205 19
	public function is_edit_entry_submission() {
206 19
		return !empty( $_POST[ self::$nonce_field ] );
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
207
	}
208
209
	/**
210
	 * When Edit entry view is requested setup the vars
211
	 */
212 15
	private function setup_vars() {
213 15
        global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
214
215 15
		$gravityview_view = GravityView_View::getInstance();
216
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
217
218 15
		$entries = $gravityview_view->getEntries();
219 15
	    self::$original_entry = $entries[0];
220 15
	    $this->entry = $entries[0];
221
222 15
		self::$original_form = $gravityview_view->getForm();
223 15
		$this->form = $gravityview_view->getForm();
224 15
		$this->form_id = $this->entry['form_id'];
225 15
		$this->view_id = $gravityview_view->getViewId();
226 15
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
227
228 15
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
229 15
	}
230
231
232
	/**
233
	 * Load required files and trigger edit flow
234
	 *
235
	 * Run when the is_edit_entry returns true.
236
	 *
237
	 * @param \GravityView_View_Data $gv_data GravityView Data object
238
	 * @param \GV\Entry   $entry   The Entry.
239
	 * @param \GV\View    $view    The View.
240
	 * @param \GV\Request $request The Request.
241
	 *
242
	 * @since develop Added $entry, $view, $request adhocs.
243
	 *
244
	 * @return void
245
	 */
246 16
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
247
248 16
		require_once( GFCommon::get_base_path() . '/form_display.php' );
249 16
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
250
251 16
		$this->setup_vars();
252
253 16
		if ( ! $gv_data ) {
254
			$gv_data = GravityView_View_Data::getInstance();
255
		}
256
257
		// Multiple Views embedded, don't proceed if nonce fails
258 16
		if ( $gv_data->has_multiple_views() && ! $this->verify_nonce() ) {
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
259
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
260
			return;
261
		}
262
263
		// Sorry, you're not allowed here.
264 16
		if ( false === $this->user_can_edit_entry( true ) ) {
265 1
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
266 1
			return;
267
		}
268
269 16
		$this->view = $view;
270
271 16
		$this->print_scripts();
272
273 16
		$this->process_save( $gv_data );
274
275 16
		$this->edit_entry_form();
276
277 16
	}
278
279
280
	/**
281
	 * Force Gravity Forms to output scripts as if it were in the admin
282
	 * @return void
283
	 */
284 15
	private function print_scripts() {
285 15
		$gravityview_view = GravityView_View::getInstance();
286
287 15
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
288
289 15
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
290
291 15
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
292
293
		// Sack is required for images
294 15
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
295 15
	}
296
297
298
	/**
299
	 * Process edit entry form save
300
	 *
301
	 * @param array $gv_data The View data.
302
	 */
303 16
	private function process_save( $gv_data ) {
304
305 16
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
306 5
			return;
307
		}
308
309
		// Make sure the entry, view, and form IDs are all correct
310 15
		$valid = $this->verify_nonce();
311
312 15
		if ( !$valid ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
313
			gravityview()->log->error( 'Nonce validation failed.' );
314
			return;
315
		}
316
317 15
		if ( $this->entry['id'] !== $_POST['lid'] ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
318
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
319
			return;
320
		}
321
322 15
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
0 ignored issues
show
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
323
324 15
		$this->process_save_process_files( $this->form_id );
325
326 15
		$this->validate();
327
328 15
		if( $this->is_valid ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->is_valid of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

Loading history...
329
330 15
			gravityview()->log->debug( 'Submission is valid.' );
331
332
			/**
333
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
334
			 */
335 15
			$form = $this->form_prepare_for_save();
336
337
			/**
338
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
339
			 */
340 15
			unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
341
342 15
			$date_created = $this->entry['date_created'];
343
344
			/**
345
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
346
			 * @since 1.17.2
347
			 */
348 15
			unset( $this->entry['date_created'] );
349
350
			/**
351
			 * @action `gravityview/edit_entry/before_update` Perform an action after the entry has been updated using Edit Entry
352
			 * @since develop
353
			 * @param array $form Gravity Forms form array
354
			 * @param string $entry_id Numeric ID of the entry that is being updated
355
			 * @param GravityView_Edit_Entry_Render $this This object
356
			 * @param GravityView_View_Data $gv_data The View data
357
			 */
358 15
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
359
360 15
			GFFormsModel::save_lead( $form, $this->entry );
361
362
	        // Delete the values for hidden inputs
363 15
	        $this->unset_hidden_field_values();
364
			
365 15
			$this->entry['date_created'] = $date_created;
366
367
			// Process calculation fields
368 15
			$this->update_calculation_fields();
369
370
			// Perform actions normally performed after updating a lead
371 15
			$this->after_update();
372
373
	        /**
374
			 * Must be AFTER after_update()!
375
			 * @see https://github.com/gravityview/GravityView/issues/764
376
			 */
377 15
			$this->maybe_update_post_fields( $form );
378
379
			/**
380
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
381
             * @since 2.1 Added $gv_data parameter
382
			 * @param array $form Gravity Forms form array
383
			 * @param string $entry_id Numeric ID of the entry that was updated
384
			 * @param GravityView_Edit_Entry_Render $this This object
385
			 * @param GravityView_View_Data $gv_data The View data
386
			 */
387 15
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
388
389
		} else {
390
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
391
		}
392
393 15
	} // process_save
394
395
	/**
396
	 * Delete the value of fields hidden by conditional logic when the entry is edited
397
	 *
398
	 * @uses GFFormsModel::update_lead_field_value()
399
	 *
400
	 * @since 1.17.4
401
	 *
402
	 * @return void
403
	 */
404 14
	private function unset_hidden_field_values() {
405 14
	    global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
406
407
		/**
408
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
409
		 * @since 1.22.2
410
		 * @param bool $unset_hidden_field_values Default: true
411
		 * @param GravityView_Edit_Entry_Render $this This object
412
		 */
413 14
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
414
415 14
		if( ! $unset_hidden_field_values ) {
416
			return;
417
		}
418
419 14
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
420 14
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
421 14
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
422
		} else {
423
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
424
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
425
		}
426
427 14
	    foreach ( $this->entry as $input_id => $field_value ) {
428
429 14
		    $field = RGFormsModel::get_field( $this->form, $input_id );
430
431
		    // Reset fields that are hidden
432
		    // Don't pass $entry as fourth parameter; force using $_POST values to calculate conditional logic
433 14
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), NULL ) ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
434
435
				$empty_value = $field->get_value_save_entry(
436
					is_array( $field->get_entry_inputs() ) ? array() : '',
437
					$this->form, '', $this->entry['id'], $this->entry
438
				);
439
440
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
441
442
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
443
444
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
445
				// after submission
446
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
447
			    $_POST[ $post_input_id ] = '';
448
		    }
449
	    }
450 14
	}
451
452
	/**
453
	 * Have GF handle file uploads
454
	 *
455
	 * Copy of code from GFFormDisplay::process_form()
456
	 *
457
	 * @param int $form_id
458
	 */
459 14
	private function process_save_process_files( $form_id ) {
460
461
		//Loading files that have been uploaded to temp folder
462 14
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
463 14
		if ( ! is_array( $files ) ) {
464 13
			$files = array();
465
		}
466
467
		/**
468
		 * Make sure the fileuploads are not overwritten if no such request was done.
469
		 * @since 1.20.1
470
		 */
471 14
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
472
473 14
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
474 14
	}
475
476
	/**
477
	 * Make sure the fileuploads are not overwritten if no such request was done.
478
	 *
479
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
480
	 *
481
	 * @since 1.20.1
482
	 *
483
	 * @param string $value Field value
484
	 * @param array $entry GF entry array
485
	 * @param GF_Field_FileUpload $field
486
	 * @param array $form GF form array
487
	 * @param string $input_id ID of the input being saved
488
	 *
489
	 * @return string
490
	 */
491 14
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
492
493 14
		if ( ! $field || $field->type != 'fileupload' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
494 14
			return $value;
495
		}
496
497 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
498
499 1
		if ( $field->multipleFiles ) {
500
			if ( empty( $value ) ) {
501
				return json_decode( $entry[ $input_id ], true );
502
			}
503
			return $value;
504
		}
505
506
		/** No file is being uploaded. */
507 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
508
			/** So return the original upload */
509 1
			return $entry[ $input_id ];
510
		}
511
512 1
		return $value;
513
	}
514
515
	/**
516
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
517
	 * Late validation done on self::custom_validation
518
	 *
519
	 * @param $plupload_init array Plupload settings
520
	 * @param $form_id
521
	 * @param $instance
522
	 * @return mixed
523
	 */
524 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...
525 2
		if( ! $this->is_edit_entry() ) {
526
			return $plupload_init;
527
		}
528
529 2
		$plupload_init['gf_vars']['max_files'] = 0;
530
531 2
		return $plupload_init;
532
	}
533
534
535
	/**
536
	 * Set visibility to visible and convert field input key to string
537
	 * @return array $form
538
	 */
539 14
	private function form_prepare_for_save() {
540
541 14
		$form = $this->filter_conditional_logic( $this->form );
542
543
	    /** @var GF_Field $field */
544 14
		foreach( $form['fields'] as $k => &$field ) {
545
546
			/**
547
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
548
			 * @since 1.16.3
549
			 * @var GF_Field $field
550
			 */
551 14
			if( $field->has_calculation() ) {
552 3
				unset( $form['fields'][ $k ] );
553
			}
554
555 14
			$field->adminOnly = false;
556
557 14
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
558 2
				foreach( $field->inputs as $key => $input ) {
559 2
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
0 ignored issues
show
introduced by
Array keys should NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
560
				}
561
			}
562
		}
563
564 14
		$form['fields'] = array_values( $form['fields'] );
565
566 14
		return $form;
567
	}
568
569 14
	private function update_calculation_fields() {
570 14
		global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
571
572 14
		$form = self::$original_form;
573 14
		$update = false;
574
575
		// get the most up to date entry values
576 14
		$entry = GFAPI::get_entry( $this->entry['id'] );
577
578 14
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
579 14
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
580 14
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
581
		} else {
582
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
583
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
584
		}
585
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
586
587 14
		if ( ! empty( $this->fields_with_calculation ) ) {
588 4
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
589 4
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
590
591 4
			foreach ( $this->fields_with_calculation as $field ) {
592 4
				$inputs = $field->get_entry_inputs();
593 4
				if ( is_array( $inputs ) ) {
594 3
				    foreach ( $inputs as $input ) {
595 3
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
596
597 3
						if ( 'product' === $field->type ) {
598 3
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
599
600
							// Only allow quantity to be set if it's allowed to be edited
601 3
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
introduced by
Found "== 3". Use Yoda Condition checks, you must
Loading history...
602
							} else { // otherwise set to what it previously was
603 3
								$_POST[ $input_name ] = $entry[ $input['id'] ];
604
							}
605
						} else {
606
							// Set to what it previously was if it's not editable
607
							if ( ! in_array( $field_id, $allowed_fields ) ) {
608
								$_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...
609
							}
610
						}
611
612 3
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
613
				    }
614
				} else {
615
					// Set to what it previously was if it's not editable
616 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
617 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
618
					}
619 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
620
				}
621
			}
622
623 4
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
624 4
				GFFormsModel::commit_batch_field_operations();
625
			}
626
		}
627 14
	}
628
629
	/**
630
	 * Handle updating the Post Image field
631
	 *
632
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
633
	 *
634
	 * @since 1.17
635
	 *
636
	 * @uses GFFormsModel::media_handle_upload
637
	 * @uses set_post_thumbnail
638
	 *
639
	 * @param array $form GF Form array
640
	 * @param GF_Field $field GF Field
641
	 * @param string $field_id Numeric ID of the field
642
	 * @param string $value
643
	 * @param array $entry GF Entry currently being edited
644
	 * @param int $post_id ID of the Post being edited
645
	 *
646
	 * @return mixed|string
647
	 */
648 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
649
650 1
		$input_name = 'input_' . $field_id;
651
652 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
653
654
			// We have a new image
655
656
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
657
658
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
659
	        $ary = stripslashes_deep( $ary );
660
			$img_url = \GV\Utils::get( $ary, 0 );
661
662
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
663
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
664
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
665
666
			$image_meta = array(
667
				'post_excerpt' => $img_caption,
668
				'post_content' => $img_description,
669
			);
670
671
			//adding title only if it is not empty. It will default to the file name if it is not in the array
672
			if ( ! empty( $img_title ) ) {
673
				$image_meta['post_title'] = $img_title;
674
			}
675
676
			/**
677
			 * 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.
678
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
679
			 */
680
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
681
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
682
683
			// is this field set as featured image?
684
			if ( $media_id && $field->postFeaturedImage ) {
685
				set_post_thumbnail( $post_id, $media_id );
686
			}
687
688 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
689
690 1
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
691 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
692 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
693 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
694
695 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal |:| does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
696
697 1
			if ( $field->postFeaturedImage ) {
698
699
				$image_meta = array(
700 1
					'ID' => get_post_thumbnail_id( $post_id ),
701 1
					'post_title' => $img_title,
702 1
					'post_excerpt' => $img_caption,
703 1
					'post_content' => $img_description,
704
				);
705
706
				// update image title, caption or description
707 1
				wp_update_post( $image_meta );
708
			}
709
		} else {
710
711
			// if we get here, image was removed or not set.
712
			$value = '';
713
714
			if ( $field->postFeaturedImage ) {
715
				delete_post_thumbnail( $post_id );
716
			}
717
		}
718
719 1
		return $value;
720
	}
721
722
	/**
723
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
724
	 *
725
	 * @param array $form Gravity Forms form
726
	 *
727
	 * @return void
728
	 */
729 14
	private function maybe_update_post_fields( $form ) {
730
731 14
		if( empty( $this->entry['post_id'] ) ) {
732 13
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
733 13
			return;
734
		}
735
736 1
		$post_id = $this->entry['post_id'];
737
738
		// Security check
739 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
740
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
741
			return;
742
		}
743
744 1
		$update_entry = false;
745
746 1
		$updated_post = $original_post = get_post( $post_id );
747
748 1
		foreach ( $this->entry as $field_id => $value ) {
749
750 1
			$field = RGFormsModel::get_field( $form, $field_id );
751
752 1
			if( ! $field ) {
753 1
				continue;
754
			}
755
756 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
757
758
				// Get the value of the field, including $_POSTed value
759 1
				$value = RGFormsModel::get_field_value( $field );
760
761
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
762 1
				$entry_tmp = $this->entry;
763 1
				$entry_tmp["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
764
765 1
				switch( $field->type ) {
766
767 1
				    case 'post_title':
768
				        $post_title = $value;
769
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
770
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
771
				        }
772
				        $updated_post->post_title = $post_title;
773
				        $updated_post->post_name  = $post_title;
774
				        unset( $post_title );
775
				        break;
776
777 1
				    case 'post_content':
778
				        $post_content = $value;
779
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
780
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
781
				        }
782
				        $updated_post->post_content = $post_content;
783
				        unset( $post_content );
784
				        break;
785 1
				    case 'post_excerpt':
786
				        $updated_post->post_excerpt = $value;
787
				        break;
788 1
				    case 'post_tags':
789
				        wp_set_post_tags( $post_id, $value, false );
790
				        break;
791 1
				    case 'post_category':
792
				        break;
793 1
				    case 'post_custom_field':
794
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
795
							$value = $value[ $field_id ];
796
						}
797
798
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
799
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
800
				        }
801
802
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
803
804
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
805
				        break;
806
807 1
				    case 'post_image':
808 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
809 1
				        break;
810
811
				}
812
813
				// update entry after
814 1
				$this->entry["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
815
816 1
				$update_entry = true;
817
818 1
				unset( $entry_tmp );
819
			}
820
821
		}
822
823 1
		if( $update_entry ) {
824
825 1
			$return_entry = GFAPI::update_entry( $this->entry );
826
827 1
			if( is_wp_error( $return_entry ) ) {
828
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
829
			} else {
830 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
831
			}
832
833
		}
834
835 1
		$return_post = wp_update_post( $updated_post, true );
836
837 1
		if( is_wp_error( $return_post ) ) {
838
			$return_post->add_data( $updated_post, '$updated_post' );
839
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
840
		} else {
841 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
842
		}
843 1
	}
844
845
	/**
846
	 * Convert a field content template into prepared output
847
	 *
848
	 * @uses GravityView_GFFormsModel::get_post_field_images()
849
	 *
850
	 * @since 1.17
851
	 *
852
	 * @param string $template The content template for the field
853
	 * @param array $form Gravity Forms form
854
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
855
	 *
856
	 * @return string
857
	 */
858
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
859
860
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
861
862
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
863
864
		//replacing post image variables
865
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
866
867
		//replacing all other variables
868
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
869
870
		// replace conditional shortcodes
871
		if( $do_shortcode ) {
872
			$output = do_shortcode( $output );
873
		}
874
875
		return $output;
876
	}
877
878
879
	/**
880
	 * Perform actions normally performed after updating a lead
881
	 *
882
	 * @since 1.8
883
	 *
884
	 * @see GFEntryDetail::lead_detail_page()
885
	 *
886
	 * @return void
887
	 */
888 14
	private function after_update() {
889
890 14
		do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
891 14
		do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
892
893
		// Re-define the entry now that we've updated it.
894 14
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
895
896 14
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
897
898 14
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
899
			// We need to clear the cache because Gravity Forms caches the field values, which
900
			// we have just updated.
901
			foreach ($this->form['fields'] as $key => $field) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
902
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
903
			}
904
		}
905
906
		/**
907
		 * Maybe process feeds.
908
		 *
909
		 * @since develop
910
		 */
911 14
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
912 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
913 1
			if ( ! is_wp_error( $feeds ) ) {
914 1
				$registered_feeds = array();
915 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
916 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
917 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
918 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
919 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
920
						}
921
					}
922
				}
923 1
				foreach ( $feeds as $feed ) {
924 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
925 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
926 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
927 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
928
								$entry = $returned_entry;
929
							}
930
931 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
932 1
							$slug = $feed_object->get_slug();
933 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
934
						}
935
					}
936
				}
937
			}
938
		}
939
940 14
		$this->entry = $entry;
941 14
	}
942
943
944
	/**
945
	 * Display the Edit Entry form
946
	 *
947
	 * @return void
948
	 */
949 15
	public function edit_entry_form() {
950
951
		?>
952
953
		<div class="gv-edit-entry-wrapper"><?php
954
955 15
			$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...
956
957
			/**
958
			 * Fixes weird wpautop() issue
959
			 * @see https://github.com/katzwebservices/GravityView/issues/451
960
			 */
961 15
			echo gravityview_strip_whitespace( $javascript );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'gravityview_strip_whitespace'
Loading history...
962
963
			?><h2 class="gv-edit-entry-title">
964
				<span><?php
965
966
				    /**
967
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
968
				     * @param string $edit_entry_title Modify the "Edit Entry" title
969
				     * @param GravityView_Edit_Entry_Render $this This object
970
				     */
971 15
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
972
973 15
				    echo esc_attr( $edit_entry_title );
974
			?></span>
975
			</h2>
976
977
			<?php $this->maybe_print_message(); ?>
978
979
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
980
981
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$this'
Loading history...
982
983
				<?php
984
985 15
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
986
987 15
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
988
989
				// Print the actual form HTML
990 15
				$this->render_edit_form();
991
992
				?>
993 15
			</form>
994
995
			<script>
996
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
997
				    return false;
998
				});
999
			</script>
1000
1001
		</div>
1002
1003
	<?php
1004 15
	}
1005
1006
	/**
1007
	 * Display success or error message if the form has been submitted
1008
	 *
1009
	 * @uses GVCommon::generate_notice
1010
	 *
1011
	 * @since 1.16.2.2
1012
	 *
1013
	 * @return void
1014
	 */
1015 15
	private function maybe_print_message() {
1016
1017 15
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1018
1019 14
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1020
1021 14
			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...
1022
1023
				// Keeping this compatible with Gravity Forms.
1024
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw '__'
Loading history...
Coding Style Comprehensibility introduced by
The string literal </div> does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
1025
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal gform_validation_message does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
1026
1027
				echo GVCommon::generate_notice( $message , 'gv-error' );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
1028
1029
			} else {
1030 14
				$view = \GV\View::by_id( $this->view_id );
1031 14
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1032 14
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1033
1034
				switch ( $edit_redirect ) {
1035
1036 14
                    case '0':
1037 1
	                    $redirect_url = $back_link;
1038 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>' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1039 1
                        break;
1040
1041 13
                    case '1':
1042 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1043 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...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1044 1
	                    break;
1045
1046 12
                    case '2':
1047 1
	                    $redirect_url = $edit_redirect_url;
1048 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1049 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>' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1050 1
                        break;
1051
1052 11
                    case '':
1053
                    default:
1054 11
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1055 11
                        break;
1056
				}
1057
1058 14
				if ( isset( $redirect_url ) ) {
1059 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 ) );
1060
				}
1061
1062
				/**
1063
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1064
				 * @since 1.5.4
1065
				 * @param string $entry_updated_message Existing message
1066
				 * @param int $view_id View ID
1067
				 * @param array $entry Gravity Forms entry array
1068
				 * @param string $back_link URL to return to the original entry. @since 1.6
1069
				 */
1070 14
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1071
1072 14
				echo GVCommon::generate_notice( $message );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
1073
			}
1074
1075
		}
1076 15
	}
1077
1078
	/**
1079
	 * Display the Edit Entry form in the original Gravity Forms format
1080
	 *
1081
	 * @since 1.9
1082
	 *
1083
	 * @return void
1084
	 */
1085 15
	private function render_edit_form() {
1086
1087
		/**
1088
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1089
		 * @since 1.17
1090
		 * @param GravityView_Edit_Entry_Render $this
1091
		 */
1092 15
		do_action( 'gravityview/edit-entry/render/before', $this );
1093
1094 15
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
1095 15
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
1096 15
		add_filter( 'gform_disable_view_counter', '__return_true' );
1097
1098 15
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1099 15
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1100
1101
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1102 15
		unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1103
1104
		// TODO: Verify multiple-page forms
1105
1106 15
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1107
1108 15
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1109
1110 15
		ob_get_clean();
1111
1112 15
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1113 15
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1114 15
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1115 15
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1116 15
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1117
1118 15
		echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
1119
1120
		/**
1121
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1122
		 * @since 1.17
1123
		 * @param GravityView_Edit_Entry_Render $this
1124
		 */
1125 15
		do_action( 'gravityview/edit-entry/render/after', $this );
1126 15
	}
1127
1128
	/**
1129
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1130
	 * @since 1.8
1131
	 * @return string
1132
	 */
1133 15
	public function render_form_buttons() {
1134 15
		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...
1135
	}
1136
1137
1138
	/**
1139
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1140
	 *
1141
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1142
	 *
1143
	 * @param array $form
1144
	 * @param boolean $ajax Whether in AJAX mode
1145
	 * @param array|string $field_values Passed parameters to the form
1146
	 *
1147
	 * @since 1.9
1148
	 *
1149
	 * @return array Modified form array
1150
	 */
1151 15
	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...
1152
1153
		// In case we have validated the form, use it to inject the validation results into the form render
1154 15
		if( isset( $this->form_after_validation ) ) {
1155 14
			$form = $this->form_after_validation;
1156
		} else {
1157 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1158
		}
1159
1160 15
		$form = $this->filter_conditional_logic( $form );
1161
1162 15
		$form = $this->prefill_conditional_logic( $form );
1163
1164
		// for now we don't support Save and Continue feature.
1165 15
		if( ! self::$supports_save_and_continue ) {
1166 15
	        unset( $form['save'] );
1167
		}
1168
1169 15
		$form = $this->unselect_default_values( $form );
1170
1171 15
		return $form;
1172
	}
1173
1174
	/**
1175
	 * 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.
1176
	 *
1177
	 * @since 1.16.2.2
1178
	 *
1179
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1180
	 * @param GF_Field $field
1181
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1182
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1183
	 * @param int $form_id Form ID
1184
	 *
1185
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1186
	 */
1187 15
	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...
1188
1189 15
		if( ! GFCommon::is_post_field( $field ) ) {
1190 15
			return $field_content;
1191
		}
1192
1193 2
        $message = null;
1194
1195
        // First, make sure they have the capability to edit the post.
1196 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1197
1198
            /**
1199
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1200
             * @param string $message The existing "You don't have permission..." text
1201
             */
1202 1
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1203
1204 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1205
            /**
1206
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1207
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1208
             */
1209
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1210
        }
1211
1212 2
        if( $message ) {
1213 1
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1214
        }
1215
1216 2
        return $field_content;
1217
	}
1218
1219
	/**
1220
	 *
1221
	 * Fill-in the saved values into the form inputs
1222
	 *
1223
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1224
	 * @param GF_Field $field
1225
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1226
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1227
	 * @param int $form_id Form ID
1228
	 *
1229
	 * @return mixed
1230
	 */
1231 15
	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...
1232
1233 15
		$gv_field = GravityView_Fields::get_associated_field( $field );
1234
1235
		// If the form has been submitted, then we don't need to pre-fill the values,
1236
		// Except for fileupload type and when a field input is overridden- run always!!
1237
		if(
1238 15
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1239 15
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1240
			&& ! GFCommon::is_product_field( $field->type )
1241 15
			|| ! empty( $field_content )
1242 15
			|| in_array( $field->type, array( 'honeypot' ) )
1243
		) {
1244 1
	        return $field_content;
1245
		}
1246
1247
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1248 15
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1249
1250 15
		$field_value = $this->get_field_value( $field );
1251
1252
	    // Prevent any PHP warnings, like undefined index
1253 15
	    ob_start();
1254
1255 15
	    $return = null;
1256
1257
		/** @var GravityView_Field $gv_field */
1258 15
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1259 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1260
		} else {
1261 15
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1262
	    }
1263
1264
	    // If there was output, it's an error
1265 15
	    $warnings = ob_get_clean();
1266
1267 15
	    if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1268
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1269
	    }
1270
1271 15
		return $return;
1272
	}
1273
1274
	/**
1275
	 * Modify the value for the current field input
1276
	 *
1277
	 * @param GF_Field $field
1278
	 *
1279
	 * @return array|mixed|string
1280
	 */
1281 15
	private function get_field_value( $field ) {
1282
1283
		/**
1284
		 * @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.
1285
		 * @param boolean True: override saved values; False: don't override (default)
1286
		 * @param $field GF_Field object Gravity Forms field object
1287
		 * @since 1.13
1288
		 */
1289 15
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1290
1291
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1292 15
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1293
1294 3
			$field_value = array();
1295
1296
			// only accept pre-populated values if the field doesn't have any choice selected.
1297 3
			$allow_pre_populated = $field->allowsPrepopulate;
1298
1299 3
			foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1300
1301 3
				$input_id = strval( $input['id'] );
1302
1303 3
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1304 3
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
0 ignored issues
show
introduced by
Expected 1 space after "="; 2 found
Loading history...
1305 3
				    $allow_pre_populated = false;
1306
				}
1307
1308
			}
1309
1310 3
			$pre_value = $field->get_value_submission( array(), false );
1311
1312 3
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1313
1314
		} else {
1315
1316 15
			$id = intval( $field->id );
1317
1318
			// get pre-populated value if exists
1319 15
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1320
1321
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1322
			// or pre-populated value if not empty and set to override saved value
1323 15
			$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;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1324
1325
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1326 15
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1327
				$categories = array();
1328
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1329
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1330
				}
1331
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1332
			}
1333
1334
		}
1335
1336
		// if value is empty get the default value if defined
1337 15
		$field_value = $field->get_value_default_if_empty( $field_value );
1338
1339
	    /**
1340
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1341
	     * @since 1.11
1342
	     * @since 1.20 Added third param
1343
	     * @param mixed $field_value field value used to populate the input
1344
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1345
	     * @param GravityView_Edit_Entry_Render $this Current object
1346
	     */
1347 15
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1348
1349
	    /**
1350
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1351
	     * @since 1.17
1352
	     * @since 1.20 Added third param
1353
	     * @param mixed $field_value field value used to populate the input
1354
	     * @param GF_Field $field Gravity Forms field object
1355
	     * @param GravityView_Edit_Entry_Render $this Current object
1356
	     */
1357 15
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1358
1359 15
		return $field_value;
1360
	}
1361
1362
1363
	// ---- Entry validation
1364
1365
	/**
1366
	 * Add field keys that Gravity Forms expects.
1367
	 *
1368
	 * @see GFFormDisplay::validate()
1369
	 * @param  array $form GF Form
1370
	 * @return array       Modified GF Form
1371
	 */
1372 14
	public function gform_pre_validation( $form ) {
1373
1374 14
		if( ! $this->verify_nonce() ) {
1375
			return $form;
1376
		}
1377
1378
		// Fix PHP warning regarding undefined index.
1379 14
		foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1380
1381
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1382
			// expects certain field array items to be set.
1383 14
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1384 14
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1385
			}
1386
1387 14
			switch( RGFormsModel::get_input_type( $field ) ) {
1388
1389
				/**
1390
				 * 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.
1391
				 *
1392
				 * 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.
1393
				 *
1394
				 * @hack
1395
				 */
1396 14
				case 'fileupload':
1397
1398
				    // Set the previous value
1399 1
				    $entry = $this->get_entry();
1400
1401 1
				    $input_name = 'input_'.$field->id;
1402 1
				    $form_id = $form['id'];
1403
1404 1
				    $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1405
1406
				    // Use the previous entry value as the default.
1407 1
				    if( isset( $entry[ $field->id ] ) ) {
1408 1
				        $value = $entry[ $field->id ];
1409
				    }
1410
1411
				    // If this is a single upload file
1412 1
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1413 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1414 1
				        $value = $file_path['url'];
1415
1416
				    } else {
1417
1418
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1419
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1420 1
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
1421
1422
				    }
1423
1424 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal multipleFiles does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
1425
1426
				        // If there are fresh uploads, process and merge them.
1427
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1428 1
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1429
				            $value = empty( $value ) ? '[]' : $value;
1430
				            $value = stripslashes_deep( $value );
1431 1
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1432
				        }
1433
1434
				    } else {
1435
1436
				        // A file already exists when editing an entry
1437
				        // We set this to solve issue when file upload fields are required.
1438 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1439
1440
				    }
1441
1442 1
				    $this->entry[ $input_name ] = $value;
1443 1
				    $_POST[ $input_name ] = $value;
1444
1445 1
				    break;
1446
1447 14
				case 'number':
1448
				    // Fix "undefined index" issue at line 1286 in form_display.php
1449 9
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1450 6
				        $_POST['input_'.$field->id ] = NULL;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1451
				    }
1452 9
				    break;
1453
			}
1454
1455
		}
1456
1457 14
		return $form;
1458
	}
1459
1460
1461
	/**
1462
	 * Process validation for a edit entry submission
1463
	 *
1464
	 * Sets the `is_valid` object var
1465
	 *
1466
	 * @return void
1467
	 */
1468 15
	private function validate() {
1469
1470
		/**
1471
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1472
		 * GF User Registration Add-on version > 3.x has a different class name
1473
		 * @since 1.16.2
1474
		 */
1475 15
		if ( class_exists( 'GF_User_Registration' ) ) {
1476 15
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1477
		} else  if ( class_exists( 'GFUser' ) ) {
1478
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1479
		}
1480
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1481
1482
		/**
1483
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1484
		 * You can enter whatever you want!
1485
		 * We try validating, and customize the results using `self::custom_validation()`
1486
		 */
1487 15
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1488
1489
		// Needed by the validate funtion
1490 15
		$failed_validation_page = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1491 15
		$field_values = RGForms::post( 'gform_field_values' );
1492
1493
		// Prevent entry limit from running when editing an entry, also
1494
		// prevent form scheduling from preventing editing
1495 15
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1496
1497
		// Hide fields depending on Edit Entry settings
1498 15
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1499
1500 15
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1501
1502 15
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1503 15
	}
1504
1505
1506
	/**
1507
	 * Make validation work for Edit Entry
1508
	 *
1509
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1510
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1511
	 * fields. This goes through all the fields and if they're an invalid post field, we
1512
	 * set them as valid. If there are still issues, we'll return false.
1513
	 *
1514
	 * @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...
1515
	 * @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...
1516
	 */
1517 15
	public function custom_validation( $validation_results ) {
1518
1519 15
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1520
1521 15
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
0 ignored issues
show
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
1522
1523 15
		$gv_valid = true;
1524
1525 15
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1526
1527 15
			$value = RGFormsModel::get_field_value( $field );
1528 15
			$field_type = RGFormsModel::get_input_type( $field );
1529
1530
			// Validate always
1531 15
			switch ( $field_type ) {
1532
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1533
1534 15
				case 'fileupload' :
1535 15
				case 'post_image':
1536
1537
				    // in case nothing is uploaded but there are already files saved
1538 2
				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1539
				        $field->failed_validation = false;
1540
				        unset( $field->validation_message );
1541
				    }
1542
1543
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1544 2
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1545
1546
				        $input_name = 'input_' . $field->id;
1547
				        //uploaded
1548
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1549
1550
				        //existent
1551
				        $entry = $this->get_entry();
1552
				        $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1553
				        if( isset( $entry[ $field->id ] ) ) {
1554
				            $value = json_decode( $entry[ $field->id ], true );
1555
				        }
1556
1557
				        // count uploaded files and existent entry files
1558
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1559
						               ( is_array( $value ) ? count( $value ) : 0 );
1560
1561
				        if( $count_files > $field->maxFiles ) {
1562
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1563
				            $field->failed_validation = 1;
1564
				            $gv_valid = false;
1565
1566
				            // in case of error make sure the newest upload files are removed from the upload input
1567
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1568
				        }
1569
1570
				    }
1571
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1572
1573 2
				    break;
1574
1575
			}
1576
1577
			// This field has failed validation.
1578 15
			if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1579
1580 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1581
1582 1
				switch ( $field_type ) {
1583
1584
				    // Captchas don't need to be re-entered.
1585 1
				    case 'captcha':
1586
1587
				        // Post Image fields aren't editable, so we un-fail them.
1588 1
				    case 'post_image':
1589
				        $field->failed_validation = false;
1590
				        unset( $field->validation_message );
1591
				        break;
1592
1593
				}
1594
1595
				// You can't continue inside a switch, so we do it after.
1596 1
				if( empty( $field->failed_validation ) ) {
1597
				    continue;
1598
				}
1599
1600
				// checks if the No Duplicates option is not validating entry against itself, since
1601
				// we're editing a stored entry, it would also assume it's a duplicate.
1602 1
				if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1603
1604
				    $entry = $this->get_entry();
1605
1606
				    // If the value of the entry is the same as the stored value
1607
				    // Then we can assume it's not a duplicate, it's the same.
1608
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1609
				        //if value submitted was not changed, then don't validate
1610
				        $field->failed_validation = false;
1611
1612
				        unset( $field->validation_message );
1613
1614
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1615
1616
				        continue;
1617
				    }
1618
				}
1619
1620
				// if here then probably we are facing the validation 'At least one field must be filled out'
1621 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 2 found
Loading history...
1622
				    unset( $field->validation_message );
1623
	                $field->validation_message = false;
1624
				    continue;
1625
				}
1626
1627 1
				$gv_valid = false;
1628
1629
			}
1630
1631
		}
1632
1633 15
		$validation_results['is_valid'] = $gv_valid;
1634
1635 15
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1636
1637
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1638 15
		$this->form_after_validation = $validation_results['form'];
1639
1640 15
		return $validation_results;
1641
	}
1642
1643
1644
	/**
1645
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1646
	 * Get the current entry and set it if it's not yet set.
1647
	 * @return array Gravity Forms entry array
1648
	 */
1649 2
	public function get_entry() {
1650
1651 2
		if( empty( $this->entry ) ) {
1652
			// Get the database value of the entry that's being edited
1653 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1654
		}
1655
1656 2
		return $this->entry;
1657
	}
1658
1659
1660
1661
	// --- Filters
1662
1663
	/**
1664
	 * Get the Edit Entry fields as configured in the View
1665
	 *
1666
	 * @since 1.8
1667
	 *
1668
	 * @param int $view_id
1669
	 *
1670
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1671
	 */
1672 16
	private function get_configured_edit_fields( $form, $view_id ) {
1673
1674
		// Get all fields for form
1675 16
		if ( \GV\View::exists( $view_id ) ) {
1676 16
			$view = \GV\View::by_id( $view_id );
1677 16
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1678
		} else {
1679
			$properties = null;
1680
		}
1681
1682
		// If edit tab not yet configured, show all fields
1683 16
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1684
1685
		// Hide fields depending on admin settings
1686 16
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1687
1688
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1689 16
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1690
1691
		/**
1692
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1693
		 * @since 1.17
1694
		 * @param GF_Field[] $fields Gravity Forms form fields
1695
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1696
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1697
		 * @param int $view_id View ID
1698
		 */
1699 16
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1700
1701 16
		return $fields;
1702
	}
1703
1704
1705
	/**
1706
	 * Filter area fields based on specified conditions
1707
	 *  - This filter removes the fields that have calculation configured
1708
	 *
1709
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1710
	 * @access private
1711
	 * @param GF_Field[] $fields
1712
	 * @param array $configured_fields
1713
	 * @since  1.5
1714
	 * @return array $fields
1715
	 */
1716 15
	private function filter_fields( $fields, $configured_fields ) {
1717
1718 15
		if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1719
			return $fields;
1720
		}
1721
1722 15
		$edit_fields = array();
1723
1724 15
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1725
1726
		// First, remove blacklist or calculation fields
1727 15
		foreach ( $fields as $key => $field ) {
1728
1729
			// Remove the fields that have calculation properties and keep them to be used later
1730
			// @since 1.16.2
1731 15
			if( $field->has_calculation() ) {
1732 4
				$this->fields_with_calculation[] = $field;
1733
				// don't remove the calculation fields on form render.
1734
			}
1735
1736 15
			if( in_array( $field->type, $field_type_blacklist ) ) {
1737 2
				unset( $fields[ $key ] );
1738
			}
1739
		}
1740
1741
		// The Edit tab has not been configured, so we return all fields by default.
1742 15
		if( empty( $configured_fields ) ) {
1743 12
			return array_values( $fields );
1744
		}
1745
1746
		// The edit tab has been configured, so we loop through to configured settings
1747 3
		foreach ( $configured_fields as $configured_field ) {
1748
1749
	        /** @var GF_Field $field */
1750 3
	        foreach ( $fields as $field ) {
1751 3
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1752 3
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1753 3
				    break;
1754
				}
1755
1756
			}
1757
1758
		}
1759
1760 3
		return $edit_fields;
1761
1762
	}
1763
1764
	/**
1765
	 * Override GF Form field properties with the ones defined on the View
1766
	 * @param  GF_Field $field GF Form field object
1767
	 * @param  array $field_setting  GV field options
1768
	 * @since  1.5
1769
	 * @return array|GF_Field
1770
	 */
1771 3
	private function merge_field_properties( $field, $field_setting ) {
1772
1773 3
		$return_field = $field;
1774
1775 3
		if( empty( $field_setting['show_label'] ) ) {
1776
			$return_field->label = '';
1777 3
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1778
			$return_field->label = $field_setting['custom_label'];
1779
		}
1780
1781 3
		if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1782
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1783
		}
1784
1785
		/**
1786
		 * Normalize page numbers - avoid conflicts with page validation
1787
		 * @since 1.6
1788
		 */
1789 3
		$return_field->pageNumber = 1;
1790
1791 3
		return $return_field;
1792
1793
	}
1794
1795
	/**
1796
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1797
	 *
1798
	 * @since 1.9.1
1799
	 *
1800
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1801
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1802
	 * @param array $form GF Form array
1803
	 * @param int $view_id View ID
1804
	 *
1805
	 * @return array Possibly modified form array
1806
	 */
1807 15
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1808
1809
	    /**
1810
		 * @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
1811
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1812
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1813
	     * @since 1.9.1
1814
	     * @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.
1815
	     * @param array $form GF Form array
1816
	     * @param int $view_id View ID
1817
	     */
1818 15
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1819
1820 15
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1821
			foreach( $fields as $k => $field ) {
1822
				if( $field->adminOnly ) {
1823
				    unset( $fields[ $k ] );
1824
				}
1825
			}
1826
			return array_values( $fields );
1827
		}
1828
1829 15
	    foreach( $fields as &$field ) {
1830 15
		    $field->adminOnly = false;
1831
		}
1832
1833 15
		return $fields;
1834
	}
1835
1836
	/**
1837
	 * Checkboxes and other checkbox-based controls should not
1838
	 * display default checks in edit mode.
1839
	 *
1840
	 * https://github.com/gravityview/GravityView/1149
1841
	 *
1842
	 * @since 2.1
1843
	 *
1844
	 * @param array $form Gravity Forms array object
1845
	 *
1846
	 * @return array $form, modified to default checkboxes, radios from showing up.
1847
	 */
1848 15
	private function unselect_default_values( $form ) {
1849
1850 15
	    foreach ( $form['fields'] as &$field ) {
1851
1852 15
			if ( empty( $field->choices ) ) {
1853 15
                continue;
1854
			}
1855
1856 2
            foreach ( $field->choices as &$choice ) {
1857 2
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
1858 1
					$choice['isSelected'] = false;
1859
				}
1860
			}
1861
		}
1862
1863 15
		return $form;
1864
	}
1865
1866
	// --- Conditional Logic
1867
1868
	/**
1869
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1870
	 * the dependent fields will be blank.
1871
	 *
1872
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1873
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1874
	 *
1875
	 * @since 1.17.4
1876
	 *
1877
	 * @param array $form Gravity Forms array object
1878
	 *
1879
	 * @return array $form, modified to fix conditional
1880
	 */
1881 15
	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...
1882
1883 15
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1884 14
			return $form;
1885
		}
1886
1887
		// Have Conditional Logic pre-fill fields as if the data were default values
1888
		/** @var GF_Field $field */
1889 1
		foreach ( $form['fields'] as &$field ) {
1890
1891 1
			if( 'checkbox' === $field->type ) {
1892
				foreach ( $field->get_entry_inputs() as $key => $input ) {
1893
				    $input_id = $input['id'];
1894
				    $choice = $field->choices[ $key ];
1895
				    $value = \GV\Utils::get( $this->entry, $input_id );
1896
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
1897
				    if( $match ) {
1898
				        $field->choices[ $key ]['isSelected'] = true;
1899
				    }
1900
				}
1901
			} else {
1902
1903
				// We need to run through each field to set the default values
1904 1
				foreach ( $this->entry as $field_id => $field_value ) {
1905
1906 1
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
1907
1908 1
				        if( 'list' === $field->type ) {
1909
				            $list_rows = maybe_unserialize( $field_value );
1910
1911
				            $list_field_value = array();
1912
				            foreach ( (array) $list_rows as $row ) {
1913
				                foreach ( (array) $row as $column ) {
1914
				                    $list_field_value[] = $column;
1915
				                }
1916
				            }
1917
1918
				            $field->defaultValue = serialize( $list_field_value );
1919
				        } else {
1920 1
				            $field->defaultValue = $field_value;
1921
				        }
1922
				    }
1923
				}
1924
			}
1925
		}
1926
1927 1
		return $form;
1928
	}
1929
1930
	/**
1931
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
1932
	 *
1933
	 * @todo Merge with caller method
1934
	 * @since 1.9
1935
	 *
1936
	 * @param array $form Gravity Forms form
1937
	 * @return array Modified form, if not using Conditional Logic
1938
	 */
1939 15
	private function filter_conditional_logic( $form ) {
1940
		/**
1941
		 * Fields that are tied to a conditional logic field that is not present in the view
1942
		 * have to still be displayed, if the condition is met.
1943
		 *
1944
		 * @see https://github.com/gravityview/GravityView/issues/840
1945
		 * @since develop
1946
		 */
1947 15
		$the_form = GFAPI::get_form( $form['id'] );
1948 15
		$editable_ids = array();
1949 15
		foreach ( $form['fields'] as $field ) {
1950 15
			$editable_ids[] = $field['id']; // wp_list_pluck is destructive in this context
1951
		}
1952 15
		$remove_conditions_rule = array();
1953 15
		foreach ( $the_form['fields'] as $field ) {
1954 15
			if ( ! empty( $field->conditionalLogic ) && ! empty( $field->conditionalLogic['rules'] ) ) {
1955 2
				foreach ( $field->conditionalLogic['rules'] as $i => $rule ) {
1956 2
					if ( ! in_array( $rule['fieldId'], $editable_ids ) ) {
1957
						/**
1958
						 * This conditional field is not editable in this View.
1959
						 * We need to remove the rule, but only if it matches.
1960
						 */
1961 2
						$value = GFAPI::get_field( $the_form, $rule['fieldId'] )->get_value_export( $this->entry );
1962 2
						$match = GFFormsModel::matches_operation( $value, $rule['value'], $rule['operator'] );
1963
						
1964 2
						if ( $match ) {
1965 2
							$remove_conditions_rule[] = array( $field['id'], $i );
1966
						}
1967
					}
1968
				}
1969
			}
1970
		}
1971
1972 15
		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...
1973 2
			foreach ( $form['fields'] as &$field ) {
1974 2
				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
1975
1976 2
				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
1977
1978 2
					if ( $field['id'] == $rule_field_id ) {
1979 1
						unset( $field->conditionalLogic['rules'][ $rule_i ] );
1980 1
						gravityview()->log->debug( 'Removed conditional rule #{rule} for field {field_id}', array( 'rule' => $rule_i, 'field_id' => $field['id'] ) );
1981
					}
1982
				}
1983
			}
1984
		}
1985
1986
		/** Normalize the indices... */
1987 15
		$form['fields'] = array_values( $form['fields'] );
1988
1989
		/**
1990
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1991
		 * @since 1.9
1992
		 * @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
1993
		 * @param array $form Gravity Forms form
1994
		 */
1995 15
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1996
1997 15
		if( $use_conditional_logic ) {
1998 15
			return $form;
1999
		}
2000
2001
		foreach( $form['fields'] as &$field ) {
2002
			/* @var GF_Field $field */
2003
			$field->conditionalLogic = null;
2004
		}
2005
2006
		unset( $form['button']['conditionalLogic'] );
2007
2008
		return $form;
2009
2010
	}
2011
2012
	/**
2013
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
2014
	 *
2015
	 * @since 1.9
2016
	 *
2017
	 * @param $has_conditional_logic
2018
	 * @param $form
2019
	 * @return mixed
2020
	 */
2021 15
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2022
2023 15
		if( ! $this->is_edit_entry() ) {
2024
			return $has_conditional_logic;
2025
		}
2026
2027
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2028 15
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2029
	}
2030
2031
2032
	// --- User checks and nonces
2033
2034
	/**
2035
	 * Check if the user can edit the entry
2036
	 *
2037
	 * - Is the nonce valid?
2038
	 * - Does the user have the right caps for the entry
2039
	 * - Is the entry in the trash?
2040
	 *
2041
	 * @todo Move to GVCommon
2042
	 *
2043
	 * @param  boolean $echo Show error messages in the form?
2044
	 * @return boolean        True: can edit form. False: nope.
2045
	 */
2046 16
	private function user_can_edit_entry( $echo = false ) {
2047
2048 16
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
2049
2050
		/**
2051
		 *  1. Permalinks are turned off
2052
		 *  2. There are two entries embedded using oEmbed
2053
		 *  3. One of the entries has just been saved
2054
		 */
2055 16
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
2056
2057
			$error = true;
2058
2059
		}
2060
2061 16
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
2062
2063
			$error = true;
2064
2065 16
		} elseif( ! $this->verify_nonce() ) {
2066
2067
			/**
2068
			 * If the Entry is embedded, there may be two entries on the same page.
2069
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2070
			 */
2071
			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...
2072
				$error = true;
2073
			} else {
2074
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2075
			}
2076
2077
		}
2078
2079 16
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2080 1
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2081
		}
2082
2083 16
		if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
2084
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
2085
		}
2086
2087
		// No errors; everything's fine here!
2088 16
		if( empty( $error ) ) {
2089 16
			return true;
2090
		}
2091
2092 1
		if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
2093
2094 1
	        $error = esc_html( $error );
2095
2096
	        /**
2097
	         * @since 1.9
2098
	         */
2099 1
	        if ( ! empty( $this->entry ) ) {
2100 1
		        $error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal window.history.go(-1); return false; does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
2101
	        }
2102
2103 1
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2104
		}
2105
2106 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2107
2108 1
		return false;
2109
	}
2110
2111
2112
	/**
2113
	 * Check whether a field is editable by the current user, and optionally display an error message
2114
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2115
	 * @param  array  $field Field or field settings array
2116
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2117
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2118
	 */
2119 3
	private function user_can_edit_field( $field, $echo = false ) {
2120
2121 3
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
2122
2123 3
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2124
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2125
		}
2126
2127
		// No errors; everything's fine here!
2128 3
		if( empty( $error ) ) {
2129 3
			return true;
2130
		}
2131
2132
		if( $echo ) {
2133
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2134
		}
2135
2136
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2137
2138
		return false;
2139
2140
	}
2141
2142
2143
	/**
2144
	 * checks if user has permissions to edit a specific field
2145
	 *
2146
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2147
	 *
2148
	 * @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...
2149
	 * @return bool
2150
	 */
2151 3
	private function check_user_cap_edit_field( $field ) {
2152
2153
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2154 3
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2155 3
			return true;
2156
		}
2157
2158
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2159
2160
		if( $field_cap ) {
2161
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2162
		}
2163
2164
		return false;
2165
	}
2166
2167
2168
	/**
2169
	 * Is the current nonce valid for editing the entry?
2170
	 * @return boolean
2171
	 */
2172 15
	public function verify_nonce() {
2173
2174
		// Verify form submitted for editing single
2175 15
		if( $this->is_edit_entry_submission() ) {
2176
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_POST
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
2177
		}
2178
2179
		// Verify
2180 15
		else if( ! $this->is_edit_entry() ) {
2181
			$valid = false;
2182
		}
2183
2184
		else {
2185 15
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
2186
		}
2187
2188
		/**
2189
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2190
		 * @since 1.13
2191
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2192
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2193
		 */
2194 15
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2195
2196 15
		return $valid;
2197
	}
2198
2199
2200
	/**
2201
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2202
	 *
2203
	 * As a hack for now we'll implode it back.
2204
	 */
2205
	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...
2206
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
Coding Style introduced by
Space before opening parenthesis of function call prohibited
Loading history...
2207
			return $field_value;
2208
		}
2209
2210
		$maybe_json = @json_decode( $field_value, true );
0 ignored issues
show
Coding Style introduced by
Silencing errors is discouraged
Loading history...
2211
2212
		if ( $maybe_json ) {
2213
			return implode( ',', $maybe_json );
2214
		}
2215
2216
		return $field_value;
2217
	}
2218
2219
2220
2221
} //end class
2222