vendor/symfony/framework-bundle/Controller/TemplateController.php line 24

  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\FrameworkBundle\Controller;
  14. use Symfony\Component\HttpFoundation\Response;
  15. use Twig\Environment;
  17. /**
  18.  * TemplateController.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  *
  22.  * @final
  23.  */
  24. class TemplateController
  25. {
  26.     private ?Environment $twig;
  28.     public function __construct(Environment $twig = null)
  29.     {
  30.         $this->twig = $twig;
  31.     }
  33.     /**
  34.      * Renders a template.
  35.      *
  36.      * @param string    $template   The template name
  37.      * @param int|null  $maxAge     Max age for client caching
  38.      * @param int|null  $sharedAge  Max age for shared (proxy) caching
  39.      * @param bool|null $private    Whether or not caching should apply for client caches only
  40.      * @param array     $context    The context (arguments) of the template
  41.      * @param int       $statusCode The HTTP status code to return with the response (200 "OK" by default)
  42.      */
  43.     public function templateAction(string $template, int $maxAge = null, int $sharedAge = null, bool $private = null, array $context = [], int $statusCode = 200): Response
  44.     {
  45.         if (null === $this->twig) {
  46.             throw new \LogicException('You cannot use the TemplateController if the Twig Bundle is not available.');
  47.         }
  49.         $response = new Response($this->twig->render($template, $context), $statusCode);
  51.         if ($maxAge) {
  52.             $response->setMaxAge($maxAge);
  53.         }
  55.         if (null !== $sharedAge) {
  56.             $response->setSharedMaxAge($sharedAge);
  57.         }
  59.         if ($private) {
  60.             $response->setPrivate();
  61.         } elseif (false === $private || (null === $private && (null !== $maxAge || null !== $sharedAge))) {
  62.             $response->setPublic();
  63.         }
  65.         return $response;
  66.     }
  68.     /**
  69.      * @param int $statusCode The HTTP status code (200 "OK" by default)
  70.      */
  71.     public function __invoke(string $template, int $maxAge = null, int $sharedAge = null, bool $private = null, array $context = [], int $statusCode = 200): Response
  72.     {
  73.         return $this->templateAction($template, $maxAge, $sharedAge, $private, $context, $statusCode);
  74.     }
  75. }