vendor/twig/twig/src/TemplateWrapper.php line 51

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  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 Twig;
  14. use Twig\Error\RuntimeError;
  16. /**
  17.  * Exposes a template to userland.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. final class TemplateWrapper
  22. {
  23.     /**
  24.      * This method is for internal use only and should never be called
  25.      * directly (use Twig\Environment::load() instead).
  26.      *
  27.      * @internal
  28.      */
  29.     public function __construct(
  30.         private Environment $env,
  31.         private Template $template,
  32.     ) {
  33.     }
  35.     /**
  36.      * @return iterable<scalar|\Stringable|null>
  37.      */
  38.     public function stream(array $context = []): iterable
  39.     {
  40.         yield from $this->template->yield($context);
  41.     }
  43.     /**
  44.      * @return iterable<scalar|\Stringable|null>
  45.      */
  46.     public function streamBlock(string $name, array $context = []): iterable
  47.     {
  48.         yield from $this->template->yieldBlock($name, $context + $this->env->getGlobals());
  49.     }
  51.     public function render(array $context = []): string
  52.     {
  53.         return $this->template->render($context);
  54.     }
  56.     public function display(array $context = []): void
  57.     {
  58.         // using func_get_args() allows to not expose the blocks argument
  59.         // as it should only be used by internal code
  60.         $this->template->display($context, \func_get_args()[1] ?? []);
  61.     }
  63.     public function hasBlock(string $name, array $context = []): bool
  64.     {
  65.         return $this->template->hasBlock($name, $context + $this->env->getGlobals());
  66.     }
  68.     /**
  69.      * @return string[] An array of defined template block names
  70.      */
  71.     public function getBlockNames(array $context = []): array
  72.     {
  73.         return $this->template->getBlockNames($context + $this->env->getGlobals());
  74.     }
  76.     public function renderBlock(string $name, array $context = []): string
  77.     {
  78.         return $this->template->renderBlock($name, $context + $this->env->getGlobals());
  79.     }
  81.     public function displayBlock(string $name, array $context = []): void
  82.     {
  83.         $context += $this->env->getGlobals();
  84.         foreach ($this->template->yieldBlock($name, $context) as $data) {
  85.             echo $data;
  86.         }
  87.     }
  89.     public function getSourceContext(): Source
  90.     {
  91.         return $this->template->getSourceContext();
  92.     }
  94.     public function getTemplateName(): string
  95.     {
  96.         return $this->template->getTemplateName();
  97.     }
  99.     /**
  100.      * Returns the escaping strategy the template body was compiled with.
  101.      *
  102.      * This describes the template's own source, not its output: `autoescape`,
  103.      * `escape`, and anything rendered by a parent, embedded, or included
  104.      * template can use another strategy.
  105.      *
  106.      * @return string|false The strategy name or false when the template is not autoescaped
  107.      */
  108.     public function getDefaultEscapeStrategy(): string|false
  109.     {
  110.         return $this->template->getDefaultEscapeStrategy();
  111.     }
  113.     /**
  114.      * @internal
  115.      */
  116.     public function isOwnedBy(Environment $env): bool
  117.     {
  118.         return $this->env === $env && $this->template->isOwnedBy($env);
  119.     }
  121.     /**
  122.      * @internal
  123.      */
  124.     public function unwrap(?Environment $env = null): Template
  125.     {
  126.         if (null === $env) {
  127.             trigger_deprecation('twig/twig', '3.30', 'Calling "%s()" without arguments is deprecated, pass the Twig environment instead.', __METHOD__);
  128.         } elseif (!$this->isOwnedBy($env)) {
  129.             throw new RuntimeError(\sprintf('A "%s" can only be used with the "%s" that created it.', self::class, Environment::class));
  130.         }
  132.         return $this->template;
  133.     }
  134. }