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 |
||
33 | class ContentListController extends Controller |
||
34 | { |
||
35 | /** |
||
36 | * @ApiDoc( |
||
37 | * resource=true, |
||
38 | * description="Lists all content lists", |
||
39 | * statusCodes={ |
||
40 | * 200="Returned on success." |
||
41 | * } |
||
42 | * ) |
||
43 | * @Route("/api/{version}/content/lists/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_list_lists") |
||
44 | * @Method("GET") |
||
45 | * |
||
46 | * @Cache(expires="10 minutes", public=true) |
||
47 | */ |
||
48 | 1 | View Code Duplication | public function listAction(Request $request) |
56 | |||
57 | /** |
||
58 | * @ApiDoc( |
||
59 | * resource=true, |
||
60 | * description="Show single content list", |
||
61 | * statusCodes={ |
||
62 | * 200="Returned on success." |
||
63 | * } |
||
64 | * ) |
||
65 | * @Route("/api/{version}/content/lists/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_show_lists", requirements={"id"="\d+"}) |
||
66 | * @Method("GET") |
||
67 | * |
||
68 | * @Cache(expires="10 minutes", public=true) |
||
69 | */ |
||
70 | 1 | public function getAction($id) |
|
74 | |||
75 | /** |
||
76 | * @ApiDoc( |
||
77 | * resource=true, |
||
78 | * description="Create new content list", |
||
79 | * statusCodes={ |
||
80 | * 201="Returned on success.", |
||
81 | * 400="Returned when not valid data." |
||
82 | * }, |
||
83 | * input="SWP\Bundle\ContentListBundle\Form\Type\ContentListType" |
||
84 | * ) |
||
85 | * @Route("/api/{version}/content/lists/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_create_lists") |
||
86 | * @Method("POST") |
||
87 | */ |
||
88 | 6 | View Code Duplication | public function createAction(Request $request) |
105 | |||
106 | /** |
||
107 | * @ApiDoc( |
||
108 | * resource=true, |
||
109 | * description="Update single content list", |
||
110 | * statusCodes={ |
||
111 | * 200="Returned on success.", |
||
112 | * 400="Returned when not valid data.", |
||
113 | * 404="Returned when not found.", |
||
114 | * 409="Returned on conflict." |
||
115 | * }, |
||
116 | * input="SWP\Bundle\ContentListBundle\Form\Type\ContentListType" |
||
117 | * ) |
||
118 | * @Route("/api/{version}/content/lists/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_update_lists", requirements={"id"="\d+"}) |
||
119 | * @Method("PATCH") |
||
120 | */ |
||
121 | 1 | public function updateAction(Request $request, $id) |
|
136 | |||
137 | /** |
||
138 | * @ApiDoc( |
||
139 | * resource=true, |
||
140 | * description="Delete single content list", |
||
141 | * statusCodes={ |
||
142 | * 204="Returned on success." |
||
143 | * } |
||
144 | * ) |
||
145 | * @Route("/api/{version}/content/lists/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_delete_lists", requirements={"id"="\d+"}) |
||
146 | * @Method("DELETE") |
||
147 | */ |
||
148 | 2 | public function deleteAction($id) |
|
157 | |||
158 | 4 | private function findOr404($id) |
|
166 | |||
167 | 6 | private function ensureContentListExists($name) |
|
173 | } |
||
174 |
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.