src/Controller/Api/ClubLessonsController.php line 74

Open in your IDE?
  1. <?php
  3. namespace App\Controller\Api;
  5. use App\Entity\Club;
  6. use Hateoas\HateoasBuilder;
  7. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Component\HttpFoundation\Response;
  10. use Symfony\Component\Routing\Annotation\Route;
  11. use OpenApi\Annotations as OA;
  12. use Psr\Log\LoggerInterface;
  13. use App\Entity\ClubLesson;
  14. use App\Model\ClubLessonView;
  15. use App\Security\Roles;
  16. use Symfony\Component\Serializer\SerializerInterface;
  17. use Symfony\Contracts\Translation\TranslatorInterface;
  18. use App\Util\RequestUtil;
  19. use App\Model\ClubLessonCreate;
  20. use App\Exception\ViolationException;
  21. use App\Util\StringUtils;
  22. use App\Entity\ClubLocation;
  23. use App\Entity\Events;
  24. use App\Model\ClubLessonUpdate;
  25. use App\Security\ClubAccess;
  26. use App\Entity\EntityFinder;
  27. use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException;
  28. use App\Exception\CRMException;
  31. class ClubLessonsController extends AbstractController
  32. {
  34.     private LoggerInterface $logger;
  35.     
  36.     public function __construct(LoggerInterface $logger)
  37.     {
  38.         $this->logger = $logger;
  39.     }
  40.     
  41.     
  42.     /**
  43.      * @Route("/api/club/{club_uuid}/lessons", name="api_get_club_lessons", methods={"GET"}, requirements={"club_uuid"="[a-z0-9_]{2,64}"})
  44.      * @OA\Get(
  45.      *     operationId="getClubLessons",
  46.      *     tags={"Club"},
  47.      *     path="/api/club/{club_uuid}/lessons",
  48.      *     summary="Give some hours",
  49.      *     @OA\Parameter(
  50.      *         description="UUID of club",
  51.      *         in="path",
  52.      *         name="club_uuid",
  53.      *         required=true,
  54.      *         @OA\Schema(
  55.      *             format="string",
  56.      *             type="string",
  57.      *             pattern="[a-z0-9_]{2,64}"
  58.      *         )
  59.      *     ),
  60.      *     @OA\Response(
  61.      *         response="200",
  62.      *         description="Successful",
  63.      *         @OA\MediaType(
  64.      *             mediaType="application/hal+json",
  65.      *             @OA\Schema(
  66.      *                 type="array",
  67.      *                 @OA\Items(ref="#/components/schemas/ClubLesson")
  68.      *             )
  69.      *         )
  70.      *     ),
  71.      *     @OA\Response(response="404", description="Club not found", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error")))
  72.      * )
  73.      */
  74.     public function getLessons($club_uuid)
  75.     {
  76.         $doctrine = $this->container->get('doctrine');
  77.         
  78.         $entityFinder = new EntityFinder($doctrine);
  79.         /** @var Club $club */
  80.         $club = $entityFinder->findOneByOrThrow(Club::class, ['uuid' => $club_uuid]); // 404
  81.         
  82.         $clubLessons = $this->container->get('doctrine')->getManager()
  83.             ->getRepository(ClubLesson::class)
  84.             ->findBy(['club' => $club]);
  86.         $lessonList = array();
  87.         foreach($clubLessons as &$clubLesson) {
  88.             array_push($lessonList, new ClubLessonView($club, $clubLesson));
  89.         }
  91.         $hateoas = HateoasBuilder::create()->build();
  92.         return new Response(
  93.             $hateoas->serialize($lessonList, 'json'),
  94.             Response::HTTP_OK, // 200
  95.             array('Content-Type' => 'application/hal+json'));
  96.     }
  98.     /**
  99.      * @Route("/api/club/{club_uuid}/lessons/{lesson_uuid}", name="api_get_club_lesson", methods={"GET"}, requirements={"club_uuid"="[a-z0-9_]{2,64}","lesson_uuid"="[a-zA-Z0-9_]{2,64}"})
  100.      * @OA\Get(
  101.      *     operationId="getClubLesson",
  102.      *     tags={"Club"},
  103.      *     path="/api/club/{club_uuid}/lessons/{lesson_uuid}",
  104.      *     summary="Give a lesson for a club",
  105.      *     @OA\Parameter(
  106.      *         description="UUID of club",
  107.      *         in="path",
  108.      *         name="club_uuid",
  109.      *         required=true,
  110.      *         @OA\Schema(
  111.      *             format="string",
  112.      *             type="string",
  113.      *             pattern="[a-z0-9_]{2,64}"
  114.      *         )
  115.      *     ),
  116.      *     @OA\Parameter(
  117.      *         description="UUID of lesson",
  118.      *         in="path",
  119.      *         name="lesson_uuid",
  120.      *         required=true,
  121.      *         @OA\Schema(
  122.      *             format="string",
  123.      *             type="string",
  124.      *             pattern="[A-Za-z0-9_]{2,64}"
  125.      *         )
  126.      *     ),
  127.      *     @OA\Response(
  128.      *         response="200",
  129.      *         description="Successful",
  130.      *         @OA\MediaType(
  131.      *             mediaType="application/hal+json",
  132.      *             @OA\Items(ref="#/components/schemas/ClubLesson")
  133.      *         )
  134.      *     ),
  135.      *     @OA\Response(response="404", description="Club or lesson not found", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error")))
  136.      * )
  137.      */
  138.     public function getLesson(string $club_uuid, string $lesson_uuid): Response
  139.     {
  140.         $doctrine = $this->container->get('doctrine');
  141.         
  142.         $entityFinder = new EntityFinder($doctrine);
  143.         /** @var Club $club */
  144.         $club = $entityFinder->findOneByOrThrow(Club::class, ['uuid' => $club_uuid]); // 404
  145.         $clubLesson = $entityFinder->findOneByOrThrow(ClubLesson::class, ['uuid' => $lesson_uuid, 'club' => $club]); // 404
  146.         
  147.         $hateoas = HateoasBuilder::create()->build();
  148.         return new Response(
  149.             $hateoas->serialize(new ClubLessonView($club, $clubLesson), 'json'),
  150.             Response::HTTP_OK, // 200
  151.             array('Content-Type' => 'application/hal+json'));
  152.     }
  153.     
  154.     
  155.     /**
  156.      * @Route("/api/club/{club_uuid}/lessons", name="api_create_club_lessons", methods={"POST"}, requirements={"club_uuid"="[a-z0-9_]{2,64}"})
  157.      * @OA\Post(
  158.      *     operationId="createClubLesson",
  159.      *     tags={"Club"},
  160.      *     path="/api/club/{club_uuid}/lessons",
  161.      *     summary="Create a lesson for a club",
  162.      *     security = {{"basicAuth": {}}},
  163.      *     @OA\Parameter(
  164.      *         description="UUID of club",
  165.      *         in="path",
  166.      *         name="club_uuid",
  167.      *         required=true,
  168.      *         @OA\Schema(
  169.      *             format="string",
  170.      *             type="string",
  171.      *             pattern="[a-z0-9_]{2,64}"
  172.      *         )
  173.      *     ),
  174.      *     @OA\Parameter(name="X-ClientId", in="header", required=true, example="my-client-name", @OA\Schema(format="string", type="string", pattern="[a-z0-9_]{2,64}")),
  175.      *     @OA\RequestBody(
  176.      *         description="Lesson object that needs to be added",
  177.      *         required=true,
  178.      *         @OA\JsonContent(ref="#/components/schemas/ClubLessonCreate"),
  179.      *     ),
  180.      *     @OA\Response(
  181.      *         response="201",
  182.      *         description="Successful",
  183.      *         @OA\MediaType(
  184.      *             mediaType="application/hal+json",
  185.      *             @OA\Schema(ref="#/components/schemas/ClubLesson")
  186.      *         )
  187.      *     ),
  188.      *     @OA\Response(response="400", description="Unvalid data", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error"))),
  189.      *     @OA\Response(response="403", description="Forbidden to create a lesson", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error"))),
  190.      *     @OA\Response(response="404", description="Club or location not found", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error")))
  191.      * )
  192.      */
  193.     public function createLesson(string $club_uuid, Request $request, SerializerInterface $serializer, TranslatorInterface $translator): Response
  194.     {
  195.         $doctrine = $this->container->get('doctrine');
  196.         
  197.         $entityFinder = new EntityFinder($doctrine);
  198.         /** @var Club $club */
  199.         $club = $entityFinder->findOneByOrThrow(Club::class, ['uuid' => $club_uuid]); // 404
  200.          
  201.         $clubAccess = new ClubAccess($this->container, $this->logger);
  202.         $clubAccess->checkAccessForUser($club, $this->getUser()); // 403
  203.         
  204.         $requestUtil = new RequestUtil($serializer, $translator);
  205.         $lessonToCreate = $requestUtil->validate($request, ClubLessonCreate::class); // 400
  206.         
  207.         $uuid = $lessonToCreate->getUuid();
  208.         if($uuid == null || trim($uuid) === '') {
  209.             $uuid = StringUtils::random_str(16);
  210.         }
  211.         
  212.         $locationUuid = $lessonToCreate->getLocationUuid();
  213.         if(empty($locationUuid)) {
  214.             $locations = $doctrine->getManager()
  215.                ->getRepository(ClubLocation::class)
  216.                ->findBy(['club' => $club]);
  217.            if(empty($locations)) {
  218.                throw $this->createNotFoundException('Location not found'); // 404
  219.            }
  220.            if(count($locations) > 1) {
  221.                throw new CRMException(Response::HTTP_BAD_REQUEST, 'Too many locations found, set a \'location_uuid\'');
  222.            }
  223.            $location = $locations[0];
  224.         } else {
  225.             $location = $entityFinder->findOneByOrThrow(ClubLocation::class, ['uuid' => $locationUuid]); // 404
  226.         }
  227.         
  228.         if($lessonToCreate->getStartTime() > $lessonToCreate->getEndTime()) {
  229.             throw new CRMException(Response::HTTP_BAD_REQUEST, 'start_time is after end_time !', ['start_time' => 'start_time is after end_time']); // 400
  230.         }
  231.         
  232.         $lesson = new ClubLesson();
  233.         $lesson->setUuid($uuid);
  234.         $lesson->setClubLocation($location);
  235.         $lesson->setClub($club);
  236.         $lesson->setPoint($lessonToCreate->getPoint());
  237.         $lesson->setDiscipline($lessonToCreate->getDiscipline());
  238.         $lesson->setAgeLevel($lessonToCreate->getAgeLevel());
  239.         $lesson->setDayOfWeek($lessonToCreate->getDayOfWeek());
  240.         $lesson->setStartTime($lessonToCreate->getStartTime());
  241.         $lesson->setEndTime($lessonToCreate->getEndTime());
  242.         $lesson->setDescription(StringUtils::defaultOrEmpty($lessonToCreate->getDescription()));
  243.         $doctrine->getManager()->persist($lesson);
  244.         
  245.         $data = ['day' => $lesson->getDayOfWeek(), 'uuid' => $uuid, 'start' => $lesson->getStartTime(), 'discipline' => $lesson->getDiscipline()];
  246.         Events::add($doctrine, Events::CLUB_LESSON_CREATED, $this->getUser(), $request, $data);
  247.         $this->logger->debug('Club lesson created: '.json_encode($data));
  248.         
  249.         $hateoas = HateoasBuilder::create()->build();
  250.         return new Response(
  251.             $hateoas->serialize(new ClubLessonView($club, $lesson), 'json'),
  252.             Response::HTTP_CREATED, // 201
  253.             array('Content-Type' => 'application/hal+json'));
  254.     }
  255.     
  256.     
  257.     /**
  258.      * @Route("/api/club/{club_uuid}/lessons/{lesson_uuid}", name="api_update_club_lessons", methods={"PATCH"}, requirements={"club_uuid"="[a-z0-9_]{2,64}","lesson_uuid"="[a-zA-Z0-9_]{2,64}"})
  259.      * @OA\Patch(
  260.      *     operationId="updateClubLesson",
  261.      *     tags={"Club"},
  262.      *     path="/api/club/{club_uuid}/lessons/{lesson_uuid}",
  263.      *     summary="Update a lesson for a club",
  264.      *     security = {{"basicAuth": {}}},
  265.      *     @OA\Parameter(name="X-ClientId", in="header", required=true, example="my-client-name", @OA\Schema(format="string", type="string", pattern="[a-z0-9_]{2,64}")),
  266.      *     @OA\Parameter(
  267.      *         description="UUID of club",
  268.      *         in="path",
  269.      *         name="club_uuid",
  270.      *         required=true,
  271.      *         @OA\Schema(
  272.      *             format="string",
  273.      *             type="string",
  274.      *             pattern="[a-z0-9_]{2,64}"
  275.      *         )
  276.      *     ),
  277.      *     @OA\Parameter(
  278.      *         description="UUID of lesson",
  279.      *         in="path",
  280.      *         name="lesson_uuid",
  281.      *         required=true,
  282.      *         @OA\Schema(
  283.      *             format="string",
  284.      *             type="string",
  285.      *             pattern="[A-Za-z0-9_]{2,64}"
  286.      *         )
  287.      *     ),
  288.      *     @OA\RequestBody(
  289.      *         description="Lesson object that needs to be added",
  290.      *         required=true,
  291.      *         @OA\JsonContent(ref="#/components/schemas/ClubLessonUpdate"),
  292.      *     ),
  293.      *     @OA\Response(response="204", description="Successful"),
  294.      *     @OA\Response(response="400", description="Unvalid data", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error"))),
  295.      *     @OA\Response(response="403", description="Forbidden to update a lesson", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error"))),
  296.      *     @OA\Response(response="404", description="Club or location or lesson not found", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error")))
  297.      * )
  298.      */
  299.     public function updateLesson(string $club_uuid, string $lesson_uuid, Request $request, SerializerInterface $serializer, TranslatorInterface $translator): Response
  300.     {
  301.         $doctrine = $this->container->get('doctrine');
  302.         
  303.         $requestUtil = new RequestUtil($serializer, $translator);
  304.         $lessonToUpdate = $requestUtil->validate($request, ClubLessonUpdate::class); // 400
  305.         
  306.         $entityFinder = new EntityFinder($doctrine);
  307.         /** @var Club $club */
  308.         $club = $entityFinder->findOneByOrThrow(Club::class, ['uuid' => $club_uuid]); // 404
  309.         
  310.         $clubAccess = new ClubAccess($this->container, $this->logger);
  311.         $clubAccess->checkAccessForUser($club, $this->getUser()); // 403
  312.         
  313.         $lesson = $entityFinder->findOneByOrThrow(ClubLesson::class, ['uuid' => $lesson_uuid, 'club' => $club]); // 404
  314.         
  315.         $uuid = $lessonToUpdate->getUuid();
  316.         if( ! empty($uuid) && $uuid !== $lesson->getUuid()) {
  317.             $entityFinder->findNoneByOrThrow(ClubLesson::class, ['uuid' => $uuid],
  318.                 function() use($uuid) {
  319.                     throw new CRMException(Response::HTTP_BAD_REQUEST, 'Lesson UUID already used: '.$uuid, ['uuid' => 'UUID already used']); // 400
  320.                 });
  321.         }
  322.         
  323.         $locationUuid = $lessonToUpdate->getLocationUuid();
  324.         if(! empty($locationUuid)) {
  325.             // check if location exists
  326.             $entityFinder->findOneByOrThrow(ClubLocation::class, ['uuid' => $locationUuid]); // 404
  327.         }
  328.         
  329.         if($lessonToUpdate->getStartTime() !== null && $lessonToUpdate->getEndTime() != null && $lessonToUpdate->getStartTime() > $lessonToUpdate->getEndTime()) {
  330.             throw new CRMException(Response::HTTP_BAD_REQUEST, 'start_time is after end_time !', ['start_time' => 'start_time is after end_time']); // 400
  331.         }
  332.         
  333.         $location = $entityFinder->findOneByOrThrow(ClubLocation::class, ['uuid' => $locationUuid]); // 404
  334.             
  335.         $entityUpdater = new EntityUpdater($doctrine, $request, $this->getUser(), Events::CLUB_LESSON_UPDATED, $this->logger);
  336.         $entityUpdater->update('uuid', $uuid, $lesson->getUuid(), function($v) use($lesson) { $lesson->setUuid($v); });
  337.         if(! empty($locationUuid)) {
  338.             $entityUpdater->update('location', $location, $lesson->getClubLocation(), function($v) use($lesson) { $lesson->setClubLocation($v); });
  339.         }
  340.         $entityUpdater->update('point', $lessonToUpdate->getPoint(), $lesson->getPoint(), function($v) use($lesson) { $lesson->setPoint($v); });
  341.         $entityUpdater->update('discipline', $lessonToUpdate->getDiscipline(), $lesson->getDiscipline(), function($v) use($lesson) { $lesson->setDiscipline($v); });
  342.         $entityUpdater->update('agelevel', $lessonToUpdate->getAgeLevel(), $lesson->getAgeLevel(), function($v) use($lesson) { $lesson->setAgeLevel($v); });
  343.         $entityUpdater->update('day', $lessonToUpdate->getDayOfWeek(), $lesson->getDayOfWeek(), function($v) use($lesson) { $lesson->setDayOfWeek($v); });
  344.         $entityUpdater->update('start', $lessonToUpdate->getStartTime(), $lesson->getStartTime(), function($v) use($lesson) { $lesson->setStartTime($v); });
  345.         $entityUpdater->update('end', $lessonToUpdate->getEndTime(), $lesson->getEndTime(), function($v) use($lesson) { $lesson->setEndTime($v); });
  346.         $entityUpdater->update('description', $lessonToUpdate->getDescription(), $lesson->getDescription(), function($v) use($lesson) { $lesson->setDescription($v); });
  347.         return $entityUpdater->toResponse($lesson, 'Club lesson updated', ['id' => $lesson->getId()]);
  348.     }
  349.     
  351.     /**
  352.      * @Route("/api/club/{club_uuid}/lessons/{lesson_uuid}", name="api_delete_club_lessons", methods={"DELETE"}, requirements={"club_uuid"="[a-z0-9_]{2,64}","lesson_uuid"="[a-zA-Z0-9_]{2,64}"})
  353.      * @OA\Delete(
  354.      *     operationId="deleteClubLesson",
  355.      *     tags={"Club"},
  356.      *     path="/api/club/{club_uuid}/lessons/{lesson_uuid}",
  357.      *     summary="Delete a lesson for a club",
  358.      *     security = {{"basicAuth": {}}},
  359.      *     @OA\Parameter(
  360.      *         description="UUID of club",
  361.      *         in="path",
  362.      *         name="club_uuid",
  363.      *         required=true,
  364.      *         @OA\Schema(
  365.      *             format="string",
  366.      *             type="string",
  367.      *             pattern="[a-z0-9_]{2,64}"
  368.      *         )
  369.      *     ),
  370.      *     @OA\Parameter(
  371.      *         description="UUID of lesson",
  372.      *         in="path",
  373.      *         name="lesson_uuid",
  374.      *         required=true,
  375.      *         @OA\Schema(
  376.      *             format="string",
  377.      *             type="string",
  378.      *             pattern="[A-Za-z0-9_]{2,64}"
  379.      *         )
  380.      *     ),
  381.      *     @OA\Parameter(name="X-ClientId", in="header", required=true, example="my-client-name", @OA\Schema(format="string", type="string", pattern="[a-z0-9_]{2,64}")),
  382.      *     @OA\Response(response="204", description="Successful"),
  383.      *     @OA\Response(response="403", description="Forbidden to delete a lesson", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error"))),
  384.      *     @OA\Response(response="404", description="Club or lesson not found", @OA\MediaType(mediaType="application/hal+json", @OA\Schema(ref="#/components/schemas/Error")))
  385.      * )
  386.      */
  387.     public function deleteLesson(Request $request, string $club_uuid, string $lesson_uuid): Response
  388.     {
  389.         $doctrine = $this->container->get('doctrine');
  390.         
  391.         $entityFinder = new EntityFinder($doctrine);
  392.         $club = $entityFinder->findOneByOrThrow(Club::class, ['uuid' => $club_uuid]); // 404
  393.         
  394.         $clubAccess = new ClubAccess($this->container, $this->logger);
  395.         $clubAccess->checkAccessForUser($club, $this->getUser()); // 403
  396.         
  397.         $clubLesson = $entityFinder->findOneByOrThrow(ClubLesson::class, ['uuid' => $lesson_uuid, 'club' => $club]); // 404
  398.         
  399.         $doctrine->getManager()->remove($clubLesson);
  400.         
  401.         $data = ['club_uuid' => $club_uuid, 'lesson_uuid' => $lesson_uuid, 'day' => $clubLesson->getDayOfWeek(), 'start' => $clubLesson->getStartTime()];
  402.         Events::add($doctrine, Events::CLUB_LESSON_DELETED, $this->getUser(), $request, $data);
  403.         $this->logger->debug('Club lesson deleted: '.json_encode($data));
  404.         
  405.         return new Response('', Response::HTTP_NO_CONTENT); // 204
  406.     }
  407. }