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 |
||
30 | class MenuController extends FOSRestController |
||
31 | { |
||
32 | /** |
||
33 | * Lists all registered menus. |
||
34 | * |
||
35 | * @ApiDoc( |
||
36 | * resource=true, |
||
37 | * description="Lists all registered menus", |
||
38 | * statusCodes={ |
||
39 | * 200="Returned on success.", |
||
40 | * 404="No menus found." |
||
41 | * } |
||
42 | * ) |
||
43 | * @Route("/api/{version}/menus/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_list_menu") |
||
44 | * @Method("GET") |
||
45 | */ |
||
46 | 2 | View Code Duplication | public function listAction(Request $request) |
54 | |||
55 | /** |
||
56 | * Get single menu. |
||
57 | * |
||
58 | * @ApiDoc( |
||
59 | * resource=true, |
||
60 | * description="Get single menu", |
||
61 | * statusCodes={ |
||
62 | * 200="Returned on success.", |
||
63 | * 404="Menu not found", |
||
64 | * 422="Menu id is not number" |
||
65 | * } |
||
66 | * ) |
||
67 | * @Route("/api/{version}/menus/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_get_menu") |
||
68 | * @Method("GET") |
||
69 | */ |
||
70 | 2 | public function getAction($id) |
|
74 | |||
75 | /** |
||
76 | * Create new menu. |
||
77 | * |
||
78 | * @ApiDoc( |
||
79 | * resource=true, |
||
80 | * description="Create new menu", |
||
81 | * statusCodes={ |
||
82 | * 201="Returned on success.", |
||
83 | * 400="Returned when form have errors" |
||
84 | * }, |
||
85 | * input="SWP\Bundle\MenuBundle\Form\Type\MenuType" |
||
86 | * ) |
||
87 | * @Route("/api/{version}/menus/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_create_menu") |
||
88 | * @Method("POST") |
||
89 | */ |
||
90 | 4 | public function createAction(Request $request) |
|
112 | |||
113 | /** |
||
114 | * Delete single menu. |
||
115 | * |
||
116 | * @ApiDoc( |
||
117 | * resource=true, |
||
118 | * description="Delete single menu", |
||
119 | * statusCodes={ |
||
120 | * 204="Returned on success.", |
||
121 | * 404="Menu not found", |
||
122 | * 422="Menu id is not number" |
||
123 | * } |
||
124 | * ) |
||
125 | * @Route("/api/{version}/menus/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_delete_menu") |
||
126 | * @Method("DELETE") |
||
127 | */ |
||
128 | 1 | public function deleteAction($id) |
|
135 | |||
136 | /** |
||
137 | * Update single menu. |
||
138 | * |
||
139 | * @ApiDoc( |
||
140 | * resource=true, |
||
141 | * description="Update single menu", |
||
142 | * statusCodes={ |
||
143 | * 201="Returned on success.", |
||
144 | * 404="Menu not found", |
||
145 | * 422="Menu id is not number", |
||
146 | * 405="Method Not Allowed" |
||
147 | * }, |
||
148 | * input="SWP\Bundle\TemplateEngineBundle\Form\Type\MenuType" |
||
149 | * ) |
||
150 | * @Route("/api/{version}/menus/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_update_menu") |
||
151 | * @Method("PATCH") |
||
152 | */ |
||
153 | 2 | View Code Duplication | public function updateAction(Request $request, $id) |
169 | |||
170 | 4 | private function findOr404($id) |
|
178 | |||
179 | 4 | private function ensureMenuItemExists($name) |
|
185 | } |
||
186 |
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.