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 |
||
21 | class ApiKeyController extends ApiController { |
||
22 | |||
23 | private $userId; |
||
24 | private $apiKeyMapper; |
||
25 | |||
26 | public function __construct($appName, IRequest $request, ApiKeyMapper $apiKeyMapper, $userId) { |
||
31 | |||
32 | /** |
||
33 | * @NoAdminRequired |
||
34 | * |
||
35 | * @param $key string |
||
36 | * @param $id int |
||
37 | * @return JSONResponse |
||
38 | */ |
||
39 | View Code Duplication | public function updateKey($key, $id) { |
|
55 | |||
56 | /** |
||
57 | * @NoAdminRequired |
||
58 | * |
||
59 | * @param $key string |
||
60 | * @return JSONResponse |
||
61 | */ |
||
62 | public function addKey($key){ |
||
73 | |||
74 | /** |
||
75 | * @NoAdminRequired |
||
76 | * |
||
77 | * @return JSONResponse |
||
78 | */ |
||
79 | public function getKey(){ |
||
88 | |||
89 | /** |
||
90 | * @NoAdminRequired |
||
91 | * |
||
92 | * @param $id int |
||
93 | * @return JSONResponse |
||
94 | */ |
||
95 | public function removeApiKey($id){ |
||
102 | |||
103 | } |
||
104 |
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.