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. /**
  15.  * Exposes a template to userland.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  */
  19. final class TemplateWrapper
  20. {
  21.     /**
  22.      * This method is for internal use only and should never be called
  23.      * directly (use Twig\Environment::load() instead).
  24.      *
  25.      * @internal
  26.      */
  27.     public function __construct(
  28.         private Environment $env,
  29.         private Template $template,
  30.     ) {
  31.     }
  33.     /**
  34.      * @return iterable<scalar|\Stringable|null>
  35.      */
  36.     public function stream(array $context = []): iterable
  37.     {
  38.         yield from $this->template->yield($context);
  39.     }
  41.     /**
  42.      * @return iterable<scalar|\Stringable|null>
  43.      */
  44.     public function streamBlock(string $name, array $context = []): iterable
  45.     {
  46.         yield from $this->template->yieldBlock($name, $context);
  47.     }
  49.     public function render(array $context = []): string
  50.     {
  51.         return $this->template->render($context);
  52.     }
  54.     public function display(array $context = [])
  55.     {
  56.         // using func_get_args() allows to not expose the blocks argument
  57.         // as it should only be used by internal code
  58.         $this->template->display($context, \func_get_args()[1] ?? []);
  59.     }
  61.     public function hasBlock(string $name, array $context = []): bool
  62.     {
  63.         return $this->template->hasBlock($name, $context);
  64.     }
  66.     /**
  67.      * @return string[] An array of defined template block names
  68.      */
  69.     public function getBlockNames(array $context = []): array
  70.     {
  71.         return $this->template->getBlockNames($context);
  72.     }
  74.     public function renderBlock(string $name, array $context = []): string
  75.     {
  76.         return $this->template->renderBlock($name, $context + $this->env->getGlobals());
  77.     }
  79.     public function displayBlock(string $name, array $context = [])
  80.     {
  81.         $context += $this->env->getGlobals();
  82.         foreach ($this->template->yieldBlock($name, $context) as $data) {
  83.             echo $data;
  84.         }
  85.     }
  87.     public function getSourceContext(): Source
  88.     {
  89.         return $this->template->getSourceContext();
  90.     }
  92.     public function getTemplateName(): string
  93.     {
  94.         return $this->template->getTemplateName();
  95.     }
  97.     /**
  98.      * @internal
  99.      *
  100.      * @return Template
  101.      */
  102.     public function unwrap()
  103.     {
  104.         return $this->template;
  105.     }
  106. }