Completed
Push — master ( cd1ec1...578283 )
by Zack
243:03 queued 200:08
created

manage_conditional_logic()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 2.0625

Importance

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