gravityview /
GravityView
Complex classes like GravityView_Duplicate_Entry often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GravityView_Duplicate_Entry, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | final class GravityView_Duplicate_Entry { |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var string The location of this file. |
||
| 26 | */ |
||
| 27 | static $file; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * @var GravityView_Duplicate_Entry This instance. |
||
| 31 | */ |
||
| 32 | static $instance; |
||
| 33 | |||
| 34 | var $view_id; |
||
| 35 | |||
| 36 | 1 | function __construct() { |
|
|
|
|||
| 37 | |||
| 38 | 1 | self::$file = plugin_dir_path( __FILE__ ); |
|
| 39 | 1 | $this->add_hooks(); |
|
| 40 | 1 | } |
|
| 41 | |||
| 42 | /** |
||
| 43 | * @since 2.5 |
||
| 44 | */ |
||
| 45 | 1 | private function add_hooks() { |
|
| 46 | |||
| 47 | 1 | add_action( 'wp', array( $this, 'process_duplicate' ), 10000 ); |
|
| 48 | |||
| 49 | 1 | add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
|
| 50 | |||
| 51 | 1 | add_action( 'gravityview_before', array( $this, 'maybe_display_message' ) ); |
|
| 52 | |||
| 53 | // For the Duplicate Entry Link, you don't want visible to all users. |
||
| 54 | 1 | add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 ); |
|
| 55 | |||
| 56 | // Modify the field options based on the name of the field type |
||
| 57 | 1 | add_filter( 'gravityview_template_duplicate_link_options', array( $this, 'duplicate_link_field_options' ), 10, 5 ); |
|
| 58 | |||
| 59 | // add template path to check for field |
||
| 60 | 1 | add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) ); |
|
| 61 | |||
| 62 | // Entry duplication in the backend |
||
| 63 | 1 | add_action( 'gform_entries_first_column_actions', array( $this, 'make_duplicate_link_row' ), 10, 5 ); |
|
| 64 | |||
| 65 | // Handle duplicate action in the backend |
||
| 66 | 1 | add_action( 'gform_pre_entry_list', array( $this, 'maybe_duplicate_list' ) ); |
|
| 67 | 1 | } |
|
| 68 | |||
| 69 | /** |
||
| 70 | * Return the instantiated class object |
||
| 71 | * |
||
| 72 | * @since 2.5 |
||
| 73 | * @return GravityView_Duplicate_Entry |
||
| 74 | */ |
||
| 75 | 2 | static public function getInstance() { |
|
| 76 | |||
| 77 | 2 | if ( empty( self::$instance ) ) { |
|
| 78 | 1 | self::$instance = new self; |
|
| 79 | } |
||
| 80 | |||
| 81 | 2 | return self::$instance; |
|
| 82 | } |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Include this extension templates path |
||
| 86 | * |
||
| 87 | * @since 2.5 |
||
| 88 | * |
||
| 89 | * @param array $file_paths List of template paths ordered |
||
| 90 | * |
||
| 91 | * @return array File paths, with duplicate field path added at index 117 |
||
| 92 | */ |
||
| 93 | 2 | public function add_template_path( $file_paths ) { |
|
| 94 | |||
| 95 | // Index 100 is the default GravityView template path. |
||
| 96 | // Index 110 is Edit Entry link |
||
| 97 | 2 | $file_paths[ 117 ] = self::$file; |
|
| 98 | |||
| 99 | 2 | return $file_paths; |
|
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Add "Duplicate Link Text" setting to the edit_link field settings |
||
| 104 | * |
||
| 105 | * @since 2.5 |
||
| 106 | * |
||
| 107 | * @param array $field_options [description] |
||
| 108 | * @param [type] $template_id [description] |
||
| 109 | * @param [type] $field_id [description] |
||
| 110 | * @param [type] $context [description] |
||
| 111 | * @param [type] $input_type [description] |
||
| 112 | * |
||
| 113 | * @return array [description] |
||
| 114 | */ |
||
| 115 | public function duplicate_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
||
| 116 | |||
| 117 | // Always a link, never a filter, always same window |
||
| 118 | unset( $field_options['show_as_link'], $field_options['search_filter'], $field_options['new_window'] ); |
||
| 119 | |||
| 120 | // Duplicate Entry link should only appear to visitors capable of editing entries |
||
| 121 | unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
||
| 122 | |||
| 123 | $add_option['duplicate_link'] = array( |
||
| 124 | 'type' => 'text', |
||
| 125 | 'label' => __( 'Duplicate Link Text', 'gravityview' ), |
||
| 126 | 'desc' => NULL, |
||
| 127 | 'value' => __( 'Duplicate Entry', 'gravityview' ), |
||
| 128 | 'merge_tags' => true, |
||
| 129 | ); |
||
| 130 | |||
| 131 | $field_options['allow_duplicate_cap'] = array( |
||
| 132 | 'type' => 'select', |
||
| 133 | 'label' => __( 'Allow the following users to duplicate the entry:', 'gravityview' ), |
||
| 134 | 'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ), |
||
| 135 | 'tooltip' => 'allow_duplicate_cap', |
||
| 136 | 'class' => 'widefat', |
||
| 137 | 'value' => 'read', // Default: entry creator |
||
| 138 | ); |
||
| 139 | |||
| 140 | return array_merge( $add_option, $field_options ); |
||
| 141 | } |
||
| 142 | |||
| 143 | |||
| 144 | /** |
||
| 145 | * Add Edit Link as a default field, outside those set in the Gravity Form form |
||
| 146 | * |
||
| 147 | * @since 2.5 |
||
| 148 | * |
||
| 149 | * @param array $entry_default_fields Existing fields |
||
| 150 | * @param string|array $form form_ID or form object |
||
| 151 | * @param string $zone Either 'single', 'directory', 'edit', 'header', 'footer' |
||
| 152 | * |
||
| 153 | * @return array $entry_default_fields, with `duplicate_link` added. Won't be added if in Edit Entry context. |
||
| 154 | */ |
||
| 155 | public function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) { |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Add Duplicate Entry Link to the Add Field dialog |
||
| 170 | * |
||
| 171 | * @since 2.5 |
||
| 172 | * |
||
| 173 | * @param array $available_fields |
||
| 174 | * |
||
| 175 | * @return array Fields with `duplicate_link` added |
||
| 176 | */ |
||
| 177 | public function add_available_field( $available_fields = array() ) { |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Change wording for the Edit context to read Entry Creator |
||
| 192 | * |
||
| 193 | * @since 2.5 |
||
| 194 | * |
||
| 195 | * @param array $visibility_caps Array of capabilities to display in field dropdown. |
||
| 196 | * @param string $field_type Type of field options to render (`field` or `widget`) |
||
| 197 | * @param string $template_id Table slug |
||
| 198 | * @param float|string $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
||
| 199 | * @param string $context What context are we in? Example: `single` or `directory` |
||
| 200 | * @param string $input_type (textarea, list, select, etc.) |
||
| 201 | * |
||
| 202 | * @return array Array of field options with `label`, `value`, `type`, `default` keys |
||
| 203 | */ |
||
| 204 | public function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Generate a consistent nonce key based on the Entry ID |
||
| 222 | * |
||
| 223 | * @since 2.5 |
||
| 224 | * |
||
| 225 | * @param int $entry_id Entry ID |
||
| 226 | * |
||
| 227 | * @return string Key used to validate request |
||
| 228 | */ |
||
| 229 | 2 | public static function get_nonce_key( $entry_id ) { |
|
| 230 | 2 | return sprintf( 'duplicate_%s', $entry_id ); |
|
| 231 | } |
||
| 232 | |||
| 233 | |||
| 234 | /** |
||
| 235 | * Generate a nonce link with the base URL of the current View embed |
||
| 236 | * |
||
| 237 | * We don't want to link to the single entry, because when duplicated, there would be nothing to return to. |
||
| 238 | * |
||
| 239 | * @since 2.5 |
||
| 240 | * |
||
| 241 | * @param array $entry Gravity Forms entry array |
||
| 242 | * @param int $view_id The View id. Not optional since 2.0 |
||
| 243 | * @param int $post_id ID of the current post/page being embedded on, if any |
||
| 244 | * |
||
| 245 | * @return string|null If directory link is valid, the URL to process the duplicate request. Otherwise, `NULL`. |
||
| 246 | */ |
||
| 247 | 2 | public static function get_duplicate_link( $entry, $view_id, $post_id = null ) { |
|
| 248 | |||
| 249 | 2 | $base = GravityView_API::directory_link( $post_id ? : $view_id, true ); |
|
| 250 | |||
| 251 | 2 | if ( empty( $base ) ) { |
|
| 252 | gravityview()->log->error( 'Post ID does not exist: {post_id}', array( 'post_id' => $post_id ) ); |
||
| 253 | return NULL; |
||
| 254 | } |
||
| 255 | |||
| 256 | 2 | $actionurl = add_query_arg( array( |
|
| 257 | 2 | 'action' => 'duplicate', |
|
| 258 | 2 | 'entry_id' => $entry['id'], |
|
| 259 | 2 | 'gvid' => $view_id, |
|
| 260 | 2 | 'view_id' => $view_id, |
|
| 261 | 2 | ), $base ); |
|
| 262 | |||
| 263 | 2 | return add_query_arg( 'duplicate', wp_create_nonce( self::get_nonce_key( $entry['id'] ) ), $actionurl ); |
|
| 264 | } |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Handle the duplication request, if $_GET['action'] is set to "duplicate" |
||
| 268 | * |
||
| 269 | * 1. Check referrer validity |
||
| 270 | * 2. Make sure there's an entry with the slug of $_GET['entry_id'] |
||
| 271 | * 3. If so, attempt to duplicate the entry. If not, set the error status |
||
| 272 | * 4. Remove `action=duplicate` from the URL |
||
| 273 | * 5. Redirect to the page using `wp_safe_redirect()` |
||
| 274 | * |
||
| 275 | * @since 2.5 |
||
| 276 | * |
||
| 277 | * @uses wp_safe_redirect() |
||
| 278 | * |
||
| 279 | * @return void|string $url URL during tests instead of redirect. |
||
| 280 | */ |
||
| 281 | 3 | public function process_duplicate() { |
|
| 282 | |||
| 283 | // If the form is submitted |
||
| 284 | 3 | if ( ! isset( $_GET['action'] ) || 'duplicate' !== $_GET['action'] || ! isset( $_GET['entry_id'] ) ) { |
|
| 285 | 3 | return; |
|
| 286 | } |
||
| 287 | |||
| 288 | // Make sure it's a GravityView request |
||
| 289 | 1 | $valid_nonce_key = wp_verify_nonce( \GV\Utils::_GET( 'duplicate' ), self::get_nonce_key( $_GET['entry_id'] ) ); |
|
| 290 | |||
| 291 | 1 | if ( ! $valid_nonce_key ) { |
|
| 292 | 1 | gravityview()->log->debug( 'Duplicate entry not processed: nonce validation failed.' ); |
|
| 293 | 1 | return; |
|
| 294 | } |
||
| 295 | |||
| 296 | // Get the entry slug |
||
| 297 | 1 | $entry_slug = esc_attr( $_GET['entry_id'] ); |
|
| 298 | |||
| 299 | // See if there's an entry there |
||
| 300 | 1 | $entry = gravityview_get_entry( $entry_slug, true, false ); |
|
| 301 | |||
| 302 | 1 | if ( $entry ) { |
|
| 303 | |||
| 304 | 1 | $has_permission = $this->user_can_duplicate_entry( $entry ); |
|
| 305 | |||
| 306 | 1 | if ( is_wp_error( $has_permission ) ) { |
|
| 307 | |||
| 308 | $messages = array( |
||
| 309 | 1 | 'message' => urlencode( $has_permission->get_error_message() ), |
|
| 310 | 1 | 'status' => 'error', |
|
| 311 | ); |
||
| 312 | |||
| 313 | } else { |
||
| 314 | |||
| 315 | // Duplicate the entry |
||
| 316 | 1 | $duplicate_response = $this->duplicate_entry( $entry ); |
|
| 317 | |||
| 318 | 1 | if ( is_wp_error( $duplicate_response ) ) { |
|
| 319 | |||
| 320 | $messages = array( |
||
| 321 | 1 | 'message' => urlencode( $duplicate_response->get_error_message() ), |
|
| 322 | 1 | 'status' => 'error', |
|
| 323 | ); |
||
| 324 | |||
| 325 | 1 | gravityview()->log->error( 'Entry {entry_slug} cannot be duplicated: {error_code} {error_message}', array( |
|
| 326 | 1 | 'entry_slug' => $entry_slug, |
|
| 327 | 1 | 'error_code' => $duplicate_response->get_error_code(), |
|
| 328 | 1 | 'error_message' => $duplicate_response->get_error_message(), |
|
| 329 | ) ); |
||
| 330 | |||
| 331 | } else { |
||
| 332 | |||
| 333 | $messages = array( |
||
| 334 | 1 | 'status' => $duplicate_response, |
|
| 335 | ); |
||
| 336 | |||
| 337 | } |
||
| 338 | |||
| 339 | } |
||
| 340 | |||
| 341 | } else { |
||
| 342 | |||
| 343 | 1 | gravityview()->log->error( 'Duplicate entry failed: there was no entry with the entry slug {entry_slug}', array( 'entry_slug' => $entry_slug ) ); |
|
| 344 | |||
| 345 | $messages = array( |
||
| 346 | 1 | 'message' => urlencode( __( 'The entry does not exist.', 'gravityview' ) ), |
|
| 347 | 1 | 'status' => 'error', |
|
| 348 | ); |
||
| 349 | } |
||
| 350 | |||
| 351 | 1 | $redirect_to_base = esc_url_raw( remove_query_arg( array( 'action', 'gvid', 'entry_id' ) ) ); |
|
| 352 | 1 | $redirect_to = add_query_arg( $messages, $redirect_to_base ); |
|
| 353 | |||
| 354 | 1 | if ( defined( 'DOING_GRAVITYVIEW_TESTS' ) ) { |
|
| 355 | 1 | return $redirect_to; |
|
| 356 | } |
||
| 357 | |||
| 358 | wp_safe_redirect( $redirect_to ); |
||
| 359 | |||
| 360 | exit(); |
||
| 361 | } |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Duplicate the entry. |
||
| 365 | * |
||
| 366 | * Done after all the checks in self::process_duplicate. |
||
| 367 | * |
||
| 368 | * @since 2.5 |
||
| 369 | * |
||
| 370 | * @param array $entry The entry to be duplicated |
||
| 371 | * |
||
| 372 | * @return WP_Error|boolean |
||
| 373 | */ |
||
| 374 | 1 | private function duplicate_entry( $entry ) { |
|
| 375 | |||
| 376 | 1 | if ( ! $entry_id = \GV\Utils::get( $entry, 'id' ) ) { |
|
| 377 | return new WP_Error( 'gravityview-duplicate-entry-missing', __( 'The entry does not exist.', 'gravityview' ) ); |
||
| 378 | } |
||
| 379 | |||
| 380 | 1 | gravityview()->log->debug( 'Starting duplicate entry: {entry_id}', array( 'entry_id' => $entry_id ) ); |
|
| 381 | |||
| 382 | 1 | global $wpdb; |
|
| 383 | |||
| 384 | 1 | $entry_table = GFFormsModel::get_entry_table_name(); |
|
| 385 | 1 | $entry_meta_table = GFFormsModel::get_entry_meta_table_name(); |
|
| 386 | |||
| 387 | 1 | if ( ! $row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $entry_table WHERE ID = %d", $entry_id ), ARRAY_A ) ) { |
|
| 388 | return new WP_Error( 'gravityview-duplicate-entry-missing', __( 'The entry does not exist.', 'gravityview' ) ); |
||
| 389 | } |
||
| 390 | |||
| 391 | 1 | $row['id'] = null; |
|
| 392 | 1 | $row['date_created'] = date( 'Y-m-d H:i:s', time() ); |
|
| 393 | 1 | $row['date_updated'] = $row['date_created']; |
|
| 394 | 1 | $row['is_starred'] = false; |
|
| 395 | 1 | $row['is_read'] = false; |
|
| 396 | 1 | $row['ip'] = GFFormsModel::get_ip(); |
|
| 397 | 1 | $row['source_url'] = esc_url_raw( remove_query_arg( array( 'action', 'gvid' ) ) ); |
|
| 398 | 1 | $row['user_agent'] = \GV\Utils::_SERVER( 'HTTP_USER_AGENT' ); |
|
| 399 | 1 | $row['created_by'] = wp_get_current_user()->ID; |
|
| 400 | |||
| 401 | /** |
||
| 402 | * @filter `gravityview/entry/duplicate/details` Modify the new entry details before it's created. |
||
| 403 | * @since 2.5 |
||
| 404 | * @param[in,out] array $row The entry details |
||
| 405 | * @param array $entry The original entry |
||
| 406 | */ |
||
| 407 | 1 | $row = apply_filters( 'gravityview/entry/duplicate/details', $row, $entry ); |
|
| 408 | |||
| 409 | 1 | if ( ! $wpdb->insert( $entry_table, $row ) ) { |
|
| 410 | 1 | return new WP_Error( 'gravityview-duplicate-entry-db-details', __( 'There was an error duplicating the entry.', 'gravityview' ) ); |
|
| 411 | } |
||
| 412 | |||
| 413 | 1 | $duplicated_id = $wpdb->insert_id; |
|
| 414 | |||
| 415 | 1 | $meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id = %d", $entry_id ), ARRAY_A ); |
|
| 416 | |||
| 417 | 1 | $duplicate_meta = new WP_List_Util( $meta ); |
|
| 418 | |||
| 419 | // Keys that should be reset by default |
||
| 420 | 1 | $reset_meta = array( 'is_approved', 'gravityview_unique_id', 'workflow_current_status_timestamp' ); |
|
| 421 | 1 | foreach ( $reset_meta as $meta_key ) { |
|
| 422 | 1 | $duplicate_meta->filter( array( 'meta_key' => $meta_key ), 'NOT' ); |
|
| 423 | } |
||
| 424 | |||
| 425 | 1 | $save_this_meta = array(); |
|
| 426 | 1 | foreach ( $duplicate_meta->get_output() as $m ) { |
|
| 427 | 1 | $save_this_meta[] = array( |
|
| 428 | 1 | 'meta_key' => $m['meta_key'], |
|
| 429 | 1 | 'meta_value' => $m['meta_value'], |
|
| 430 | 1 | 'item_index' => $m['item_index'], |
|
| 431 | ); |
||
| 432 | } |
||
| 433 | |||
| 434 | // Update the row ID for later usage |
||
| 435 | 1 | $row['id'] = $duplicated_id; |
|
| 436 | |||
| 437 | /** |
||
| 438 | * @filter `gravityview/entry/duplicate/meta` Modify the new entry meta details. |
||
| 439 | * @param[in,out] array $save_this_meta The duplicate meta. Use/add meta_key, meta_value, item_index. |
||
| 440 | * @param array $row The duplicated entry |
||
| 441 | * @param array $entry The original entry |
||
| 442 | */ |
||
| 443 | 1 | $save_this_meta = apply_filters( 'gravityview/entry/duplicate/meta', $save_this_meta, $row, $entry ); |
|
| 444 | |||
| 445 | 1 | foreach ( $save_this_meta as $data ) { |
|
| 446 | 1 | $data['form_id'] = $entry['form_id']; |
|
| 447 | 1 | $data['entry_id'] = $duplicated_id; |
|
| 448 | |||
| 449 | 1 | if ( ! $wpdb->insert( $entry_meta_table, $data ) ) { |
|
| 450 | return new WP_Error( 'gravityview-duplicate-entry-db-meta', __( 'There was an error duplicating the entry.', 'gravityview' ) ); |
||
| 451 | } |
||
| 452 | } |
||
| 453 | |||
| 454 | 1 | $duplicated_entry = \GFAPI::get_entry( $duplicated_id ); |
|
| 455 | |||
| 456 | 1 | $duplicate_response = 'duplicated'; |
|
| 457 | |||
| 458 | /** |
||
| 459 | * @action `gravityview/duplicate-entry/duplicated` Triggered when an entry is duplicated |
||
| 460 | * @since 2.5 |
||
| 461 | * @param array $duplicated_entry The duplicated entry |
||
| 462 | * @param array $entry The original entry |
||
| 463 | */ |
||
| 464 | 1 | do_action( 'gravityview/duplicate-entry/duplicated', $duplicated_entry, $entry ); |
|
| 465 | |||
| 466 | 1 | gravityview()->log->debug( 'Duplicate response: {duplicate_response}', array( 'duplicate_response' => $duplicate_response ) ); |
|
| 467 | |||
| 468 | 1 | return $duplicate_response; |
|
| 469 | } |
||
| 470 | |||
| 471 | /** |
||
| 472 | * Is the current nonce valid for editing the entry? |
||
| 473 | * |
||
| 474 | * @since 2.5 |
||
| 475 | * |
||
| 476 | * @return boolean |
||
| 477 | */ |
||
| 478 | 1 | public function verify_nonce() { |
|
| 500 | |||
| 501 | /** |
||
| 502 | * Get the onclick attribute for the confirm dialogs that warns users before they duplicate an entry |
||
| 503 | * |
||
| 504 | * @since 2.5 |
||
| 505 | * |
||
| 506 | * @return string HTML `onclick` attribute |
||
| 507 | */ |
||
| 508 | 1 | public static function get_confirm_dialog() { |
|
| 509 | |||
| 525 | |||
| 526 | /** |
||
| 527 | * Check if the user can edit the entry |
||
| 528 | * |
||
| 529 | * - Is the nonce valid? |
||
| 530 | * - Does the user have the right caps for the entry |
||
| 531 | * - Is the entry in the trash? |
||
| 532 | * |
||
| 533 | * @since 2.5 |
||
| 534 | * |
||
| 535 | * @param array $entry Gravity Forms entry array |
||
| 536 | * @param int $view_id ID of the View being rendered |
||
| 537 | * |
||
| 538 | * @return boolean|WP_Error True: can edit form. WP_Error: nope. |
||
| 539 | */ |
||
| 540 | 1 | private function user_can_duplicate_entry( $entry = array(), $view_id = null ) { |
|
| 561 | |||
| 562 | |||
| 563 | /** |
||
| 564 | * checks if user has permissions to view the link or duplicate a specific entry |
||
| 565 | * |
||
| 566 | * @since 2.5 |
||
| 567 | * |
||
| 568 | * @param array $entry Gravity Forms entry array |
||
| 569 | * @param array $field Field settings (optional) |
||
| 570 | * @param int $view_id Pass a View ID to check caps against. If not set, check against current View |
||
| 571 | * |
||
| 572 | * @return bool |
||
| 573 | */ |
||
| 574 | 2 | public static function check_user_cap_duplicate_entry( $entry, $field = array(), $view_id = 0 ) { |
|
| 649 | |||
| 650 | |||
| 651 | /** |
||
| 652 | * After processing duplicate entry, the user will be redirected to the referring View or embedded post/page. Display a message on redirection. |
||
| 653 | * |
||
| 654 | * If success, there will be `status` URL parameters `status=>success` |
||
| 655 | * If an error, there will be `status` and `message` URL parameters `status=>error&message=example` |
||
| 656 | * |
||
| 657 | * @since 2.5 |
||
| 658 | * |
||
| 659 | * @param int $current_view_id The ID of the View being rendered |
||
| 660 | * |
||
| 661 | * @return void |
||
| 662 | */ |
||
| 663 | 37 | public function maybe_display_message( $current_view_id = 0 ) { |
|
| 675 | |||
| 676 | public function display_message() { |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Add a Duplicate link to the row of actions on the entry list in the backend. |
||
| 712 | * |
||
| 713 | * @since 2.5.1 |
||
| 714 | * |
||
| 715 | * @param int $form_id The form ID. |
||
| 716 | * @param int $field_id The field ID. |
||
| 717 | * @param string $value The value. |
||
| 718 | * @param array $entry The entryvalue The value. |
||
| 719 | * @param array $entry The entry. |
||
| 720 | * @param string $query_string The query. |
||
| 721 | * |
||
| 722 | * @return void |
||
| 723 | */ |
||
| 724 | public function make_duplicate_link_row( $form_id, $field_id, $value, $entry, $query_string ) { |
||
| 742 | |||
| 743 | /** |
||
| 744 | * Perhaps duplicate this entry if the action has been corrected. |
||
| 745 | * |
||
| 746 | * @since 2.5.1 |
||
| 747 | * |
||
| 748 | * @param int $form_id The form ID. |
||
| 749 | * |
||
| 750 | * @return void |
||
| 751 | */ |
||
| 752 | public function maybe_duplicate_list( $form_id ) { |
||
| 816 | |||
| 817 | |||
| 818 | } // end class |
||
| 819 | |||
| 822 |
Loading history...
Adding explicit visibility (
private,protected, orpublic) is generally recommend to communicate to other developers how, and from where this method is intended to be used.