vendor/api-platform/core/src/Action/ExceptionAction.php line 50

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\Action;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\Util\ErrorFormatGuesser;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use Symfony\Component\Debug\Exception\FlattenException as LegacyFlattenException;
  22. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\Serializer\SerializerInterface;
  27. /**
  28. * Renders a normalized exception for a given {@see FlattenException} or {@see LegacyFlattenException}.
  29. *
  30. * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  31. * @author Kévin Dunglas <dunglas@gmail.com>
  32. */
  33. final class ExceptionAction
  34. {
  35. use OperationRequestInitiatorTrait;
  37. private $serializer;
  38. private $errorFormats;
  39. private $exceptionToStatus;
  40. /**
  41. * @var ResourceMetadataCollectionFactoryInterface|ResourceMetadataFactoryInterface|null
  42. */
  43. private $resourceMetadataFactory;
  45. /**
  46. * @param array $errorFormats A list of enabled error formats
  47. * @param array $exceptionToStatus A list of exceptions mapped to their HTTP status code
  48. * @param mixed|null $resourceMetadataFactory
  49. */
  50. public function __construct(SerializerInterface $serializer, array $errorFormats, array $exceptionToStatus = [], $resourceMetadataFactory = null)
  51. {
  52. $this->serializer = $serializer;
  53. $this->errorFormats = $errorFormats;
  54. $this->exceptionToStatus = $exceptionToStatus;
  55. $this->resourceMetadataFactory = $resourceMetadataFactory;
  57. if (null !== $resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  58. trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  59. } else {
  60. $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  61. }
  62. }
  64. /**
  65. * Converts an exception to a JSON response.
  66. *
  67. * @param FlattenException|LegacyFlattenException $exception
  68. */
  69. public function __invoke($exception, Request $request): Response
  70. {
  71. $operation = $this->initializeOperation($request);
  72. $exceptionClass = $exception->getClass();
  73. $statusCode = $exception->getStatusCode();
  75. $exceptionToStatus = array_merge(
  76. $this->exceptionToStatus,
  77. $operation ? $operation->getExceptionToStatus() ?? [] : $this->getOperationExceptionToStatus($request)
  78. );
  80. foreach ($exceptionToStatus as $class => $status) {
  81. if (is_a($exceptionClass, $class, true)) {
  82. $statusCode = $status;
  84. break;
  85. }
  86. }
  88. $headers = $exception->getHeaders();
  89. $format = ErrorFormatGuesser::guessErrorFormat($request, $this->errorFormats);
  90. $headers['Content-Type'] = sprintf('%s; charset=utf-8', $format['value'][0]);
  91. $headers['X-Content-Type-Options'] = 'nosniff';
  92. $headers['X-Frame-Options'] = 'deny';
  94. return new Response($this->serializer->serialize($exception, $format['key'], ['statusCode' => $statusCode]), $statusCode, $headers);
  95. }
  97. private function getOperationExceptionToStatus(Request $request): array
  98. {
  99. // TODO: remove legacy layer in 3.0
  100. if ($request->attributes->has('_api_exception_to_status')) {
  101. return $request->attributes->get('_api_exception_to_status');
  102. }
  104. $attributes = RequestAttributesExtractor::extractAttributes($request);
  106. if ([] === $attributes || null === $this->resourceMetadataFactory) {
  107. return [];
  108. }
  110. $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  111. $operationExceptionToStatus = $resourceMetadata->getOperationAttribute($attributes, 'exception_to_status', [], false);
  112. $resourceExceptionToStatus = $resourceMetadata->getAttribute('exception_to_status', []);
  114. if (!\is_array($operationExceptionToStatus) || !\is_array($resourceExceptionToStatus)) {
  115. throw new \LogicException('"exception_to_status" attribute should be an array.');
  116. }
  118. return array_merge(
  119. $resourceExceptionToStatus,
  120. $operationExceptionToStatus
  121. );
  122. }
  123. }
  125. class_alias(ExceptionAction::class, \ApiPlatform\Core\Action\ExceptionAction::class);