vendor/symfony/twig-bridge/TwigEngine.php line 53

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\Bridge\Twig;
  14. @trigger_error('The '.TwigEngine::class.' class is deprecated since version 4.3 and will be removed in 5.0; use \Twig\Environment instead.', E_USER_DEPRECATED);
  16. use Symfony\Component\Templating\EngineInterface;
  17. use Symfony\Component\Templating\StreamingEngineInterface;
  18. use Symfony\Component\Templating\TemplateNameParserInterface;
  19. use Symfony\Component\Templating\TemplateReferenceInterface;
  20. use Twig\Environment;
  21. use Twig\Error\Error;
  22. use Twig\Error\LoaderError;
  23. use Twig\Loader\ExistsLoaderInterface;
  24. use Twig\Template;
  26. /**
  27.  * This engine knows how to render Twig templates.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  *
  31.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  32.  */
  33. class TwigEngine implements EngineInterface, StreamingEngineInterface
  34. {
  35.     protected $environment;
  36.     protected $parser;
  38.     public function __construct(Environment $environment, TemplateNameParserInterface $parser)
  39.     {
  40.         $this->environment = $environment;
  41.         $this->parser = $parser;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      *
  47.      * It also supports Template as name parameter.
  48.      *
  49.      * @throws Error if something went wrong like a thrown exception while rendering the template
  50.      */
  51.     public function render($name, array $parameters = [])
  52.     {
  53.         return $this->load($name)->render($parameters);
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      *
  59.      * It also supports Template as name parameter.
  60.      *
  61.      * @throws Error if something went wrong like a thrown exception while rendering the template
  62.      */
  63.     public function stream($name, array $parameters = [])
  64.     {
  65.         $this->load($name)->display($parameters);
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      *
  71.      * It also supports Template as name parameter.
  72.      */
  73.     public function exists($name)
  74.     {
  75.         if ($name instanceof Template) {
  76.             return true;
  77.         }
  79.         $loader = $this->environment->getLoader();
  81.         if ($loader instanceof ExistsLoaderInterface || method_exists($loader, 'exists')) {
  82.             return $loader->exists((string) $name);
  83.         }
  85.         try {
  86.             // cast possible TemplateReferenceInterface to string because the
  87.             // EngineInterface supports them but LoaderInterface does not
  88.             $loader->getSourceContext((string) $name)->getCode();
  89.         } catch (LoaderError $e) {
  90.             return false;
  91.         }
  93.         return true;
  94.     }
  96.     /**
  97.      * {@inheritdoc}
  98.      *
  99.      * It also supports Template as name parameter.
  100.      */
  101.     public function supports($name)
  102.     {
  103.         if ($name instanceof Template) {
  104.             return true;
  105.         }
  107.         $template = $this->parser->parse($name);
  109.         return 'twig' === $template->get('engine');
  110.     }
  112.     /**
  113.      * Loads the given template.
  114.      *
  115.      * @param string|TemplateReferenceInterface|Template $name A template name or an instance of
  116.      *                                                         TemplateReferenceInterface or Template
  117.      *
  118.      * @return Template
  119.      *
  120.      * @throws \InvalidArgumentException if the template does not exist
  121.      */
  122.     protected function load($name)
  123.     {
  124.         if ($name instanceof Template) {
  125.             return $name;
  126.         }
  128.         try {
  129.             return $this->environment->loadTemplate((string) $name);
  130.         } catch (LoaderError $e) {
  131.             throw new \InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
  132.         }
  133.     }
  134. }