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 |
||
13 | class UserController extends StructureController |
||
14 | { |
||
15 | /** |
||
16 | * @ApiDoc( |
||
17 | * resource=true, |
||
18 | * description="Liste les users.", |
||
19 | * section="User", |
||
20 | * parameters={ |
||
21 | * { |
||
22 | * "name"="offset", |
||
23 | * "dataType"="integer", |
||
24 | * "requirement"="\d+", |
||
25 | * "description"="starkerxp_structure.doc.offset.result", |
||
26 | * "required"="false" |
||
27 | * }, |
||
28 | * { |
||
29 | * "name"="limit", |
||
30 | * "dataType"="integer", |
||
31 | * "requirement"="\d+", |
||
32 | * "description"="starkerxp_structure.doc.limit.result", |
||
33 | * "required"="false" |
||
34 | * }, |
||
35 | * { |
||
36 | * "name"="fields", |
||
37 | * "dataType"="string", |
||
38 | * "requirement"="\w+", |
||
39 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
40 | * "required"="false" |
||
41 | * }, |
||
42 | * { |
||
43 | * "name"="sort", |
||
44 | * "dataType"="string", |
||
45 | * "requirement"="\w+", |
||
46 | * "description"="starkerxp_structure.doc.sort.result", |
||
47 | * "required"="false" |
||
48 | * } |
||
49 | * }, |
||
50 | * views = { "default" } |
||
51 | * ) |
||
52 | */ |
||
53 | public function cgetAction(Request $request) |
||
75 | |||
76 | |||
77 | /** |
||
78 | * @ApiDoc( |
||
79 | * resource=true, |
||
80 | * description="Affiche un user.", |
||
81 | * section="User", |
||
82 | * requirements={ |
||
83 | * { |
||
84 | * "name"="user_id", |
||
85 | * "dataType"="integer", |
||
86 | * "requirement"="\d+", |
||
87 | * "description"="Permet d'afficher l'élément choisis" |
||
88 | * } |
||
89 | * }, |
||
90 | * parameters={ |
||
91 | * { |
||
92 | * "name"="fields", |
||
93 | * "dataType"="string", |
||
94 | * "requirement"="\w+", |
||
95 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
96 | * "required"="false" |
||
97 | * } |
||
98 | * }, |
||
99 | * views = { "default" } |
||
100 | * ) |
||
101 | */ |
||
102 | View Code Duplication | public function getAction(Request $request) |
|
118 | |||
119 | /** |
||
120 | * @ApiDoc( |
||
121 | * resource=true, |
||
122 | * description="Ajoute un user.", |
||
123 | * section="User", |
||
124 | * requirements={ |
||
125 | * { |
||
126 | * "name"="email", |
||
127 | * "dataType"="string", |
||
128 | * "requirement"="\w+", |
||
129 | * "description"="Définit l'identifiant de connexion" |
||
130 | * }, |
||
131 | * { |
||
132 | * "name"="type", |
||
133 | * "dataType"="integer", |
||
134 | * "requirement"="\d+", |
||
135 | * "description"="1 - User / 2 - Api" |
||
136 | * }, |
||
137 | * }, |
||
138 | * views = { "default" } |
||
139 | * ) |
||
140 | */ |
||
141 | View Code Duplication | public function postAction(Request $request) |
|
162 | |||
163 | /** |
||
164 | * @ApiDoc( |
||
165 | * resource=true, |
||
166 | * description="Modifie un user.", |
||
167 | * section="User", |
||
168 | * requirements={ |
||
169 | * { |
||
170 | * "name"="user_id", |
||
171 | * "dataType"="integer", |
||
172 | * "requirement"="\d+", |
||
173 | * "description"="Permet de modifier l'élément choisi." |
||
174 | * } |
||
175 | * }, |
||
176 | * views = { "default" } |
||
177 | * ) |
||
178 | */ |
||
179 | public function putAction(Request $request) |
||
208 | |||
209 | /** |
||
210 | * @ApiDoc( |
||
211 | * resource=true, |
||
212 | * description="Supprime un user.", |
||
213 | * section="User", |
||
214 | * requirements={ |
||
215 | * { |
||
216 | * "name"="user_id", |
||
217 | * "dataType"="integer", |
||
218 | * "requirement"="\d+", |
||
219 | * "description"="Permet de supprimer l'élément choisi." |
||
220 | * } |
||
221 | * }, |
||
222 | * views = { "default" } |
||
223 | * ) |
||
224 | * @Security("has_role('ROLE_SUPER_ADMIN')") |
||
225 | */ |
||
226 | public function deleteAction(Request $request) |
||
235 | |||
236 | } |
||
237 |
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.