eventespresso /
event-espresso-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like EE_Admin 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 EE_Admin, and based on these observations, apply Extract Interface, too.
| 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
||
| 24 | final class EE_Admin { |
||
| 25 | |||
| 26 | /** |
||
| 27 | * @access private |
||
| 28 | * @var EE_Admin $_instance |
||
| 29 | */ |
||
| 30 | private static $_instance; |
||
| 31 | |||
| 32 | |||
| 33 | |||
| 34 | /** |
||
| 35 | *@ singleton method used to instantiate class object |
||
| 36 | *@ access public |
||
| 37 | *@ return class instance |
||
| 38 | * |
||
| 39 | * @throws \EE_Error |
||
| 40 | */ |
||
| 41 | public static function instance() { |
||
| 42 | // check if class object is instantiated |
||
| 43 | if ( ! self::$_instance instanceof EE_Admin ) { |
||
| 44 | self::$_instance = new self(); |
||
| 45 | } |
||
| 46 | return self::$_instance; |
||
| 47 | } |
||
| 48 | |||
| 49 | |||
| 50 | |||
| 51 | /** |
||
| 52 | * class constructor |
||
| 53 | * |
||
| 54 | * @throws \EE_Error |
||
| 55 | */ |
||
| 56 | protected function __construct() { |
||
| 57 | // define global EE_Admin constants |
||
| 58 | $this->_define_all_constants(); |
||
| 59 | // set autoloaders for our admin page classes based on included path information |
||
| 60 | EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder( EE_ADMIN ); |
||
| 61 | // admin hooks |
||
| 62 | add_filter( 'plugin_action_links', array( $this, 'filter_plugin_actions' ), 10, 2 ); |
||
| 63 | // load EE_Request_Handler early |
||
| 64 | add_action( 'AHEE__EE_System__core_loaded_and_ready', array( $this, 'get_request' )); |
||
| 65 | add_action( 'AHEE__EE_System__initialize_last', array( $this, 'init' )); |
||
| 66 | // post shortcode tracking |
||
| 67 | add_action( |
||
| 68 | 'AHEE__EE_System__initialize_last', |
||
| 69 | array( 'EventEspresso\core\admin\PostShortcodeTracking', 'set_hooks_admin' ) |
||
| 70 | ); |
||
| 71 | add_action( 'AHEE__EE_Admin_Page__route_admin_request', array( $this, 'route_admin_request' ), 100, 2 ); |
||
| 72 | add_action( 'wp_loaded', array( $this, 'wp_loaded' ), 100 ); |
||
| 73 | add_action( 'admin_init', array( $this, 'admin_init' ), 100 ); |
||
| 74 | add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ), 20 ); |
||
| 75 | add_action( 'admin_notices', array( $this, 'display_admin_notices' ), 10 ); |
||
| 76 | add_action( 'network_admin_notices', array( $this, 'display_admin_notices' ), 10 ); |
||
| 77 | add_filter( 'pre_update_option', array( $this, 'check_for_invalid_datetime_formats' ), 100, 2 ); |
||
| 78 | add_filter('admin_footer_text', array( $this, 'espresso_admin_footer' )); |
||
| 79 | |||
| 80 | //reset Environment config (we only do this on admin page loads); |
||
| 81 | EE_Registry::instance()->CFG->environment->recheck_values(); |
||
| 82 | |||
| 83 | do_action( 'AHEE__EE_Admin__loaded' ); |
||
| 84 | } |
||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | /** |
||
| 91 | * _define_all_constants |
||
| 92 | * define constants that are set globally for all admin pages |
||
| 93 | * |
||
| 94 | * @access private |
||
| 95 | * @return void |
||
| 96 | */ |
||
| 97 | private function _define_all_constants() { |
||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | /** |
||
| 108 | * filter_plugin_actions - adds links to the Plugins page listing |
||
| 109 | * |
||
| 110 | * @access public |
||
| 111 | * @param array $links |
||
| 112 | * @param string $plugin |
||
| 113 | * @return array |
||
| 114 | */ |
||
| 115 | public function filter_plugin_actions( $links, $plugin ) { |
||
| 116 | // set $main_file in stone |
||
| 117 | static $main_file; |
||
| 118 | // if $main_file is not set yet |
||
| 119 | if ( ! $main_file ) { |
||
| 120 | $main_file = plugin_basename( EVENT_ESPRESSO_MAIN_FILE ); |
||
| 121 | } |
||
| 122 | if ( $plugin === $main_file ) { |
||
| 123 | // compare current plugin to this one |
||
| 124 | if ( EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance ) { |
||
| 125 | $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings" title="Event Espresso is in maintenance mode. Click this link to learn why.">' . __('Maintenance Mode Active', 'event_espresso' ) . '</a>'; |
||
| 126 | array_unshift( $links, $maintenance_link ); |
||
| 127 | } else { |
||
| 128 | $org_settings_link = '<a href="admin.php?page=espresso_general_settings">' . __( 'Settings', 'event_espresso' ) . '</a>'; |
||
| 129 | $events_link = '<a href="admin.php?page=espresso_events">' . __( 'Events', 'event_espresso' ) . '</a>'; |
||
| 130 | // add before other links |
||
| 131 | array_unshift( $links, $org_settings_link, $events_link ); |
||
| 132 | } |
||
| 133 | } |
||
| 134 | return $links; |
||
| 135 | } |
||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | /** |
||
| 140 | * _get_request |
||
| 141 | * |
||
| 142 | * @access public |
||
| 143 | * @return void |
||
| 144 | */ |
||
| 145 | public function get_request() { |
||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | /** |
||
| 153 | * hide_admin_pages_except_maintenance_mode |
||
| 154 | * |
||
| 155 | * @access public |
||
| 156 | * @param array $admin_page_folder_names |
||
| 157 | * @return array |
||
| 158 | */ |
||
| 159 | public function hide_admin_pages_except_maintenance_mode( $admin_page_folder_names = array() ){ |
||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | /** |
||
| 170 | * init- should fire after shortcode, module, addon, other plugin (default priority), and even EE_Front_Controller's init phases have run |
||
| 171 | * |
||
| 172 | * @access public |
||
| 173 | * @return void |
||
| 174 | */ |
||
| 175 | public function init() { |
||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | /** |
||
| 208 | * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from the list of options. |
||
| 209 | * |
||
| 210 | * the wp function "wp_nav_menu_item_post_type_meta_box" found in wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that to override any queries found in the existing query for the given post type. Note that _default_query is not a normal property on the post_type object. It's found ONLY in this particular context. |
||
| 211 | * @param object $post_type WP post type object |
||
| 212 | * @return object WP post type object |
||
| 213 | */ |
||
| 214 | public function remove_pages_from_nav_menu( $post_type ) { |
||
| 225 | |||
| 226 | |||
| 227 | |||
| 228 | /** |
||
| 229 | * WP by default only shows three metaboxes in "nav-menus.php" for first times users. We want to make sure our metaboxes get shown as well |
||
| 230 | * |
||
| 231 | * @access public |
||
| 232 | * @return void |
||
| 233 | */ |
||
| 234 | public function enable_hidden_ee_nav_menu_metaboxes() { |
||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | |||
| 265 | /** |
||
| 266 | * This method simply registers custom nav menu boxes for "nav_menus.php route" |
||
| 267 | * |
||
| 268 | * Currently EE is using this to make sure there are menu options for our CPT archive page routes. |
||
| 269 | * |
||
| 270 | * @todo modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by addons etc. |
||
| 271 | * |
||
| 272 | * @access public |
||
| 273 | * @return void |
||
| 274 | */ |
||
| 275 | public function register_custom_nav_menu_boxes() { |
||
| 278 | |||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | /** |
||
| 283 | * Use this to edit the post link for our cpts so that the edit link points to the correct page. |
||
| 284 | * |
||
| 285 | * @since 4.3.0 |
||
| 286 | * |
||
| 287 | * @param string $link the original link generated by wp |
||
| 288 | * @param int $id post id |
||
| 289 | * |
||
| 290 | * @return string the (maybe) modified link |
||
| 291 | */ |
||
| 292 | public function modify_edit_post_link( $link, $id ) { |
||
| 305 | |||
| 306 | |||
| 307 | |||
| 308 | |||
| 309 | public function ee_cpt_archive_pages() { |
||
| 386 | |||
| 387 | |||
| 388 | |||
| 389 | /** |
||
| 390 | * Returns an array of event archive nav items. |
||
| 391 | * |
||
| 392 | * @todo for now this method is just in place so when it gets abstracted further we can substitute in whatever method we use for getting the extra nav menu items |
||
| 393 | * @return array |
||
| 394 | */ |
||
| 395 | View Code Duplication | private function _get_extra_nav_menu_pages_items() { |
|
| 403 | |||
| 404 | |||
| 405 | |||
| 406 | /** |
||
| 407 | * Setup nav menu walker item for usage in the event archive nav menu metabox. It receives a menu_item array with the properties and converts it to the menu item object. |
||
| 408 | * |
||
| 409 | * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php |
||
| 410 | * @param $menu_item_values |
||
| 411 | * @return stdClass |
||
| 412 | */ |
||
| 413 | private function _setup_extra_nav_menu_pages_items( $menu_item_values ) { |
||
| 438 | |||
| 439 | |||
| 440 | /** |
||
| 441 | * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an EE_Admin_Page route is called. |
||
| 442 | * |
||
| 443 | * @return void |
||
| 444 | */ |
||
| 445 | public function route_admin_request() {} |
||
| 446 | |||
| 447 | |||
| 448 | |||
| 449 | /** |
||
| 450 | * wp_loaded should fire on the WordPress wp_loaded hook. This fires on a VERY late priority. |
||
| 451 | * @return void |
||
| 452 | */ |
||
| 453 | public function wp_loaded() {} |
||
| 454 | |||
| 455 | |||
| 456 | |||
| 457 | |||
| 458 | /** |
||
| 459 | * admin_init |
||
| 460 | * |
||
| 461 | * @access public |
||
| 462 | * @return void |
||
| 463 | */ |
||
| 464 | public function admin_init() { |
||
| 489 | |||
| 490 | |||
| 491 | /** |
||
| 492 | * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection. |
||
| 493 | * |
||
| 494 | * @param string $output Current output. |
||
| 495 | * @return string |
||
| 496 | */ |
||
| 497 | public function modify_dropdown_pages( $output ) { |
||
| 517 | |||
| 518 | |||
| 519 | |||
| 520 | /** |
||
| 521 | * enqueue all admin scripts that need loaded for admin pages |
||
| 522 | * |
||
| 523 | * @access public |
||
| 524 | * @return void |
||
| 525 | */ |
||
| 526 | public function enqueue_admin_scripts() { |
||
| 581 | |||
| 582 | |||
| 583 | |||
| 584 | /** |
||
| 585 | * display_admin_notices |
||
| 586 | * |
||
| 587 | * @access public |
||
| 588 | * @return string |
||
| 589 | */ |
||
| 590 | public function display_admin_notices() { |
||
| 593 | |||
| 594 | |||
| 595 | |||
| 596 | /** |
||
| 597 | * get_persistent_admin_notices |
||
| 598 | * |
||
| 599 | * @access public |
||
| 600 | * @return void |
||
| 601 | */ |
||
| 602 | public function get_persistent_admin_notices() { |
||
| 611 | |||
| 612 | |||
| 613 | |||
| 614 | /** |
||
| 615 | * dismiss_persistent_admin_notice |
||
| 616 | * |
||
| 617 | * @access public |
||
| 618 | * @return void |
||
| 619 | */ |
||
| 620 | public function dismiss_ee_nag_notice_callback() { |
||
| 623 | |||
| 624 | |||
| 625 | |||
| 626 | /** |
||
| 627 | * @param $elements |
||
| 628 | * @return array |
||
| 629 | */ |
||
| 630 | public function dashboard_glance_items( $elements ) { |
||
| 653 | |||
| 654 | |||
| 655 | /** |
||
| 656 | * check_for_invalid_datetime_formats |
||
| 657 | * |
||
| 658 | * if an admin changes their date or time format settings on the WP General Settings admin page, verify that their selected format can be parsed by PHP |
||
| 659 | * |
||
| 660 | * @access public |
||
| 661 | * @param $value |
||
| 662 | * @param $option |
||
| 663 | * @throws EE_Error |
||
| 664 | * @return string |
||
| 665 | */ |
||
| 666 | public function check_for_invalid_datetime_formats( $value, $option ) { |
||
| 712 | |||
| 713 | |||
| 714 | |||
| 715 | /** |
||
| 716 | * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso" |
||
| 717 | * |
||
| 718 | * @access public |
||
| 719 | * @param $content |
||
| 720 | * @return string |
||
| 721 | */ |
||
| 722 | public function its_eSpresso( $content ) { |
||
| 725 | |||
| 726 | |||
| 727 | |||
| 728 | /** |
||
| 729 | * espresso_admin_footer |
||
| 730 | * |
||
| 731 | * @access public |
||
| 732 | * @return string |
||
| 733 | */ |
||
| 734 | public function espresso_admin_footer() { |
||
| 741 | |||
| 742 | |||
| 743 | |||
| 744 | /** |
||
| 745 | * static method for registering ee admin page. |
||
| 746 | * |
||
| 747 | * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register. |
||
| 748 | * |
||
| 749 | * @since 4.3.0 |
||
| 750 | * @deprecated 4.3.0 Use EE_Register_Admin_Page::register() instead |
||
| 751 | * @see EE_Register_Admin_Page::register() |
||
| 752 | * |
||
| 753 | * @param $page_basename |
||
| 754 | * @param $page_path |
||
| 755 | * @param array $config |
||
| 756 | * @return void |
||
| 757 | */ |
||
| 758 | public static function register_ee_admin_page( $page_basename, $page_path, $config = array() ) { |
||
| 766 | |||
| 767 | |||
| 768 | } |
||
| 769 | // End of file EE_Admin.core.php |
||
| 771 |
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.