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 |
||
32 | class WidgetController extends FOSRestController |
||
33 | { |
||
34 | /** |
||
35 | * Lists all registered widgets. |
||
36 | * |
||
37 | * @ApiDoc( |
||
38 | * resource=true, |
||
39 | * description="Lists all registered widgets", |
||
40 | * statusCodes={ |
||
41 | * 200="Returned on success." |
||
42 | * } |
||
43 | * ) |
||
44 | * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets") |
||
45 | * @Method("GET") |
||
46 | * @Cache(expires="10 minutes", public=true) |
||
47 | */ |
||
48 | 2 | public function listAction(Request $request) |
|
56 | |||
57 | /** |
||
58 | 2 | * Get single widget. |
|
59 | * |
||
60 | * @ApiDoc( |
||
61 | * resource=true, |
||
62 | 2 | * description="Get single widget", |
|
63 | * statusCodes={ |
||
64 | * 200="Returned on success.", |
||
65 | * 404="Widget not found", |
||
66 | * 422="Widget id is not number" |
||
67 | * } |
||
68 | * ) |
||
69 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_get_widget") |
||
70 | * @Method("GET") |
||
71 | */ |
||
72 | public function getAction($id) |
||
76 | |||
77 | /** |
||
78 | * Create new widget. |
||
79 | * |
||
80 | 3 | * Note: |
|
81 | * |
||
82 | 3 | * Widget Type can be widget ID or his class (string). |
|
83 | * Example: "SWP\\Bundle\\CoreBundle\\Widget\\ContentListWidget" |
||
84 | * |
||
85 | * @ApiDoc( |
||
86 | 3 | * resource=true, |
|
87 | 3 | * description="Create new widget", |
|
88 | * statusCodes={ |
||
89 | 3 | * 201="Returned on success.", |
|
90 | * 400="Returned when form have errors" |
||
91 | * }, |
||
92 | * input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType" |
||
93 | * ) |
||
94 | 3 | * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_create_widget") |
|
95 | 2 | * @Method("POST") |
|
96 | */ |
||
97 | View Code Duplication | public function createAction(Request $request) |
|
111 | |||
112 | /** |
||
113 | * Delete single widget. |
||
114 | * |
||
115 | * @ApiDoc( |
||
116 | 2 | * resource=true, |
|
117 | * description="Delete single widget", |
||
118 | 2 | * statusCodes={ |
|
119 | * 204="Returned on success.", |
||
120 | 2 | * 404="Widget not found", |
|
121 | 2 | * 422="Widget id is not number" |
|
122 | 2 | * } |
|
123 | 2 | * ) |
|
124 | 2 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_delete_widget") |
|
125 | 2 | * @Method("DELETE") |
|
126 | */ |
||
127 | 2 | public function deleteAction($id) |
|
140 | |||
141 | /** |
||
142 | * Update single widget. |
||
143 | * |
||
144 | * @ApiDoc( |
||
145 | * resource=true, |
||
146 | * description="Update single widget", |
||
147 | * statusCodes={ |
||
148 | 1 | * 201="Returned on success.", |
|
149 | * 404="Widget not found", |
||
150 | 1 | * 422="Widget id is not number", |
|
151 | * 405="Method Not Allowed" |
||
152 | * }, |
||
153 | * input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType" |
||
154 | 1 | * ) |
|
155 | 1 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_update_widget") |
|
156 | * @Method("PATCH") |
||
157 | 1 | */ |
|
158 | View Code Duplication | public function updateAction(Request $request, $id) |
|
174 | |||
175 | private function findOr404(int $id) |
||
183 | |||
184 | private function ensureWidgetExists(string $name) |
||
192 | |||
193 | private function getWidgetRepository() |
||
197 | } |
||
198 |
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.