vendor/api-platform/core/src/State/ApiResource/Error.php line 181

  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\State\ApiResource;
  16. use ApiPlatform\JsonLd\ContextBuilderInterface;
  17. use ApiPlatform\Metadata\ApiProperty;
  18. use ApiPlatform\Metadata\Error as Operation;
  19. use ApiPlatform\Metadata\ErrorResource;
  20. use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
  21. use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
  22. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
  23. use Symfony\Component\Serializer\Annotation\Groups;
  24. use Symfony\Component\Serializer\Annotation\Ignore;
  25. use Symfony\Component\Serializer\Annotation\SerializedName;
  26. use Symfony\Component\WebLink\Link;
  28. #[ErrorResource(
  29.     types: ['hydra:Error'],
  30.     openapi: false,
  31.     uriVariables: ['status'],
  32.     uriTemplate: '/errors/{status}',
  33.     operations: [
  34.         new Operation(
  35.             name: '_api_errors_problem',
  36.             outputFormats: ['json' => ['application/problem+json']],
  37.             normalizationContext: [
  38.                 'groups' => ['jsonproblem'],
  39.                 'skip_null_values' => true,
  40.                 'rfc_7807_compliant_errors' => true,
  41.             ],
  42.         ),
  43.         new Operation(
  44.             name: '_api_errors_hydra',
  45.             outputFormats: ['jsonld' => ['application/problem+json']],
  46.             normalizationContext: [
  47.                 'groups' => ['jsonld'],
  48.                 'skip_null_values' => true,
  49.                 'rfc_7807_compliant_errors' => true,
  50.             ],
  51.             links: [new Link(rel: ContextBuilderInterface::JSONLD_NS.'error', href: 'http://www.w3.org/ns/hydra/error')],
  52.         ),
  53.         new Operation(
  54.             name: '_api_errors_jsonapi',
  55.             outputFormats: ['jsonapi' => ['application/vnd.api+json']],
  56.             normalizationContext: [
  57.                 'groups' => ['jsonapi'],
  58.                 'skip_null_values' => true,
  59.                 'rfc_7807_compliant_errors' => true,
  60.             ],
  61.         ),
  62.     ],
  63.     provider: 'api_platform.state.error_provider',
  64.     graphQlOperations: []
  65. )]
  66. class Error extends \Exception implements ProblemExceptionInterface, HttpExceptionInterface
  67. {
  68.     public function __construct(
  69.         private string $title,
  70.         private string $detail,
  71.         #[ApiProperty(identifier: true)] private int $status,
  72.         array $originalTrace = null,
  73.         private ?string $instance = null,
  74.         private string $type = 'about:blank',
  75.         private array $headers = [],
  76.         \Throwable $previous = null
  77.     ) {
  78.         parent::__construct($title, $status, $previous);
  80.         if (!$originalTrace) {
  81.             return;
  82.         }
  84.         $this->originalTrace = [];
  85.         foreach ($originalTrace as $i => $t) {
  86.             unset($t['args']); // we don't want arguments in our JSON traces, especially with xdebug
  87.             $this->originalTrace[$i] = $t;
  88.         }
  89.     }
  91.     #[SerializedName('trace')]
  92.     #[Groups(['trace'])]
  93.     public ?array $originalTrace = null;
  95.     #[SerializedName('hydra:title')]
  96.     #[Groups(['jsonld'])]
  97.     public function getHydraTitle(): ?string
  98.     {
  99.         return $this->title;
  100.     }
  102.     #[SerializedName('hydra:description')]
  103.     #[Groups(['jsonld'])]
  104.     public function getHydraDescription(): ?string
  105.     {
  106.         return $this->detail;
  107.     }
  109.     #[SerializedName('description')]
  110.     public function getDescription(): ?string
  111.     {
  112.         return $this->detail;
  113.     }
  115.     public static function createFromException(\Exception|\Throwable $exception, int $status): self
  116.     {
  117.         $headers = ($exception instanceof SymfonyHttpExceptionInterface || $exception instanceof HttpExceptionInterface) ? $exception->getHeaders() : [];
  119.         return new self('An error occurred', $exception->getMessage(), $status, $exception->getTrace(), type: "/errors/$status", headers: $headers, previous: $exception->getPrevious());
  120.     }
  122.     #[Ignore]
  123.     public function getHeaders(): array
  124.     {
  125.         return $this->headers;
  126.     }
  128.     #[Ignore]
  129.     public function getStatusCode(): int
  130.     {
  131.         return $this->status;
  132.     }
  134.     /**
  135.      * @param array<string, string> $headers
  136.      */
  137.     public function setHeaders(array $headers): void
  138.     {
  139.         $this->headers = $headers;
  140.     }
  142.     #[Groups(['jsonld', 'jsonproblem'])]
  143.     public function getType(): string
  144.     {
  145.         return $this->type;
  146.     }
  148.     public function setType(string $type): void
  149.     {
  150.         $this->type = $type;
  151.     }
  153.     #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
  154.     public function getTitle(): ?string
  155.     {
  156.         return $this->title;
  157.     }
  159.     public function setTitle(string $title = null): void
  160.     {
  161.         $this->title = $title;
  162.     }
  164.     #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
  165.     public function getStatus(): ?int
  166.     {
  167.         return $this->status;
  168.     }
  170.     public function setStatus(int $status): void
  171.     {
  172.         $this->status = $status;
  173.     }
  175.     #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
  176.     public function getDetail(): ?string
  177.     {
  178.         return $this->detail;
  179.     }
  181.     public function setDetail(string $detail = null): void
  182.     {
  183.         $this->detail = $detail;
  184.     }
  186.     #[Groups(['jsonld', 'jsonproblem'])]
  187.     public function getInstance(): ?string
  188.     {
  189.         return $this->instance;
  190.     }
  192.     public function setInstance(string $instance = null): void
  193.     {
  194.         $this->instance = $instance;
  195.     }
  196. }