vendor/api-platform/core/src/Problem/Serializer/ErrorNormalizer.php line 46

  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\Problem\Serializer;
  16. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  17. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  18. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  20. /**
  21.  * Normalizes errors according to the API Problem spec (RFC 7807).
  22.  *
  23.  * @see https://tools.ietf.org/html/rfc7807
  24.  *
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  28. {
  29.     use ErrorNormalizerTrait;
  30.     public const FORMAT = 'jsonproblem';
  31.     public const TYPE = 'type';
  32.     public const TITLE = 'title';
  33.     private array $defaultContext = [
  34.         self::TYPE => 'https://tools.ietf.org/html/rfc2616#section-10',
  35.         self::TITLE => 'An error occurred',
  36.     ];
  38.     public function __construct(private readonly bool $debug = false, array $defaultContext = [])
  39.     {
  40.         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function normalize(mixed $object, string $format = null, array $context = []): array
  47.     {
  48.         $data = [
  49.             'type' => $context[self::TYPE] ?? $this->defaultContext[self::TYPE],
  50.             'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
  51.             'detail' => $this->getErrorMessage($object, $context, $this->debug),
  52.         ];
  54.         if ($this->debug && null !== $trace = $object->getTrace()) {
  55.             $data['trace'] = $trace;
  56.         }
  58.         return $data;
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  65.     {
  66.         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
  67.     }
  69.     public function hasCacheableSupportsMethod(): bool
  70.     {
  71.         return true;
  72.     }
  73. }