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 OwnController 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 OwnController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class OwnController extends ResourceController |
||
| 20 | { |
||
| 21 | public function setContainer(ContainerInterface $container = null) |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @ApiDoc( |
||
| 29 | * description="Renvoie des détails sur les achievements et le niveau de l'utilisateur", |
||
| 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 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 35 | * }, |
||
| 36 | * section="Utilisateurs" |
||
| 37 | * ) |
||
| 38 | * @Route("/own/achievements") |
||
| 39 | * @Method("GET") |
||
| 40 | */ |
||
| 41 | public function getAchievementsAction(Request $request) |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @ApiDoc( |
||
| 48 | * description="Renvoie des détails sur les achievements et le niveau de l'utilisateur", |
||
| 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 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 54 | * }, |
||
| 55 | * section="Utilisateurs" |
||
| 56 | * ) |
||
| 57 | * @Route("/users/{slug}/achievements") |
||
| 58 | * @Method("GET") |
||
| 59 | */ |
||
| 60 | public function getUserAchievementsAction(Request $request, $slug) |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @param Request $request |
||
| 68 | * @return JsonResponse |
||
| 69 | */ |
||
| 70 | private function retrieveAchievements($request, $user) |
||
| 155 | |||
| 156 | /** |
||
| 157 | * @ApiDoc( |
||
| 158 | * description="Retourne la liste des smartphones enregistrés", |
||
| 159 | * statusCodes={ |
||
| 160 | * 200="Requête traitée avec succès", |
||
| 161 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 162 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 163 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 164 | * }, |
||
| 165 | * section="Utilisateurs" |
||
| 166 | * ) |
||
| 167 | * @Route("/own/devices") |
||
| 168 | * @Method("GET") |
||
| 169 | */ |
||
| 170 | public function getDevicesAction() |
||
| 178 | |||
| 179 | /** |
||
| 180 | * @ApiDoc( |
||
| 181 | * description="Enregistre un smartphone auprès de l'API", |
||
| 182 | * requirements={ |
||
| 183 | * { |
||
| 184 | * "name"="device", |
||
| 185 | * "dataType"="string", |
||
| 186 | * "description"="Identifiant du téléphone" |
||
| 187 | * }, |
||
| 188 | * { |
||
| 189 | * "name"="type", |
||
| 190 | * "dataType"="string", |
||
| 191 | * "description"="Android | iOS | WP" |
||
| 192 | * } |
||
| 193 | * }, |
||
| 194 | * statusCodes={ |
||
| 195 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 196 | * 400="La syntaxe de la requête est erronée", |
||
| 197 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 198 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 199 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 200 | * }, |
||
| 201 | * section="Utilisateurs" |
||
| 202 | * ) |
||
| 203 | * @Route("/own/devices") |
||
| 204 | * @Method("POST") |
||
| 205 | */ |
||
| 206 | public function postDeviceAction(Request $request) |
||
| 232 | |||
| 233 | /** |
||
| 234 | * @ApiDoc( |
||
| 235 | * description="Supprime un smartphone enregistré", |
||
| 236 | * statusCodes={ |
||
| 237 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 238 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 239 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 240 | * 404="Aucun résultat ne correspond au token transmis", |
||
| 241 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 242 | * }, |
||
| 243 | * section="Utilisateurs" |
||
| 244 | * ) |
||
| 245 | * @Route("/own/devices/{id}") |
||
| 246 | * @Method("DELETE") |
||
| 247 | */ |
||
| 248 | public function deleteDeviceAction($id) |
||
| 265 | |||
| 266 | /** |
||
| 267 | * @ApiDoc( |
||
| 268 | * description="Renvoie les notifications non lues de l'utilisateur actuel", |
||
| 269 | * output="KI\UserBundle\Entity\Notification", |
||
| 270 | * statusCodes={ |
||
| 271 | * 200="Requête traitée avec succès", |
||
| 272 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 273 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 274 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 275 | * }, |
||
| 276 | * section="Utilisateurs" |
||
| 277 | * ) |
||
| 278 | * @Route("/own/notifications") |
||
| 279 | * @Method("GET") |
||
| 280 | */ |
||
| 281 | public function getNotificationsAction() |
||
| 313 | |||
| 314 | /** |
||
| 315 | * @ApiDoc( |
||
| 316 | * description="Renvoie la liste des clubs suivis", |
||
| 317 | * output="KI\UserBundle\Entity\Club", |
||
| 318 | * statusCodes={ |
||
| 319 | * 200="Requête traitée avec succès", |
||
| 320 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 321 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 322 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 323 | * }, |
||
| 324 | * section="Utilisateurs" |
||
| 325 | * ) |
||
| 326 | * @Route("/own/followed") |
||
| 327 | * @Method("GET") |
||
| 328 | */ |
||
| 329 | public function getFollowedAction() |
||
| 333 | |||
| 334 | protected function getFollowedClubs($user = null) |
||
| 350 | |||
| 351 | /** |
||
| 352 | * @ApiDoc( |
||
| 353 | * description="Renvoie la liste des évènements suivis et persos", |
||
| 354 | * output="KI\PublicationBundle\Entity\Event", |
||
| 355 | * statusCodes={ |
||
| 356 | * 200="Requête traitée avec succès", |
||
| 357 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 358 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 359 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 360 | * }, |
||
| 361 | * section="Utilisateurs" |
||
| 362 | * ) |
||
| 363 | * @Route("/own/events") |
||
| 364 | * @Method("GET") |
||
| 365 | */ |
||
| 366 | public function getOwnEventsAction(Request $request) |
||
| 382 | |||
| 383 | /** |
||
| 384 | * @ApiDoc( |
||
| 385 | * description="Retourne le calendrier de l'utilisateur au format ICS", |
||
| 386 | * statusCodes={ |
||
| 387 | * 200="Requête traitée avec succès", |
||
| 388 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 389 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 390 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 391 | * }, |
||
| 392 | * section="Utilisateurs" |
||
| 393 | * ) |
||
| 394 | * @Route("/users/{token}/calendar") |
||
| 395 | * @Method("GET") |
||
| 396 | */ |
||
| 397 | public function getOwnCalendarAction($token) |
||
| 417 | |||
| 418 | private function getCourseitems($user = null) |
||
| 441 | |||
| 442 | /** |
||
| 443 | * @ApiDoc( |
||
| 444 | * description="Renvoie la liste des news suivies", |
||
| 445 | * output="KI\PublicationBundle\Entity\Newsitem", |
||
| 446 | * statusCodes={ |
||
| 447 | * 200="Requête traitée avec succès", |
||
| 448 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 449 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 450 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 451 | * }, |
||
| 452 | * section="Utilisateurs" |
||
| 453 | * ) |
||
| 454 | * @Route("/own/newsitems") |
||
| 455 | * @Method("GET") |
||
| 456 | */ |
||
| 457 | View Code Duplication | public function getNewsItemsAction() |
|
| 473 | |||
| 474 | /** |
||
| 475 | * @ApiDoc( |
||
| 476 | * description="Renvoie la liste des cours suivis", |
||
| 477 | * output="KI\PublicationBundle\Entity\Course", |
||
| 478 | * statusCodes={ |
||
| 479 | * 200="Requête traitée avec succès", |
||
| 480 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 481 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 482 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 483 | * }, |
||
| 484 | * section="Utilisateurs" |
||
| 485 | * ) |
||
| 486 | * @Route("/own/courses") |
||
| 487 | * @Method("GET") |
||
| 488 | */ |
||
| 489 | public function getOwnCoursesAction() |
||
| 500 | |||
| 501 | /** |
||
| 502 | * @ApiDoc( |
||
| 503 | * description="Renvoie la liste des prochains cours de l'utilisateur", |
||
| 504 | * output="KI\PublicationBundle\Entity\Courseitem", |
||
| 505 | * statusCodes={ |
||
| 506 | * 200="Requête traitée avec succès", |
||
| 507 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 508 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 509 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 510 | * }, |
||
| 511 | * section="Utilisateurs" |
||
| 512 | * ) |
||
| 513 | * @Route("/own/courseitems") |
||
| 514 | * @Method("GET") |
||
| 515 | */ |
||
| 516 | public function getCourseitemsAction() |
||
| 520 | |||
| 521 | /** |
||
| 522 | * @ApiDoc( |
||
| 523 | * description="Change ou ajoute une préférence", |
||
| 524 | * requirements={ |
||
| 525 | * { |
||
| 526 | * "name"="key", |
||
| 527 | * "dataType"="string", |
||
| 528 | * "description"="Préférence éditée ou changée" |
||
| 529 | * }, |
||
| 530 | * { |
||
| 531 | * "name"="value", |
||
| 532 | * "dataType"="string", |
||
| 533 | * "description"="Valeur de la préférence" |
||
| 534 | * } |
||
| 535 | * }, |
||
| 536 | * statusCodes={ |
||
| 537 | * 204="Requête traitée avec succès mais pas d'information à renvoyer", |
||
| 538 | * 400="La syntaxe de la requête est erronée", |
||
| 539 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 540 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 541 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 542 | * }, |
||
| 543 | * section="Utilisateurs" |
||
| 544 | * ) |
||
| 545 | * @Route("/own/preferences") |
||
| 546 | * @Method("PATCH") |
||
| 547 | */ |
||
| 548 | public function changePreferenceAction(Request $request) |
||
| 565 | |||
| 566 | /** |
||
| 567 | * @ApiDoc( |
||
| 568 | * description="Supprime un préférence", |
||
| 569 | * requirements={ |
||
| 570 | * { |
||
| 571 | * "name"="key", |
||
| 572 | * "dataType"="string", |
||
| 573 | * "description"="Préférence supprimée" |
||
| 574 | * } |
||
| 575 | * }, |
||
| 576 | * statusCodes={ |
||
| 577 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 578 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 579 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 580 | * 404="Ressource non trouvée", |
||
| 581 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 582 | * }, |
||
| 583 | * section="Utilisateurs" |
||
| 584 | * ) |
||
| 585 | * @Route("/own/preferences") |
||
| 586 | * @Method("DELETE") |
||
| 587 | */ |
||
| 588 | public function removePreferenceAction(Request $request) |
||
| 606 | |||
| 607 | /** |
||
| 608 | * @ApiDoc( |
||
| 609 | * description="Renvoie les préférences de l'utilisateur courant", |
||
| 610 | * output="array", |
||
| 611 | * statusCodes={ |
||
| 612 | * 200="Requête traitée avec succès", |
||
| 613 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 614 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 615 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 616 | * }, |
||
| 617 | * section="Utilisateurs" |
||
| 618 | * ) |
||
| 619 | * @Route("/own/preferences") |
||
| 620 | * @Method("GET") |
||
| 621 | */ |
||
| 622 | public function getPreferencesAction() |
||
| 627 | |||
| 628 | /** |
||
| 629 | * @ApiDoc( |
||
| 630 | * description="Crée un token si non existant et le retourne", |
||
| 631 | * statusCodes={ |
||
| 632 | * 200="Requête traitée avec succès", |
||
| 633 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 634 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 635 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 636 | * }, |
||
| 637 | * section="Utilisateurs" |
||
| 638 | * ) |
||
| 639 | * @Route("/own/token") |
||
| 640 | * @Method("GET") |
||
| 641 | */ |
||
| 642 | public function getTokenAction() |
||
| 648 | |||
| 649 | /** |
||
| 650 | * @ApiDoc( |
||
| 651 | * description="Renvoie la liste des dépannages demandés par l'utilisateur", |
||
| 652 | * output="KI\ClubinfoBundle\Entity\Fix", |
||
| 653 | * statusCodes={ |
||
| 654 | * 200="Requête traitée avec succès", |
||
| 655 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 656 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 657 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 658 | * }, |
||
| 659 | * section="Utilisateurs" |
||
| 660 | * ) |
||
| 661 | * @Route("/own/fixs") |
||
| 662 | * @Method("GET") |
||
| 663 | */ |
||
| 664 | public function getOwnFixsAction() |
||
| 684 | |||
| 685 | /** |
||
| 686 | * @ApiDoc( |
||
| 687 | * description="Renvoie l'utilisateur actuel", |
||
| 688 | * output="KI\UserBundle\Entity\User", |
||
| 689 | * statusCodes={ |
||
| 690 | * 200="Requête traitée avec succès", |
||
| 691 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 692 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 693 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 694 | * }, |
||
| 695 | * section="Utilisateurs" |
||
| 696 | * ) |
||
| 697 | * @Route("/own/user") |
||
| 698 | * @Method("GET") |
||
| 699 | */ |
||
| 700 | public function getOwnUserAction() |
||
| 704 | |||
| 705 | /** |
||
| 706 | * @ApiDoc( |
||
| 707 | * description="Renvoie les clubs de l'utilisateur actuel", |
||
| 708 | * output="KI\UserBundle\Entity\ClubUser", |
||
| 709 | * statusCodes={ |
||
| 710 | * 200="Requête traitée avec succès", |
||
| 711 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 712 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 713 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 714 | * }, |
||
| 715 | * section="Utilisateurs" |
||
| 716 | * ) |
||
| 717 | * @Route("/own/clubs") |
||
| 718 | * @Method("GET") |
||
| 719 | */ |
||
| 720 | public function getOwnClubsAction() |
||
| 724 | |||
| 725 | /** |
||
| 726 | * @ApiDoc( |
||
| 727 | * description="Met à jour les informations du compte", |
||
| 728 | * requirements={ |
||
| 729 | * { |
||
| 730 | * "name"="old", |
||
| 731 | * "dataType"="string", |
||
| 732 | * "description"="L'ancien mot de passe" |
||
| 733 | * }, |
||
| 734 | * { |
||
| 735 | * "name"="password", |
||
| 736 | * "dataType"="string", |
||
| 737 | * "description"="Le nouveau mot de passe" |
||
| 738 | * }, |
||
| 739 | * { |
||
| 740 | * "name"="confirm", |
||
| 741 | * "dataType"="string", |
||
| 742 | * "description"="Le mot de passe une seconde fois (confirmation)" |
||
| 743 | * } |
||
| 744 | * }, |
||
| 745 | * statusCodes={ |
||
| 746 | * 204="Requête traitée avec succès mais pas d’information à renvoyer", |
||
| 747 | * 401="Une authentification est nécessaire pour effectuer cette action", |
||
| 748 | * 403="Pas les droits suffisants pour effectuer cette action", |
||
| 749 | * 404="Ressource non trouvée", |
||
| 750 | * 503="Service temporairement indisponible ou en maintenance", |
||
| 751 | * }, |
||
| 752 | * section="Utilisateurs" |
||
| 753 | * ) |
||
| 754 | * @Route("/own/user") |
||
| 755 | * @Method("POST") |
||
| 756 | */ |
||
| 757 | public function postOwnUserAction(Request $request) |
||
| 780 | } |
||
| 781 |