vendor/can/rest/src/Can/RestBundle/Controller/FallbackController.php line 55

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\Controller;
  5. use Can\RestBundle\Caching\CacheHeader;
  6. use Can\RestBundle\EventListener\ErrorListener;
  7. use Can\RestBundle\Problem\ProblemConfiguration;
  9. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Component\HttpFoundation\Response;
  12. use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
  14. use Exception;
  15. use Throwable;
  17. /**
  18.  * Fallback controller.
  19.  *
  20.  * This controller is used when a problem occurs handling a request which is
  21.  * outside the scope of the REST service.
  22.  *
  23.  * Most often, if the REST service does not live together with other services
  24.  * in the same application, all request to undefined endpoints (which will
  25.  * result in a 404 response) are forwarded here.
  26.  *
  27.  * Feel free to extend this controller to implement a more elaborated error
  28.  * handling logic.
  29.  *
  30.  * @see ErrorListener
  31.  * @see ProblemConfiguration::$catchAll
  32.  *
  33.  * @package can/rest-bundle
  34.  * @author lechecacharro <lechecacharro@gmail.com>
  35.  */
  36. class FallbackController
  37. {
  39.     /**
  40.      * @noinspection PhpUnusedParameterInspection
  41.      *
  42.      * Fallback Action.
  43.      *
  44.      * The default implementation just returns an immutable 410 (Gone)
  45.      * response.
  46.      *
  47.      * @see ErrorListener
  48.      *
  49.      * @param Request                                  $request
  50.      * @param FlattenException | Exception | Throwable $exception
  51.      * @param DebugLoggerInterface | null              $logger
  52.      *
  53.      * @return Response
  54.      */
  55.     public function index(Request $request, $exception, DebugLoggerInterface $logger = null): Response
  56.     {
  57.         return $this->gone();
  58.     }
  61.     /**
  62.      * @return Response
  63.      */
  64.     protected function gone(): Response
  65.     {
  66.         // Response is not going to change over time
  67.         $response = new Response('', 410);
  68.         $response->headers->set(CacheHeader::CACHE_CONTROL, 'public, max-age=31536000, immutable');
  69.         $response->headers->set(CacheHeader::EXPIRES, date('r', strtotime('+1 year')));
  71.         return $response;
  72.     }
  74. }