vendor/friendsofsymfony/rest-bundle/Serializer/Normalizer/ExceptionHandler.php line 14

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\RestBundle\Serializer\Normalizer;
  14. @trigger_error(sprintf('The %s\ExceptionHandler class is deprecated since FOSRestBundle 2.8.', __NAMESPACE__), E_USER_DEPRECATED);
  16. use JMS\Serializer\Context;
  17. use JMS\Serializer\GraphNavigatorInterface;
  18. use JMS\Serializer\Handler\SubscribingHandlerInterface;
  19. use JMS\Serializer\JsonSerializationVisitor;
  20. use JMS\Serializer\XmlSerializationVisitor;
  22. /**
  23.  * @deprecated since 2.8
  24.  */
  25. class ExceptionHandler extends AbstractExceptionNormalizer implements SubscribingHandlerInterface
  26. {
  27.     public static function getSubscribingMethods()
  28.     {
  29.         return [
  30.             [
  31.                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
  32.                 'format' => 'json',
  33.                 'type' => \Error::class,
  34.                 'method' => 'serializeErrorToJson',
  35.             ],
  36.             [
  37.                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
  38.                 'format' => 'json',
  39.                 'type' => \Exception::class,
  40.                 'method' => 'serializeToJson',
  41.             ],
  42.             [
  43.                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
  44.                 'format' => 'xml',
  45.                 'type' => \Error::class,
  46.                 'method' => 'serializeErrorToXml',
  47.             ],
  48.             [
  49.                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
  50.                 'format' => 'xml',
  51.                 'type' => \Exception::class,
  52.                 'method' => 'serializeToXml',
  53.             ],
  54.         ];
  55.     }
  57.     public function serializeToJson(
  58.         JsonSerializationVisitor $visitor,
  59.         \Exception $exception,
  60.         array $type,
  61.         Context $context
  62.     ) {
  63.         $data = $this->convertToArray($exception, $context);
  65.         return $visitor->visitArray($data, $type, $context);
  66.     }
  68.     public function serializeErrorToJson(
  69.         JsonSerializationVisitor $visitor,
  70.         \Throwable $exception,
  71.         array $type,
  72.         Context $context
  73.     ) {
  74.         $data = $this->convertThrowableToArray($exception, $context);
  76.         return $visitor->visitArray($data, $type, $context);
  77.     }
  79.     public function serializeToXml(
  80.         XmlSerializationVisitor $visitor,
  81.         \Exception $exception,
  82.         array $type,
  83.         Context $context
  84.     ) {
  85.         $data = $this->convertToArray($exception, $context);
  87.         $document = $visitor->getDocument(true);
  89.         if (!$visitor->getCurrentNode()) {
  90.             $visitor->createRoot();
  91.         }
  93.         foreach ($data as $key => $value) {
  94.             $entryNode = $document->createElement($key);
  95.             $visitor->getCurrentNode()->appendChild($entryNode);
  96.             $visitor->setCurrentNode($entryNode);
  98.             $node = $context->getNavigator()->accept($value, null, $context);
  99.             if (null !== $node) {
  100.                 $visitor->getCurrentNode()->appendChild($node);
  101.             }
  103.             $visitor->revertCurrentNode();
  104.         }
  105.     }
  107.     public function serializeErrorToXml(
  108.         XmlSerializationVisitor $visitor,
  109.         \Throwable $exception,
  110.         array $type,
  111.         Context $context
  112.     ) {
  113.         $data = $this->convertThrowableToArray($exception, $context);
  115.         $document = $visitor->getDocument(true);
  117.         if (!$visitor->getCurrentNode()) {
  118.             $visitor->createRoot();
  119.         }
  121.         foreach ($data as $key => $value) {
  122.             $entryNode = $document->createElement($key);
  123.             $visitor->getCurrentNode()->appendChild($entryNode);
  124.             $visitor->setCurrentNode($entryNode);
  126.             $node = $context->getNavigator()->accept($value, null, $context);
  127.             if (null !== $node) {
  128.                 $visitor->getCurrentNode()->appendChild($node);
  129.             }
  131.             $visitor->revertCurrentNode();
  132.         }
  133.     }
  135.     protected function convertToArray(\Exception $exception, Context $context)
  136.     {
  137.         return $this->convertThrowableToArray($exception, $context);
  138.     }
  140.     private function convertThrowableToArray(\Throwable $throwable, Context $context): array
  141.     {
  142.         $data = [];
  144.         if ($context->hasAttribute('template_data')) {
  145.             $templateData = $context->getAttribute('template_data');
  147.             if (array_key_exists('status_code', $templateData)) {
  148.                 $data['code'] = $statusCode = $templateData['status_code'];
  149.             } elseif ($context->hasAttribute('status_code')) {
  150.                 $data['code'] = $context->getAttribute('status_code');
  151.             }
  152.         } elseif ($context->hasAttribute('status_code')) {
  153.             $data['code'] = $context->getAttribute('status_code');
  154.         }
  156.         $data['message'] = $this->getMessageFromThrowable($throwable, isset($statusCode) ? $statusCode : null);
  158.         return $data;
  159.     }
  160. }