vendor/friendsofsymfony/rest-bundle/Controller/ExceptionController.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\Controller;
  14. @trigger_error(sprintf('The %s\ExceptionController class is deprecated since FOSRestBundle 2.8.', __NAMESPACE__), E_USER_DEPRECATED);
  16. use FOS\RestBundle\Exception\FlattenException as FosFlattenException;
  17. use FOS\RestBundle\Util\ExceptionValueMap;
  18. use FOS\RestBundle\View\View;
  19. use FOS\RestBundle\View\ViewHandlerInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  23. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  24. use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
  26. /**
  27.  * Custom ExceptionController that uses the view layer and supports HTTP response status code mapping.
  28.  *
  29.  * @deprecated since 2.8
  30.  */
  31. class ExceptionController
  32. {
  33.     private $viewHandler;
  34.     private $exceptionCodes;
  35.     private $showException;
  37.     public function __construct(
  38.         ViewHandlerInterface $viewHandler,
  39.         ExceptionValueMap $exceptionCodes,
  40.         bool $showException
  41.     ) {
  42.         $this->viewHandler = $viewHandler;
  43.         $this->exceptionCodes = $exceptionCodes;
  44.         $this->showException = $showException;
  45.     }
  47.     /**
  48.      * @param \Throwable $exception
  49.      */
  50.     public function showAction(Request $request, $exception, DebugLoggerInterface $logger = null)
  51.     {
  52.         $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
  54.         if ($exception instanceof \Exception) {
  55.             $code = $this->getStatusCode($exception);
  56.         } else {
  57.             $code = $this->getStatusCodeFromThrowable($exception);
  58.         }
  59.         $templateData = $this->getTemplateData($currentContent, $code, $exception, $logger);
  61.         if ($exception instanceof \Exception) {
  62.             $view = $this->createView($exception, $code, $templateData, $request, $this->showException);
  63.         } else {
  64.             $view = $this->createViewFromThrowable($exception, $code, $templateData, $request, $this->showException);
  65.         }
  67.         $response = $this->viewHandler->handle($view);
  69.         return $response;
  70.     }
  72.     /**
  73.      * @param int  $code
  74.      * @param bool $showException
  75.      *
  76.      * @return View
  77.      */
  78.     protected function createView(\Exception $exception, $code, array $templateData, Request $request, $showException)
  79.     {
  80.         return $this->createViewFromThrowable($exception, $code, $templateData);
  81.     }
  83.     /**
  84.      * @return int
  85.      */
  86.     protected function getStatusCode(\Exception $exception)
  87.     {
  88.         return $this->getStatusCodeFromThrowable($exception);
  89.     }
  91.     private function createViewFromThrowable(\Throwable $exception, $code, array $templateData): View
  92.     {
  93.         $view = new View($exception, $code, $exception instanceof HttpExceptionInterface ? $exception->getHeaders() : []);
  94.         $view->setTemplateVar('raw_exception', false);
  95.         $view->setTemplateData($templateData, false);
  97.         return $view;
  98.     }
  100.     private function getTemplateData(string $currentContent, int $code, \Throwable $throwable, DebugLoggerInterface $logger = null): array
  101.     {
  102.         if (class_exists(FlattenException::class)) {
  103.             $exception = FlattenException::createFromThrowable($throwable);
  104.         } else {
  105.             $exception = FosFlattenException::createFromThrowable($throwable);
  106.         }
  108.         return [
  109.             'exception' => $exception,
  110.             'status' => 'error',
  111.             'status_code' => $code,
  112.             'status_text' => array_key_exists($code, Response::$statusTexts) ? Response::$statusTexts[$code] : 'error',
  113.             'currentContent' => $currentContent,
  114.             'logger' => $logger,
  115.         ];
  116.     }
  118.     /**
  119.      * Gets and cleans any content that was already outputted.
  120.      *
  121.      * This code comes from Symfony and should be synchronized on a regular basis
  122.      * see src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php
  123.      */
  124.     private function getAndCleanOutputBuffering($startObLevel): string
  125.     {
  126.         if (ob_get_level() <= $startObLevel) {
  127.             return '';
  128.         }
  129.         Response::closeOutputBuffers($startObLevel + 1, true);
  131.         return ob_get_clean();
  132.     }
  134.     private function getStatusCodeFromThrowable(\Throwable $exception): int
  135.     {
  136.         // If matched
  137.         if ($statusCode = $this->exceptionCodes->resolveThrowable($exception)) {
  138.             return $statusCode;
  139.         }
  141.         // Otherwise, default
  142.         if ($exception instanceof HttpExceptionInterface) {
  143.             return $exception->getStatusCode();
  144.         }
  146.         return 500;
  147.     }
  148. }