Complex classes like FrmAppController 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 FrmAppController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 3 | class FrmAppController { |
||
| 4 | |||
| 5 | public static function menu() { |
||
| 14 | |||
| 15 | private static function get_menu_position() { |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @since 3.05 |
||
| 21 | */ |
||
| 22 | private static function menu_icon() { |
||
| 23 | $icon = FrmAppHelper::svg_logo( |
||
| 24 | array( |
||
| 25 | 'fill' => '#a0a5aa', |
||
| 26 | 'orange' => '#a0a5aa', |
||
| 27 | ) |
||
| 28 | ); |
||
| 29 | $icon = 'data:image/svg+xml;base64,' . base64_encode( $icon ); |
||
| 30 | |||
| 31 | return apply_filters( 'frm_icon', $icon ); |
||
| 32 | } |
||
| 33 | |||
| 34 | /** |
||
| 35 | * @since 3.0 |
||
| 36 | */ |
||
| 37 | public static function add_admin_class( $classes ) { |
||
| 38 | if ( self::is_white_page() ) { |
||
| 39 | $classes .= ' frm-white-body '; |
||
| 40 | $classes .= self::get_os(); |
||
| 41 | |||
| 42 | $page = str_replace( 'formidable-', '', FrmAppHelper::simple_get( 'page', 'sanitize_title' ) ); |
||
| 43 | if ( empty( $page ) || $page === 'formidable' ) { |
||
| 44 | $action = FrmAppHelper::simple_get( 'frm_action', 'sanitize_title' ); |
||
| 45 | if ( in_array( $action, array( 'settings', 'edit', 'list' ) ) ) { |
||
| 46 | $page .= $action; |
||
| 47 | } else { |
||
| 48 | $page = $action; |
||
| 49 | } |
||
| 50 | } |
||
| 51 | if ( ! empty( $page ) ) { |
||
| 52 | $classes .= ' frm-admin-page-' . $page; |
||
| 53 | } |
||
| 54 | } |
||
| 55 | |||
| 56 | if ( FrmAppHelper::is_full_screen() ) { |
||
| 57 | $classes .= apply_filters( 'frm_admin_full_screen_class', ' frm-full-screen folded' ); |
||
| 58 | } |
||
| 59 | |||
| 60 | return $classes; |
||
| 61 | } |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @since 4.0 |
||
| 65 | */ |
||
| 66 | private static function get_os() { |
||
| 67 | $agent = strtolower( FrmAppHelper::get_server_value( 'HTTP_USER_AGENT' ) ); |
||
| 68 | $os = ''; |
||
| 69 | if ( strpos( $agent, 'mac' ) !== false ) { |
||
| 70 | $os = ' osx'; |
||
| 71 | } elseif ( strpos( $agent, 'linux' ) !== false ) { |
||
| 72 | $os = ' linux'; |
||
| 73 | } elseif ( strpos( $agent, 'windows' ) !== false ) { |
||
| 74 | $os = ' windows'; |
||
| 75 | } |
||
| 76 | return $os; |
||
| 77 | } |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @since 3.0 |
||
| 81 | */ |
||
| 82 | private static function is_white_page() { |
||
| 83 | $white_pages = array( |
||
| 84 | 'formidable', |
||
| 85 | 'formidable-entries', |
||
| 86 | 'formidable-pro-upgrade', |
||
| 87 | 'formidable-addons', |
||
| 88 | 'formidable-import', |
||
| 89 | 'formidable-settings', |
||
| 90 | 'formidable-styles', |
||
| 91 | ); |
||
| 92 | |||
| 93 | $get_page = FrmAppHelper::simple_get( 'page', 'sanitize_title' ); |
||
| 94 | $is_white_page = in_array( $get_page, $white_pages ); |
||
| 95 | |||
| 96 | if ( ! $is_white_page ) { |
||
| 97 | $screen = get_current_screen(); |
||
| 98 | $is_white_page = ( $screen && strpos( $screen->id, 'frm_display' ) !== false ); |
||
| 99 | } |
||
| 100 | |||
| 101 | return $is_white_page; |
||
| 102 | } |
||
| 103 | |||
| 104 | public static function load_wp_admin_style() { |
||
| 105 | FrmAppHelper::load_font_style(); |
||
| 106 | } |
||
| 107 | |||
| 108 | public static function get_form_nav( $form, $show_nav = false, $title = 'show' ) { |
||
| 109 | $show_nav = FrmAppHelper::get_param( 'show_nav', $show_nav, 'get', 'absint' ); |
||
| 110 | if ( empty( $show_nav ) || ! $form ) { |
||
| 111 | return; |
||
| 112 | } |
||
| 113 | |||
| 114 | FrmForm::maybe_get_form( $form ); |
||
| 115 | if ( ! is_object( $form ) ) { |
||
| 116 | return; |
||
| 117 | } |
||
| 118 | |||
| 119 | $id = $form->id; |
||
| 120 | $current_page = self::get_current_page(); |
||
| 121 | $nav_items = self::get_form_nav_items( $form ); |
||
| 122 | |||
| 123 | include( FrmAppHelper::plugin_path() . '/classes/views/shared/form-nav.php' ); |
||
| 124 | } |
||
| 125 | |||
| 126 | private static function get_current_page() { |
||
| 127 | $page = FrmAppHelper::simple_get( 'page', 'sanitize_title' ); |
||
| 128 | $post_type = FrmAppHelper::simple_get( 'post_type', 'sanitize_title', 'None' ); |
||
| 129 | $current_page = isset( $_GET['page'] ) ? $page : $post_type; |
||
| 130 | |||
| 131 | if ( FrmAppHelper::is_view_builder_page() ) { |
||
| 132 | $current_page = 'frm_display'; |
||
| 133 | } |
||
| 134 | |||
| 135 | return $current_page; |
||
| 136 | } |
||
| 137 | |||
| 138 | private static function get_form_nav_items( $form ) { |
||
| 139 | $id = $form->parent_form_id ? $form->parent_form_id : $form->id; |
||
| 140 | |||
| 141 | $nav_items = array( |
||
| 142 | array( |
||
| 143 | 'link' => FrmForm::get_edit_link( $id ), |
||
| 144 | 'label' => __( 'Build', 'formidable' ), |
||
| 145 | 'current' => array( 'edit', 'new', 'duplicate' ), |
||
| 146 | 'page' => 'formidable', |
||
| 147 | 'permission' => 'frm_edit_forms', |
||
| 148 | ), |
||
| 149 | array( |
||
| 150 | 'link' => admin_url( 'admin.php?page=formidable&frm_action=settings&id=' . absint( $id ) ), |
||
| 151 | 'label' => __( 'Settings', 'formidable' ), |
||
| 152 | 'current' => array( 'settings' ), |
||
| 153 | 'page' => 'formidable', |
||
| 154 | 'permission' => 'frm_edit_forms', |
||
| 155 | ), |
||
| 156 | array( |
||
| 157 | 'link' => admin_url( 'admin.php?page=formidable-entries&frm-full=1&frm_action=list&form=' . absint( $id ) ), |
||
| 158 | 'label' => __( 'Entries', 'formidable' ), |
||
| 159 | 'current' => array(), |
||
| 160 | 'page' => 'formidable-entries', |
||
| 161 | 'permission' => 'frm_view_entries', |
||
| 162 | ), |
||
| 163 | ); |
||
| 164 | |||
| 165 | // Let people know reports and views exist. |
||
| 166 | if ( ! FrmAppHelper::pro_is_installed() ) { |
||
| 167 | $nav_items[] = array( |
||
| 168 | 'link' => '', |
||
| 169 | 'label' => __( 'Views', 'formidable' ), |
||
| 170 | 'current' => array(), |
||
| 171 | 'page' => '', |
||
| 172 | 'permission' => 'frm_view_entries', |
||
| 173 | 'atts' => array( |
||
| 174 | 'class' => 'frm_show_upgrade frm_noallow', |
||
| 175 | 'data-upgrade' => __( 'Views', 'formidable' ), |
||
| 176 | 'data-medium' => 'views-nav', |
||
| 177 | ), |
||
| 178 | ); |
||
| 179 | $nav_items[] = array( |
||
| 180 | 'link' => '', |
||
| 181 | 'label' => __( 'Reports', 'formidable' ), |
||
| 182 | 'current' => array(), |
||
| 183 | 'page' => '', |
||
| 184 | 'permission' => 'frm_view_entries', |
||
| 185 | 'atts' => array( |
||
| 186 | 'class' => 'frm_show_upgrade frm_noallow', |
||
| 187 | 'data-upgrade' => __( 'Reports', 'formidable' ), |
||
| 188 | 'data-medium' => 'reports-nav', |
||
| 189 | ), |
||
| 190 | ); |
||
| 191 | } |
||
| 192 | |||
| 193 | $nav_args = array( |
||
| 194 | 'form_id' => $id, |
||
| 195 | 'form' => $form, |
||
| 196 | ); |
||
| 197 | |||
| 198 | return apply_filters( 'frm_form_nav_list', $nav_items, $nav_args ); |
||
| 199 | } |
||
| 200 | |||
| 201 | // Adds a settings link to the plugins page |
||
| 202 | public static function settings_link( $links ) { |
||
| 203 | $settings = '<a href="' . esc_url( admin_url( 'admin.php?page=formidable' ) ) . '">' . __( 'Build a Form', 'formidable' ) . '</a>'; |
||
| 204 | array_unshift( $links, $settings ); |
||
| 205 | |||
| 206 | return $links; |
||
| 207 | } |
||
| 208 | |||
| 209 | public static function pro_get_started_headline() { |
||
| 210 | self::review_request(); |
||
| 211 | FrmAppHelper::min_pro_version_notice( '4.0' ); |
||
| 212 | } |
||
| 213 | |||
| 214 | /** |
||
| 215 | * Add admin notices as needed for reviews |
||
| 216 | * |
||
| 217 | * @since 3.04.03 |
||
| 218 | */ |
||
| 219 | private static function review_request() { |
||
| 220 | $reviews = new FrmReviews(); |
||
| 221 | $reviews->review_request(); |
||
| 222 | } |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Save the request to hide the review |
||
| 226 | * |
||
| 227 | * @since 3.04.03 |
||
| 228 | */ |
||
| 229 | public static function dismiss_review() { |
||
| 230 | FrmAppHelper::permission_check( 'frm_change_settings' ); |
||
| 231 | check_ajax_referer( 'frm_ajax', 'nonce' ); |
||
| 232 | |||
| 233 | $reviews = new FrmReviews(); |
||
| 234 | $reviews->dismiss_review(); |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * @since 3.04.02 |
||
| 239 | */ |
||
| 240 | public static function include_upgrade_overlay() { |
||
| 241 | wp_enqueue_script( 'jquery-ui-dialog' ); |
||
| 242 | wp_enqueue_style( 'jquery-ui-dialog' ); |
||
| 243 | |||
| 244 | add_action( 'admin_footer', 'FrmAppController::upgrade_overlay_html' ); |
||
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * @since 3.06.03 |
||
| 249 | */ |
||
| 250 | public static function upgrade_overlay_html() { |
||
| 251 | $is_pro = FrmAppHelper::pro_is_installed(); |
||
| 252 | $upgrade_link = array( |
||
| 253 | 'medium' => 'builder', |
||
| 254 | 'content' => 'upgrade', |
||
| 255 | ); |
||
| 256 | $default_link = FrmAppHelper::admin_upgrade_link( $upgrade_link ); |
||
| 257 | |||
| 258 | include( FrmAppHelper::plugin_path() . '/classes/views/shared/upgrade_overlay.php' ); |
||
| 259 | |||
| 260 | include( FrmAppHelper::plugin_path() . '/classes/views/shared/confirm-overlay.php' ); |
||
| 261 | } |
||
| 262 | |||
| 263 | public static function include_info_overlay() { |
||
| 264 | wp_enqueue_script( 'jquery-ui-dialog' ); |
||
| 265 | wp_enqueue_style( 'jquery-ui-dialog' ); |
||
| 266 | |||
| 267 | add_action( 'admin_footer', 'FrmAppController::info_overlay_html' ); |
||
| 268 | } |
||
| 269 | |||
| 270 | public static function info_overlay_html() { |
||
| 271 | include( FrmAppHelper::plugin_path() . '/classes/views/shared/info-overlay.php' ); |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * @since 3.04.02 |
||
| 276 | */ |
||
| 277 | public static function remove_upsells() { |
||
| 278 | remove_action( 'frm_before_settings', 'FrmSettingsController::license_box' ); |
||
| 279 | remove_action( 'frm_after_settings', 'FrmSettingsController::settings_cta' ); |
||
| 280 | } |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Don't nag people to install WPForms |
||
| 284 | * |
||
| 285 | * @since 3.05 |
||
| 286 | */ |
||
| 287 | public static function remove_wpforms_nag( $upsell ) { |
||
| 288 | if ( is_array( $upsell ) ) { |
||
| 289 | foreach ( $upsell as $k => $plugin ) { |
||
| 290 | if ( strpos( $plugin['slug'], 'wpforms' ) !== false ) { |
||
| 291 | unset( $upsell[ $k ] ); |
||
| 292 | } |
||
| 293 | } |
||
| 294 | } |
||
| 295 | |||
| 296 | return $upsell; |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * If there are CURL problems on this server, wp_remote_post won't work for installing |
||
| 301 | * Use a javascript fallback instead. |
||
| 302 | * |
||
| 303 | * @since 2.0.3 |
||
| 304 | */ |
||
| 305 | public static function install_js_fallback() { |
||
| 306 | FrmAppHelper::load_admin_wide_js(); |
||
| 307 | echo '<div id="hidden frm_install_message"></div><script type="text/javascript">jQuery(document).ready(function(){frm_install_now();});</script>'; |
||
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * Check if the database is outdated |
||
| 312 | * |
||
| 313 | * @since 2.0.1 |
||
| 314 | * @return boolean |
||
| 315 | */ |
||
| 316 | public static function needs_update() { |
||
| 317 | $needs_upgrade = self::compare_for_update( |
||
| 318 | array( |
||
| 319 | 'option' => 'frm_db_version', |
||
| 320 | 'new_db_version' => FrmAppHelper::$db_version, |
||
| 321 | 'new_plugin_version' => FrmAppHelper::plugin_version(), |
||
| 322 | ) |
||
| 323 | ); |
||
| 324 | |||
| 325 | if ( ! $needs_upgrade ) { |
||
| 326 | $needs_upgrade = apply_filters( 'frm_db_needs_upgrade', $needs_upgrade ); |
||
| 327 | } |
||
| 328 | |||
| 329 | return $needs_upgrade; |
||
| 330 | } |
||
| 331 | |||
| 332 | /** |
||
| 333 | * Check both version number and DB number for changes |
||
| 334 | * |
||
| 335 | * @since 3.0.04 |
||
| 336 | */ |
||
| 337 | public static function compare_for_update( $atts ) { |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Check for database update and trigger js loading |
||
| 354 | * |
||
| 355 | * @since 2.0.1 |
||
| 356 | */ |
||
| 357 | public static function admin_init() { |
||
| 358 | new FrmPersonalData(); // register personal data hooks |
||
| 359 | |||
| 360 | if ( ! FrmAppHelper::doing_ajax() && self::needs_update() ) { |
||
| 361 | self::network_upgrade_site(); |
||
| 362 | } |
||
| 363 | |||
| 364 | if ( ! FrmAppHelper::doing_ajax() ) { |
||
| 365 | // don't continue during ajax calls |
||
| 366 | self::admin_js(); |
||
| 367 | } |
||
| 368 | } |
||
| 369 | |||
| 370 | public static function admin_js() { |
||
| 371 | $version = FrmAppHelper::plugin_version(); |
||
| 372 | FrmAppHelper::load_admin_wide_js( false ); |
||
| 449 | |||
| 450 | public static function load_lang() { |
||
| 453 | |||
| 454 | /** |
||
| 455 | * Check if the styles are updated when a form is loaded on the front-end |
||
| 456 | * |
||
| 457 | * @since 3.0.1 |
||
| 458 | */ |
||
| 459 | public static function maybe_update_styles() { |
||
| 464 | |||
| 465 | /** |
||
| 466 | * @since 3.0 |
||
| 467 | */ |
||
| 468 | public static function create_rest_routes() { |
||
| 475 | |||
| 476 | /** |
||
| 477 | * Run silent upgrade on each site in the network during a network upgrade. |
||
| 478 | * Update database settings for all sites in a network during network upgrade process. |
||
| 479 | * |
||
| 480 | * @since 2.0.1 |
||
| 481 | * |
||
| 482 | * @param int $blog_id Blog ID. |
||
| 483 | */ |
||
| 484 | public static function network_upgrade_site( $blog_id = 0 ) { |
||
| 501 | |||
| 502 | /** |
||
| 503 | * @since 3.0 |
||
| 504 | */ |
||
| 505 | public static function api_install() { |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Silent database upgrade (no redirect). |
||
| 520 | * Called via ajax request during network upgrade process. |
||
| 521 | * |
||
| 522 | * @since 2.0.1 |
||
| 523 | */ |
||
| 524 | public static function ajax_install() { |
||
| 528 | |||
| 529 | public static function install() { |
||
| 533 | |||
| 534 | public static function uninstall() { |
||
| 547 | |||
| 548 | public static function drop_tables( $tables ) { |
||
| 557 | |||
| 558 | public static function deauthorize() { |
||
| 568 | |||
| 569 | public static function set_footer_text( $text ) { |
||
| 576 | |||
| 577 | /** |
||
| 578 | * @deprecated 1.07.05 |
||
| 579 | * @codeCoverageIgnore |
||
| 580 | */ |
||
| 581 | public static function get_form_shortcode( $atts ) { |
||
| 584 | |||
| 585 | /** |
||
| 586 | * @deprecated 2.5.4 |
||
| 587 | * @codeCoverageIgnore |
||
| 588 | */ |
||
| 589 | public static function widget_text_filter( $content ) { |
||
| 592 | |||
| 593 | /** |
||
| 594 | * Deprecated in favor of wpmu_upgrade_site |
||
| 595 | * |
||
| 596 | * @deprecated 2.3 |
||
| 597 | * @codeCoverageIgnore |
||
| 598 | */ |
||
| 599 | public static function front_head() { |
||
| 602 | |||
| 603 | /** |
||
| 604 | * @deprecated 3.0.04 |
||
| 605 | * @codeCoverageIgnore |
||
| 606 | */ |
||
| 607 | public static function activation_install() { |
||
| 610 | |||
| 611 | /** |
||
| 612 | * @deprecated 3.0 |
||
| 613 | * @codeCoverageIgnore |
||
| 614 | */ |
||
| 615 | public static function page_route( $content ) { |
||
| 618 | } |
||
| 619 |