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