Automattic /
jetpack
Complex classes like Base_Admin_Menu 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 Base_Admin_Menu, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | abstract class Base_Admin_Menu { |
||
| 16 | /** |
||
| 17 | * Holds class instances. |
||
| 18 | * |
||
| 19 | * @var array |
||
| 20 | */ |
||
| 21 | protected static $instances; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Whether the current request is a REST API request. |
||
| 25 | * |
||
| 26 | * @var bool |
||
| 27 | */ |
||
| 28 | protected $is_api_request = false; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * Domain of the current site. |
||
| 32 | * |
||
| 33 | * @var string |
||
| 34 | */ |
||
| 35 | protected $domain; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * The CSS classes used to hide the submenu items in navigation. |
||
| 39 | * |
||
| 40 | * @var string |
||
| 41 | */ |
||
| 42 | const HIDE_CSS_CLASS = 'hide-if-js'; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * Base_Admin_Menu constructor. |
||
| 46 | */ |
||
| 47 | protected function __construct() { |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Determine if the current request is from API |
||
| 63 | */ |
||
| 64 | public function set_is_api_request() { |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Returns class instance. |
||
| 73 | * |
||
| 74 | * @return Admin_Menu |
||
| 75 | */ |
||
| 76 | public static function get_instance() { |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Sets up class properties for REST API requests. |
||
| 88 | * |
||
| 89 | * @param \WP_REST_Response $response Response from the endpoint. |
||
| 90 | */ |
||
| 91 | public function rest_api_init( $response ) { |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Updates the menu data of the given menu slug. |
||
| 99 | * |
||
| 100 | * @param string $slug Slug of the menu to update. |
||
| 101 | * @param string $url New menu URL. |
||
|
|
|||
| 102 | * @param string $title New menu title. |
||
| 103 | * @param string $cap New menu capability. |
||
| 104 | * @param string $icon New menu icon. |
||
| 105 | * @param int $position New menu position. |
||
| 106 | * @return bool Whether the menu has been updated. |
||
| 107 | */ |
||
| 108 | public function update_menu( $slug, $url = null, $title = null, $cap = null, $icon = null, $position = null ) { |
||
| 163 | |||
| 164 | /** |
||
| 165 | * Updates the submenus of the given menu slug. |
||
| 166 | * |
||
| 167 | * It hides the menu by adding the `hide-if-js` css class and duplicates the submenu with the new slug. |
||
| 168 | * |
||
| 169 | * @param string $slug Menu slug. |
||
| 170 | * @param array $submenus_to_update Array of new submenu slugs. |
||
| 171 | */ |
||
| 172 | public function update_submenus( $slug, $submenus_to_update ) { |
||
| 222 | |||
| 223 | /** |
||
| 224 | * Adds a menu separator. |
||
| 225 | * |
||
| 226 | * @param int $position The position in the menu order this item should appear. |
||
| 227 | * @param string $cap Optional. The capability required for this menu to be displayed to the user. |
||
| 228 | * Default: 'read'. |
||
| 229 | */ |
||
| 230 | public function add_admin_menu_separator( $position = null, $cap = 'read' ) { |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Enqueues scripts and styles. |
||
| 244 | */ |
||
| 245 | public function enqueue_scripts() { |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Mark the core colors stylesheets as RTL depending on the value from the environment. |
||
| 279 | * This fixes a core issue where the extra RTL data is not added to the colors stylesheet. |
||
| 280 | * https://core.trac.wordpress.org/ticket/53090 |
||
| 281 | */ |
||
| 282 | public function configure_colors_for_rtl_stylesheets() { |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Injects inline-styles for site icon for when third-party plugins remove enqueued stylesheets. |
||
| 288 | * Unable to use wp_add_inline_style as plugins remove styles from all non-standard handles |
||
| 289 | */ |
||
| 290 | public function set_site_icon_inline_styles() { |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Hide the submenu page based on slug and return the item that was hidden. |
||
| 302 | * |
||
| 303 | * Instead of actually removing the submenu item, a safer approach is to hide it and filter it in the API response. |
||
| 304 | * In this manner we'll avoid breaking third-party plugins depending on items that no longer exist. |
||
| 305 | * |
||
| 306 | * A false|array value is returned to be consistent with remove_submenu_page() function |
||
| 307 | * |
||
| 308 | * @param string $menu_slug The parent menu slug. |
||
| 309 | * @param string $submenu_slug The submenu slug that should be hidden. |
||
| 310 | * @return false|array |
||
| 311 | */ |
||
| 312 | public function hide_submenu_page( $menu_slug, $submenu_slug ) { |
||
| 331 | |||
| 332 | /** |
||
| 333 | * Apply the hide-if-js CSS class to a submenu item. |
||
| 334 | * |
||
| 335 | * @param int $index The position of a submenu item in the submenu array. |
||
| 336 | * @param string $parent_slug The parent slug. |
||
| 337 | * @param array $item The submenu item. |
||
| 338 | */ |
||
| 339 | public function hide_submenu_element( $index, $parent_slug, $item ) { |
||
| 347 | |||
| 348 | /** |
||
| 349 | * Check if the menu has submenu items visible |
||
| 350 | * |
||
| 351 | * @param array $submenu_items The submenu items. |
||
| 352 | * @return bool |
||
| 353 | */ |
||
| 354 | public function has_visible_items( $submenu_items ) { |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Return the number of existing submenu items under the supplied parent slug. |
||
| 365 | * |
||
| 366 | * @param string $parent_slug The slug of the parent menu. |
||
| 367 | * @return int The number of submenu items under $parent_slug. |
||
| 368 | */ |
||
| 369 | public function get_submenu_item_count( $parent_slug ) { |
||
| 378 | |||
| 379 | /** |
||
| 380 | * Adds the given menu item in the specified position. |
||
| 381 | * |
||
| 382 | * @param array $item The menu item to add. |
||
| 383 | * @param int $position The position in the menu order this item should appear. |
||
| 384 | */ |
||
| 385 | public function set_menu_item( $item, $position = null ) { |
||
| 399 | |||
| 400 | /** |
||
| 401 | * Determines whether the current locale is right-to-left (RTL). |
||
| 402 | */ |
||
| 403 | public function is_rtl() { |
||
| 406 | |||
| 407 | /** |
||
| 408 | * Checks for any SVG icons in the menu, and overrides things so that |
||
| 409 | * we can display the icon in the correct colour for the theme. |
||
| 410 | */ |
||
| 411 | public function override_svg_icons() { |
||
| 470 | |||
| 471 | /** |
||
| 472 | * Hide menus that are unauthorized and don't have visible submenus and cases when the menu has the same slug |
||
| 473 | * as the first submenu item. |
||
| 474 | * |
||
| 475 | * This must be done at the end of menu and submenu manipulation in order to avoid performing this check each time |
||
| 476 | * the submenus are altered. |
||
| 477 | */ |
||
| 478 | public function hide_parent_of_hidden_submenus() { |
||
| 510 | |||
| 511 | /** |
||
| 512 | * Sort the hidden submenus by moving them at the end of the array in order to avoid WP using them as default URLs. |
||
| 513 | * |
||
| 514 | * This operation has to be done at the end of submenu manipulation in order to guarantee that the hidden submenus |
||
| 515 | * are at the end of the array. |
||
| 516 | */ |
||
| 517 | public function sort_hidden_submenus() { |
||
| 532 | |||
| 533 | /** |
||
| 534 | * Check if the given item is visible or not in the admin menu. |
||
| 535 | * |
||
| 536 | * @param array $item A menu or submenu array. |
||
| 537 | */ |
||
| 538 | public function is_item_visible( $item ) { |
||
| 541 | |||
| 542 | /** |
||
| 543 | * Whether to use wp-admin pages rather than Calypso. |
||
| 544 | * |
||
| 545 | * Options: |
||
| 546 | * false - Calypso (Default). |
||
| 547 | * true - wp-admin. |
||
| 548 | * |
||
| 549 | * @return bool |
||
| 550 | */ |
||
| 551 | abstract public function should_link_to_wp_admin(); |
||
| 552 | |||
| 553 | /** |
||
| 554 | * Create the desired menu output. |
||
| 555 | */ |
||
| 556 | abstract public function reregister_menu_items(); |
||
| 557 | } |
||
| 558 |
Loading history...
This check looks for
@paramannotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.