vendor/api-platform/core/src/Hydra/Serializer/ErrorNormalizer.php line 52

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\Hydra\Serializer;
  16. use ApiPlatform\Api\UrlGeneratorInterface;
  17. use ApiPlatform\Problem\Serializer\ErrorNormalizerTrait;
  18. use Symfony\Component\Debug\Exception\FlattenException as LegacyFlattenException;
  19. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  20. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  21. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  23. /**
  24.  * Converts {@see \Exception} or {@see FlattenException} or {@see LegacyFlattenException} to a Hydra error representation.
  25.  *
  26.  * @author Kévin Dunglas <dunglas@gmail.com>
  27.  * @author Samuel ROZE <samuel.roze@gmail.com>
  28.  */
  29. final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  30. {
  31.     use ErrorNormalizerTrait;
  33.     public const FORMAT = 'jsonld';
  34.     public const TITLE = 'title';
  36.     private $urlGenerator;
  37.     private $debug;
  38.     private $defaultContext = [self::TITLE => 'An error occurred'];
  40.     public function __construct(UrlGeneratorInterface $urlGenerator, bool $debug = false, array $defaultContext = [])
  41.     {
  42.         $this->urlGenerator = $urlGenerator;
  43.         $this->debug = $debug;
  44.         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
  45.     }
  47.     /**
  48.      * {@inheritdoc}
  49.      *
  50.      * @return array|string|int|float|bool|\ArrayObject|null
  51.      */
  52.     public function normalize($object, $format = null, array $context = [])
  53.     {
  54.         $data = [
  55.             '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Error']),
  56.             '@type' => 'hydra:Error',
  57.             'hydra:title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
  58.             'hydra:description' => $this->getErrorMessage($object, $context, $this->debug),
  59.         ];
  61.         if ($this->debug && null !== $trace = $object->getTrace()) {
  62.             $data['trace'] = $trace;
  63.         }
  65.         return $data;
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function supportsNormalization($data, $format = null, array $context = []): bool
  72.     {
  73.         return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException || $data instanceof LegacyFlattenException);
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function hasCacheableSupportsMethod(): bool
  80.     {
  81.         return true;
  82.     }
  83. }
  85. class_alias(ErrorNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\ErrorNormalizer::class);