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