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 | View Code Duplication | class EventController extends StructureController |
|
|
|||
14 | { |
||
15 | /** |
||
16 | * @ApiDoc( |
||
17 | * resource=true, |
||
18 | * description="Liste les events.", |
||
19 | * section="Campagne", |
||
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 | * ) |
||
51 | */ |
||
52 | public function cgetAction(Request $request) |
||
73 | |||
74 | |||
75 | /** |
||
76 | * @ApiDoc( |
||
77 | * resource=true, |
||
78 | * description="Affiche un event.", |
||
79 | * section="Campagne", |
||
80 | * requirements={ |
||
81 | * { |
||
82 | * "name"="campagne_id", |
||
83 | * "dataType"="integer", |
||
84 | * "requirement"="\d+", |
||
85 | * "description"="Permet d'afficher l'élément choisis" |
||
86 | * }, |
||
87 | * { |
||
88 | * "name"="event_id", |
||
89 | * "dataType"="integer", |
||
90 | * "requirement"="\d+", |
||
91 | * "description"="Permet d'afficher l'élément choisis" |
||
92 | * } |
||
93 | * }, |
||
94 | * parameters={ |
||
95 | * { |
||
96 | * "name"="fields", |
||
97 | * "dataType"="string", |
||
98 | * "requirement"="\w+", |
||
99 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
100 | * "required"="false" |
||
101 | * } |
||
102 | * } |
||
103 | * ) |
||
104 | */ |
||
105 | public function getAction(Request $request) |
||
121 | |||
122 | /** |
||
123 | * @ApiDoc( |
||
124 | * resource=true, |
||
125 | * description="Ajoute un event.", |
||
126 | * section="Campagne" |
||
127 | * ) |
||
128 | */ |
||
129 | public function postAction(Request $request) |
||
149 | |||
150 | /** |
||
151 | * @ApiDoc( |
||
152 | * resource=true, |
||
153 | * description="Modifie un event.", |
||
154 | * section="Campagne", |
||
155 | * requirements={ |
||
156 | * { |
||
157 | * "name"="campagne_id", |
||
158 | * "dataType"="integer", |
||
159 | * "requirement"="\d+", |
||
160 | * "description"="Permet de modifier un élément de la campagne" |
||
161 | * }, |
||
162 | * { |
||
163 | * "name"="event_id", |
||
164 | * "dataType"="integer", |
||
165 | * "requirement"="\d+", |
||
166 | * "description"="Permet de modifier l'élément choisis" |
||
167 | * } |
||
168 | * } |
||
169 | * ) |
||
170 | */ |
||
171 | public function putAction(Request $request) |
||
193 | |||
194 | /** |
||
195 | * @ApiDoc( |
||
196 | * resource=true, |
||
197 | * description="Supprime un event.", |
||
198 | * section="Campagne", |
||
199 | * requirements={ |
||
200 | * { |
||
201 | * "name"="campagne_id", |
||
202 | * "dataType"="integer", |
||
203 | * "requirement"="\d+", |
||
204 | * "description"="Permet de supprimer un élément de la campagne" |
||
205 | * }, |
||
206 | * { |
||
207 | * "name"="event_id", |
||
208 | * "dataType"="integer", |
||
209 | * "requirement"="\d+", |
||
210 | * "description"="Permet de supprimer l'élément choisis" |
||
211 | * } |
||
212 | * } |
||
213 | * ) |
||
214 | */ |
||
215 | public function deleteAction(Request $request) |
||
230 | |||
231 | } |
||
232 |
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.