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:
| 1 | <?php |
||
| 19 | class Test_Admin_Menu extends WP_UnitTestCase { |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Menu data fixture. |
||
| 23 | * |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | public static $menu_data; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Submenu data fixture. |
||
| 30 | * |
||
| 31 | * @var array |
||
| 32 | */ |
||
| 33 | public static $submenu_data; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Test domain. |
||
| 37 | * |
||
| 38 | * @var string |
||
| 39 | */ |
||
| 40 | public static $domain; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Admin menu instance. |
||
| 44 | * |
||
| 45 | * @var Admin_Menu |
||
| 46 | */ |
||
| 47 | public static $admin_menu; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Mock user ID. |
||
| 51 | * |
||
| 52 | * @var int |
||
| 53 | */ |
||
| 54 | private static $user_id = 0; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Create shared fixtures. |
||
| 58 | * |
||
| 59 | * @param WP_UnitTest_Factory $factory Fixture factory. |
||
| 60 | */ |
||
| 61 | View Code Duplication | public static function wpSetUpBeforeClass( $factory ) { |
|
| 67 | |||
| 68 | /** |
||
| 69 | * Set up data. |
||
| 70 | */ |
||
| 71 | View Code Duplication | public function setUp() { |
|
| 83 | |||
| 84 | /** |
||
| 85 | * Test get_instance. |
||
| 86 | * |
||
| 87 | * @covers ::get_instance |
||
| 88 | * @covers ::__construct |
||
| 89 | */ |
||
| 90 | public function test_get_instance() { |
||
| 91 | $instance = Admin_Menu::get_instance(); |
||
| 92 | |||
| 93 | $this->assertInstanceOf( Admin_Menu::class, $instance ); |
||
| 94 | $this->assertSame( $instance, static::$admin_menu ); |
||
| 95 | |||
| 96 | $this->assertSame( 99999, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) ); |
||
| 97 | $this->assertSame( 10, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) ); |
||
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Tests add_admin_menu_separator |
||
| 102 | * |
||
| 103 | * @covers ::add_admin_menu_separator |
||
| 104 | */ |
||
| 105 | public function test_add_admin_menu_separator() { |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Test_Admin_Menu. |
||
| 127 | * |
||
| 128 | * @covers ::reregister_menu_items |
||
| 129 | */ |
||
| 130 | public function test_admin_menu_output() { |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Shim wpcomsh fallback site icon. |
||
| 146 | * |
||
| 147 | * @return string |
||
| 148 | */ |
||
| 149 | public function wpcomsh_site_icon_url() { |
||
| 152 | |||
| 153 | /** |
||
| 154 | * Custom site icon. |
||
| 155 | * |
||
| 156 | * @return string |
||
| 157 | */ |
||
| 158 | public function custom_site_icon_url() { |
||
| 161 | |||
| 162 | /** |
||
| 163 | * Tests add_my_home_menu |
||
| 164 | * |
||
| 165 | * @covers ::add_my_home_menu |
||
| 166 | */ |
||
| 167 | public function test_add_my_home_menu() { |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Tests add_stats_menu |
||
| 191 | * |
||
| 192 | * @covers ::add_stats_menu |
||
| 193 | */ |
||
| 194 | public function test_add_stats_menu() { |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Tests add_upgrades_menu |
||
| 204 | * |
||
| 205 | * @covers ::add_upgrades_menu |
||
| 206 | */ |
||
| 207 | View Code Duplication | public function test_add_upgrades_menu() { |
|
| 215 | |||
| 216 | /** |
||
| 217 | * Tests add_posts_menu |
||
| 218 | * |
||
| 219 | * @covers ::add_posts_menu |
||
| 220 | */ |
||
| 221 | View Code Duplication | public function test_add_posts_menu() { |
|
| 229 | |||
| 230 | /** |
||
| 231 | * Tests add_media_menu |
||
| 232 | * |
||
| 233 | * @covers ::add_media_menu |
||
| 234 | */ |
||
| 235 | View Code Duplication | public function test_add_media_menu() { |
|
| 243 | |||
| 244 | /** |
||
| 245 | * Tests add_page_menu |
||
| 246 | * |
||
| 247 | * @covers ::add_page_menu |
||
| 248 | */ |
||
| 249 | View Code Duplication | public function test_add_page_menu() { |
|
| 257 | |||
| 258 | /** |
||
| 259 | * Tests add_custom_post_type_menu |
||
| 260 | * |
||
| 261 | * @covers ::add_custom_post_type_menu |
||
| 262 | */ |
||
| 263 | public function test_add_custom_post_type_menu() { |
||
| 290 | |||
| 291 | /** |
||
| 292 | * Tests add_comments_menu |
||
| 293 | * |
||
| 294 | * @covers ::add_comments_menu |
||
| 295 | */ |
||
| 296 | View Code Duplication | public function test_add_comments_menu() { |
|
| 304 | |||
| 305 | /** |
||
| 306 | * Tests add_appearance_menu |
||
| 307 | * |
||
| 308 | * @covers ::add_appearance_menu |
||
| 309 | */ |
||
| 310 | View Code Duplication | public function test_add_appearance_menu() { |
|
| 320 | |||
| 321 | /** |
||
| 322 | * Tests add_plugins_menu |
||
| 323 | * |
||
| 324 | * @covers ::add_plugins_menu |
||
| 325 | */ |
||
| 326 | public function test_add_plugins_menu() { |
||
| 327 | global $menu, $submenu; |
||
| 328 | |||
| 329 | static::$admin_menu->add_plugins_menu(); |
||
| 330 | |||
| 331 | $this->assertSame( 'https://wordpress.com/plugins/' . static::$domain, $menu[65][2] ); |
||
| 332 | $this->assertEmpty( $submenu['plugins.php'] ); |
||
| 333 | |||
| 334 | // Reset. |
||
| 335 | $menu = static::$menu_data; |
||
| 336 | $submenu = static::$submenu_data; |
||
| 337 | |||
| 338 | // Check submenu are kept when using WP Admin links. |
||
| 339 | static::$admin_menu->add_plugins_menu( true ); |
||
| 340 | $this->assertNotEmpty( $submenu['plugins.php'] ); |
||
| 341 | } |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Tests add_users_menu |
||
| 345 | * |
||
| 346 | * @covers ::add_users_menu |
||
| 347 | */ |
||
| 348 | public function test_add_users_menu() { |
||
| 387 | |||
| 388 | /** |
||
| 389 | * Tests add_tools_menu |
||
| 390 | * |
||
| 391 | * @covers ::add_tools_menu |
||
| 392 | */ |
||
| 393 | View Code Duplication | public function test_add_tools_menu() { |
|
| 403 | |||
| 404 | /** |
||
| 405 | * Tests add_options_menu |
||
| 406 | * |
||
| 407 | * @covers ::add_options_menu |
||
| 408 | */ |
||
| 409 | View Code Duplication | public function test_add_options_menu() { |
|
| 416 | |||
| 417 | /** |
||
| 418 | * Tests add_jetpack_menu |
||
| 419 | * |
||
| 420 | * @covers ::add_jetpack_menu |
||
| 421 | */ |
||
| 422 | public function add_jetpack_menu() { |
||
| 431 | |||
| 432 | /** |
||
| 433 | * Tests add_gutenberg_menus |
||
| 434 | * |
||
| 435 | * @covers ::add_gutenberg_menus |
||
| 436 | */ |
||
| 437 | public function test_add_gutenberg_menus() { |
||
| 457 | } |
||
| 458 |
Let’s assume you have a class which uses late-static binding:
The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the
getSomeVariable()on that sub-class, you will receive a runtime error:In the case above, it makes sense to update
SomeClassto useselfinstead: