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 CampaignController extends StructureController |
||
16 | { |
||
17 | /** |
||
18 | * @ApiDoc( |
||
19 | * resource=true, |
||
20 | * description="Show campaigns list.", |
||
21 | * section="Campaign", |
||
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 | View Code Duplication | public function cgetAction(Request $request) |
|
74 | |||
75 | /** |
||
76 | * @ApiDoc( |
||
77 | * resource=true, |
||
78 | * description="Show campaign.", |
||
79 | * section="Campaign", |
||
80 | * requirements={ |
||
81 | * { |
||
82 | * "name"="campaign_id", |
||
83 | * "dataType"="integer", |
||
84 | * "requirement"="\d+", |
||
85 | * "description"="Permet d'afficher l'élément choisis" |
||
86 | * } |
||
87 | * }, |
||
88 | * parameters={ |
||
89 | * { |
||
90 | * "name"="fields", |
||
91 | * "dataType"="string", |
||
92 | * "requirement"="\w+", |
||
93 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
94 | * "required"="false" |
||
95 | * } |
||
96 | * }, |
||
97 | * views = { "default" } |
||
98 | * ) |
||
99 | */ |
||
100 | View Code Duplication | public function getAction(Request $request) |
|
115 | |||
116 | /** |
||
117 | * @ApiDoc( |
||
118 | * resource=true, |
||
119 | * description="Add campaign.", |
||
120 | * section="Campaign", |
||
121 | * views = {"default"} |
||
122 | * ) |
||
123 | */ |
||
124 | public function postAction(Request $request) |
||
146 | |||
147 | /** |
||
148 | * @ApiDoc( |
||
149 | * resource=true, |
||
150 | * description="Edit campaign.", |
||
151 | * section="Campaign", |
||
152 | * requirements={ |
||
153 | * { |
||
154 | * "name"="campaign_id", |
||
155 | * "dataType"="integer", |
||
156 | * "requirement"="\d+", |
||
157 | * "description"="Permet de modifier l'élément choisi." |
||
158 | * } |
||
159 | * }, |
||
160 | * views = { "default" } |
||
161 | * ) |
||
162 | */ |
||
163 | View Code Duplication | public function putAction(Request $request) |
|
188 | |||
189 | /** |
||
190 | * @ApiDoc( |
||
191 | * resource=true, |
||
192 | * description="Delete campaign.", |
||
193 | * section="Campaign", |
||
194 | * requirements={ |
||
195 | * { |
||
196 | * "name"="campaign_id", |
||
197 | * "dataType"="integer", |
||
198 | * "requirement"="\d+", |
||
199 | * "description"="Permet de supprimer l'élément choisi." |
||
200 | * } |
||
201 | * }, |
||
202 | * views = { "default" } |
||
203 | * ) |
||
204 | */ |
||
205 | 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.