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 |
||
15 | class TemplateController extends StructureController |
||
16 | { |
||
17 | /** |
||
18 | * @ApiDoc( |
||
19 | * resource=true, |
||
20 | * description="List templates.", |
||
21 | * section="starkerxp_campaign.template", |
||
22 | * parameters={ |
||
23 | * { |
||
24 | * "name"="offset", |
||
25 | * "dataType"="integer", |
||
26 | * "requirement"="\d+", |
||
27 | * "description"="starkerxp_structure.doc.offset.result", |
||
28 | * "required"="false" |
||
29 | * }, |
||
30 | * { |
||
31 | * "name"="limit", |
||
32 | * "dataType"="integer", |
||
33 | * "requirement"="\d+", |
||
34 | * "description"="starkerxp_structure.doc.limit.result", |
||
35 | * "required"="false" |
||
36 | * }, |
||
37 | * { |
||
38 | * "name"="fields", |
||
39 | * "dataType"="string", |
||
40 | * "requirement"="\w+", |
||
41 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
42 | * "required"="false" |
||
43 | * }, |
||
44 | * { |
||
45 | * "name"="sort", |
||
46 | * "dataType"="string", |
||
47 | * "requirement"="\w+", |
||
48 | * "description"="starkerxp_structure.doc.sort.result", |
||
49 | * "required"="false" |
||
50 | * } |
||
51 | * }, |
||
52 | * views = { "default" } |
||
53 | * ) |
||
54 | * |
||
55 | */ |
||
56 | View Code Duplication | public function cgetAction(Request $request) |
|
77 | |||
78 | |||
79 | /** |
||
80 | * @ApiDoc( |
||
81 | * resource=true, |
||
82 | * description="Affiche un template.", |
||
83 | * section="starkerxp_campaign.template", |
||
84 | * requirements={ |
||
85 | * { |
||
86 | * "name"="template_id", |
||
87 | * "dataType"="integer", |
||
88 | * "requirement"="\d+", |
||
89 | * "description"="Permet d'afficher l'élément choisis" |
||
90 | * } |
||
91 | * }, |
||
92 | * parameters={ |
||
93 | * { |
||
94 | * "name"="fields", |
||
95 | * "dataType"="string", |
||
96 | * "requirement"="\w+", |
||
97 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
98 | * "required"="false" |
||
99 | * } |
||
100 | * }, |
||
101 | * views = { "default" } |
||
102 | * ) |
||
103 | */ |
||
104 | View Code Duplication | public function getAction(Request $request) |
|
120 | |||
121 | /** |
||
122 | * @ApiDoc( |
||
123 | * resource=true, |
||
124 | * description="Ajoute un template.", |
||
125 | * section="starkerxp_campaign.template", |
||
126 | * views = { "default" } |
||
127 | * ) |
||
128 | */ |
||
129 | public function postAction(Request $request) |
||
150 | |||
151 | /** |
||
152 | * @ApiDoc( |
||
153 | * resource=true, |
||
154 | * description="Modifie un template.", |
||
155 | * section="starkerxp_campaign.template", |
||
156 | * requirements={ |
||
157 | * { |
||
158 | * "name"="template_id", |
||
159 | * "dataType"="integer", |
||
160 | * "requirement"="\d+", |
||
161 | * "description"="Permet de modifier l'élément choisi." |
||
162 | * } |
||
163 | * }, |
||
164 | * views = { "default" } |
||
165 | * ) |
||
166 | */ |
||
167 | View Code Duplication | public function putAction(Request $request) |
|
189 | |||
190 | /** |
||
191 | * @ApiDoc( |
||
192 | * resource=true, |
||
193 | * description="Supprime un template.", |
||
194 | * section="starkerxp_campaign.template", |
||
195 | * requirements={ |
||
196 | * { |
||
197 | * "name"="template_id", |
||
198 | * "dataType"="integer", |
||
199 | * "requirement"="\d+", |
||
200 | * "description"="Permet de supprimer l'élément choisi." |
||
201 | * } |
||
202 | * }, |
||
203 | * views = { "default" } |
||
204 | * ) |
||
205 | */ |
||
206 | View Code Duplication | public function deleteAction(Request $request) |
|
222 | |||
223 | } |
||
224 |
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.