Completed
Push — master ( 4ba683...3a59f6 )
by Zack
31:21 queued 27:45
created

GravityView_Edit_Entry_Render::after_update()   C

Complexity

Conditions 13
Paths 6

Size

Total Lines 54

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 25
CRAP Score 13.2076

Importance

Changes 0
Metric Value
cc 13
nc 6
nop 0
dl 0
loc 54
ccs 25
cts 28
cp 0.8929
crap 13.2076
rs 6.6166
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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 14
	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 14
		$this->loader = $loader;
121 14
	}
122
123 14
	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 14
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
127
128
		// Don't display an embedded form when editing an entry
129 14
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
130 14
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
131
132
		// Stop Gravity Forms processing what is ours!
133 14
		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 14
		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 14
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
138
139
		// Disable conditional logic if needed (since 1.9)
140 14
		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 14
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
144
145
		// Add fields expected by GFFormDisplay::validate()
146 14
		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 14
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
150 14
	}
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 18
	public function is_edit_entry() {
194
195 18
		$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 18
		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 18
	public function is_edit_entry_submission() {
206 18
		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 14
	private function setup_vars() {
213 14
        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 14
		$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 14
		$entries = $gravityview_view->getEntries();
219 14
	    self::$original_entry = $entries[0];
220 14
	    $this->entry = $entries[0];
221
222 14
		self::$original_form = $gravityview_view->getForm();
223 14
		$this->form = $gravityview_view->getForm();
224 14
		$this->form_id = $this->entry['form_id'];
225 14
		$this->view_id = $gravityview_view->getViewId();
226 14
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
227
228 14
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
229 14
	}
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 15
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
247
248 15
		require_once( GFCommon::get_base_path() . '/form_display.php' );
249 15
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
250
251 15
		$this->setup_vars();
252
253 15
		if ( ! $gv_data ) {
254
			$gv_data = GravityView_View_Data::getInstance();
255
		}
256
257
		// Multiple Views embedded, don't proceed if nonce fails
258 15
		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 15
		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 15
		$this->view = $view;
270
271 15
		$this->print_scripts();
272
273 15
		$this->process_save( $gv_data );
274
275 15
		$this->edit_entry_form();
276
277 15
	}
278
279
280
	/**
281
	 * Force Gravity Forms to output scripts as if it were in the admin
282
	 * @return void
283
	 */
284 14
	private function print_scripts() {
285 14
		$gravityview_view = GravityView_View::getInstance();
286
287 14
		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 14
		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 14
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
292
293
		// Sack is required for images
294 14
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
295 14
	}
296
297
298
	/**
299
	 * Process edit entry form save
300
	 *
301
	 * @param array $gv_data The View data.
302
	 */
303 15
	private function process_save( $gv_data ) {
304
305 15
		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 14
		$valid = $this->verify_nonce();
311
312 14
		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 14
		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 14
		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 14
		$this->process_save_process_files( $this->form_id );
325
326 14
		$this->validate();
327
328 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...
329
330 14
			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 14
			$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 14
			unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
341
342 14
			$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 14
			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 14
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
359
360 14
			GFFormsModel::save_lead( $form, $this->entry );
361
362
	        // Delete the values for hidden inputs
363 14
	        $this->unset_hidden_field_values();
364
			
365 14
			$this->entry['date_created'] = $date_created;
366
367
			// Process calculation fields
368 14
			$this->update_calculation_fields();
369
370
			// Perform actions normally performed after updating a lead
371 14
			$this->after_update();
372
373
	        /**
374
			 * Must be AFTER after_update()!
375
			 * @see https://github.com/gravityview/GravityView/issues/764
376
			 */
377 14
			$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 14
			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 14
	} // 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 13
	private function unset_hidden_field_values() {
405 13
	    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 13
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
414
415 13
		if( ! $unset_hidden_field_values ) {
416
			return;
417
		}
418
419 13
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
420 13
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
421 13
			$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 13
	    foreach ( $this->entry as $input_id => $field_value ) {
428
429 13
		    $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 13
		    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 13
	}
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 13
	private function process_save_process_files( $form_id ) {
460
461
		//Loading files that have been uploaded to temp folder
462 13
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
463 13
		if ( ! is_array( $files ) ) {
464 12
			$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 13
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
472
473 13
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
474 13
	}
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 13
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
492
493 13
		if ( ! $field || $field->type != 'fileupload' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
494 13
			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 13
	private function form_prepare_for_save() {
540
541 13
		$form = $this->form;
542
543 13
		$non_submitted_fields = array();
544
545
	    /** @var GF_Field $field */
546 13
		foreach( $form['fields'] as $k => &$field ) {
547
548
			/**
549
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
550
			 * @since 1.16.3
551
			 * @var GF_Field $field
552
			 */
553 13
			if( $field->has_calculation() ) {
554 3
				unset( $form['fields'][ $k ] );
555
			}
556
557 13
			$field->adminOnly = false;
558
559 13
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
560 3
				foreach( $field->inputs as $key => $input ) {
561 3
				    $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...
562
				}
563
			}
564
565
			/**
566
			 * Unset fields that are used in conditionals, but only if these fields
567
			 * are not present in the edit view fields.
568
			 * @since develop
569
			 */
570 13
			if ( ! empty( $field['conditionalLogic'] ) && ! empty( $field['conditionalLogic']['rules'] ) ) {
571 1
				foreach ( wp_list_pluck( $field['conditionalLogic']['rules'], 'fieldId' ) as $conditional_id ) {
572 1
					$post_input_id = 'input_' . str_replace( '.', '_', $conditional_id );
573 1
					if ( ! isset( $_POST[ $post_input_id ] ) ) {
574 1
						$non_submitted_fields []= $conditional_id;
0 ignored issues
show
introduced by
Expected 1 space before "="; 0 found
Loading history...
575
					}
576
				}
577
			}
578
		}
579
580
		/**
581
		 * Remove fields that are not submitted. For now we only do this with
582
		 * fields that are used in conditional logic. In the future we may try
583
		 * (or need) to remove all fields that are not being submitted. Or look
584
		 * at the view edit configuration.
585
		 */
586 13
		foreach ( $form['fields'] as $k => $field ) {
587 13
			if ( in_array( $field['id'], $non_submitted_fields ) ) {
588 1
				unset( $form['fields'][ $k ] );
589
			}
590
		}
591
592 13
		$form['fields'] = array_values( $form['fields'] );
593
594 13
		return $form;
595
	}
596
597 13
	private function update_calculation_fields() {
598 13
		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...
599
600 13
		$form = self::$original_form;
601 13
		$update = false;
602
603
		// get the most up to date entry values
604 13
		$entry = GFAPI::get_entry( $this->entry['id'] );
605
606 13
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
607 13
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
608 13
			$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...
609
		} else {
610
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
611
			$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...
612
		}
613
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
614
615 13
		if ( ! empty( $this->fields_with_calculation ) ) {
616 4
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
617 4
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
618
619 4
			foreach ( $this->fields_with_calculation as $field ) {
620 4
				$inputs = $field->get_entry_inputs();
621 4
				if ( is_array( $inputs ) ) {
622 3
				    foreach ( $inputs as $input ) {
623 3
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
624
625 3
						if ( 'product' === $field->type ) {
626 3
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
627
628
							// Only allow quantity to be set if it's allowed to be edited
629 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...
630
							} else { // otherwise set to what it previously was
631 3
								$_POST[ $input_name ] = $entry[ $input['id'] ];
632
							}
633
						} else {
634
							// Set to what it previously was if it's not editable
635
							if ( ! in_array( $field_id, $allowed_fields ) ) {
636
								$_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...
637
							}
638
						}
639
640 3
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
641
				    }
642
				} else {
643
					// Set to what it previously was if it's not editable
644 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
645 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
646
					}
647 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
648
				}
649
			}
650
651 4
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
652 4
				GFFormsModel::commit_batch_field_operations();
653
			}
654
		}
655 13
	}
656
657
	/**
658
	 * Handle updating the Post Image field
659
	 *
660
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
661
	 *
662
	 * @since 1.17
663
	 *
664
	 * @uses GFFormsModel::media_handle_upload
665
	 * @uses set_post_thumbnail
666
	 *
667
	 * @param array $form GF Form array
668
	 * @param GF_Field $field GF Field
669
	 * @param string $field_id Numeric ID of the field
670
	 * @param string $value
671
	 * @param array $entry GF Entry currently being edited
672
	 * @param int $post_id ID of the Post being edited
673
	 *
674
	 * @return mixed|string
675
	 */
676 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
677
678 1
		$input_name = 'input_' . $field_id;
679
680 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
681
682
			// We have a new image
683
684
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
685
686
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
687
	        $ary = stripslashes_deep( $ary );
688
			$img_url = \GV\Utils::get( $ary, 0 );
689
690
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
691
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
692
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
693
694
			$image_meta = array(
695
				'post_excerpt' => $img_caption,
696
				'post_content' => $img_description,
697
			);
698
699
			//adding title only if it is not empty. It will default to the file name if it is not in the array
700
			if ( ! empty( $img_title ) ) {
701
				$image_meta['post_title'] = $img_title;
702
			}
703
704
			/**
705
			 * 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.
706
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
707
			 */
708
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
709
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
710
711
			// is this field set as featured image?
712
			if ( $media_id && $field->postFeaturedImage ) {
713
				set_post_thumbnail( $post_id, $media_id );
714
			}
715
716 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
717
718 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...
719 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
720 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
721 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
722
723 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...
724
725 1
			if ( $field->postFeaturedImage ) {
726
727
				$image_meta = array(
728 1
					'ID' => get_post_thumbnail_id( $post_id ),
729 1
					'post_title' => $img_title,
730 1
					'post_excerpt' => $img_caption,
731 1
					'post_content' => $img_description,
732
				);
733
734
				// update image title, caption or description
735 1
				wp_update_post( $image_meta );
736
			}
737
		} else {
738
739
			// if we get here, image was removed or not set.
740
			$value = '';
741
742
			if ( $field->postFeaturedImage ) {
743
				delete_post_thumbnail( $post_id );
744
			}
745
		}
746
747 1
		return $value;
748
	}
749
750
	/**
751
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
752
	 *
753
	 * @param array $form Gravity Forms form
754
	 *
755
	 * @return void
756
	 */
757 13
	private function maybe_update_post_fields( $form ) {
758
759 13
		if( empty( $this->entry['post_id'] ) ) {
760 12
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
761 12
			return;
762
		}
763
764 1
		$post_id = $this->entry['post_id'];
765
766
		// Security check
767 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
768
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
769
			return;
770
		}
771
772 1
		$update_entry = false;
773
774 1
		$updated_post = $original_post = get_post( $post_id );
775
776 1
		foreach ( $this->entry as $field_id => $value ) {
777
778 1
			$field = RGFormsModel::get_field( $form, $field_id );
779
780 1
			if( ! $field ) {
781 1
				continue;
782
			}
783
784 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
785
786
				// Get the value of the field, including $_POSTed value
787 1
				$value = RGFormsModel::get_field_value( $field );
788
789
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
790 1
				$entry_tmp = $this->entry;
791 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...
792
793 1
				switch( $field->type ) {
794
795 1
				    case 'post_title':
796
				        $post_title = $value;
797
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
798
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
799
				        }
800
				        $updated_post->post_title = $post_title;
801
				        $updated_post->post_name  = $post_title;
802
				        unset( $post_title );
803
				        break;
804
805 1
				    case 'post_content':
806
				        $post_content = $value;
807
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
808
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
809
				        }
810
				        $updated_post->post_content = $post_content;
811
				        unset( $post_content );
812
				        break;
813 1
				    case 'post_excerpt':
814
				        $updated_post->post_excerpt = $value;
815
				        break;
816 1
				    case 'post_tags':
817
				        wp_set_post_tags( $post_id, $value, false );
818
				        break;
819 1
				    case 'post_category':
820
				        break;
821 1
				    case 'post_custom_field':
822
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
823
							$value = $value[ $field_id ];
824
						}
825
826
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
827
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
828
				        }
829
830
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
831
832
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
833
				        break;
834
835 1
				    case 'post_image':
836 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
837 1
				        break;
838
839
				}
840
841
				// update entry after
842 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...
843
844 1
				$update_entry = true;
845
846 1
				unset( $entry_tmp );
847
			}
848
849
		}
850
851 1
		if( $update_entry ) {
852
853 1
			$return_entry = GFAPI::update_entry( $this->entry );
854
855 1
			if( is_wp_error( $return_entry ) ) {
856
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
857
			} else {
858 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
859
			}
860
861
		}
862
863 1
		$return_post = wp_update_post( $updated_post, true );
864
865 1
		if( is_wp_error( $return_post ) ) {
866
			$return_post->add_data( $updated_post, '$updated_post' );
867
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
868
		} else {
869 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
870
		}
871 1
	}
872
873
	/**
874
	 * Convert a field content template into prepared output
875
	 *
876
	 * @uses GravityView_GFFormsModel::get_post_field_images()
877
	 *
878
	 * @since 1.17
879
	 *
880
	 * @param string $template The content template for the field
881
	 * @param array $form Gravity Forms form
882
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
883
	 *
884
	 * @return string
885
	 */
886
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
887
888
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
889
890
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
891
892
		//replacing post image variables
893
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
894
895
		//replacing all other variables
896
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
897
898
		// replace conditional shortcodes
899
		if( $do_shortcode ) {
900
			$output = do_shortcode( $output );
901
		}
902
903
		return $output;
904
	}
905
906
907
	/**
908
	 * Perform actions normally performed after updating a lead
909
	 *
910
	 * @since 1.8
911
	 *
912
	 * @see GFEntryDetail::lead_detail_page()
913
	 *
914
	 * @return void
915
	 */
916 13
	private function after_update() {
917
918 13
		do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
919 13
		do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
920
921
		// Re-define the entry now that we've updated it.
922 13
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
923
924 13
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
925
926 13
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
927
			// We need to clear the cache because Gravity Forms caches the field values, which
928
			// we have just updated.
929
			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...
930
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
931
			}
932
		}
933
934
		/**
935
		 * Maybe process feeds.
936
		 *
937
		 * @since develop
938
		 */
939 13
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
940 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
941 1
			if ( ! is_wp_error( $feeds ) ) {
942 1
				$registered_feeds = array();
943 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
944 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
945 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
946 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
947 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
948
						}
949
					}
950
				}
951 1
				foreach ( $feeds as $feed ) {
952 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
953 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
954 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
955 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
956
								$entry = $returned_entry;
957
							}
958
959 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
960 1
							$slug = $feed_object->get_slug();
961 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
962
						}
963
					}
964
				}
965
			}
966
		}
967
968 13
		$this->entry = $entry;
969 13
	}
970
971
972
	/**
973
	 * Display the Edit Entry form
974
	 *
975
	 * @return void
976
	 */
977 14
	public function edit_entry_form() {
978
979
		?>
980
981
		<div class="gv-edit-entry-wrapper"><?php
982
983 14
			$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...
984
985
			/**
986
			 * Fixes weird wpautop() issue
987
			 * @see https://github.com/katzwebservices/GravityView/issues/451
988
			 */
989 14
			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...
990
991
			?><h2 class="gv-edit-entry-title">
992
				<span><?php
993
994
				    /**
995
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
996
				     * @param string $edit_entry_title Modify the "Edit Entry" title
997
				     * @param GravityView_Edit_Entry_Render $this This object
998
				     */
999 14
				    $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...
1000
1001 14
				    echo esc_attr( $edit_entry_title );
1002
			?></span>
1003
			</h2>
1004
1005
			<?php $this->maybe_print_message(); ?>
1006
1007
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
1008
1009
			<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...
1010
1011
				<?php
1012
1013 14
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
1014
1015 14
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
1016
1017
				// Print the actual form HTML
1018 14
				$this->render_edit_form();
1019
1020
				?>
1021 14
			</form>
1022
1023
			<script>
1024
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1025
				    return false;
1026
				});
1027
			</script>
1028
1029
		</div>
1030
1031
	<?php
1032 14
	}
1033
1034
	/**
1035
	 * Display success or error message if the form has been submitted
1036
	 *
1037
	 * @uses GVCommon::generate_notice
1038
	 *
1039
	 * @since 1.16.2.2
1040
	 *
1041
	 * @return void
1042
	 */
1043 14
	private function maybe_print_message() {
1044
1045 14
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1046
1047 13
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1048
1049 13
			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...
1050
1051
				// Keeping this compatible with Gravity Forms.
1052
				$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...
1053
				$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...
1054
1055
				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...
1056
1057
			} else {
1058 13
				$view = \GV\View::by_id( $this->view_id );
1059 13
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1060 13
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1061
1062
				switch ( $edit_redirect ) {
1063
1064 13
                    case '0':
1065 1
	                    $redirect_url = $back_link;
1066 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...
1067 1
                        break;
1068
1069 12
                    case '1':
1070 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1071 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...
1072 1
	                    break;
1073
1074 11
                    case '2':
1075 1
	                    $redirect_url = $edit_redirect_url;
1076 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1077 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...
1078 1
                        break;
1079
1080 10
                    case '':
1081
                    default:
1082 10
					    $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...
1083 10
                        break;
1084
				}
1085
1086 13
				if ( isset( $redirect_url ) ) {
1087 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 ) );
1088
				}
1089
1090
				/**
1091
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1092
				 * @since 1.5.4
1093
				 * @param string $entry_updated_message Existing message
1094
				 * @param int $view_id View ID
1095
				 * @param array $entry Gravity Forms entry array
1096
				 * @param string $back_link URL to return to the original entry. @since 1.6
1097
				 */
1098 13
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1099
1100 13
				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...
1101
			}
1102
1103
		}
1104 14
	}
1105
1106
	/**
1107
	 * Display the Edit Entry form in the original Gravity Forms format
1108
	 *
1109
	 * @since 1.9
1110
	 *
1111
	 * @return void
1112
	 */
1113 14
	private function render_edit_form() {
1114
1115
		/**
1116
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1117
		 * @since 1.17
1118
		 * @param GravityView_Edit_Entry_Render $this
1119
		 */
1120 14
		do_action( 'gravityview/edit-entry/render/before', $this );
1121
1122 14
		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...
1123 14
		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...
1124 14
		add_filter( 'gform_disable_view_counter', '__return_true' );
1125
1126 14
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1127 14
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1128
1129
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1130 14
		unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1131
1132
		// TODO: Verify multiple-page forms
1133
1134 14
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1135
1136 14
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1137
1138 14
		ob_get_clean();
1139
1140 14
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1141 14
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1142 14
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1143 14
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1144 14
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1145
1146 14
		echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
1147
1148
		/**
1149
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1150
		 * @since 1.17
1151
		 * @param GravityView_Edit_Entry_Render $this
1152
		 */
1153 14
		do_action( 'gravityview/edit-entry/render/after', $this );
1154 14
	}
1155
1156
	/**
1157
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1158
	 * @since 1.8
1159
	 * @return string
1160
	 */
1161 14
	public function render_form_buttons() {
1162 14
		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...
1163
	}
1164
1165
1166
	/**
1167
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1168
	 *
1169
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1170
	 *
1171
	 * @param array $form
1172
	 * @param boolean $ajax Whether in AJAX mode
1173
	 * @param array|string $field_values Passed parameters to the form
1174
	 *
1175
	 * @since 1.9
1176
	 *
1177
	 * @return array Modified form array
1178
	 */
1179 14
	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...
1180
1181
		// In case we have validated the form, use it to inject the validation results into the form render
1182 14
		if( isset( $this->form_after_validation ) ) {
1183 13
			$form = $this->form_after_validation;
1184
		} else {
1185 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1186
		}
1187
1188 14
		$form = $this->filter_conditional_logic( $form );
1189
1190 14
		$form = $this->prefill_conditional_logic( $form );
1191
1192
		// for now we don't support Save and Continue feature.
1193 14
		if( ! self::$supports_save_and_continue ) {
1194 14
	        unset( $form['save'] );
1195
		}
1196
1197 14
		$form = $this->unselect_default_values( $form );
1198
1199 14
		return $form;
1200
	}
1201
1202
	/**
1203
	 * 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.
1204
	 *
1205
	 * @since 1.16.2.2
1206
	 *
1207
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1208
	 * @param GF_Field $field
1209
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1210
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1211
	 * @param int $form_id Form ID
1212
	 *
1213
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1214
	 */
1215 14
	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...
1216
1217 14
		if( ! GFCommon::is_post_field( $field ) ) {
1218 14
			return $field_content;
1219
		}
1220
1221 2
        $message = null;
1222
1223
        // First, make sure they have the capability to edit the post.
1224 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1225
1226
            /**
1227
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1228
             * @param string $message The existing "You don't have permission..." text
1229
             */
1230 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...
1231
1232 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1233
            /**
1234
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1235
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1236
             */
1237
            $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...
1238
        }
1239
1240 2
        if( $message ) {
1241 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...
1242
        }
1243
1244 2
        return $field_content;
1245
	}
1246
1247
	/**
1248
	 *
1249
	 * Fill-in the saved values into the form inputs
1250
	 *
1251
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1252
	 * @param GF_Field $field
1253
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1254
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1255
	 * @param int $form_id Form ID
1256
	 *
1257
	 * @return mixed
1258
	 */
1259 14
	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...
1260
1261 14
		$gv_field = GravityView_Fields::get_associated_field( $field );
1262
1263
		// If the form has been submitted, then we don't need to pre-fill the values,
1264
		// Except for fileupload type and when a field input is overridden- run always!!
1265
		if(
1266 14
			( $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...
1267 14
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1268
			&& ! GFCommon::is_product_field( $field->type )
1269 14
			|| ! empty( $field_content )
1270 14
			|| in_array( $field->type, array( 'honeypot' ) )
1271
		) {
1272 1
	        return $field_content;
1273
		}
1274
1275
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1276 14
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1277
1278 14
		$field_value = $this->get_field_value( $field );
1279
1280
	    // Prevent any PHP warnings, like undefined index
1281 14
	    ob_start();
1282
1283 14
	    $return = null;
1284
1285
		/** @var GravityView_Field $gv_field */
1286 14
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1287 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1288
		} else {
1289 14
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1290
	    }
1291
1292
	    // If there was output, it's an error
1293 14
	    $warnings = ob_get_clean();
1294
1295 14
	    if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1296
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1297
	    }
1298
1299 14
		return $return;
1300
	}
1301
1302
	/**
1303
	 * Modify the value for the current field input
1304
	 *
1305
	 * @param GF_Field $field
1306
	 *
1307
	 * @return array|mixed|string
1308
	 */
1309 14
	private function get_field_value( $field ) {
1310
1311
		/**
1312
		 * @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.
1313
		 * @param boolean True: override saved values; False: don't override (default)
1314
		 * @param $field GF_Field object Gravity Forms field object
1315
		 * @since 1.13
1316
		 */
1317 14
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1318
1319
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1320 14
		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...
1321
1322 4
			$field_value = array();
1323
1324
			// only accept pre-populated values if the field doesn't have any choice selected.
1325 4
			$allow_pre_populated = $field->allowsPrepopulate;
1326
1327 4
			foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1328
1329 4
				$input_id = strval( $input['id'] );
1330
1331 4
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1332 4
				    $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...
1333 4
				    $allow_pre_populated = false;
1334
				}
1335
1336
			}
1337
1338 4
			$pre_value = $field->get_value_submission( array(), false );
1339
1340 4
			$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...
1341
1342
		} else {
1343
1344 14
			$id = intval( $field->id );
1345
1346
			// get pre-populated value if exists
1347 14
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1348
1349
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1350
			// or pre-populated value if not empty and set to override saved value
1351 14
			$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...
1352
1353
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1354 14
			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...
1355
				$categories = array();
1356
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1357
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1358
				}
1359
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1360
			}
1361
1362
		}
1363
1364
		// if value is empty get the default value if defined
1365 14
		$field_value = $field->get_value_default_if_empty( $field_value );
1366
1367
	    /**
1368
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1369
	     * @since 1.11
1370
	     * @since 1.20 Added third param
1371
	     * @param mixed $field_value field value used to populate the input
1372
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1373
	     * @param GravityView_Edit_Entry_Render $this Current object
1374
	     */
1375 14
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1376
1377
	    /**
1378
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1379
	     * @since 1.17
1380
	     * @since 1.20 Added third param
1381
	     * @param mixed $field_value field value used to populate the input
1382
	     * @param GF_Field $field Gravity Forms field object
1383
	     * @param GravityView_Edit_Entry_Render $this Current object
1384
	     */
1385 14
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1386
1387 14
		return $field_value;
1388
	}
1389
1390
1391
	// ---- Entry validation
1392
1393
	/**
1394
	 * Add field keys that Gravity Forms expects.
1395
	 *
1396
	 * @see GFFormDisplay::validate()
1397
	 * @param  array $form GF Form
1398
	 * @return array       Modified GF Form
1399
	 */
1400 13
	public function gform_pre_validation( $form ) {
1401
1402 13
		if( ! $this->verify_nonce() ) {
1403
			return $form;
1404
		}
1405
1406
		// Fix PHP warning regarding undefined index.
1407 13
		foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1408
1409
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1410
			// expects certain field array items to be set.
1411 13
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1412 13
	            $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...
1413
			}
1414
1415 13
			switch( RGFormsModel::get_input_type( $field ) ) {
1416
1417
				/**
1418
				 * 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.
1419
				 *
1420
				 * 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.
1421
				 *
1422
				 * @hack
1423
				 */
1424 13
				case 'fileupload':
1425
1426
				    // Set the previous value
1427 1
				    $entry = $this->get_entry();
1428
1429 1
				    $input_name = 'input_'.$field->id;
1430 1
				    $form_id = $form['id'];
1431
1432 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...
1433
1434
				    // Use the previous entry value as the default.
1435 1
				    if( isset( $entry[ $field->id ] ) ) {
1436 1
				        $value = $entry[ $field->id ];
1437
				    }
1438
1439
				    // If this is a single upload file
1440 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...
1441 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1442 1
				        $value = $file_path['url'];
1443
1444
				    } else {
1445
1446
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1447
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1448 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...
1449
1450
				    }
1451
1452 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...
1453
1454
				        // If there are fresh uploads, process and merge them.
1455
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1456 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...
1457
				            $value = empty( $value ) ? '[]' : $value;
1458
				            $value = stripslashes_deep( $value );
1459 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...
1460
				        }
1461
1462
				    } else {
1463
1464
				        // A file already exists when editing an entry
1465
				        // We set this to solve issue when file upload fields are required.
1466 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1467
1468
				    }
1469
1470 1
				    $this->entry[ $input_name ] = $value;
1471 1
				    $_POST[ $input_name ] = $value;
1472
1473 1
				    break;
1474
1475 13
				case 'number':
1476
				    // Fix "undefined index" issue at line 1286 in form_display.php
1477 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...
1478 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...
1479
				    }
1480 9
				    break;
1481
			}
1482
1483
		}
1484
1485 13
		return $form;
1486
	}
1487
1488
1489
	/**
1490
	 * Process validation for a edit entry submission
1491
	 *
1492
	 * Sets the `is_valid` object var
1493
	 *
1494
	 * @return void
1495
	 */
1496 14
	private function validate() {
1497
1498
		/**
1499
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1500
		 * GF User Registration Add-on version > 3.x has a different class name
1501
		 * @since 1.16.2
1502
		 */
1503 14
		if ( class_exists( 'GF_User_Registration' ) ) {
1504 14
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1505
		} else  if ( class_exists( 'GFUser' ) ) {
1506
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1507
		}
1508
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1509
1510
		/**
1511
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1512
		 * You can enter whatever you want!
1513
		 * We try validating, and customize the results using `self::custom_validation()`
1514
		 */
1515 14
		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...
1516
1517
		// Needed by the validate funtion
1518 14
		$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...
1519 14
		$field_values = RGForms::post( 'gform_field_values' );
1520
1521
		// Prevent entry limit from running when editing an entry, also
1522
		// prevent form scheduling from preventing editing
1523 14
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1524
1525
		// Hide fields depending on Edit Entry settings
1526 14
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1527
1528 14
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1529
1530 14
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1531 14
	}
1532
1533
1534
	/**
1535
	 * Make validation work for Edit Entry
1536
	 *
1537
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1538
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1539
	 * fields. This goes through all the fields and if they're an invalid post field, we
1540
	 * set them as valid. If there are still issues, we'll return false.
1541
	 *
1542
	 * @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...
1543
	 * @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...
1544
	 */
1545 14
	public function custom_validation( $validation_results ) {
1546
1547 14
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1548
1549 14
		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...
1550
1551 14
		$gv_valid = true;
1552
1553 14
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1554
1555 14
			$value = RGFormsModel::get_field_value( $field );
1556 14
			$field_type = RGFormsModel::get_input_type( $field );
1557
1558
			// Validate always
1559 14
			switch ( $field_type ) {
1560
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1561
1562 14
				case 'fileupload' :
1563 14
				case 'post_image':
1564
1565
				    // in case nothing is uploaded but there are already files saved
1566 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...
1567
				        $field->failed_validation = false;
1568
				        unset( $field->validation_message );
1569
				    }
1570
1571
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1572 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...
1573
1574
				        $input_name = 'input_' . $field->id;
1575
				        //uploaded
1576
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1577
1578
				        //existent
1579
				        $entry = $this->get_entry();
1580
				        $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1581
				        if( isset( $entry[ $field->id ] ) ) {
1582
				            $value = json_decode( $entry[ $field->id ], true );
1583
				        }
1584
1585
				        // count uploaded files and existent entry files
1586
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1587
						               ( is_array( $value ) ? count( $value ) : 0 );
1588
1589
				        if( $count_files > $field->maxFiles ) {
1590
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1591
				            $field->failed_validation = 1;
1592
				            $gv_valid = false;
1593
1594
				            // in case of error make sure the newest upload files are removed from the upload input
1595
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1596
				        }
1597
1598
				    }
1599
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1600
1601 2
				    break;
1602
1603
			}
1604
1605
			// This field has failed validation.
1606 14
			if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1607
1608 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1609
1610 1
				switch ( $field_type ) {
1611
1612
				    // Captchas don't need to be re-entered.
1613 1
				    case 'captcha':
1614
1615
				        // Post Image fields aren't editable, so we un-fail them.
1616 1
				    case 'post_image':
1617
				        $field->failed_validation = false;
1618
				        unset( $field->validation_message );
1619
				        break;
1620
1621
				}
1622
1623
				// You can't continue inside a switch, so we do it after.
1624 1
				if( empty( $field->failed_validation ) ) {
1625
				    continue;
1626
				}
1627
1628
				// checks if the No Duplicates option is not validating entry against itself, since
1629
				// we're editing a stored entry, it would also assume it's a duplicate.
1630 1
				if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1631
1632
				    $entry = $this->get_entry();
1633
1634
				    // If the value of the entry is the same as the stored value
1635
				    // Then we can assume it's not a duplicate, it's the same.
1636
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1637
				        //if value submitted was not changed, then don't validate
1638
				        $field->failed_validation = false;
1639
1640
				        unset( $field->validation_message );
1641
1642
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1643
1644
				        continue;
1645
				    }
1646
				}
1647
1648
				// if here then probably we are facing the validation 'At least one field must be filled out'
1649 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...
1650
				    unset( $field->validation_message );
1651
	                $field->validation_message = false;
1652
				    continue;
1653
				}
1654
1655 1
				$gv_valid = false;
1656
1657
			}
1658
1659
		}
1660
1661 14
		$validation_results['is_valid'] = $gv_valid;
1662
1663 14
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1664
1665
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1666 14
		$this->form_after_validation = $validation_results['form'];
1667
1668 14
		return $validation_results;
1669
	}
1670
1671
1672
	/**
1673
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1674
	 * Get the current entry and set it if it's not yet set.
1675
	 * @return array Gravity Forms entry array
1676
	 */
1677 2
	public function get_entry() {
1678
1679 2
		if( empty( $this->entry ) ) {
1680
			// Get the database value of the entry that's being edited
1681 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1682
		}
1683
1684 2
		return $this->entry;
1685
	}
1686
1687
1688
1689
	// --- Filters
1690
1691
	/**
1692
	 * Get the Edit Entry fields as configured in the View
1693
	 *
1694
	 * @since 1.8
1695
	 *
1696
	 * @param int $view_id
1697
	 *
1698
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1699
	 */
1700 15
	private function get_configured_edit_fields( $form, $view_id ) {
1701
1702
		// Get all fields for form
1703 15
		if ( \GV\View::exists( $view_id ) ) {
1704 15
			$view = \GV\View::by_id( $view_id );
1705 15
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1706
		} else {
1707
			$properties = null;
1708
		}
1709
1710
		// If edit tab not yet configured, show all fields
1711 15
		$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...
1712
1713
		// Hide fields depending on admin settings
1714 15
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1715
1716
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1717 15
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1718
1719
		/**
1720
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1721
		 * @since 1.17
1722
		 * @param GF_Field[] $fields Gravity Forms form fields
1723
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1724
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1725
		 * @param int $view_id View ID
1726
		 */
1727 15
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1728
1729 15
		return $fields;
1730
	}
1731
1732
1733
	/**
1734
	 * Filter area fields based on specified conditions
1735
	 *  - This filter removes the fields that have calculation configured
1736
	 *
1737
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1738
	 * @access private
1739
	 * @param GF_Field[] $fields
1740
	 * @param array $configured_fields
1741
	 * @since  1.5
1742
	 * @return array $fields
1743
	 */
1744 14
	private function filter_fields( $fields, $configured_fields ) {
1745
1746 14
		if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1747
			return $fields;
1748
		}
1749
1750 14
		$edit_fields = array();
1751
1752 14
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1753
1754
		// First, remove blacklist or calculation fields
1755 14
		foreach ( $fields as $key => $field ) {
1756
1757
			// Remove the fields that have calculation properties and keep them to be used later
1758
			// @since 1.16.2
1759 14
			if( $field->has_calculation() ) {
1760 4
				$this->fields_with_calculation[] = $field;
1761
				// don't remove the calculation fields on form render.
1762
			}
1763
1764 14
			if( in_array( $field->type, $field_type_blacklist ) ) {
1765 2
				unset( $fields[ $key ] );
1766
			}
1767
		}
1768
1769
		// The Edit tab has not been configured, so we return all fields by default.
1770 14
		if( empty( $configured_fields ) ) {
1771 13
			return array_values( $fields );
1772
		}
1773
1774
		// The edit tab has been configured, so we loop through to configured settings
1775 1
		foreach ( $configured_fields as $configured_field ) {
1776
1777
	        /** @var GF_Field $field */
1778 1
	        foreach ( $fields as $field ) {
1779 1
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1780 1
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1781 1
				    break;
1782
				}
1783
1784
			}
1785
1786
		}
1787
1788 1
		return $edit_fields;
1789
1790
	}
1791
1792
	/**
1793
	 * Override GF Form field properties with the ones defined on the View
1794
	 * @param  GF_Field $field GF Form field object
1795
	 * @param  array $field_setting  GV field options
1796
	 * @since  1.5
1797
	 * @return array|GF_Field
1798
	 */
1799 1
	private function merge_field_properties( $field, $field_setting ) {
1800
1801 1
		$return_field = $field;
1802
1803 1
		if( empty( $field_setting['show_label'] ) ) {
1804
			$return_field->label = '';
1805 1
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1806
			$return_field->label = $field_setting['custom_label'];
1807
		}
1808
1809 1
		if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1810
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1811
		}
1812
1813
		/**
1814
		 * Normalize page numbers - avoid conflicts with page validation
1815
		 * @since 1.6
1816
		 */
1817 1
		$return_field->pageNumber = 1;
1818
1819 1
		return $return_field;
1820
1821
	}
1822
1823
	/**
1824
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1825
	 *
1826
	 * @since 1.9.1
1827
	 *
1828
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1829
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1830
	 * @param array $form GF Form array
1831
	 * @param int $view_id View ID
1832
	 *
1833
	 * @return array Possibly modified form array
1834
	 */
1835 14
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1836
1837
	    /**
1838
		 * @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
1839
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1840
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1841
	     * @since 1.9.1
1842
	     * @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.
1843
	     * @param array $form GF Form array
1844
	     * @param int $view_id View ID
1845
	     */
1846 14
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1847
1848 14
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1849
			foreach( $fields as $k => $field ) {
1850
				if( $field->adminOnly ) {
1851
				    unset( $fields[ $k ] );
1852
				}
1853
			}
1854
			return array_values( $fields );
1855
		}
1856
1857 14
	    foreach( $fields as &$field ) {
1858 14
		    $field->adminOnly = false;
1859
		}
1860
1861 14
		return $fields;
1862
	}
1863
1864
	/**
1865
	 * Checkboxes and other checkbox-based controls should not
1866
	 * display default checks in edit mode.
1867
	 *
1868
	 * https://github.com/gravityview/GravityView/1149
1869
	 *
1870
	 * @since 2.1
1871
	 *
1872
	 * @param array $form Gravity Forms array object
1873
	 *
1874
	 * @return array $form, modified to default checkboxes, radios from showing up.
1875
	 */
1876 14
	private function unselect_default_values( $form ) {
1877
1878 14
	    foreach ( $form['fields'] as &$field ) {
1879
1880 14
			if ( empty( $field->choices ) ) {
1881 14
                continue;
1882
			}
1883
1884 3
            foreach ( $field->choices as &$choice ) {
1885 3
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
1886 1
					$choice['isSelected'] = false;
1887
				}
1888
			}
1889
		}
1890
1891 14
		return $form;
1892
	}
1893
1894
	// --- Conditional Logic
1895
1896
	/**
1897
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1898
	 * the dependent fields will be blank.
1899
	 *
1900
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1901
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1902
	 *
1903
	 * @since 1.17.4
1904
	 *
1905
	 * @param array $form Gravity Forms array object
1906
	 *
1907
	 * @return array $form, modified to fix conditional
1908
	 */
1909 14
	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...
1910
1911 14
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1912 14
			return $form;
1913
		}
1914
1915
		// Have Conditional Logic pre-fill fields as if the data were default values
1916
		/** @var GF_Field $field */
1917
		foreach ( $form['fields'] as &$field ) {
1918
1919
			if( 'checkbox' === $field->type ) {
1920
				foreach ( $field->get_entry_inputs() as $key => $input ) {
1921
				    $input_id = $input['id'];
1922
				    $choice = $field->choices[ $key ];
1923
				    $value = \GV\Utils::get( $this->entry, $input_id );
1924
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
1925
				    if( $match ) {
1926
				        $field->choices[ $key ]['isSelected'] = true;
1927
				    }
1928
				}
1929
			} else {
1930
1931
				// We need to run through each field to set the default values
1932
				foreach ( $this->entry as $field_id => $field_value ) {
1933
1934
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
1935
1936
				        if( 'list' === $field->type ) {
1937
				            $list_rows = maybe_unserialize( $field_value );
1938
1939
				            $list_field_value = array();
1940
				            foreach ( (array) $list_rows as $row ) {
1941
				                foreach ( (array) $row as $column ) {
1942
				                    $list_field_value[] = $column;
1943
				                }
1944
				            }
1945
1946
				            $field->defaultValue = serialize( $list_field_value );
1947
				        } else {
1948
				            $field->defaultValue = $field_value;
1949
				        }
1950
				    }
1951
				}
1952
			}
1953
		}
1954
1955
		return $form;
1956
	}
1957
1958
	/**
1959
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
1960
	 *
1961
	 * @todo Merge with caller method
1962
	 * @since 1.9
1963
	 *
1964
	 * @param array $form Gravity Forms form
1965
	 * @return array Modified form, if not using Conditional Logic
1966
	 */
1967 14
	private function filter_conditional_logic( $form ) {
1968
1969
		/**
1970
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1971
		 * @since 1.9
1972
		 * @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
1973
		 * @param array $form Gravity Forms form
1974
		 */
1975 14
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1976
1977 14
		if( $use_conditional_logic ) {
1978 14
			return $form;
1979
		}
1980
1981
		foreach( $form['fields'] as &$field ) {
1982
			/* @var GF_Field $field */
1983
			$field->conditionalLogic = null;
1984
		}
1985
1986
		unset( $form['button']['conditionalLogic'] );
1987
1988
		return $form;
1989
1990
	}
1991
1992
	/**
1993
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
1994
	 *
1995
	 * @since 1.9
1996
	 *
1997
	 * @param $has_conditional_logic
1998
	 * @param $form
1999
	 * @return mixed
2000
	 */
2001 14
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2002
2003 14
		if( ! $this->is_edit_entry() ) {
2004
			return $has_conditional_logic;
2005
		}
2006
2007
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2008 14
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2009
	}
2010
2011
2012
	// --- User checks and nonces
2013
2014
	/**
2015
	 * Check if the user can edit the entry
2016
	 *
2017
	 * - Is the nonce valid?
2018
	 * - Does the user have the right caps for the entry
2019
	 * - Is the entry in the trash?
2020
	 *
2021
	 * @todo Move to GVCommon
2022
	 *
2023
	 * @param  boolean $echo Show error messages in the form?
2024
	 * @return boolean        True: can edit form. False: nope.
2025
	 */
2026 15
	private function user_can_edit_entry( $echo = false ) {
2027
2028 15
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
2029
2030
		/**
2031
		 *  1. Permalinks are turned off
2032
		 *  2. There are two entries embedded using oEmbed
2033
		 *  3. One of the entries has just been saved
2034
		 */
2035 15
		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...
2036
2037
			$error = true;
2038
2039
		}
2040
2041 15
		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...
2042
2043
			$error = true;
2044
2045 15
		} elseif( ! $this->verify_nonce() ) {
2046
2047
			/**
2048
			 * If the Entry is embedded, there may be two entries on the same page.
2049
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2050
			 */
2051
			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...
2052
				$error = true;
2053
			} else {
2054
				$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...
2055
			}
2056
2057
		}
2058
2059 15
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2060 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...
2061
		}
2062
2063 15
		if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
2064
			$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...
2065
		}
2066
2067
		// No errors; everything's fine here!
2068 15
		if( empty( $error ) ) {
2069 15
			return true;
2070
		}
2071
2072 1
		if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
2073
2074 1
	        $error = esc_html( $error );
2075
2076
	        /**
2077
	         * @since 1.9
2078
	         */
2079 1
	        if ( ! empty( $this->entry ) ) {
2080 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...
2081
	        }
2082
2083 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...
2084
		}
2085
2086 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2087
2088 1
		return false;
2089
	}
2090
2091
2092
	/**
2093
	 * Check whether a field is editable by the current user, and optionally display an error message
2094
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2095
	 * @param  array  $field Field or field settings array
2096
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2097
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2098
	 */
2099 1
	private function user_can_edit_field( $field, $echo = false ) {
2100
2101 1
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
2102
2103 1
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2104
			$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...
2105
		}
2106
2107
		// No errors; everything's fine here!
2108 1
		if( empty( $error ) ) {
2109 1
			return true;
2110
		}
2111
2112
		if( $echo ) {
2113
			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...
2114
		}
2115
2116
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2117
2118
		return false;
2119
2120
	}
2121
2122
2123
	/**
2124
	 * checks if user has permissions to edit a specific field
2125
	 *
2126
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2127
	 *
2128
	 * @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...
2129
	 * @return bool
2130
	 */
2131 1
	private function check_user_cap_edit_field( $field ) {
2132
2133
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2134 1
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2135 1
			return true;
2136
		}
2137
2138
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2139
2140
		if( $field_cap ) {
2141
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2142
		}
2143
2144
		return false;
2145
	}
2146
2147
2148
	/**
2149
	 * Is the current nonce valid for editing the entry?
2150
	 * @return boolean
2151
	 */
2152 14
	public function verify_nonce() {
2153
2154
		// Verify form submitted for editing single
2155 14
		if( $this->is_edit_entry_submission() ) {
2156
			$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...
2157
		}
2158
2159
		// Verify
2160 14
		else if( ! $this->is_edit_entry() ) {
2161
			$valid = false;
2162
		}
2163
2164
		else {
2165 14
			$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...
2166
		}
2167
2168
		/**
2169
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2170
		 * @since 1.13
2171
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2172
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2173
		 */
2174 14
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2175
2176 14
		return $valid;
2177
	}
2178
2179
2180
	/**
2181
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2182
	 *
2183
	 * As a hack for now we'll implode it back.
2184
	 */
2185
	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...
2186
		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...
2187
			return $field_value;
2188
		}
2189
2190
		$maybe_json = @json_decode( $field_value, true );
0 ignored issues
show
Coding Style introduced by
Silencing errors is discouraged
Loading history...
2191
2192
		if ( $maybe_json ) {
2193
			return implode( ',', $maybe_json );
2194
		}
2195
2196
		return $field_value;
2197
	}
2198
2199
2200
2201
} //end class
2202