Completed
Push — master ( af77e8...7d9d07 )
by Zack
11s
created

GravityView_Edit_Entry_Render::verify_nonce()   B

Complexity

Conditions 3
Paths 3

Size

Total Lines 26
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 3.1406

Importance

Changes 0
Metric Value
cc 3
eloc 9
nc 3
nop 0
dl 0
loc 26
ccs 6
cts 8
cp 0.75
crap 3.1406
rs 8.8571
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
     * Updated entry is valid (GF Validation object)
97
     *
98
     * @var array
99
     */
100
	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...
101
102 2
    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...
103 2
        $this->loader = $loader;
104 2
    }
105
106 2
    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...
107
108
        /** @define "GRAVITYVIEW_DIR" "../../../" */
109 2
        include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
110
111
        // Don't display an embedded form when editing an entry
112 2
        add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
113 2
        add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
114
115
        // Stop Gravity Forms processing what is ours!
116 2
        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...
117
118 2
        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...
119
120 2
        add_action( 'gravityview_edit_entry', array( $this, 'init' ) );
121
122
        // Disable conditional logic if needed (since 1.9)
123 2
        add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
124
125
        // Make sure GF doesn't validate max files (since 1.9)
126 2
        add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
127
128
        // Add fields expected by GFFormDisplay::validate()
129 2
        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...
130
131 2
    }
132
133
    /**
134
     * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
135
     *
136
     * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
137
     * And then removes it on the `wp_footer` action
138
     *
139
     * @since 1.16.1
140
     *
141
     * @return void
142
     */
143 1
    public function prevent_render_form() {
144 1
        if( $this->is_edit_entry() ) {
145 1
            if( 'wp_head' === current_filter() ) {
146 1
                add_filter( 'gform_shortcode_form', '__return_empty_string' );
147
            } else {
148 1
                remove_filter( 'gform_shortcode_form', '__return_empty_string' );
149
            }
150
        }
151 1
    }
152
153
    /**
154
     * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
155
     * backend form, we need to prevent them from saving twice.
156
     * @return void
157
     */
158
    public function prevent_maybe_process_form() {
159
160
        if( ! empty( $_POST ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
161
	        do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[prevent_maybe_process_form] $_POSTed data (sanitized): ', 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...
162
        }
163
164
        if( $this->is_edit_entry_submission() ) {
165
            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...
166
	        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...
167
        }
168
    }
169
170
    /**
171
     * Is the current page an Edit Entry page?
172
     * @return boolean
173
     */
174 3
    public function is_edit_entry() {
175
176 3
        $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...
177
178 3
        return ( $is_edit_entry || $this->is_edit_entry_submission() );
179
    }
180
181
	/**
182
	 * Is the current page an Edit Entry page?
183
	 * @since 1.9
184
	 * @return boolean
185
	 */
186 2
	public function is_edit_entry_submission() {
187 2
		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...
188
	}
189
190
    /**
191
     * When Edit entry view is requested setup the vars
192
     */
193 2
    private function setup_vars() {
194 2
        $gravityview_view = GravityView_View::getInstance();
195
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
196
197 2
        $entries = $gravityview_view->getEntries();
198 2
	    self::$original_entry = $entries[0];
199 2
	    $this->entry = $entries[0];
200
201 2
        self::$original_form = $gravityview_view->getForm();
202 2
        $this->form = $gravityview_view->getForm();
203 2
        $this->form_id = $gravityview_view->getFormId();
204 2
        $this->view_id = $gravityview_view->getViewId();
205
206 2
        self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
207 2
    }
208
209
210
    /**
211
     * Load required files and trigger edit flow
212
     *
213
     * Run when the is_edit_entry returns true.
214
     *
215
     * @param GravityView_View_Data $gv_data GravityView Data object
216
     * @return void
217
     */
218 3
    public function init( $gv_data ) {
219
220 3
        require_once( GFCommon::get_base_path() . '/form_display.php' );
221 3
        require_once( GFCommon::get_base_path() . '/entry_detail.php' );
222
223 3
        $this->setup_vars();
224
225
        // Multiple Views embedded, don't proceed if nonce fails
226 3
		$multiple_views = defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? gravityview()->views->count() > 1 : $gv_data->has_multiple_views();
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
227 3
        if( $multiple_views && ! 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...
228
            do_action('gravityview_log_error', __METHOD__ . ': Nonce validation failed for the Edit Entry request; returning' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
229
            return;
230
        }
231
232
        // Sorry, you're not allowed here.
233 3
        if( false === $this->user_can_edit_entry( true ) ) {
234 1
            do_action('gravityview_log_error', __METHOD__ . ': User is not allowed to edit this entry; returning', $this->entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
235 1
            return;
236
        }
237
238 3
        $this->print_scripts();
239
240 3
        $this->process_save();
241
242 3
        $this->edit_entry_form();
243
244 3
    }
245
246
247
    /**
248
     * Force Gravity Forms to output scripts as if it were in the admin
249
     * @return void
250
     */
251 2
    private function print_scripts() {
252 2
        $gravityview_view = GravityView_View::getInstance();
253
254 2
        wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
255
256 2
        GFFormDisplay::enqueue_form_scripts($gravityview_view->getForm(), false);
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...
257
258
        // Sack is required for images
259 2
        wp_print_scripts( array( 'sack', 'gform_gravityforms' ) );
260 2
    }
261
262
263
    /**
264
     * Process edit entry form save
265
     */
266 3
    private function process_save() {
267
268 3
        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...
269 3
            return;
270
        }
271
272
        // Make sure the entry, view, and form IDs are all correct
273 3
        $valid = $this->verify_nonce();
274
275 3
        if( !$valid ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
276
            do_action('gravityview_log_error', __METHOD__ . ' Nonce validation failed.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
277
            return;
278
        }
279
280 3
        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...
281
            do_action('gravityview_log_error', __METHOD__ . ' Entry ID did not match posted entry ID.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
282
            return;
283
        }
284
285 3
        do_action('gravityview_log_debug', __METHOD__ . ': $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
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...
286
287 3
        $this->process_save_process_files( $this->form_id );
288
289 3
        $this->validate();
290
291 3
        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...
292
293 3
            do_action('gravityview_log_debug', __METHOD__ . ': Submission is valid.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
294
295
            /**
296
             * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
297
             */
298 3
            $form = $this->form_prepare_for_save();
299
300
            /**
301
             * @hack to avoid the capability validation of the method save_lead for GF 1.9+
302
             */
303 3
            unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
304
305 3
            $date_created = $this->entry['date_created'];
306
307
            /**
308
             * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
309
             * @since 1.17.2
310
             */
311 3
            unset( $this->entry['date_created'] );
312
313 3
            GFFormsModel::save_lead( $form, $this->entry );
314
315
	        // Delete the values for hidden inputs
316 3
	        $this->unset_hidden_field_values();
317
            
318 3
            $this->entry['date_created'] = $date_created;
319
320
            // Process calculation fields
321 3
            $this->update_calculation_fields();
322
323
            // Perform actions normally performed after updating a lead
324 3
            $this->after_update();
325
326
	        /**
327
             * Must be AFTER after_update()!
328
             * @see https://github.com/gravityview/GravityView/issues/764
329
             */
330 3
            $this->maybe_update_post_fields( $form );
331
332
            /**
333
             * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
334
             * @param array $form Gravity Forms form array
335
             * @param string $entry_id Numeric ID of the entry that was updated
336
             * @param GravityView_Edit_Entry_Render $this This object
337
             */
338 3
            do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this );
339
340
        } else {
341
            do_action('gravityview_log_error', __METHOD__ . ': Submission is NOT valid.', $this->entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
342
        }
343
344 3
    } // process_save
345
346
	/**
347
	 * Delete the value of fields hidden by conditional logic when the entry is edited
348
     *
349
     * @uses GFFormsModel::update_lead_field_value()
350
     *
351
     * @since 1.17.4
352
     *
353
     * @return void
354
	 */
355 2
    private function unset_hidden_field_values() {
356 2
	    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...
357
358 2
	    $lead_detail_table      = GFFormsModel::get_lead_details_table_name();
359 2
	    $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...
360
361 2
	    foreach ( $this->entry as $input_id => $field_value ) {
362
363 2
		    $field = RGFormsModel::get_field( $this->form, $input_id );
364
365
		    // Reset fields that are hidden
366
		    // Don't pass $entry as fourth parameter; force using $_POST values to calculate conditional logic
367 2
		    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...
368
369
		        // List fields are stored as empty arrays when empty
370
			    $empty_value = $this->is_field_json_encoded( $field ) ? '[]' : '';
371
372
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
373
374
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
375
376
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
377
                // after submission
378
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
379 2
			    $_POST[ $post_input_id ] = '';
380
		    }
381
	    }
382 2
    }
383
384
    /**
385
     * Have GF handle file uploads
386
     *
387
     * Copy of code from GFFormDisplay::process_form()
388
     *
389
     * @param int $form_id
390
     */
391 2
    private function process_save_process_files( $form_id ) {
392
393
        //Loading files that have been uploaded to temp folder
394 2
        $files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
395 2
        if ( ! is_array( $files ) ) {
396 2
            $files = array();
397
        }
398
399
		/**
400
		 * Make sure the fileuploads are not overwritten if no such request was done.
401
         * @since 1.20.1
402
		 */
403 2
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
404
405 2
        RGFormsModel::$uploaded_files[ $form_id ] = $files;
406 2
    }
407
408
	/**
409
	 * Make sure the fileuploads are not overwritten if no such request was done.
410
	 *
411
     * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
412
     *
413
	 * @since 1.20.1
414
	 *
415
	 * @param string $value Field value
416
	 * @param array $entry GF entry array
417
	 * @param GF_Field_FileUpload $field
418
	 * @param array $form GF form array
419
	 * @param string $input_id ID of the input being saved
420
	 *
421
	 * @return string
422
	 */
423 2
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
424
425 2
		if ( ! $field || $field->type != 'fileupload' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
426 2
			return $value;
427
		}
428
429 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
430
431 1
		if ( $field->multipleFiles ) {
432
			if ( empty( $value ) ) {
433
				return json_decode( $entry[ $input_id ], true );
434
			}
435
			return $value;
436
		}
437
438
		/** No file is being uploaded. */
439 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
440
			/** So return the original upload */
441 1
			return $entry[ $input_id ];
442
		}
443
444 1
		return $value;
445
	}
446
447
    /**
448
     * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
449
     * Late validation done on self::custom_validation
450
     *
451
     * @param $plupload_init array Plupload settings
452
     * @param $form_id
453
     * @param $instance
454
     * @return mixed
455
     */
456 1
    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...
457 1
        if( ! $this->is_edit_entry() ) {
458
            return $plupload_init;
459
        }
460
461 1
        $plupload_init['gf_vars']['max_files'] = 0;
462
463 1
        return $plupload_init;
464
    }
465
466
467
    /**
468
     * Unset adminOnly and convert field input key to string
469
     * @return array $form
470
     */
471 2
    private function form_prepare_for_save() {
472
473 2
        $form = $this->form;
474
475
	    /** @var GF_Field $field */
476 2
        foreach( $form['fields'] as $k => &$field ) {
477
478
            /**
479
             * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
480
             * @since 1.16.3
481
             * @var GF_Field $field
482
             */
483 2
            if( $field->has_calculation() ) {
484
                unset( $form['fields'][ $k ] );
485
            }
486
487 2
            $field->adminOnly = false;
488
489 2
            if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
490
                foreach( $field->inputs as $key => $input ) {
491 2
                    $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...
492
                }
493
            }
494
        }
495
496 2
        return $form;
497
    }
498
499 2
    private function update_calculation_fields() {
500
501 2
        $form = self::$original_form;
502 2
        $update = false;
503
504
        // get the most up to date entry values
505 2
        $entry = GFAPI::get_entry( $this->entry['id'] );
506
507 2
        if( !empty( $this->fields_with_calculation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
508
            $update = true;
509
            foreach ( $this->fields_with_calculation as $calc_field ) {
510
                $inputs = $calc_field->get_entry_inputs();
511
                if ( is_array( $inputs ) ) {
512
                    foreach ( $inputs as $input ) {
513
                        $input_name = 'input_' . str_replace( '.', '_', $input['id'] );
514
                        $entry[ strval( $input['id'] ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
515
                    }
516
                } else {
517
                    $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...
518
                    $entry[ strval( $calc_field->id ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
519
                }
520
            }
521
522
        }
523
524 2
        if( $update ) {
525
526
            $return_entry = GFAPI::update_entry( $entry );
527
528
            if( is_wp_error( $return_entry ) ) {
529
                do_action( 'gravityview_log_error', 'Updating the entry calculation fields failed', $return_entry );
530
            } else {
531
                do_action( 'gravityview_log_debug', 'Updating the entry calculation fields succeeded' );
532
            }
533
        }
534 2
    }
535
536
    /**
537
     * Handle updating the Post Image field
538
     *
539
     * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
540
     *
541
     * @since 1.17
542
     *
543
     * @uses GFFormsModel::media_handle_upload
544
     * @uses set_post_thumbnail
545
     * 
546
     * @param array $form GF Form array
547
     * @param GF_Field $field GF Field
548
     * @param string $field_id Numeric ID of the field
549
     * @param string $value
550
     * @param array $entry GF Entry currently being edited
551
     * @param int $post_id ID of the Post being edited
552
     *
553
     * @return mixed|string
554
     */
555
    private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
556
557
        $input_name = 'input_' . $field_id;
558
559
        if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
560
561
            // We have a new image
562
563
            $value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
564
565
            $ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
566
            $img_url = rgar( $ary, 0 );
567
568
            $img_title       = count( $ary ) > 1 ? $ary[1] : '';
569
            $img_caption     = count( $ary ) > 2 ? $ary[2] : '';
570
            $img_description = count( $ary ) > 3 ? $ary[3] : '';
571
572
            $image_meta = array(
573
                'post_excerpt' => $img_caption,
574
                'post_content' => $img_description,
575
            );
576
577
            //adding title only if it is not empty. It will default to the file name if it is not in the array
578
            if ( ! empty( $img_title ) ) {
579
                $image_meta['post_title'] = $img_title;
580
            }
581
582
            /**
583
             * 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.
584
             * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
585
             */
586
            require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
587
            $media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
588
589
            // is this field set as featured image?
590
            if ( $media_id && $field->postFeaturedImage ) {
591
                set_post_thumbnail( $post_id, $media_id );
592
            }
593
594
        } elseif ( !empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
595
596
            // Same image although the image title, caption or description might have changed
597
598
            $ary = array();
599
            if( ! empty( $entry[ $field_id ] ) ) {
600
                $ary = is_array( $entry[ $field_id ] ) ? $entry[ $field_id ] : explode( '|:|', $entry[ $field_id ] );
601
            }
602
            $img_url = rgar( $ary, 0 );
603
604
            // is this really the same image or something went wrong ?
605
            if( $img_url === $_POST[ $input_name ] ) {
606
607
                $img_title       = rgar( $value, $field_id .'.1' );
608
                $img_caption     = rgar( $value, $field_id .'.4' );
609
                $img_description = rgar( $value, $field_id .'.7' );
610
611
                $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...
612
613
                if ( $field->postFeaturedImage ) {
614
615
                    $image_meta = array(
616
                        'ID' => get_post_thumbnail_id( $post_id ),
617
                        'post_title' => $img_title,
618
                        'post_excerpt' => $img_caption,
619
                        'post_content' => $img_description,
620
                    );
621
622
                    // update image title, caption or description
623
                    wp_update_post( $image_meta );
624
                }
625
            }
626
627
        } else {
628
629
            // if we get here, image was removed or not set.
630
            $value = '';
631
632
            if ( $field->postFeaturedImage ) {
633
                delete_post_thumbnail( $post_id );
634
            }
635
        }
636
637
        return $value;
638
    }
639
640
    /**
641
     * Loop through the fields being edited and if they include Post fields, update the Entry's post object
642
     *
643
     * @param array $form Gravity Forms form
644
     *
645
     * @return void
646
     */
647 2
    private function maybe_update_post_fields( $form ) {
648
649 2
        if( empty( $this->entry['post_id'] ) ) {
650 2
	        do_action( 'gravityview_log_debug', __METHOD__ . ': This entry has no post fields. Continuing...' );
651 2
            return;
652
        }
653
654
        $post_id = $this->entry['post_id'];
655
656
        // Security check
657
        if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
658
            do_action( 'gravityview_log_error', 'The current user does not have the ability to edit Post #'.$post_id );
659
            return;
660
        }
661
662
        $update_entry = false;
663
664
        $updated_post = $original_post = get_post( $post_id );
665
666
        foreach ( $this->entry as $field_id => $value ) {
667
668
            $field = RGFormsModel::get_field( $form, $field_id );
669
670
            if( ! $field ) {
671
                continue;
672
            }
673
674
            if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
675
676
                // Get the value of the field, including $_POSTed value
677
                $value = RGFormsModel::get_field_value( $field );
678
679
                // Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
680
                $entry_tmp = $this->entry;
681
                $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...
682
683
                switch( $field->type ) {
684
685
                    case 'post_title':
686
                        $post_title = $value;
687
                        if( rgar( $form, 'postTitleTemplateEnabled' ) ) {
688
                            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
689
                        }
690
                        $updated_post->post_title = $post_title;
691
                        $updated_post->post_name  = $post_title;
692
                        unset( $post_title );
693
                        break;
694
695
                    case 'post_content':
696
                        $post_content = $value;
697
                        if( rgar( $form, 'postContentTemplateEnabled' ) ) {
698
                            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
699
                        }
700
                        $updated_post->post_content = $post_content;
701
                        unset( $post_content );
702
                        break;
703
                    case 'post_excerpt':
704
                        $updated_post->post_excerpt = $value;
705
                        break;
706
                    case 'post_tags':
707
                        wp_set_post_tags( $post_id, $value, false );
708
                        break;
709
                    case 'post_category':
710
                        break;
711
                    case 'post_custom_field':
712
                        if( ! empty( $field->customFieldTemplateEnabled ) ) {
713
                            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
714
                        }
715
716
	                    if ( $this->is_field_json_encoded( $field ) && ! is_string( $value ) ) {
717
		                    $value = function_exists('wp_json_encode') ? wp_json_encode( $value ) : json_encode( $value );
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...
718
	                    }
719
720
                        update_post_meta( $post_id, $field->postCustomFieldName, $value );
721
                        break;
722
723
                    case 'post_image':
724
                        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
725
                        break;
726
727
                }
728
729
                // update entry after
730
                $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...
731
732
                $update_entry = true;
733
734
                unset( $entry_tmp );
735
            }
736
737
        }
738
739
        if( $update_entry ) {
740
741
            $return_entry = GFAPI::update_entry( $this->entry );
742
743
            if( is_wp_error( $return_entry ) ) {
744
               do_action( 'gravityview_log_error', 'Updating the entry post fields failed', array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) );
745
            } else {
746
                do_action( 'gravityview_log_debug', 'Updating the entry post fields for post #'.$post_id.' succeeded' );
747
            }
748
749
        }
750
751
        $return_post = wp_update_post( $updated_post, true );
752
753
        if( is_wp_error( $return_post ) ) {
754
            $return_post->add_data( $updated_post, '$updated_post' );
755
            do_action( 'gravityview_log_error', 'Updating the post content failed', compact( 'updated_post', 'return_post' ) );
756
        } else {
757
            do_action( 'gravityview_log_debug', 'Updating the post content for post #'.$post_id.' succeeded', $updated_post );
758
        }
759
    }
760
761
	/**
762
     * Is the field stored in a JSON-encoded manner?
763
     *
764
	 * @param GF_Field $field
765
	 *
766
	 * @return bool True: stored in DB json_encode()'d; False: not encoded
767
	 */
768
    private function is_field_json_encoded( $field ) {
769
770
	    $json_encoded = false;
771
772
        $input_type = RGFormsModel::get_input_type( $field );
773
774
	    // Only certain custom field types are supported
775
	    switch( $input_type ) {
776
		    case 'fileupload':
777
		    case 'list':
778
		    case 'multiselect':
779
			    $json_encoded = true;
780
			    break;
781
	    }
782
783
	    return $json_encoded;
784
    }
785
786
    /**
787
     * Convert a field content template into prepared output
788
     *
789
     * @uses GravityView_GFFormsModel::get_post_field_images()
790
     *
791
     * @since 1.17
792
     *
793
     * @param string $template The content template for the field
794
     * @param array $form Gravity Forms form
795
     * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
796
     *
797
     * @return string
798
     */
799
    private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
800
801
        require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
802
803
        $post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
804
805
        //replacing post image variables
806
        $output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
807
808
        //replacing all other variables
809
        $output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
810
811
        // replace conditional shortcodes
812
        if( $do_shortcode ) {
813
            $output = do_shortcode( $output );
814
        }
815
816
        return $output;
817
    }
818
819
820
    /**
821
     * Perform actions normally performed after updating a lead
822
     *
823
     * @since 1.8
824
     *
825
     * @see GFEntryDetail::lead_detail_page()
826
     *
827
     * @return void
828
     */
829 2
    private function after_update() {
830
831 2
        do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
832 2
        do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
833
834
        // Re-define the entry now that we've updated it.
835 2
        $entry = RGFormsModel::get_lead( $this->entry['id'] );
836
837 2
        $entry = GFFormsModel::set_entry_meta( $entry, $this->form );
838
839
        // We need to clear the cache because Gravity Forms caches the field values, which
840
        // we have just updated.
841 2
        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...
842 2
            GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
843
        }
844
845 2
        $this->entry = $entry;
846 2
    }
847
848
849
    /**
850
     * Display the Edit Entry form
851
     *
852
     * @return void
853
     */
854 2
    public function edit_entry_form() {
855
856
        ?>
857
858
        <div class="gv-edit-entry-wrapper"><?php
859
860 2
            $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...
861
862
            /**
863
             * Fixes weird wpautop() issue
864
             * @see https://github.com/katzwebservices/GravityView/issues/451
865
             */
866 2
            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...
867
868
            ?><h2 class="gv-edit-entry-title">
869
                <span><?php
870
871
                    /**
872
                     * @filter `gravityview_edit_entry_title` Modify the edit entry title
873
                     * @param string $edit_entry_title Modify the "Edit Entry" title
874
                     * @param GravityView_Edit_Entry_Render $this This object
875
                     */
876 2
                    $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...
877
878 2
                    echo esc_attr( $edit_entry_title );
879
            ?></span>
880
            </h2>
881
882
            <?php $this->maybe_print_message(); ?>
883
884
            <?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
885
886
            <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...
887
888
                <?php
889
890 2
                wp_nonce_field( self::$nonce_key, self::$nonce_key );
891
892 2
                wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
893
894
                // Print the actual form HTML
895 2
                $this->render_edit_form();
896
897
                ?>
898
            </form>
899
900
            <script>
901
                gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
902
                    return false;
903
                });
904
            </script>
905
906
        </div>
907
908
    <?php
909 2
    }
910
911
    /**
912
     * Display success or error message if the form has been submitted
913
     *
914
     * @uses GVCommon::generate_notice
915
     *
916
     * @since 1.16.2.2
917
     *
918
     * @return void
919
     */
920 2
    private function maybe_print_message() {
921
922 2
        if( rgpost('action') === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
923
924
            $back_link = esc_url( remove_query_arg( array( 'page', 'view', 'edit' ) ) );
925
926
            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...
927
928
                // Keeping this compatible with Gravity Forms.
929
                $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...
930
                $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...
931
932
                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...
933
934
            } else {
935
                $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...
936
937
                /**
938
                 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
939
                 * @since 1.5.4
940
                 * @param string $entry_updated_message Existing message
941
                 * @param int $view_id View ID
942
                 * @param array $entry Gravity Forms entry array
943
                 * @param string $back_link URL to return to the original entry. @since 1.6
944
                 */
945
                $message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
946
947
                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...
948
            }
949
950
        }
951 2
    }
952
953
    /**
954
     * Display the Edit Entry form in the original Gravity Forms format
955
     *
956
     * @since 1.9
957
     *
958
     * @return void
959
     */
960 2
    private function render_edit_form() {
961
962
        /**
963
         * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
964
         * @since 1.17
965
         * @param GravityView_Edit_Entry_Render $this
966
         */
967 2
        do_action( 'gravityview/edit-entry/render/before', $this );
968
969 2
        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...
970 2
        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...
971 2
        add_filter( 'gform_disable_view_counter', '__return_true' );
972
973 2
        add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
974 2
        add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
975
976
        // We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
977 2
        unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
978
979
        // TODO: Verify multiple-page forms
980
981 2
        ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
982
983 2
        $html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
984
985 2
        ob_get_clean();
986
987 2
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
988 2
        remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
989 2
        remove_filter( 'gform_disable_view_counter', '__return_true' );
990 2
        remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
991 2
        remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
992
993 2
        echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
994
995
        /**
996
         * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
997
         * @since 1.17
998
         * @param GravityView_Edit_Entry_Render $this
999
         */
1000 2
        do_action( 'gravityview/edit-entry/render/after', $this );
1001 2
    }
1002
1003
    /**
1004
     * Display the Update/Cancel/Delete buttons for the Edit Entry form
1005
     * @since 1.8
1006
     * @return string
1007
     */
1008 2
    public function render_form_buttons() {
1009 2
        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...
1010
    }
1011
1012
1013
    /**
1014
     * Modify the form fields that are shown when using GFFormDisplay::get_form()
1015
     *
1016
     * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1017
     *
1018
     * @param array $form
1019
     * @param boolean $ajax Whether in AJAX mode
1020
     * @param array|string $field_values Passed parameters to the form
1021
     *
1022
     * @since 1.9
1023
     *
1024
     * @return array Modified form array
1025
     */
1026 2
    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...
1027
1028
        // In case we have validated the form, use it to inject the validation results into the form render
1029 2
        if( isset( $this->form_after_validation ) ) {
1030 2
            $form = $this->form_after_validation;
1031
        } else {
1032 2
            $form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1033
        }
1034
1035 2
        $form = $this->filter_conditional_logic( $form );
1036
1037 2
        $form = $this->prefill_conditional_logic( $form );
1038
1039
        // for now we don't support Save and Continue feature.
1040 2
        if( ! self::$supports_save_and_continue ) {
1041 2
	        unset( $form['save'] );
1042
        }
1043
1044 2
        return $form;
1045
    }
1046
1047
    /**
1048
     * 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.
1049
     *
1050
     * @since 1.16.2.2
1051
     *
1052
     * @param string $field_content Always empty. Returning not-empty overrides the input.
1053
     * @param GF_Field $field
1054
     * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1055
     * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1056
     * @param int $form_id Form ID
1057
     *
1058
     * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1059
     */
1060 2
    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...
1061
1062 2
        if( GFCommon::is_post_field( $field ) ) {
1063
1064
            $message = null;
1065
1066
            // First, make sure they have the capability to edit the post.
1067
            if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1068
1069
                /**
1070
                 * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1071
                 * @param string $message The existing "You don't have permission..." text
1072
                 */
1073
                $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...
1074
1075
            } elseif( null === get_post( $this->entry['post_id'] ) ) {
1076
                /**
1077
                 * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1078
                 * @param string $message The existing "This field is not editable; the post no longer exists." text
1079
                 */
1080
                $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...
1081
            }
1082
1083
            if( $message ) {
1084
                $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...
1085
            }
1086
        }
1087
1088 2
        return $field_content;
1089
    }
1090
1091
    /**
1092
     *
1093
     * Fill-in the saved values into the form inputs
1094
     *
1095
     * @param string $field_content Always empty. Returning not-empty overrides the input.
1096
     * @param GF_Field $field
1097
     * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1098
     * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1099
     * @param int $form_id Form ID
1100
     *
1101
     * @return mixed
1102
     */
1103 2
    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...
1104
1105 2
        $gv_field = GravityView_Fields::get_associated_field( $field );
1106
1107
        // If the form has been submitted, then we don't need to pre-fill the values,
1108
        // Except for fileupload type and when a field input is overridden- run always!!
1109
        if(
1110 2
            ( $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...
1111 2
            && false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1112
            && ! GFCommon::is_product_field( $field->type )
1113 2
            || ! empty( $field_content )
1114 2
            || in_array( $field->type, array( 'honeypot' ) )
1115
        ) {
1116
	        return $field_content;
1117
        }
1118
1119
        // SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1120 2
        $field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1121
1122 2
        $field_value = $this->get_field_value( $field );
1123
1124
	    // Prevent any PHP warnings, like undefined index
1125 2
	    ob_start();
1126
1127 2
	    $return = null;
1128
1129
        /** @var GravityView_Field $gv_field */
1130 2
        if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1131 1
            $return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1132
        } else {
1133 2
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1134
	    }
1135
1136
	    // If there was output, it's an error
1137 2
	    $warnings = ob_get_clean();
1138
1139 2
	    if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1140
		    do_action( 'gravityview_log_error', __METHOD__ . $warnings, $field_value );
1141
	    }
1142
1143 2
        return $return;
1144
    }
1145
1146
    /**
1147
     * Modify the value for the current field input
1148
     *
1149
     * @param GF_Field $field
1150
     *
1151
     * @return array|mixed|string
1152
     */
1153 2
    private function get_field_value( $field ) {
1154
1155
        /**
1156
         * @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.
1157
         * @param boolean True: override saved values; False: don't override (default)
1158
         * @param $field GF_Field object Gravity Forms field object
1159
         * @since 1.13
1160
         */
1161 2
        $override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1162
1163
        // We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1164 2
        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...
1165
1166
            $field_value = array();
1167
1168
            // only accept pre-populated values if the field doesn't have any choice selected.
1169
            $allow_pre_populated = $field->allowsPrepopulate;
1170
1171
            foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1172
1173
                $input_id = strval( $input['id'] );
1174
                
1175
                if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1176
                    $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...
1177
                    $allow_pre_populated = false;
1178
                }
1179
1180
            }
1181
1182
            $pre_value = $field->get_value_submission( array(), false );
1183
1184
            $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...
1185
1186
        } else {
1187
1188 2
            $id = intval( $field->id );
1189
1190
            // get pre-populated value if exists
1191 2
            $pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1192
1193
            // saved field entry value (if empty, fallback to the pre-populated value, if exists)
1194
            // or pre-populated value if not empty and set to override saved value
1195 2
            $field_value = !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...
1196
1197
            // in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1198 2
            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...
1199
                $categories = array();
1200
                foreach ( explode( ',', $field_value ) as $cat_string ) {
1201
                    $categories[] = GFCommon::format_post_category( $cat_string, true );
1202
                }
1203
                $field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1204
            }
1205
1206
        }
1207
1208
        // if value is empty get the default value if defined
1209 2
        $field_value = $field->get_value_default_if_empty( $field_value );
1210
1211
	    /**
1212
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1213
	     * @since 1.11
1214
	     * @since 1.20 Added third param
1215
	     * @param mixed $field_value field value used to populate the input
1216
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1217
	     * @param GravityView_Edit_Entry_Render $this Current object
1218
	     */
1219 2
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1220
1221
	    /**
1222
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1223
	     * @since 1.17
1224
	     * @since 1.20 Added third param
1225
	     * @param mixed $field_value field value used to populate the input
1226
	     * @param GF_Field $field Gravity Forms field object
1227
	     * @param GravityView_Edit_Entry_Render $this Current object
1228
	     */
1229 2
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1230
1231 2
        return $field_value;
1232
    }
1233
1234
1235
    // ---- Entry validation
1236
1237
    /**
1238
     * Add field keys that Gravity Forms expects.
1239
     *
1240
     * @see GFFormDisplay::validate()
1241
     * @param  array $form GF Form
1242
     * @return array       Modified GF Form
1243
     */
1244 2
    public function gform_pre_validation( $form ) {
1245
1246 2
        if( ! $this->verify_nonce() ) {
1247
            return $form;
1248
        }
1249
1250
        // Fix PHP warning regarding undefined index.
1251 2
        foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1252
1253
            // This is because we're doing admin form pretending to be front-end, so Gravity Forms
1254
            // expects certain field array items to be set.
1255 2
            foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1256 2
	            $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...
1257
            }
1258
1259 2
            switch( RGFormsModel::get_input_type( $field ) ) {
1260
1261
                /**
1262
                 * 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.
1263
                 *
1264
                 * 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.
1265
                 *
1266
                 * @hack
1267
                 */
1268 2
                case 'fileupload':
1269
1270
                    // Set the previous value
1271 1
                    $entry = $this->get_entry();
1272
1273 1
                    $input_name = 'input_'.$field->id;
1274 1
                    $form_id = $form['id'];
1275
1276 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...
1277
1278
                    // Use the previous entry value as the default.
1279 1
                    if( isset( $entry[ $field->id ] ) ) {
1280 1
                        $value = $entry[ $field->id ];
1281
                    }
1282
1283
                    // If this is a single upload file
1284 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...
1285 1
                        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1286 1
                        $value = $file_path['url'];
1287
1288
                    } else {
1289
1290
                        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1291
                        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1292 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...
1293
1294
                    }
1295
1296 1
                    if( rgar($field, "multipleFiles") ) {
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 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...
1297
1298
                        // If there are fresh uploads, process and merge them.
1299
                        // Otherwise, use the passed values, which should be json-encoded array of URLs
1300 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...
1301
                            $value = empty( $value ) ? '[]' : $value;
1302
                            $value = stripslashes_deep( $value );
1303 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...
1304
                        }
1305
1306
                    } else {
1307
1308
                        // A file already exists when editing an entry
1309
                        // We set this to solve issue when file upload fields are required.
1310 1
                        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1311
1312
                    }
1313
1314 1
                    $this->entry[ $input_name ] = $value;
1315 1
                    $_POST[ $input_name ] = $value;
1316
1317 1
                    break;
1318
1319 2
                case 'number':
1320
                    // Fix "undefined index" issue at line 1286 in form_display.php
1321 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...
1322
                        $_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...
1323
                    }
1324 2
                    break;
1325
            }
1326
1327
        }
1328
1329 2
        return $form;
1330
    }
1331
1332
1333
    /**
1334
     * Process validation for a edit entry submission
1335
     *
1336
     * Sets the `is_valid` object var
1337
     *
1338
     * @return void
1339
     */
1340 3
    private function validate() {
1341
1342
        /**
1343
         * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1344
         * GF User Registration Add-on version > 3.x has a different class name
1345
         * @since 1.16.2
1346
         */
1347 3
        if ( class_exists( 'GF_User_Registration' ) ) {
1348 3
            remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1349
        } else  if ( class_exists( 'GFUser' ) ) {
1350
            remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1351
        }
1352
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1353
1354
        /**
1355
         * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1356
         * You can enter whatever you want!
1357
         * We try validating, and customize the results using `self::custom_validation()`
1358
         */
1359 3
        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...
1360
1361
        // Needed by the validate funtion
1362 3
        $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...
1363 3
        $field_values = RGForms::post( 'gform_field_values' );
1364
1365
        // Prevent entry limit from running when editing an entry, also
1366
        // prevent form scheduling from preventing editing
1367 3
        unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1368
1369
        // Hide fields depending on Edit Entry settings
1370 3
        $this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1371
1372 3
        $this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1373
1374 3
        remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1375 3
    }
1376
1377
1378
    /**
1379
     * Make validation work for Edit Entry
1380
     *
1381
     * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1382
     * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1383
     * fields. This goes through all the fields and if they're an invalid post field, we
1384
     * set them as valid. If there are still issues, we'll return false.
1385
     *
1386
     * @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...
1387
     * @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...
1388
     */
1389 3
    public function custom_validation( $validation_results ) {
1390
1391 3
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results: ', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1392
1393 3
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
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...
1394
1395 3
        $gv_valid = true;
1396
1397 3
        foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1398
1399 3
            $value = RGFormsModel::get_field_value( $field );
1400 3
            $field_type = RGFormsModel::get_input_type( $field );
1401
1402
            // Validate always
1403
            switch ( $field_type ) {
1404
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1405
1406 3
                case 'fileupload' :
1407 3
                case 'post_image':
1408
1409
                    // in case nothing is uploaded but there are already files saved
1410 1
                    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1411
                        $field->failed_validation = false;
1412
                        unset( $field->validation_message );
1413
                    }
1414
1415
                    // validate if multi file upload reached max number of files [maxFiles] => 2
1416 1
                    if( rgobj( $field, 'maxFiles') && rgobj( $field, 'multipleFiles') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1417
1418
                        $input_name = 'input_' . $field->id;
1419
                        //uploaded
1420
                        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1421
1422
                        //existent
1423
                        $entry = $this->get_entry();
1424
                        $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1425
                        if( isset( $entry[ $field->id ] ) ) {
1426
                            $value = json_decode( $entry[ $field->id ], true );
1427
                        }
1428
1429
                        // count uploaded files and existent entry files
1430
                        $count_files = count( $file_names ) + count( $value );
1431
1432
                        if( $count_files > $field->maxFiles ) {
1433
                            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1434
                            $field->failed_validation = 1;
1435
                            $gv_valid = false;
1436
1437
                            // in case of error make sure the newest upload files are removed from the upload input
1438
                            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1439
                        }
1440
1441
                    }
1442
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1443
1444 1
                    break;
1445
1446
            }
1447
1448
            // This field has failed validation.
1449 3
            if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1450
1451 1
                do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'field' => $field, 'value' => $value ) );
1452
1453
                switch ( $field_type ) {
1454
1455
                    // Captchas don't need to be re-entered.
1456 1
                    case 'captcha':
1457
1458
                        // Post Image fields aren't editable, so we un-fail them.
1459 1
                    case 'post_image':
1460
                        $field->failed_validation = false;
1461
                        unset( $field->validation_message );
1462
                        break;
1463
1464
                }
1465
1466
                // You can't continue inside a switch, so we do it after.
1467 1
                if( empty( $field->failed_validation ) ) {
1468
                    continue;
1469
                }
1470
1471
                // checks if the No Duplicates option is not validating entry against itself, since
1472
                // we're editing a stored entry, it would also assume it's a duplicate.
1473 1
                if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1474
1475
                    $entry = $this->get_entry();
1476
1477
                    // If the value of the entry is the same as the stored value
1478
                    // Then we can assume it's not a duplicate, it's the same.
1479
                    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1480
                        //if value submitted was not changed, then don't validate
1481
                        $field->failed_validation = false;
1482
1483
                        unset( $field->validation_message );
1484
1485
                        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', $entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1486
1487
                        continue;
1488
                    }
1489
                }
1490
1491
                // if here then probably we are facing the validation 'At least one field must be filled out'
1492 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...
1493
                    unset( $field->validation_message );
1494
	                $field->validation_message = false;
1495
                    continue;
1496
                }
1497
1498 3
                $gv_valid = false;
1499
1500
            }
1501
1502
        }
1503
1504 3
        $validation_results['is_valid'] = $gv_valid;
1505
1506 3
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results.', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1507
1508
        // We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1509 3
        $this->form_after_validation = $validation_results['form'];
1510
1511 3
        return $validation_results;
1512
    }
1513
1514
1515
    /**
1516
     * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1517
     * Get the current entry and set it if it's not yet set.
1518
     * @return array Gravity Forms entry array
1519
     */
1520 1
    public function get_entry() {
1521
1522 1
        if( empty( $this->entry ) ) {
1523
            // Get the database value of the entry that's being edited
1524 1
            $this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1525
        }
1526
1527 1
        return $this->entry;
1528
    }
1529
1530
1531
1532
    // --- Filters
1533
1534
    /**
1535
     * Get the Edit Entry fields as configured in the View
1536
     *
1537
     * @since 1.8
1538
     *
1539
     * @param int $view_id
1540
     *
1541
     * @return array Array of fields that are configured in the Edit tab in the Admin
1542
     */
1543 3
    private function get_configured_edit_fields( $form, $view_id ) {
1544
1545
        // Get all fields for form
1546 3
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1547 3
			if ( \GV\View::exists( $view_id ) ) {
1548 3
				$view = \GV\View::by_id( $view_id );
1549 3
				$properties = $view->fields->as_configuration();
1550
			}
1551
		} else {
1552
			/** GravityView_View_Data is deprecated. */
1553
			$properties = GravityView_View_Data::getInstance()->get_fields( $view_id );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::get_fields() has been deprecated.

This method has been deprecated.

Loading history...
1554
		}
1555
1556
        // If edit tab not yet configured, show all fields
1557 3
        $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...
1558
1559
        // Hide fields depending on admin settings
1560 3
        $fields = $this->filter_fields( $form['fields'], $edit_fields );
1561
1562
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1563 3
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1564
1565
        /**
1566
         * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1567
         * @since 1.17
1568
         * @param GF_Field[] $fields Gravity Forms form fields
1569
         * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1570
         * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1571
         * @param int $view_id View ID
1572
         */
1573 3
        $fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1574
1575 3
        return $fields;
1576
    }
1577
1578
1579
    /**
1580
     * Filter area fields based on specified conditions
1581
     *  - This filter removes the fields that have calculation configured
1582
     *
1583
     * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1584
     * @access private
1585
     * @param GF_Field[] $fields
1586
     * @param array $configured_fields
1587
     * @since  1.5
1588
     * @return array $fields
1589
     */
1590 2
    private function filter_fields( $fields, $configured_fields ) {
1591
1592 2
        if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1593
            return $fields;
1594
        }
1595
1596 2
        $edit_fields = array();
1597
1598 2
        $field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1599
1600
        // First, remove blacklist or calculation fields
1601 2
        foreach ( $fields as $key => $field ) {
1602
1603
            // Remove the fields that have calculation properties and keep them to be used later
1604
            // @since 1.16.2
1605 2
            if( $field->has_calculation() ) {
1606
                $this->fields_with_calculation[] = $field;
1607
                // don't remove the calculation fields on form render.
1608
            }
1609
1610 2
            if( in_array( $field->type, $field_type_blacklist ) ) {
1611 2
                unset( $fields[ $key ] );
1612
            }
1613
        }
1614
1615
        // The Edit tab has not been configured, so we return all fields by default.
1616 2
        if( empty( $configured_fields ) ) {
1617 2
            return $fields;
1618
        }
1619
1620
        // The edit tab has been configured, so we loop through to configured settings
1621
        foreach ( $configured_fields as $configured_field ) {
1622
1623
	        /** @var GF_Field $field */
1624
	        foreach ( $fields as $field ) {
1625
1626
                if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1627
                    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1628
                    break;
1629
                }
1630
1631
            }
1632
1633
        }
1634
1635
        return $edit_fields;
1636
1637
    }
1638
1639
    /**
1640
     * Override GF Form field properties with the ones defined on the View
1641
     * @param  GF_Field $field GF Form field object
1642
     * @param  array $field_setting  GV field options
1643
     * @since  1.5
1644
     * @return array|GF_Field
1645
     */
1646
    private function merge_field_properties( $field, $field_setting ) {
1647
1648
        $return_field = $field;
1649
1650
        if( empty( $field_setting['show_label'] ) ) {
1651
            $return_field->label = '';
1652
        } elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1653
            $return_field->label = $field_setting['custom_label'];
1654
        }
1655
1656
        if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1657
            $return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1658
        }
1659
1660
        /**
1661
         * Normalize page numbers - avoid conflicts with page validation
1662
         * @since 1.6
1663
         */
1664
        $return_field->pageNumber = 1;
1665
1666
        return $return_field;
1667
1668
    }
1669
1670
    /**
1671
     * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1672
     *
1673
     * @since 1.9.1
1674
     *
1675
     * @param array|GF_Field[] $fields Gravity Forms form fields
1676
     * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1677
     * @param array $form GF Form array
1678
     * @param int $view_id View ID
1679
     *
1680
     * @return array Possibly modified form array
1681
     */
1682 2
    private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1683
1684
	    /**
1685
         * @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
1686
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1687
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1688
	     * @since 1.9.1
1689
	     * @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.
1690
	     * @param array $form GF Form array
1691
	     * @param int $view_id View ID
1692
	     */
1693 2
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1694
1695 2
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1696
            foreach( $fields as $k => $field ) {
1697
                if( $field->adminOnly ) {
1698
                    unset( $fields[ $k ] );
1699
                }
1700
            }
1701
            return $fields;
1702
        }
1703
1704 2
	    foreach( $fields as &$field ) {
1705 2
		    $field->adminOnly = false;
1706
        }
1707
1708 2
        return $fields;
1709
    }
1710
1711
    // --- Conditional Logic
1712
1713
    /**
1714
     * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1715
     * the dependent fields will be blank.
1716
     *
1717
     * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1718
     * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1719
     *
1720
     * @since 1.17.4
1721
     *
1722
     * @param array $form Gravity Forms array object
1723
     *
1724
     * @return array $form, modified to fix conditional
1725
     */
1726 2
    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...
1727
1728 2
        if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1729 2
            return $form;
1730
        }
1731
1732
        // Have Conditional Logic pre-fill fields as if the data were default values
1733
        /** @var GF_Field $field */
1734
        foreach ( $form['fields'] as &$field ) {
1735
1736
            if( 'checkbox' === $field->type ) {
1737
                foreach ( $field->get_entry_inputs() as $key => $input ) {
1738
                    $input_id = $input['id'];
1739
                    $choice = $field->choices[ $key ];
1740
                    $value = rgar( $this->entry, $input_id );
1741
                    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
1742
                    if( $match ) {
1743
                        $field->choices[ $key ]['isSelected'] = true;
1744
                    }
1745
                }
1746
            } else {
1747
1748
                // We need to run through each field to set the default values
1749
                foreach ( $this->entry as $field_id => $field_value ) {
1750
1751
                    if( floatval( $field_id ) === floatval( $field->id ) ) {
1752
1753
                        if( 'list' === $field->type ) {
1754
                            $list_rows = maybe_unserialize( $field_value );
1755
1756
                            $list_field_value = array();
1757
                            foreach ( (array) $list_rows as $row ) {
1758
                                foreach ( (array) $row as $column ) {
1759
                                    $list_field_value[] = $column;
1760
                                }
1761
                            }
1762
1763
                            $field->defaultValue = serialize( $list_field_value );
1764
                        } else {
1765
                            $field->defaultValue = $field_value;
1766
                        }
1767
                    }
1768
                }
1769
            }
1770
        }
1771
1772
        return $form;
1773
    }
1774
1775
    /**
1776
     * Remove the conditional logic rules from the form button and the form fields, if needed.
1777
     *
1778
     * @todo Merge with caller method
1779
     * @since 1.9
1780
     *
1781
     * @param array $form Gravity Forms form
1782
     * @return array Modified form, if not using Conditional Logic
1783
     */
1784 2
    private function filter_conditional_logic( $form ) {
1785
1786
        /**
1787
         * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1788
         * @since 1.9
1789
         * @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
1790
         * @param array $form Gravity Forms form
1791
         */
1792 2
        $use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1793
1794 2
        if( $use_conditional_logic ) {
1795 2
            return $form;
1796
        }
1797
1798
        foreach( $form['fields'] as &$field ) {
1799
            /* @var GF_Field $field */
1800
            $field->conditionalLogic = null;
1801
        }
1802
1803
        unset( $form['button']['conditionalLogic'] );
1804
1805
        return $form;
1806
1807
    }
1808
1809
    /**
1810
     * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
1811
     *
1812
     * @since 1.9
1813
     *
1814
     * @param $has_conditional_logic
1815
     * @param $form
1816
     * @return mixed
1817
     */
1818 2
    public function manage_conditional_logic( $has_conditional_logic, $form ) {
1819
1820 2
        if( ! $this->is_edit_entry() ) {
1821
            return $has_conditional_logic;
1822
        }
1823
1824
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
1825 2
        return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
1826
    }
1827
1828
1829
    // --- User checks and nonces
1830
1831
    /**
1832
     * Check if the user can edit the entry
1833
     *
1834
     * - Is the nonce valid?
1835
     * - Does the user have the right caps for the entry
1836
     * - Is the entry in the trash?
1837
     *
1838
     * @todo Move to GVCommon
1839
     *
1840
     * @param  boolean $echo Show error messages in the form?
1841
     * @return boolean        True: can edit form. False: nope.
1842
     */
1843 3
    private function user_can_edit_entry( $echo = false ) {
1844
1845 3
        $error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1846
1847
        /**
1848
         *  1. Permalinks are turned off
1849
         *  2. There are two entries embedded using oEmbed
1850
         *  3. One of the entries has just been saved
1851
         */
1852 3
        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...
1853
1854
            $error = true;
1855
1856
        }
1857
1858 3
        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...
1859
1860
            $error = true;
1861
1862 3
        } elseif( ! $this->verify_nonce() ) {
1863
1864
            /**
1865
             * If the Entry is embedded, there may be two entries on the same page.
1866
             * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
1867
             */
1868
            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...
1869
                $error = true;
1870
            } else {
1871
                $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...
1872
            }
1873
1874
        }
1875
1876 3
        if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
1877 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...
1878
        }
1879
1880 3
        if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1881
            $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...
1882
        }
1883
1884
        // No errors; everything's fine here!
1885 3
        if( empty( $error ) ) {
1886 3
            return true;
1887
        }
1888
1889 1
        if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
1890
1891 1
	        $error = esc_html( $error );
1892
1893
	        /**
1894
	         * @since 1.9
1895
	         */
1896 1
	        if ( ! empty( $this->entry ) ) {
1897 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...
1898
	        }
1899
1900 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...
1901
        }
1902
1903 1
        do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_entry]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1904
1905 1
        return false;
1906
    }
1907
1908
1909
    /**
1910
     * Check whether a field is editable by the current user, and optionally display an error message
1911
     * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
1912
     * @param  array  $field Field or field settings array
1913
     * @param  boolean $echo  Whether to show error message telling user they aren't allowed
1914
     * @return boolean         True: user can edit the current field; False: nope, they can't.
1915
     */
1916
    private function user_can_edit_field( $field, $echo = false ) {
1917
1918
        $error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1919
1920
        if( ! $this->check_user_cap_edit_field( $field ) ) {
1921
            $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...
1922
        }
1923
1924
        // No errors; everything's fine here!
1925
        if( empty( $error ) ) {
1926
            return true;
1927
        }
1928
1929
        if( $echo ) {
1930
            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...
1931
        }
1932
1933
        do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_field]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1934
1935
        return false;
1936
1937
    }
1938
1939
1940
    /**
1941
     * checks if user has permissions to edit a specific field
1942
     *
1943
     * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
1944
     *
1945
     * @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...
1946
     * @return bool
1947
     */
1948
    private function check_user_cap_edit_field( $field ) {
1949
1950
        // If they can edit any entries (as defined in Gravity Forms), we're good.
1951
        if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
1952
            return true;
1953
        }
1954
1955
        $field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
1956
1957
        // If the field has custom editing capaibilities set, check those
1958
        if( $field_cap ) {
1959
            return GVCommon::has_cap( $field['allow_edit_cap'] );
1960
        }
1961
1962
        return false;
1963
    }
1964
1965
1966
    /**
1967
     * Is the current nonce valid for editing the entry?
1968
     * @return boolean
1969
     */
1970 2
    public function verify_nonce() {
1971
1972
        // Verify form submitted for editing single
1973 2
        if( $this->is_edit_entry_submission() ) {
1974
            $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...
1975
        }
1976
1977
        // Verify
1978 2
        else if( ! $this->is_edit_entry() ) {
1979
            $valid = false;
1980
        }
1981
1982
        else {
1983 2
            $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...
1984
        }
1985
1986
        /**
1987
         * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
1988
         * @since 1.13
1989
         * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
1990
         * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
1991
         */
1992 2
        $valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
1993
1994 2
        return $valid;
1995
    }
1996
1997
1998
1999
} //end class