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 ) { |
|
| 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 ) { |
|
| 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() { |
|
| 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 ) { |
|
| 472 | |||
| 473 | /** |
||
| 474 | * Is the current nonce valid for editing the entry? |
||
| 475 | * |
||
| 476 | * @since 2.5 |
||
| 477 | * |
||
| 478 | * @return boolean |
||
| 479 | */ |
||
| 480 | 1 | public function verify_nonce() { |
|
| 502 | |||
| 503 | /** |
||
| 504 | * Get the onclick attribute for the confirm dialogs that warns users before they duplicate an entry |
||
| 505 | * |
||
| 506 | * @since 2.5 |
||
| 507 | * |
||
| 508 | * @return string HTML `onclick` attribute |
||
| 509 | */ |
||
| 510 | 1 | public static function get_confirm_dialog() { |
|
| 527 | |||
| 528 | /** |
||
| 529 | * Check if the user can edit the entry |
||
| 530 | * |
||
| 531 | * - Is the nonce valid? |
||
| 532 | * - Does the user have the right caps for the entry |
||
| 533 | * - Is the entry in the trash? |
||
| 534 | * |
||
| 535 | * @since 2.5 |
||
| 536 | * |
||
| 537 | * @param array $entry Gravity Forms entry array |
||
| 538 | * @param int $view_id ID of the View being rendered |
||
| 539 | * |
||
| 540 | * @return boolean|WP_Error True: can edit form. WP_Error: nope. |
||
| 541 | */ |
||
| 542 | 1 | private function user_can_duplicate_entry( $entry = array(), $view_id = null ) { |
|
| 563 | |||
| 564 | |||
| 565 | /** |
||
| 566 | * checks if user has permissions to view the link or duplicate a specific entry |
||
| 567 | * |
||
| 568 | * @since 2.5 |
||
| 569 | * |
||
| 570 | * @param array $entry Gravity Forms entry array |
||
| 571 | * @param array $field Field settings (optional) |
||
| 572 | * @param int $view_id Pass a View ID to check caps against. If not set, check against current View |
||
| 573 | * |
||
| 574 | * @return bool |
||
| 575 | */ |
||
| 576 | 2 | public static function check_user_cap_duplicate_entry( $entry, $field = array(), $view_id = 0 ) { |
|
| 651 | |||
| 652 | |||
| 653 | /** |
||
| 654 | * After processing duplicate entry, the user will be redirected to the referring View or embedded post/page. Display a message on redirection. |
||
| 655 | * |
||
| 656 | * If success, there will be `status` URL parameters `status=>success` |
||
| 657 | * If an error, there will be `status` and `message` URL parameters `status=>error&message=example` |
||
| 658 | * |
||
| 659 | * @since 2.5 |
||
| 660 | * |
||
| 661 | * @param int $current_view_id The ID of the View being rendered |
||
| 662 | * |
||
| 663 | * @return void |
||
| 664 | */ |
||
| 665 | 37 | public function maybe_display_message( $current_view_id = 0 ) { |
|
| 677 | |||
| 678 | public function display_message() { |
||
| 711 | |||
| 712 | /** |
||
| 713 | * Add a Duplicate link to the row of actions on the entry list in the backend. |
||
| 714 | * |
||
| 715 | * @since 2.5.1 |
||
| 716 | * |
||
| 717 | * @param int $form_id The form ID. |
||
| 718 | * @param int $field_id The field ID. |
||
| 719 | * @param string $value The value. |
||
| 720 | * @param array $entry The entry. |
||
| 721 | * @param string $query_string The query. |
||
| 722 | * |
||
| 723 | * @return void |
||
| 724 | */ |
||
| 725 | public function make_duplicate_link_row( $form_id, $field_id, $value, $entry, $query_string ) { |
||
| 743 | |||
| 744 | /** |
||
| 745 | * Perhaps duplicate this entry if the action has been corrected. |
||
| 746 | * |
||
| 747 | * @since 2.5.1 |
||
| 748 | * |
||
| 749 | * @param int $form_id The form ID. |
||
| 750 | * |
||
| 751 | * @return void |
||
| 752 | */ |
||
| 753 | public function maybe_duplicate_list( $form_id ) { |
||
| 817 | |||
| 818 | |||
| 819 | } // end class |
||
| 820 | |||
| 823 |
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.