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() { |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Returns class instance. |
||
| 64 | * |
||
| 65 | * @return Admin_Menu |
||
| 66 | */ |
||
| 67 | public static function get_instance() { |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Updates the menu data of the given menu slug. |
||
| 79 | * |
||
| 80 | * @param string $slug Slug of the menu to update. |
||
| 81 | * @param string $url New menu URL. |
||
|
|
|||
| 82 | * @param string $title New menu title. |
||
| 83 | * @param string $cap New menu capability. |
||
| 84 | * @param string $icon New menu icon. |
||
| 85 | * @param int $position New menu position. |
||
| 86 | * @return bool Whether the menu has been updated. |
||
| 87 | */ |
||
| 88 | public function update_menu( $slug, $url = null, $title = null, $cap = null, $icon = null, $position = null ) { |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Updates the submenus of the given menu slug. |
||
| 146 | * |
||
| 147 | * It hides the menu by adding the `hide-if-js` css class and duplicates the submenu with the new slug. |
||
| 148 | * |
||
| 149 | * @param string $slug Menu slug. |
||
| 150 | * @param array $submenus_to_update Array of new submenu slugs. |
||
| 151 | */ |
||
| 152 | public function update_submenus( $slug, $submenus_to_update ) { |
||
| 202 | |||
| 203 | /** |
||
| 204 | * Adds a menu separator. |
||
| 205 | * |
||
| 206 | * @param int $position The position in the menu order this item should appear. |
||
| 207 | * @param string $cap Optional. The capability required for this menu to be displayed to the user. |
||
| 208 | * Default: 'read'. |
||
| 209 | */ |
||
| 210 | public function add_admin_menu_separator( $position = null, $cap = 'read' ) { |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Enqueues scripts and styles. |
||
| 224 | */ |
||
| 225 | public function enqueue_scripts() { |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Mark the core colors stylesheets as RTL depending on the value from the environment. |
||
| 259 | * This fixes a core issue where the extra RTL data is not added to the colors stylesheet. |
||
| 260 | * https://core.trac.wordpress.org/ticket/53090 |
||
| 261 | */ |
||
| 262 | public function configure_colors_for_rtl_stylesheets() { |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Injects inline-styles for site icon for when third-party plugins remove enqueued stylesheets. |
||
| 268 | * Unable to use wp_add_inline_style as plugins remove styles from all non-standard handles |
||
| 269 | */ |
||
| 270 | public function set_site_icon_inline_styles() { |
||
| 279 | |||
| 280 | /** |
||
| 281 | * Hide the submenu page based on slug and return the item that was hidden. |
||
| 282 | * |
||
| 283 | * Instead of actually removing the submenu item, a safer approach is to hide it and filter it in the API response. |
||
| 284 | * In this manner we'll avoid breaking third-party plugins depending on items that no longer exist. |
||
| 285 | * |
||
| 286 | * A false|array value is returned to be consistent with remove_submenu_page() function |
||
| 287 | * |
||
| 288 | * @param string $menu_slug The parent menu slug. |
||
| 289 | * @param string $submenu_slug The submenu slug that should be hidden. |
||
| 290 | * @return false|array |
||
| 291 | */ |
||
| 292 | public function hide_submenu_page( $menu_slug, $submenu_slug ) { |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Apply the hide-if-js CSS class to a submenu item. |
||
| 314 | * |
||
| 315 | * @param int $index The position of a submenu item in the submenu array. |
||
| 316 | * @param string $parent_slug The parent slug. |
||
| 317 | * @param array $item The submenu item. |
||
| 318 | */ |
||
| 319 | public function hide_submenu_element( $index, $parent_slug, $item ) { |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Check if the menu has submenu items visible |
||
| 330 | * |
||
| 331 | * @param array $submenu_items The submenu items. |
||
| 332 | * @return bool |
||
| 333 | */ |
||
| 334 | public function has_visible_items( $submenu_items ) { |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Return the number of existing submenu items under the supplied parent slug. |
||
| 345 | * |
||
| 346 | * @param string $parent_slug The slug of the parent menu. |
||
| 347 | * @return int The number of submenu items under $parent_slug. |
||
| 348 | */ |
||
| 349 | public function get_submenu_item_count( $parent_slug ) { |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Adds the given menu item in the specified position. |
||
| 361 | * |
||
| 362 | * @param array $item The menu item to add. |
||
| 363 | * @param int $position The position in the menu order this item should appear. |
||
| 364 | */ |
||
| 365 | public function set_menu_item( $item, $position = null ) { |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Determines whether the current locale is right-to-left (RTL). |
||
| 382 | */ |
||
| 383 | public function is_rtl() { |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Checks for any SVG icons in the menu, and overrides things so that |
||
| 389 | * we can display the icon in the correct colour for the theme. |
||
| 390 | */ |
||
| 391 | public function override_svg_icons() { |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Hide menus that are unauthorized and don't have visible submenus and cases when the menu has the same slug |
||
| 448 | * as the first submenu item. |
||
| 449 | * |
||
| 450 | * This must be done at the end of menu and submenu manipulation in order to avoid performing this check each time |
||
| 451 | * the submenus are altered. |
||
| 452 | */ |
||
| 453 | public function hide_parent_of_hidden_submenus() { |
||
| 485 | |||
| 486 | /** |
||
| 487 | * Sort the hidden submenus by moving them at the end of the array in order to avoid WP using them as default URLs. |
||
| 488 | * |
||
| 489 | * This operation has to be done at the end of submenu manipulation in order to guarantee that the hidden submenus |
||
| 490 | * are at the end of the array. |
||
| 491 | */ |
||
| 492 | public function sort_hidden_submenus() { |
||
| 507 | |||
| 508 | /** |
||
| 509 | * Check if the given item is visible or not in the admin menu. |
||
| 510 | * |
||
| 511 | * @param array $item A menu or submenu array. |
||
| 512 | */ |
||
| 513 | public function is_item_visible( $item ) { |
||
| 516 | |||
| 517 | /** |
||
| 518 | * Whether to use wp-admin pages rather than Calypso. |
||
| 519 | * |
||
| 520 | * Options: |
||
| 521 | * false - Calypso (Default). |
||
| 522 | * true - wp-admin. |
||
| 523 | * |
||
| 524 | * @return bool |
||
| 525 | */ |
||
| 526 | abstract public function should_link_to_wp_admin(); |
||
| 527 | |||
| 528 | /** |
||
| 529 | * Create the desired menu output. |
||
| 530 | */ |
||
| 531 | abstract public function reregister_menu_items(); |
||
| 532 | } |
||
| 533 |
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.