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 |
||
| 17 | class ClubsController extends SubresourceController |
||
| 18 | { |
||
| 19 | public function setContainer(ContainerInterface $container = null) |
||
| 24 | |||
| 25 | /** |
||
| 26 | * @ApiDoc( |
||
| 27 | * resource=true, |
||
| 28 | * description="Liste les clubs", |
||
| 29 | * output="KI\UserBundle\Entity\Club", |
||
| 30 | * statusCodes={ |
||
| 31 | * 200="Requête traitée avec succès", |
||
| 32 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 33 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 34 | * }, |
||
| 35 | * section="Utilisateurs" |
||
| 36 | * ) |
||
| 37 | * @Route("/clubs") |
||
| 38 | * @Method("GET") |
||
| 39 | */ |
||
| 40 | public function getClubsAction() |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @ApiDoc( |
||
| 47 | * description="Retourne un club", |
||
| 48 | * output="KI\UserBundle\Entity\Club", |
||
| 49 | * statusCodes={ |
||
| 50 | * 200="Requête traitée avec succès", |
||
| 51 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 52 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 53 | * 404="Ressource non trouvée" |
||
| 54 | * }, |
||
| 55 | * section="Utilisateurs" |
||
| 56 | * ) |
||
| 57 | * @Route("/clubs/{slug}") |
||
| 58 | * @Method("GET") |
||
| 59 | */ |
||
| 60 | public function getClubAction($slug) |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @ApiDoc( |
||
| 69 | * description="Crée un club", |
||
| 70 | * input="KI\UserBundle\Form\ClubType", |
||
| 71 | * output="KI\UserBundle\Entity\Club", |
||
| 72 | * statusCodes={ |
||
| 73 | * 201="Requête traitée avec succès avec création d’un document", |
||
| 74 | * 400="La syntaxe de la requête est erronée", |
||
| 75 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 76 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 77 | * }, |
||
| 78 | * section="Utilisateurs" |
||
| 79 | * ) |
||
| 80 | * @Route("/clubs") |
||
| 81 | * @Method("POST") |
||
| 82 | */ |
||
| 83 | public function postClubAction() |
||
| 89 | |||
| 90 | /** |
||
| 91 | * @ApiDoc( |
||
| 92 | * description="Modifie un club", |
||
| 93 | * input="KI\UserBundle\Form\ClubType", |
||
| 94 | * statusCodes={ |
||
| 95 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 96 | * 400="La syntaxe de la requête est erronée", |
||
| 97 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 98 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 99 | * 404="Ressource non trouvée", |
||
| 100 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 101 | * }, |
||
| 102 | * section="Utilisateurs" |
||
| 103 | * ) |
||
| 104 | * @Route("/clubs/{slug}") |
||
| 105 | * @Method("PATCH") |
||
| 106 | */ |
||
| 107 | public function patchClubAction($slug) |
||
| 119 | |||
| 120 | /** |
||
| 121 | * @ApiDoc( |
||
| 122 | * description="Supprime un club", |
||
| 123 | * statusCodes={ |
||
| 124 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 125 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 126 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 127 | * 404="Ressource non trouvée", |
||
| 128 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 129 | * }, |
||
| 130 | * section="Utilisateurs" |
||
| 131 | * ) |
||
| 132 | * @Route("/clubs/{slug}") |
||
| 133 | * @Method("DELETE") |
||
| 134 | */ |
||
| 135 | View Code Duplication | public function deleteClubAction($slug) |
|
| 149 | |||
| 150 | /** |
||
| 151 | * @ApiDoc( |
||
| 152 | * description="Liste les membres d'un club", |
||
| 153 | * output="KI\UserBundle\Entity\User", |
||
| 154 | * statusCodes={ |
||
| 155 | * 200="Requête traitée avec succès", |
||
| 156 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 157 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 158 | * 404="Ressource non trouvée", |
||
| 159 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 160 | * }, |
||
| 161 | * section="Utilisateurs" |
||
| 162 | * ) |
||
| 163 | * @Route("/clubs/{slug}/users") |
||
| 164 | * @Method("GET") |
||
| 165 | */ |
||
| 166 | public function getClubUsersAction($slug) |
||
| 172 | |||
| 173 | /** |
||
| 174 | * @ApiDoc( |
||
| 175 | * description="Ajoute un membre à un club", |
||
| 176 | * requirements={ |
||
| 177 | * { |
||
| 178 | * "name"="role", |
||
| 179 | * "dataType"="string", |
||
| 180 | * "description"="Le rôle du membre dans le club" |
||
| 181 | * } |
||
| 182 | * }, |
||
| 183 | * statusCodes={ |
||
| 184 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 185 | * 400="La syntaxe de la requête est erronée", |
||
| 186 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 187 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 188 | * 404="Ressource non trouvée", |
||
| 189 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 190 | * }, |
||
| 191 | * section="Utilisateurs" |
||
| 192 | * ) |
||
| 193 | * @Route("/clubs/{slugClub}/users/{username}") |
||
| 194 | * @Method("POST") |
||
| 195 | */ |
||
| 196 | public function postClubUserAction(Request $request, $slugClub, $username) |
||
| 233 | |||
| 234 | /** |
||
| 235 | * @ApiDoc( |
||
| 236 | * description="Modifie un membre d'un club", |
||
| 237 | * requirements={ |
||
| 238 | * { |
||
| 239 | * "name"="role", |
||
| 240 | * "dataType"="string", |
||
| 241 | * "description"="Le rôle du membre dans le club" |
||
| 242 | * } |
||
| 243 | * }, |
||
| 244 | * statusCodes={ |
||
| 245 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 246 | * 400="La syntaxe de la requête est erronée", |
||
| 247 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 248 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 249 | * 404="Ressource non trouvée", |
||
| 250 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 251 | * }, |
||
| 252 | * section="Utilisateurs" |
||
| 253 | * ) |
||
| 254 | * @Route("/clubs/{slug}/users/{username}") |
||
| 255 | * @Method("PATCH") |
||
| 256 | */ |
||
| 257 | public function patchClubUserAction(Request $request, $slug, $username) |
||
| 289 | |||
| 290 | /** |
||
| 291 | * @ApiDoc( |
||
| 292 | * description="Enlève un membre d'un club", |
||
| 293 | * statusCodes={ |
||
| 294 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 295 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 296 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 297 | * 404="Ressource non trouvée", |
||
| 298 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 299 | * }, |
||
| 300 | * section="Utilisateurs" |
||
| 301 | * ) |
||
| 302 | * @Route("/clubs/{slug}/users/{id}") |
||
| 303 | * @Method("DELETE") |
||
| 304 | */ |
||
| 305 | public function deleteClubUserAction($slug, $id) |
||
| 327 | |||
| 328 | /** |
||
| 329 | * @ApiDoc( |
||
| 330 | * description="Echange les priorité des 2 clubUsers associés aux Users", |
||
| 331 | * statusCodes={ |
||
| 332 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 333 | * 400="La syntaxe de la requête est erronée", |
||
| 334 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 335 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 336 | * 404="Ressource non trouvée", |
||
| 337 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 338 | * }, |
||
| 339 | * section="Utilisateurs" |
||
| 340 | * ) |
||
| 341 | * @Route("/clubs/{slug}/users/{username}/{direction}") |
||
| 342 | * @Method("PATCH") |
||
| 343 | */ |
||
| 344 | public function swapPriorityClubUserAction($slug, $username, $direction) |
||
| 373 | |||
| 374 | /** |
||
| 375 | * @ApiDoc( |
||
| 376 | * description="Abonne un utilisateur à un club", |
||
| 377 | * statusCodes={ |
||
| 378 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 379 | * 400="La syntaxe de la requête est erronée", |
||
| 380 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 381 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 382 | * 404="Ressource non trouvée", |
||
| 383 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 384 | * }, |
||
| 385 | * section="Utilisateurs" |
||
| 386 | * ) |
||
| 387 | * @Route("/clubs/{slug}/follow") |
||
| 388 | * @Method("POST") |
||
| 389 | */ |
||
| 390 | View Code Duplication | public function followClubAction($slug) |
|
| 404 | |||
| 405 | /** |
||
| 406 | * @ApiDoc( |
||
| 407 | * description="Désabonne un utilisateur d'un club", |
||
| 408 | * statusCodes={ |
||
| 409 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 410 | * 400="La syntaxe de la requête est erronée", |
||
| 411 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 412 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 413 | * 404="Ressource non trouvée", |
||
| 414 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 415 | * }, |
||
| 416 | * section="Utilisateurs" |
||
| 417 | * ) |
||
| 418 | * @Route("/clubs/{slug}/unfollow") |
||
| 419 | * @Method("POST") |
||
| 420 | */ |
||
| 421 | View Code Duplication | public function unFollowClubAction($slug) |
|
| 435 | |||
| 436 | /** |
||
| 437 | * @ApiDoc( |
||
| 438 | * description="Retourne toutes les news publiées par un club", |
||
| 439 | * statusCodes={ |
||
| 440 | * 200="Requête traitée avec succès", |
||
| 441 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 442 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 443 | * 404="Ressource non trouvée", |
||
| 444 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 445 | * }, |
||
| 446 | * section="Utilisateurs" |
||
| 447 | * ) |
||
| 448 | * @Route("/clubs/{slug}/newsitems") |
||
| 449 | * @Method("GET") |
||
| 450 | */ |
||
| 451 | View Code Duplication | public function getNewsitemsClubAction($slug) |
|
| 467 | |||
| 468 | /** |
||
| 469 | * @ApiDoc( |
||
| 470 | * description="Retourne tous les events publiés par un club", |
||
| 471 | * statusCodes={ |
||
| 472 | * 200="Requête traitée avec succès", |
||
| 473 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 474 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 475 | * 404="Ressource non trouvée", |
||
| 476 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 477 | * }, |
||
| 478 | * section="Utilisateurs" |
||
| 479 | * ) |
||
| 480 | * @Route("/clubs/{slug}/events") |
||
| 481 | * @Method("GET") |
||
| 482 | */ |
||
| 483 | View Code Duplication | public function getEventsClubAction($slug) |
|
| 499 | } |
||
| 500 |