Completed
Push — develop ( e5d071...9b5a20 )
by Gennady
39:04 queued 15:57
created

GravityView_Edit_Entry_Render::validate()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 36

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 11
CRAP Score 3.0327

Importance

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

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

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

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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