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

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;
  21. use Twig\Loader\SourceContextLoaderInterface;
  23. /**
  24.  * ExceptionController renders error or exception pages for a given
  25.  * FlattenException.
  26.  *
  27.  * @author Fabien Potencier <fabien@symfony.com>
  28.  * @author Matthias Pigulla <mp@webfactory.de>
  29.  */
  30. class ExceptionController
  31. {
  32.     protected $twig;
  33.     protected $debug;
  35.     /**
  36.      * @param bool $debug Show error (false) or exception (true) pages by default
  37.      */
  38.     public function __construct(Environment $twig, bool $debug)
  39.     {
  40.         $this->twig = $twig;
  41.         $this->debug = $debug;
  42.     }
  44.     /**
  45.      * Converts an Exception to a Response.
  46.      *
  47.      * A "showException" request parameter can be used to force display of an error page (when set to false) or
  48.      * the exception page (when true). If it is not present, the "debug" value passed into the constructor will
  49.      * be used.
  50.      *
  51.      * @return Response
  52.      *
  53.      * @throws \InvalidArgumentException When the exception template does not exist
  54.      */
  55.     public function showAction(Request $request, FlattenException $exception, DebugLoggerInterface $logger = null)
  56.     {
  57.         $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
  58.         $showException = $request->attributes->get('showException', $this->debug); // As opposed to an additional parameter, this maintains BC
  60.         $code = $exception->getStatusCode();
  62.         return new Response($this->twig->render(
  63.             (string) $this->findTemplate($request, $request->getRequestFormat(), $code, $showException),
  64.             [
  65.                 'status_code' => $code,
  66.                 'status_text' => isset(Response::$statusTexts[$code]) ? Response::$statusTexts[$code] : '',
  67.                 'exception' => $exception,
  68.                 'logger' => $logger,
  69.                 'currentContent' => $currentContent,
  70.             ]
  71.         ), 200, ['Content-Type' => $request->getMimeType($request->getRequestFormat()) ?: 'text/html']);
  72.     }
  74.     /**
  75.      * @param int $startObLevel
  76.      *
  77.      * @return string
  78.      */
  79.     protected function getAndCleanOutputBuffering($startObLevel)
  80.     {
  81.         if (ob_get_level() <= $startObLevel) {
  82.             return '';
  83.         }
  85.         Response::closeOutputBuffers($startObLevel + 1, true);
  87.         return ob_get_clean();
  88.     }
  90.     /**
  91.      * @param string $format
  92.      * @param int    $code          An HTTP response status code
  93.      * @param bool   $showException
  94.      *
  95.      * @return string
  96.      */
  97.     protected function findTemplate(Request $request, $format, $code, $showException)
  98.     {
  99.         $name = $showException ? 'exception' : 'error';
  100.         if ($showException && 'html' == $format) {
  101.             $name = 'exception_full';
  102.         }
  104.         // For error pages, try to find a template for the specific HTTP status code and format
  105.         if (!$showException) {
  106.             $template = sprintf('@Twig/Exception/%s%s.%s.twig', $name, $code, $format);
  107.             if ($this->templateExists($template)) {
  108.                 return $template;
  109.             }
  110.         }
  112.         // try to find a template for the given format
  113.         $template = sprintf('@Twig/Exception/%s.%s.twig', $name, $format);
  114.         if ($this->templateExists($template)) {
  115.             return $template;
  116.         }
  118.         // default to a generic HTML exception
  119.         $request->setRequestFormat('html');
  121.         return sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : $name);
  122.     }
  124.     // to be removed when the minimum required version of Twig is >= 2.0
  125.     protected function templateExists($template)
  126.     {
  127.         $template = (string) $template;
  129.         $loader = $this->twig->getLoader();
  131.         if (1 === Environment::MAJOR_VERSION && !$loader instanceof ExistsLoaderInterface) {
  132.             try {
  133.                 if ($loader instanceof SourceContextLoaderInterface) {
  134.                     $loader->getSourceContext($template);
  135.                 } else {
  136.                     $loader->getSource($template);
  137.                 }
  139.                 return true;
  140.             } catch (LoaderError $e) {
  141.             }
  143.             return false;
  144.         }
  146.         return $loader->exists($template);
  147.     }
  148. }