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

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