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 CampagneController extends StructureController |
|
|
|||
14 | { |
||
15 | /** |
||
16 | * @ApiDoc( |
||
17 | * resource=true, |
||
18 | * description="Liste les campagnes.", |
||
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 | * @ApiDoc( |
||
76 | * resource=true, |
||
77 | * description="Affiche une campagne.", |
||
78 | * section="Campagne", |
||
79 | * requirements={ |
||
80 | * { |
||
81 | * "name"="campagne_id", |
||
82 | * "dataType"="integer", |
||
83 | * "requirement"="\d+", |
||
84 | * "description"="Permet d'afficher l'élément choisis" |
||
85 | * } |
||
86 | * }, |
||
87 | * parameters={ |
||
88 | * { |
||
89 | * "name"="fields", |
||
90 | * "dataType"="string", |
||
91 | * "requirement"="\w+", |
||
92 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
93 | * "required"="false" |
||
94 | * } |
||
95 | * } |
||
96 | * ) |
||
97 | */ |
||
98 | public function getAction(Request $request) |
||
114 | |||
115 | /** |
||
116 | * @ApiDoc( |
||
117 | * resource=true, |
||
118 | * description="Ajoute une campagne.", |
||
119 | * section="Campagne" |
||
120 | * ) |
||
121 | */ |
||
122 | public function postAction(Request $request) |
||
142 | |||
143 | /** |
||
144 | * @ApiDoc( |
||
145 | * resource=true, |
||
146 | * description="Modifie une campagne.", |
||
147 | * section="Campagne", |
||
148 | * requirements={ |
||
149 | * { |
||
150 | * "name"="campagne_id", |
||
151 | * "dataType"="integer", |
||
152 | * "requirement"="\d+", |
||
153 | * "description"="Permet de modifier l'élément choisi." |
||
154 | * } |
||
155 | * } |
||
156 | * ) |
||
157 | */ |
||
158 | public function putAction(Request $request) |
||
180 | |||
181 | /** |
||
182 | * @ApiDoc( |
||
183 | * resource=true, |
||
184 | * description="Supprime une campagne.", |
||
185 | * section="Campagne", |
||
186 | * requirements={ |
||
187 | * { |
||
188 | * "name"="campagne_id", |
||
189 | * "dataType"="integer", |
||
190 | * "requirement"="\d+", |
||
191 | * "description"="Permet de supprimer l'élément choisi." |
||
192 | * } |
||
193 | * } |
||
194 | * ) |
||
195 | */ |
||
196 | public function deleteAction(Request $request) |
||
211 | |||
212 | } |
||
213 |
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.