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 |
||
13 | final class Session implements SessionInterface |
||
14 | { |
||
15 | /** |
||
16 | * @var LoggerInterface |
||
17 | */ |
||
18 | private $logger; |
||
19 | |||
20 | /** |
||
21 | * @param LoggerInterface $logger |
||
22 | */ |
||
23 | public function __construct(LoggerInterface $logger = null) |
||
27 | |||
28 | /** |
||
29 | * @param Request $request |
||
30 | * @param string $key |
||
31 | * |
||
32 | * @return bool |
||
33 | */ |
||
34 | public function has(Request $request, string $key): bool |
||
42 | |||
43 | /** |
||
44 | * @param Request $request |
||
45 | * @param string $key |
||
46 | * |
||
47 | * @return mixed |
||
48 | */ |
||
49 | View Code Duplication | public function get(Request $request, string $key) |
|
60 | |||
61 | /** |
||
62 | * @param Request $request |
||
63 | * @param string $key |
||
64 | * @param mixed $value |
||
65 | */ |
||
66 | View Code Duplication | public function set(Request $request, string $key, $value) |
|
77 | |||
78 | /** |
||
79 | * @param Request $request |
||
80 | * @param string $key |
||
81 | */ |
||
82 | public function remove(Request $request, string $key) |
||
88 | |||
89 | /** |
||
90 | * @param Request $request |
||
91 | * @param FlashMessage $flashMessage |
||
92 | */ |
||
93 | public function addFlash(Request $request, FlashMessage $flashMessage) |
||
97 | |||
98 | /** |
||
99 | * @param Request $request |
||
100 | * |
||
101 | * @return FlashMessage|null |
||
102 | */ |
||
103 | public function getFlash(Request $request) |
||
114 | |||
115 | /** |
||
116 | * @param Request $request |
||
117 | * |
||
118 | * @return PSR7Session |
||
119 | */ |
||
120 | private function getSession(Request $request): PSR7Session |
||
124 | } |
||
125 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.