Completed
Push — develop ( 642f83...d0fd4b )
by Gennady
16:43
created

GravityView_Edit_Entry_Render::get_field_value()   D

Complexity

Conditions 20
Paths 46

Size

Total Lines 80

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 20
CRAP Score 21.8529

Importance

Changes 0
Metric Value
cc 20
nc 46
nop 1
dl 0
loc 80
ccs 20
cts 24
cp 0.8333
crap 21.8529
rs 4.1666
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 16 and the first side effect is on line 13.

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

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

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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