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 |
||
7 | |||
8 | class AdminltePresenter extends Presenter |
||
9 | { |
||
10 | /** |
||
11 | * {@inheritdoc} |
||
12 | */ |
||
13 | public function getOpenTagWrapper(): ?string |
||
14 | { |
||
15 | return PHP_EOL . '<ul class="sidebar-menu tree" data-widget="tree">' . PHP_EOL; |
||
16 | } |
||
17 | |||
18 | /** |
||
19 | * {@inheritdoc} |
||
20 | */ |
||
21 | public function getCloseTagWrapper(): ?string |
||
22 | { |
||
23 | return PHP_EOL . '</ul>' . PHP_EOL; |
||
24 | } |
||
25 | |||
26 | /** |
||
27 | * {@inheritdoc} |
||
28 | */ |
||
29 | public function getMenuWithoutDropdownWrapper(MenuItemContract $item): ?string |
||
32 | } |
||
33 | |||
34 | /** |
||
35 | * {@inheritdoc}. |
||
36 | */ |
||
37 | public function getActiveState(MenuItemContract $item, $state = ' class="active"'): mixed |
||
38 | { |
||
39 | return $item->isActive() ? $state : null; |
||
40 | } |
||
41 | |||
42 | /** |
||
43 | * Get active state on child items. |
||
44 | * |
||
45 | * @param $item |
||
46 | * @param string $state |
||
47 | * |
||
48 | * @return null|string |
||
49 | */ |
||
50 | public function getActiveStateOnChild(MenuItemContract $item, string $state = 'active'): ?string |
||
51 | { |
||
52 | return $item->hasActiveOnChild() ? $state : null; |
||
53 | } |
||
54 | |||
55 | /** |
||
56 | * {@inheritdoc} |
||
57 | */ |
||
58 | public function getDividerWrapper(): ?string |
||
59 | { |
||
60 | return '<li class="divider"></li>'; |
||
61 | } |
||
62 | |||
63 | /** |
||
64 | * {@inheritdoc} |
||
65 | */ |
||
66 | public function getHeaderWrapper(MenuItemContract $item): ?string |
||
69 | } |
||
70 | |||
71 | /** |
||
72 | * {@inheritdoc}. |
||
73 | */ |
||
74 | public function getMenuWithDropDownWrapper(MenuItemContract $item): ?string |
||
88 | } |
||
89 | |||
90 | /** |
||
91 | * Get multilevel menu wrapper. |
||
92 | * |
||
93 | * @param MenuItemContract $item |
||
94 | * |
||
95 | * @return string |
||
96 | */ |
||
97 | public function getMultiLevelDropdownWrapper(MenuItemContract $item): string |
||
111 | } |
||
112 | } |
||
113 |
This check compares calls to functions or methods with their respective definitions. If the call has less arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.