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:
Complex classes like EventsController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use EventsController, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
18 | class EventsController extends ResourceController |
||
19 | { |
||
20 | public function setContainer(ContainerInterface $container = null) |
||
25 | |||
26 | /** |
||
27 | * @ApiDoc( |
||
28 | * resource=true, |
||
29 | * description="Liste les événements", |
||
30 | * output="KI\PublicationBundle\Entity\Event", |
||
31 | * statusCodes={ |
||
32 | * 200="Requête traitée avec succès", |
||
33 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
34 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
35 | * 503="Service temporairement indisponible ou en maintenance", |
||
36 | * }, |
||
37 | * section="Publications" |
||
38 | * ) |
||
39 | * @Route("/events") |
||
40 | * @Method("GET") |
||
41 | */ |
||
42 | public function getEventsAction() |
||
46 | |||
47 | /** |
||
48 | * @ApiDoc( |
||
49 | * description="Retourne un événement", |
||
50 | * output="KI\PublicationBundle\Entity\Event", |
||
51 | * statusCodes={ |
||
52 | * 200="Requête traitée avec succès", |
||
53 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
54 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
55 | * 404="Ressource non trouvée", |
||
56 | * 503="Service temporairement indisponible ou en maintenance", |
||
57 | * }, |
||
58 | * section="Publications" |
||
59 | * ) |
||
60 | * @Route("/events/{slug}") |
||
61 | * @Method("GET") |
||
62 | */ |
||
63 | public function getEventAction($slug) |
||
69 | |||
70 | /** |
||
71 | * @ApiDoc( |
||
72 | * description="Crée un événement", |
||
73 | * input="KI\PublicationBundle\Form\EventType", |
||
74 | * output="KI\PublicationBundle\Entity\Event", |
||
75 | * statusCodes={ |
||
76 | * 201="Requête traitée avec succès avec création d’un document", |
||
77 | * 400="La syntaxe de la requête est erronée", |
||
78 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
79 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
80 | * 503="Service temporairement indisponible ou en maintenance", |
||
81 | * }, |
||
82 | * section="Publications" |
||
83 | * ) |
||
84 | * @Route("/events") |
||
85 | * @Method("POST") |
||
86 | */ |
||
87 | View Code Duplication | public function postEventAction() |
|
97 | |||
98 | /** |
||
99 | * @ApiDoc( |
||
100 | * description="Modifie un événement", |
||
101 | * input="KI\PublicationBundle\Form\EventType", |
||
102 | * statusCodes={ |
||
103 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
104 | * 400="La syntaxe de la requête est erronée", |
||
105 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
106 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
107 | * 404="Ressource non trouvée", |
||
108 | * 503="Service temporairement indisponible ou en maintenance", |
||
109 | * }, |
||
110 | * section="Publications" |
||
111 | * ) |
||
112 | * @Route("/events/{slug}") |
||
113 | * @Method("PATCH") |
||
114 | */ |
||
115 | public function patchEventAction($slug) |
||
127 | |||
128 | /** |
||
129 | * @ApiDoc( |
||
130 | * description="Supprime un événement", |
||
131 | * statusCodes={ |
||
132 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
133 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
134 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
135 | * 404="Ressource non trouvée", |
||
136 | * 503="Service temporairement indisponible ou en maintenance", |
||
137 | * }, |
||
138 | * section="Publications" |
||
139 | * ) |
||
140 | * @Route("/events/{slug}") |
||
141 | * @Method("DELETE") |
||
142 | */ |
||
143 | public function deleteEventAction($slug) |
||
161 | |||
162 | /** |
||
163 | * @ApiDoc( |
||
164 | * description="Shotgunne un événement", |
||
165 | * requirements={ |
||
166 | * { |
||
167 | * "name"="motivation", |
||
168 | * "dataType"="string", |
||
169 | * "description"="Un texte de motivation" |
||
170 | * } |
||
171 | * }, |
||
172 | * output="KI\PublicationBundle\Entity\EventUser", |
||
173 | * statusCodes={ |
||
174 | * 201="Requête traitée avec succès avec création d’un document", |
||
175 | * 400="La syntaxe de la requête est erronée", |
||
176 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
177 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
178 | * 503="Service temporairement indisponible ou en maintenance", |
||
179 | * }, |
||
180 | * section="Publications" |
||
181 | * ) |
||
182 | * @Route("/events/{slug}/shotgun") |
||
183 | * @Method("POST") |
||
184 | */ |
||
185 | public function postEventUserAction(Request $request, $slug) |
||
217 | |||
218 | /** |
||
219 | * @ApiDoc( |
||
220 | * description="Modifie un shotgun", |
||
221 | * requirements={ |
||
222 | * { |
||
223 | * "name"="motivation", |
||
224 | * "dataType"="string", |
||
225 | * "description"="Un texte de motivation" |
||
226 | * } |
||
227 | * }, |
||
228 | * statusCodes={ |
||
229 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
230 | * 400="La syntaxe de la requête est erronée", |
||
231 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
232 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
233 | * 404="Ressource non trouvée", |
||
234 | * 503="Service temporairement indisponible ou en maintenance", |
||
235 | * }, |
||
236 | * section="Publications" |
||
237 | * ) |
||
238 | * @Route("/events/{slug}/shotgun") |
||
239 | * @Method("PATCH") |
||
240 | */ |
||
241 | public function patchEventUserAction(Request $request, $slug) |
||
263 | |||
264 | /** |
||
265 | * @ApiDoc( |
||
266 | * description="Enlève un utilisateur du shotgun", |
||
267 | * statusCodes={ |
||
268 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
269 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
270 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
271 | * 404="Ressource non trouvée", |
||
272 | * 503="Service temporairement indisponible ou en maintenance", |
||
273 | * }, |
||
274 | * section="Publications" |
||
275 | * ) |
||
276 | * @Route("/events/{slug}/shotgun") |
||
277 | * @Method("DELETE") |
||
278 | */ |
||
279 | public function deleteEventUserAction($slug) |
||
311 | |||
312 | /** |
||
313 | * @ApiDoc( |
||
314 | * description="Retourne le tableau des utilisateurs ayant réussi le shotgun ainsi que la liste d'attente classée par date de shotgun et le nombre limite de personnes pouvant shotgunner.", |
||
315 | * statusCodes={ |
||
316 | * 200="Requête traitée avec succès", |
||
317 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
318 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
319 | * 404="Ressource non trouvée", |
||
320 | * 503="Service temporairement indisponible ou en maintenance", |
||
321 | * }, |
||
322 | * section="Publications" |
||
323 | * ) |
||
324 | * @Route("/events/{slug}/shotgun") |
||
325 | * @Method("GET") |
||
326 | */ |
||
327 | public function getEventUserAction($slug) |
||
404 | |||
405 | /** |
||
406 | * @ApiDoc( |
||
407 | * description="Ajoute un utilisateur à l'event", |
||
408 | * statusCodes={ |
||
409 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
410 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
411 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
412 | * 404="Ressource non trouvée", |
||
413 | * 503="Service temporairement indisponible ou en maintenance", |
||
414 | * }, |
||
415 | * section="Publications" |
||
416 | * ) |
||
417 | * @Route("/events/{slug}/attend") |
||
418 | * @Method("POST") |
||
419 | */ |
||
420 | public function attendAction($slug) |
||
442 | |||
443 | /** |
||
444 | * @ApiDoc( |
||
445 | * description="Retire la demande d'inscription", |
||
446 | * statusCodes={ |
||
447 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
448 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
449 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
450 | * 404="Ressource non trouvée", |
||
451 | * 503="Service temporairement indisponible ou en maintenance", |
||
452 | * }, |
||
453 | * section="Publications" |
||
454 | * ) |
||
455 | * @Route("/events/{slug}/attend") |
||
456 | * @Method("DELETE") |
||
457 | */ |
||
458 | View Code Duplication | public function noAttendAction($slug) |
|
472 | |||
473 | /** |
||
474 | * @ApiDoc( |
||
475 | * description="Ajoute un utilisateur qui ne vient pas à l'event", |
||
476 | * statusCodes={ |
||
477 | * 200="Requête traitée avec succès mais pas d’information à renvoyer", |
||
478 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
479 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
480 | * 404="Ressource non trouvée", |
||
481 | * 503="Service temporairement indisponible ou en maintenance", |
||
482 | * }, |
||
483 | * section="Publications" |
||
484 | * ) |
||
485 | * @Route("/events/{slug}/decline") |
||
486 | * @Method("POST") |
||
487 | */ |
||
488 | public function addPookieAction($slug) |
||
506 | |||
507 | /** |
||
508 | * @ApiDoc( |
||
509 | * description="Retire la demande de désinscription", |
||
510 | * statusCodes={ |
||
511 | * 200="Requête traitée avec succès mais pas d’information à renvoyer", |
||
512 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
513 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
514 | * 404="Ressource non trouvée", |
||
515 | * 503="Service temporairement indisponible ou en maintenance", |
||
516 | * }, |
||
517 | * section="Publications" |
||
518 | * ) |
||
519 | * @Route("/events/{slug}/decline") |
||
520 | * @Method("DELETE") |
||
521 | */ |
||
522 | View Code Duplication | public function removePookieAction($slug) |
|
536 | |||
537 | /** |
||
538 | * @ApiDoc( |
||
539 | * description="Retourne la liste des participants à l'événement", |
||
540 | * statusCodes={ |
||
541 | * 200="Requête traitée avec succès", |
||
542 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
543 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
544 | * 404="Ressource non trouvée", |
||
545 | * 503="Service temporairement indisponible ou en maintenance", |
||
546 | * }, |
||
547 | * section="Publications" |
||
548 | * ) |
||
549 | * @Route("/events/{slug}/attendees") |
||
550 | * @Method("GET") |
||
551 | */ |
||
552 | public function getAttendeesAction($slug) |
||
556 | |||
557 | /** |
||
558 | * @ApiDoc( |
||
559 | * description="Retourne la liste des non-participants à l'événement", |
||
560 | * statusCodes={ |
||
561 | * 200="Requête traitée avec succès", |
||
562 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
563 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
564 | * 404="Ressource non trouvée", |
||
565 | * 503="Service temporairement indisponible ou en maintenance", |
||
566 | * }, |
||
567 | * section="Publications" |
||
568 | * ) |
||
569 | * @Route("/events/{slug}/pookies") |
||
570 | * @Method("GET") |
||
571 | */ |
||
572 | public function getPookiesAction($slug) |
||
576 | } |
||
577 |