vendor/symfony/twig-bundle/Controller/ExceptionController.php line 54

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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 Symfony\Bundle\TwigBundle\Controller;
  14. use Symfony\Component\Debug\Exception\FlattenException;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
  18. use Twig\Environment;
  19. use Twig\Error\LoaderError;
  20. use Twig\Loader\ExistsLoaderInterface;
  22. /**
  23.  * ExceptionController renders error or exception pages for a given
  24.  * FlattenException.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  * @author Matthias Pigulla <mp@webfactory.de>
  28.  */
  29. class ExceptionController
  30. {
  31.     protected $twig;
  32.     protected $debug;
  34.     /**
  35.      * @param bool $debug Show error (false) or exception (true) pages by default
  36.      */
  37.     public function __construct(Environment $twig, bool $debug)
  38.     {
  39.         $this->twig = $twig;
  40.         $this->debug = $debug;
  41.     }
  43.     /**
  44.      * Converts an Exception to a Response.
  45.      *
  46.      * A "showException" request parameter can be used to force display of an error page (when set to false) or
  47.      * the exception page (when true). If it is not present, the "debug" value passed into the constructor will
  48.      * be used.
  49.      *
  50.      * @return Response
  51.      *
  52.      * @throws \InvalidArgumentException When the exception template does not exist
  53.      */
  54.     public function showAction(Request $request, FlattenException $exception, DebugLoggerInterface $logger = null)
  55.     {
  56.         $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
  57.         $showException = $request->attributes->get('showException', $this->debug); // As opposed to an additional parameter, this maintains BC
  59.         $code = $exception->getStatusCode();
  61.         return new Response($this->twig->render(
  62.             (string) $this->findTemplate($request, $request->getRequestFormat(), $code, $showException),
  63.             [
  64.                 'status_code' => $code,
  65.                 'status_text' => isset(Response::$statusTexts[$code]) ? Response::$statusTexts[$code] : '',
  66.                 'exception' => $exception,
  67.                 'logger' => $logger,
  68.                 'currentContent' => $currentContent,
  69.             ]
  70.         ), 200, ['Content-Type' => $request->getMimeType($request->getRequestFormat()) ?: 'text/html']);
  71.     }
  73.     /**
  74.      * @param int $startObLevel
  75.      *
  76.      * @return string
  77.      */
  78.     protected function getAndCleanOutputBuffering($startObLevel)
  79.     {
  80.         if (ob_get_level() <= $startObLevel) {
  81.             return '';
  82.         }
  84.         Response::closeOutputBuffers($startObLevel + 1, true);
  86.         return ob_get_clean();
  87.     }
  89.     /**
  90.      * @param string $format
  91.      * @param int    $code          An HTTP response status code
  92.      * @param bool   $showException
  93.      *
  94.      * @return string
  95.      */
  96.     protected function findTemplate(Request $request, $format, $code, $showException)
  97.     {
  98.         $name = $showException ? 'exception' : 'error';
  99.         if ($showException && 'html' == $format) {
  100.             $name = 'exception_full';
  101.         }
  103.         // For error pages, try to find a template for the specific HTTP status code and format
  104.         if (!$showException) {
  105.             $template = sprintf('@Twig/Exception/%s%s.%s.twig', $name, $code, $format);
  106.             if ($this->templateExists($template)) {
  107.                 return $template;
  108.             }
  109.         }
  111.         // try to find a template for the given format
  112.         $template = sprintf('@Twig/Exception/%s.%s.twig', $name, $format);
  113.         if ($this->templateExists($template)) {
  114.             return $template;
  115.         }
  117.         // default to a generic HTML exception
  118.         $request->setRequestFormat('html');
  120.         return sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : $name);
  121.     }
  123.     // to be removed when the minimum required version of Twig is >= 3.0
  124.     protected function templateExists($template)
  125.     {
  126.         $template = (string) $template;
  128.         $loader = $this->twig->getLoader();
  129.         if ($loader instanceof ExistsLoaderInterface || method_exists($loader, 'exists')) {
  130.             return $loader->exists($template);
  131.         }
  133.         try {
  134.             $loader->getSourceContext($template)->getCode();
  136.             return true;
  137.         } catch (LoaderError $e) {
  138.         }
  140.         return false;
  141.     }
  142. }