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 EventController extends StructureController |
||
16 | { |
||
17 | /** |
||
18 | * @ApiDoc( |
||
19 | * resource=true, |
||
20 | * description="Show events 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 | public function cgetAction(Request $request) |
||
56 | { |
||
57 | $manager = $this->get("starkerxp_campaign.manager.event"); |
||
58 | try { |
||
59 | $options = $this->resolveParams()->resolve($request->query->all()); |
||
60 | $orderBy = $this->getOrderBy($options['sort']); |
||
61 | $resultSets = $manager->findBy([], $orderBy, $options['limit'], $options['offset']); |
||
62 | } catch (\Exception $e) { |
||
63 | return new JsonResponse(["payload" => $e->getMessage()], 400); |
||
64 | } |
||
65 | if (empty($resultSets)) { |
||
66 | return new JsonResponse([]); |
||
67 | } |
||
68 | $retour = array_map( |
||
69 | function ($element) use ($manager, $options) { |
||
70 | return $manager->toArray($element, $this->getFields($options['fields'])); |
||
71 | }, |
||
72 | $resultSets |
||
73 | ); |
||
74 | |||
75 | return new JsonResponse($retour); |
||
76 | } |
||
77 | |||
78 | |||
79 | /** |
||
80 | * @ApiDoc( |
||
81 | * resource=true, |
||
82 | * description="Show event.", |
||
83 | * section="Campaign", |
||
84 | * requirements={ |
||
85 | * { |
||
86 | * "name"="campaign_id", |
||
87 | * "dataType"="integer", |
||
88 | * "requirement"="\d+", |
||
89 | * "description"="Show an element" |
||
90 | * }, |
||
91 | * { |
||
92 | * "name"="event_id", |
||
93 | * "dataType"="integer", |
||
94 | * "requirement"="\d+", |
||
95 | * "description"="Show an element" |
||
96 | * } |
||
97 | * }, |
||
98 | * parameters={ |
||
99 | * { |
||
100 | * "name"="fields", |
||
101 | * "dataType"="string", |
||
102 | * "requirement"="\w+", |
||
103 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
104 | * "required"="false" |
||
105 | * } |
||
106 | * }, |
||
107 | * views = { "default" } |
||
108 | * ) |
||
109 | */ |
||
110 | View Code Duplication | public function getAction(Request $request) |
|
126 | |||
127 | /** |
||
128 | * @ApiDoc( |
||
129 | * resource=true, |
||
130 | * description="Ajoute un event.", |
||
131 | * section="Campaign", |
||
132 | * views = { "default" } |
||
133 | * ) |
||
134 | */ |
||
135 | public function postAction(Request $request) |
||
161 | |||
162 | /** |
||
163 | * @ApiDoc( |
||
164 | * resource=true, |
||
165 | * description="Edit event.", |
||
166 | * section="Campaign", |
||
167 | * requirements={ |
||
168 | * { |
||
169 | * "name"="campaign_id", |
||
170 | * "dataType"="integer", |
||
171 | * "requirement"="\d+", |
||
172 | * "description"="Permet de modifier un élément de la campaign" |
||
173 | * }, |
||
174 | * { |
||
175 | * "name"="event_id", |
||
176 | * "dataType"="integer", |
||
177 | * "requirement"="\d+", |
||
178 | * "description"="edit an elements" |
||
179 | * } |
||
180 | * }, |
||
181 | * views = { "default" } |
||
182 | * ) |
||
183 | */ |
||
184 | public function putAction(Request $request) |
||
209 | |||
210 | /** |
||
211 | * @ApiDoc( |
||
212 | * resource=true, |
||
213 | * description="Delete event.", |
||
214 | * section="Campaign", |
||
215 | * requirements={ |
||
216 | * { |
||
217 | * "name"="campaign_id", |
||
218 | * "dataType"="integer", |
||
219 | * "requirement"="\d+", |
||
220 | * "description"="Permet de supprimer un élément de la campaign" |
||
221 | * }, |
||
222 | * { |
||
223 | * "name"="event_id", |
||
224 | * "dataType"="integer", |
||
225 | * "requirement"="\d+", |
||
226 | * "description"="Delete an elements" |
||
227 | * } |
||
228 | * }, |
||
229 | * views = { "default" } |
||
230 | * ) |
||
231 | */ |
||
232 | View Code Duplication | public function deleteAction(Request $request) |
|
250 | |||
251 | } |
||
252 |
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.