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 |
||
23 | View Code Duplication | class ApiNode extends AbstractNode |
|
|
|||
24 | { |
||
25 | /** |
||
26 | * add api |
||
27 | * |
||
28 | * @param \Unikorp\KongAdminApi\Document\ApiDocument $document |
||
29 | * |
||
30 | * @return \Psr\Http\Message\ResponseInterface |
||
31 | */ |
||
32 | 2 | public function addApi(Document $document): ResponseInterface |
|
36 | |||
37 | /** |
||
38 | * retrieve api |
||
39 | * |
||
40 | * @param string $nameOrId |
||
41 | * |
||
42 | * @return \Psr\Http\Message\ResponseInterface |
||
43 | */ |
||
44 | 2 | public function retrieveApi(string $nameOrId): ResponseInterface |
|
48 | |||
49 | /** |
||
50 | * list apis |
||
51 | * |
||
52 | * @param \Unikorp\KongAdminApi\Document\ApiDocument $document |
||
53 | * |
||
54 | * @return \Psr\Http\Message\ResponseInterface |
||
55 | */ |
||
56 | 2 | public function listApis(Document $document = null): ResponseInterface |
|
60 | |||
61 | /** |
||
62 | * update api |
||
63 | * |
||
64 | * @param string $nameOrId |
||
65 | * @param \Unikorp\KongAdminApi\Document\ApiDocument $document |
||
66 | * |
||
67 | * @return \Psr\Http\Message\ResponseInterface |
||
68 | */ |
||
69 | 2 | public function updateApi(string $nameOrId, Document $document): ResponseInterface |
|
73 | |||
74 | /** |
||
75 | * update or create api |
||
76 | * |
||
77 | * @param \Unikorp\KongAdminApi\Document\ApiDocument $document |
||
78 | * |
||
79 | * @return \Psr\Http\Message\ResponseInterface |
||
80 | */ |
||
81 | 2 | public function updateOrCreateApi(Document $document): ResponseInterface |
|
85 | |||
86 | /** |
||
87 | * delete api |
||
88 | * |
||
89 | * @param string $nameOrId |
||
90 | * |
||
91 | * @return \Psr\Http\Message\ResponseInterface |
||
92 | */ |
||
93 | 2 | public function deleteApi(string $nameOrId): ResponseInterface |
|
97 | } |
||
98 |
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.