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

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\FrameworkBundle\Controller;
  14. use Symfony\Component\DependencyInjection\ContainerAwareInterface;
  15. use Symfony\Component\DependencyInjection\ContainerInterface;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\Templating\EngineInterface;
  18. use Twig\Environment;
  20. /**
  21.  * TemplateController.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @final since version 3.4
  26.  */
  27. class TemplateController implements ContainerAwareInterface
  28. {
  29.     /**
  30.      * @deprecated since version 3.4, to be removed in 4.0
  31.      */
  32.     protected $container;
  34.     private $twig;
  35.     private $templating;
  37.     public function __construct(Environment $twig = null, EngineInterface $templating = null)
  38.     {
  39.         $this->twig = $twig;
  40.         $this->templating = $templating;
  41.     }
  43.     /**
  44.      * @deprecated since version 3.4, to be removed in 4.0 alongside with the ContainerAwareInterface type.
  45.      */
  46.     public function setContainer(ContainerInterface $container = null)
  47.     {
  48.         @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 3.4 and will be removed in 4.0. Inject a Twig Environment or an EngineInterface using the constructor instead.', __METHOD__), \E_USER_DEPRECATED);
  50.         if ($container->has('templating')) {
  51.             $this->templating = $container->get('templating');
  52.         } elseif ($container->has('twig')) {
  53.             $this->twig = $container->get('twig');
  54.         }
  55.         $this->container = $container;
  56.     }
  58.     /**
  59.      * Renders a template.
  60.      *
  61.      * @param string    $template  The template name
  62.      * @param int|null  $maxAge    Max age for client caching
  63.      * @param int|null  $sharedAge Max age for shared (proxy) caching
  64.      * @param bool|null $private   Whether or not caching should apply for client caches only
  65.      *
  66.      * @return Response A Response instance
  67.      */
  68.     public function templateAction($template, $maxAge = null, $sharedAge = null, $private = null)
  69.     {
  70.         if ($this->templating) {
  71.             $response = new Response($this->templating->render($template));
  72.         } elseif ($this->twig) {
  73.             $response = new Response($this->twig->render($template));
  74.         } else {
  75.             throw new \LogicException('You can not use the TemplateController if the Templating Component or the Twig Bundle are not available.');
  76.         }
  78.         if (null !== $maxAge) {
  79.             $response->setMaxAge($maxAge);
  80.         }
  82.         if (null !== $sharedAge) {
  83.             $response->setSharedMaxAge($sharedAge);
  84.         }
  86.         if ($private) {
  87.             $response->setPrivate();
  88.         } elseif (false === $private || (null === $private && (null !== $maxAge || null !== $sharedAge))) {
  89.             $response->setPublic();
  90.         }
  92.         return $response;
  93.     }
  94. }