vendor/symfony/serializer/Normalizer/ProblemNormalizer.php line 46

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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. namespace Symfony\Component\Serializer\Normalizer;
  14. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  15. use Symfony\Component\Serializer\Exception\InvalidArgumentException;
  17. /**
  18.  * Normalizes errors according to the API Problem spec (RFC 7807).
  19.  *
  20.  * @see https://tools.ietf.org/html/rfc7807
  21.  *
  22.  * @author Kévin Dunglas <dunglas@gmail.com>
  23.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  24.  */
  25. class ProblemNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  26. {
  27.     public const TITLE = 'title';
  28.     public const TYPE = 'type';
  29.     public const STATUS = 'status';
  31.     private $debug;
  32.     private $defaultContext = [
  33.         self::TYPE => 'https://tools.ietf.org/html/rfc2616#section-10',
  34.         self::TITLE => 'An error occurred',
  35.     ];
  37.     public function __construct(bool $debug = false, array $defaultContext = [])
  38.     {
  39.         $this->debug = $debug;
  40.         $this->defaultContext = $defaultContext + $this->defaultContext;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function normalize(mixed $object, string $format = null, array $context = []): array
  47.     {
  48.         if (!$object instanceof FlattenException) {
  49.             throw new InvalidArgumentException(sprintf('The object must implement "%s".', FlattenException::class));
  50.         }
  52.         $context += $this->defaultContext;
  53.         $debug = $this->debug && ($context['debug'] ?? true);
  55.         $data = [
  56.             self::TYPE => $context['type'],
  57.             self::TITLE => $context['title'],
  58.             self::STATUS => $context['status'] ?? $object->getStatusCode(),
  59.             'detail' => $debug ? $object->getMessage() : $object->getStatusText(),
  60.         ];
  61.         if ($debug) {
  62.             $data['class'] = $object->getClass();
  63.             $data['trace'] = $object->getTrace();
  64.         }
  66.         return $data;
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      *
  72.      * @param array $context
  73.      */
  74.     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */): bool
  75.     {
  76.         return $data instanceof FlattenException;
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function hasCacheableSupportsMethod(): bool
  83.     {
  84.         return true;
  85.     }
  86. }