Completed
Push — develop ( aaa44e...ca5ce1 )
by Gennady
36:00 queued 16:04
created

GravityView_Edit_Entry_Render::validate()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 36

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 11
CRAP Score 3.0327

Importance

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

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

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

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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