vendor/api-platform/core/src/Action/ExceptionAction.php line 42

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Action;
  16. use ApiPlatform\Core\Util\ErrorFormatGuesser;
  17. use Symfony\Component\Debug\Exception\FlattenException;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\Serializer\SerializerInterface;
  22. /**
  23.  * Renders a normalized exception for a given {@see \Symfony\Component\Debug\Exception\FlattenException}.
  24.  *
  25.  * Usage:
  26.  *
  27.  *     $exceptionAction = new ExceptionAction(
  28.  *         new Serializer(),
  29.  *         [
  30.  *             'jsonproblem' => ['application/problem+json'],
  31.  *             'jsonld' => ['application/ld+json'],
  32.  *         ],
  33.  *         [
  34.  *             ExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  35.  *             InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  36.  *         ]
  37.  *     );
  38.  *
  39.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  40.  * @author Kévin Dunglas <dunglas@gmail.com>
  41.  */
  42. final class ExceptionAction
  43. {
  44.     private $serializer;
  45.     private $errorFormats;
  46.     private $exceptionToStatus;
  48.     /**
  49.      * @param array $errorFormats      A list of enabled formats, the first one will be the default
  50.      * @param array $exceptionToStatus A list of exceptions mapped to their HTTP status code
  51.      */
  52.     public function __construct(SerializerInterface $serializer, array $errorFormats, array $exceptionToStatus = [])
  53.     {
  54.         $this->serializer = $serializer;
  55.         $this->errorFormats = $errorFormats;
  56.         $this->exceptionToStatus = $exceptionToStatus;
  57.     }
  59.     /**
  60.      * Converts an exception to a JSON response.
  61.      */
  62.     public function __invoke(FlattenException $exception, Request $request): Response
  63.     {
  64.         $exceptionClass = $exception->getClass();
  65.         $statusCode = $exception->getStatusCode();
  67.         foreach ($this->exceptionToStatus as $class => $status) {
  68.             if (is_a($exceptionClass, $class, true)) {
  69.                 $statusCode = $status;
  71.                 break;
  72.             }
  73.         }
  75.         $headers = $exception->getHeaders();
  76.         $format = ErrorFormatGuesser::guessErrorFormat($request, $this->errorFormats);
  77.         $headers['Content-Type'] = sprintf('%s; charset=utf-8', $format['value'][0]);
  78.         $headers['X-Content-Type-Options'] = 'nosniff';
  79.         $headers['X-Frame-Options'] = 'deny';
  81.         return new Response($this->serializer->serialize($exception, $format['key'], ['statusCode' => $statusCode]), $statusCode, $headers);
  82.     }
  83. }