src/Controller/ServiceRestController.php line 63

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the tmb/go-api package.
  5.  * 
  6.  * (c) 2021 acero <acero@tinizara.org>
  7.  * 
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace App\Controller;
  14. use App\DataTransfer\ServiceOptionsInfoDTO;
  16. use Can\RestBundle\Controller\RestController;
  17. use Can\RestBundle\Link\Std\DescribedByLink;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\Routing\Annotation\Route;
  21. /**
  22.  * Service REST Controller.
  23.  *
  24.  * This class was generated on Mon, 22 Feb 2021 09:36:10 +0100.
  25.  *
  26.  * @package tmb/go-api
  27.  * @author acero <acero@tinizara.org>
  28.  */
  29. class ServiceRestController extends RestController
  30. {
  33.     /**
  34.      * @Route("/", methods={"OPTIONS"}, name="options_service_collection")
  35.      *
  36.      * OPTIONS /
  37.      *
  38.      * @return Response
  39.      */
  40.     public function getOptions(): Response
  41.     {
  42.         $options = new ServiceOptionsInfoDTO();
  44.         $response = $this->createResponse(200, $options);
  45.         $response->headers->set('Allow', 'GET,POST,DELETE,HEAD,OPTIONS,PUT,PATCH');
  46.         $response->headers->set('Link', (string) new DescribedByLink($this->schemaURL()));
  48.         return $response;
  49.     }
  51.     /**
  52.      * @Route("/", methods={"GET"}, name="get_service_collection")
  53.      *
  54.      * GET /
  55.      *
  56.      * Altough there's actually nothing behind this endpoint, its advisable to
  57.      * include a route for GET /, as it's probably that clients accidentally
  58.      * (or not) make requests to this endpoint (e.g., ping this endpoint to
  59.      * check whether the service is alive).
  60.      *
  61.      * @return Response
  62.      */
  63.     public function getCollection(): Response
  64.     {
  65.         $response = $this->createResponse(204);
  66.         $response->headers->set('Cache-Control', 'public, max-age=31536000, immutable');
  68.         return $response;
  69.     }
  71.     /**
  72.      * @Route("/", methods={"HEAD"}, name="head_service_collection")
  73.      *
  74.      * HEAD /
  75.      *
  76.      * See comment on GET / endpoint above. Clients may use this endpoint to
  77.      * check whether the service is alive.
  78.      *
  79.      * @return Response
  80.      */
  81.     public function headCollection(): Response
  82.     {
  83.         $response = $this->createResponse(204);
  84.         $response->headers->set('Cache-Control', 'public, max-age=31536000, immutable');
  86.         return $response;
  87.     }
  90. }