vendor/twig/twig/src/Node/ModuleNode.php line 81

  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  * (c) Armin Ronacher
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Twig\Node;
  15. use Twig\Attribute\YieldReady;
  16. use Twig\Compiler;
  17. use Twig\Node\Expression\AbstractExpression;
  18. use Twig\Node\Expression\ConstantExpression;
  19. use Twig\Source;
  21. /**
  22.  * Represents a module node.
  23.  *
  24.  * If you need to customize the behavior of the generated class, add nodes to
  25.  * the following nodes: display_start, display_end, constructor_start,
  26.  * constructor_end, and class_end.
  27.  *
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  */
  30. #[YieldReady]
  31. final class ModuleNode extends Node
  32. {
  33.     /**
  34.      * @param BodyNode $body
  35.      */
  36.     public function __construct(Node $body, ?AbstractExpression $parent, Node $blocks, Node $macros, Node $traits, $embeddedTemplates, Source $source)
  37.     {
  38.         if (!$body instanceof BodyNode) {
  39.             trigger_deprecation('twig/twig', '3.12', \sprintf('Not passing a "%s" instance as the "body" argument of the "%s" constructor is deprecated.', BodyNode::class, static::class));
  40.         }
  42.         $nodes = [
  43.             'body' => $body,
  44.             'blocks' => $blocks,
  45.             'macros' => $macros,
  46.             'traits' => $traits,
  47.             'display_start' => new Node(),
  48.             'display_end' => new Node(),
  49.             'constructor_start' => new Node(),
  50.             'constructor_end' => new Node(),
  51.             'class_end' => new Node(),
  52.         ];
  53.         if (null !== $parent) {
  54.             $nodes['parent'] = $parent;
  55.         }
  57.         // embedded templates are set as attributes so that they are only visited once by the visitors
  58.         parent::__construct($nodes, [
  59.             'index' => null,
  60.             'embedded_templates' => $embeddedTemplates,
  61.         ], 1);
  63.         // populate the template name of all node children
  64.         $this->setSourceContext($source);
  65.     }
  67.     public function setIndex($index)
  68.     {
  69.         $this->setAttribute('index', $index);
  70.     }
  72.     public function compile(Compiler $compiler): void
  73.     {
  74.         $this->compileTemplate($compiler);
  76.         foreach ($this->getAttribute('embedded_templates') as $template) {
  77.             $compiler->subcompile($template);
  78.         }
  79.     }
  81.     protected function compileTemplate(Compiler $compiler)
  82.     {
  83.         if (!$this->getAttribute('index')) {
  84.             $compiler->write('<?php');
  85.         }
  87.         $this->compileClassHeader($compiler);
  89.         $this->compileConstructor($compiler);
  91.         $this->compileGetParent($compiler);
  93.         $this->compileDisplay($compiler);
  95.         $compiler->subcompile($this->getNode('blocks'));
  97.         $this->compileMacros($compiler);
  99.         $this->compileGetTemplateName($compiler);
  101.         $this->compileIsTraitable($compiler);
  103.         $this->compileDebugInfo($compiler);
  105.         $this->compileGetSourceContext($compiler);
  107.         $this->compileClassFooter($compiler);
  108.     }
  110.     protected function compileGetParent(Compiler $compiler)
  111.     {
  112.         if (!$this->hasNode('parent')) {
  113.             return;
  114.         }
  115.         $parent = $this->getNode('parent');
  117.         $compiler
  118.             ->write("protected function doGetParent(array \$context): bool|string|Template|TemplateWrapper\n", "{\n")
  119.             ->indent()
  120.             ->addDebugInfo($parent)
  121.             ->write('return ')
  122.         ;
  124.         if ($parent instanceof ConstantExpression) {
  125.             $compiler->subcompile($parent);
  126.         } else {
  127.             $compiler
  128.                 ->raw('$this->loadTemplate(')
  129.                 ->subcompile($parent)
  130.                 ->raw(', ')
  131.                 ->repr($this->getSourceContext()->getName())
  132.                 ->raw(', ')
  133.                 ->repr($parent->getTemplateLine())
  134.                 ->raw(')')
  135.             ;
  136.         }
  138.         $compiler
  139.             ->raw(";\n")
  140.             ->outdent()
  141.             ->write("}\n\n")
  142.         ;
  143.     }
  145.     protected function compileClassHeader(Compiler $compiler)
  146.     {
  147.         $compiler
  148.             ->write("\n\n")
  149.         ;
  150.         if (!$this->getAttribute('index')) {
  151.             $compiler
  152.                 ->write("use Twig\Environment;\n")
  153.                 ->write("use Twig\Error\LoaderError;\n")
  154.                 ->write("use Twig\Error\RuntimeError;\n")
  155.                 ->write("use Twig\Extension\CoreExtension;\n")
  156.                 ->write("use Twig\Extension\SandboxExtension;\n")
  157.                 ->write("use Twig\Markup;\n")
  158.                 ->write("use Twig\Sandbox\SecurityError;\n")
  159.                 ->write("use Twig\Sandbox\SecurityNotAllowedTagError;\n")
  160.                 ->write("use Twig\Sandbox\SecurityNotAllowedFilterError;\n")
  161.                 ->write("use Twig\Sandbox\SecurityNotAllowedFunctionError;\n")
  162.                 ->write("use Twig\Source;\n")
  163.                 ->write("use Twig\Template;\n")
  164.                 ->write("use Twig\TemplateWrapper;\n")
  165.                 ->write("\n")
  166.             ;
  167.         }
  168.         $compiler
  169.             // if the template name contains */, add a blank to avoid a PHP parse error
  170.             ->write('/* '.str_replace('*/', '* /', $this->getSourceContext()->getName())." */\n")
  171.             ->write('class '.$compiler->getEnvironment()->getTemplateClass($this->getSourceContext()->getName(), $this->getAttribute('index')))
  172.             ->raw(" extends Template\n")
  173.             ->write("{\n")
  174.             ->indent()
  175.             ->write("private Source \$source;\n")
  176.             ->write("/**\n")
  177.             ->write(" * @var array<string, Template>\n")
  178.             ->write(" */\n")
  179.             ->write("private array \$macros = [];\n\n")
  180.         ;
  181.     }
  183.     protected function compileConstructor(Compiler $compiler)
  184.     {
  185.         $compiler
  186.             ->write("public function __construct(Environment \$env)\n", "{\n")
  187.             ->indent()
  188.             ->subcompile($this->getNode('constructor_start'))
  189.             ->write("parent::__construct(\$env);\n\n")
  190.             ->write("\$this->source = \$this->getSourceContext();\n\n")
  191.         ;
  193.         // parent
  194.         if (!$this->hasNode('parent')) {
  195.             $compiler->write("\$this->parent = false;\n\n");
  196.         }
  198.         $countTraits = \count($this->getNode('traits'));
  199.         if ($countTraits) {
  200.             // traits
  201.             foreach ($this->getNode('traits') as $i => $trait) {
  202.                 $node = $trait->getNode('template');
  204.                 $compiler
  205.                     ->addDebugInfo($node)
  206.                     ->write(\sprintf('$_trait_%s = $this->loadTemplate(', $i))
  207.                     ->subcompile($node)
  208.                     ->raw(', ')
  209.                     ->repr($node->getTemplateName())
  210.                     ->raw(', ')
  211.                     ->repr($node->getTemplateLine())
  212.                     ->raw(");\n")
  213.                     ->write(\sprintf("if (!\$_trait_%s->unwrap()->isTraitable()) {\n", $i))
  214.                     ->indent()
  215.                     ->write("throw new RuntimeError('Template \"'.")
  216.                     ->subcompile($trait->getNode('template'))
  217.                     ->raw(".'\" cannot be used as a trait.', ")
  218.                     ->repr($node->getTemplateLine())
  219.                     ->raw(", \$this->source);\n")
  220.                     ->outdent()
  221.                     ->write("}\n")
  222.                     ->write(\sprintf("\$_trait_%s_blocks = \$_trait_%s->unwrap()->getBlocks();\n\n", $i, $i))
  223.                 ;
  225.                 foreach ($trait->getNode('targets') as $key => $value) {
  226.                     $compiler
  227.                         ->write(\sprintf('if (!isset($_trait_%s_blocks[', $i))
  228.                         ->string($key)
  229.                         ->raw("])) {\n")
  230.                         ->indent()
  231.                         ->write("throw new RuntimeError('Block ")
  232.                         ->string($key)
  233.                         ->raw(' is not defined in trait ')
  234.                         ->subcompile($trait->getNode('template'))
  235.                         ->raw(".', ")
  236.                         ->repr($node->getTemplateLine())
  237.                         ->raw(", \$this->source);\n")
  238.                         ->outdent()
  239.                         ->write("}\n\n")
  241.                         ->write(\sprintf('$_trait_%s_blocks[', $i))
  242.                         ->subcompile($value)
  243.                         ->raw(\sprintf('] = $_trait_%s_blocks[', $i))
  244.                         ->string($key)
  245.                         ->raw(\sprintf(']; unset($_trait_%s_blocks[', $i))
  246.                         ->string($key)
  247.                         ->raw("]);\n\n")
  248.                     ;
  249.                 }
  250.             }
  252.             if ($countTraits > 1) {
  253.                 $compiler
  254.                     ->write("\$this->traits = array_merge(\n")
  255.                     ->indent()
  256.                 ;
  258.                 for ($i = 0; $i < $countTraits; ++$i) {
  259.                     $compiler
  260.                         ->write(\sprintf('$_trait_%s_blocks'.($i == $countTraits - 1 ? '' : ',')."\n", $i))
  261.                     ;
  262.                 }
  264.                 $compiler
  265.                     ->outdent()
  266.                     ->write(");\n\n")
  267.                 ;
  268.             } else {
  269.                 $compiler
  270.                     ->write("\$this->traits = \$_trait_0_blocks;\n\n")
  271.                 ;
  272.             }
  274.             $compiler
  275.                 ->write("\$this->blocks = array_merge(\n")
  276.                 ->indent()
  277.                 ->write("\$this->traits,\n")
  278.                 ->write("[\n")
  279.             ;
  280.         } else {
  281.             $compiler
  282.                 ->write("\$this->blocks = [\n")
  283.             ;
  284.         }
  286.         // blocks
  287.         $compiler
  288.             ->indent()
  289.         ;
  291.         foreach ($this->getNode('blocks') as $name => $node) {
  292.             $compiler
  293.                 ->write(\sprintf("'%s' => [\$this, 'block_%s'],\n", $name, $name))
  294.             ;
  295.         }
  297.         if ($countTraits) {
  298.             $compiler
  299.                 ->outdent()
  300.                 ->write("]\n")
  301.                 ->outdent()
  302.                 ->write(");\n")
  303.             ;
  304.         } else {
  305.             $compiler
  306.                 ->outdent()
  307.                 ->write("];\n")
  308.             ;
  309.         }
  311.         $compiler
  312.             ->subcompile($this->getNode('constructor_end'))
  313.             ->outdent()
  314.             ->write("}\n\n")
  315.         ;
  316.     }
  318.     protected function compileDisplay(Compiler $compiler)
  319.     {
  320.         $compiler
  321.             ->write("protected function doDisplay(array \$context, array \$blocks = []): iterable\n", "{\n")
  322.             ->indent()
  323.             ->write("\$macros = \$this->macros;\n")
  324.             ->subcompile($this->getNode('display_start'))
  325.             ->subcompile($this->getNode('body'))
  326.         ;
  328.         if ($this->hasNode('parent')) {
  329.             $parent = $this->getNode('parent');
  331.             $compiler->addDebugInfo($parent);
  332.             if ($parent instanceof ConstantExpression) {
  333.                 $compiler
  334.                     ->write('$this->parent = $this->loadTemplate(')
  335.                     ->subcompile($parent)
  336.                     ->raw(', ')
  337.                     ->repr($this->getSourceContext()->getName())
  338.                     ->raw(', ')
  339.                     ->repr($parent->getTemplateLine())
  340.                     ->raw(");\n")
  341.                 ;
  342.             }
  343.             $compiler->write('yield from ');
  345.             if ($parent instanceof ConstantExpression) {
  346.                 $compiler->raw('$this->parent');
  347.             } else {
  348.                 $compiler->raw('$this->getParent($context)');
  349.             }
  350.             $compiler->raw("->unwrap()->yield(\$context, array_merge(\$this->blocks, \$blocks));\n");
  351.         }
  353.         $compiler->subcompile($this->getNode('display_end'));
  355.         if (!$this->hasNode('parent')) {
  356.             $compiler->write("yield from [];\n");
  357.         }
  359.         $compiler
  360.             ->outdent()
  361.             ->write("}\n\n")
  362.         ;
  363.     }
  365.     protected function compileClassFooter(Compiler $compiler)
  366.     {
  367.         $compiler
  368.             ->subcompile($this->getNode('class_end'))
  369.             ->outdent()
  370.             ->write("}\n")
  371.         ;
  372.     }
  374.     protected function compileMacros(Compiler $compiler)
  375.     {
  376.         $compiler->subcompile($this->getNode('macros'));
  377.     }
  379.     protected function compileGetTemplateName(Compiler $compiler)
  380.     {
  381.         $compiler
  382.             ->write("/**\n")
  383.             ->write(" * @codeCoverageIgnore\n")
  384.             ->write(" */\n")
  385.             ->write("public function getTemplateName(): string\n", "{\n")
  386.             ->indent()
  387.             ->write('return ')
  388.             ->repr($this->getSourceContext()->getName())
  389.             ->raw(";\n")
  390.             ->outdent()
  391.             ->write("}\n\n")
  392.         ;
  393.     }
  395.     protected function compileIsTraitable(Compiler $compiler)
  396.     {
  397.         // A template can be used as a trait if:
  398.         //   * it has no parent
  399.         //   * it has no macros
  400.         //   * it has no body
  401.         //
  402.         // Put another way, a template can be used as a trait if it
  403.         // only contains blocks and use statements.
  404.         $traitable = !$this->hasNode('parent') && 0 === \count($this->getNode('macros'));
  405.         if ($traitable) {
  406.             if ($this->getNode('body') instanceof BodyNode) {
  407.                 $nodes = $this->getNode('body')->getNode('0');
  408.             } else {
  409.                 $nodes = $this->getNode('body');
  410.             }
  412.             if (!\count($nodes)) {
  413.                 $nodes = new Node([$nodes]);
  414.             }
  416.             foreach ($nodes as $node) {
  417.                 if (!\count($node)) {
  418.                     continue;
  419.                 }
  421.                 $traitable = false;
  422.                 break;
  423.             }
  424.         }
  426.         if ($traitable) {
  427.             return;
  428.         }
  430.         $compiler
  431.             ->write("/**\n")
  432.             ->write(" * @codeCoverageIgnore\n")
  433.             ->write(" */\n")
  434.             ->write("public function isTraitable(): bool\n", "{\n")
  435.             ->indent()
  436.             ->write("return false;\n")
  437.             ->outdent()
  438.             ->write("}\n\n")
  439.         ;
  440.     }
  442.     protected function compileDebugInfo(Compiler $compiler)
  443.     {
  444.         $compiler
  445.             ->write("/**\n")
  446.             ->write(" * @codeCoverageIgnore\n")
  447.             ->write(" */\n")
  448.             ->write("public function getDebugInfo(): array\n", "{\n")
  449.             ->indent()
  450.             ->write(\sprintf("return %s;\n", str_replace("\n", '', var_export(array_reverse($compiler->getDebugInfo(), true), true))))
  451.             ->outdent()
  452.             ->write("}\n\n")
  453.         ;
  454.     }
  456.     protected function compileGetSourceContext(Compiler $compiler)
  457.     {
  458.         $compiler
  459.             ->write("public function getSourceContext(): Source\n", "{\n")
  460.             ->indent()
  461.             ->write('return new Source(')
  462.             ->string($compiler->getEnvironment()->isDebug() ? $this->getSourceContext()->getCode() : '')
  463.             ->raw(', ')
  464.             ->string($this->getSourceContext()->getName())
  465.             ->raw(', ')
  466.             ->string($this->getSourceContext()->getPath())
  467.             ->raw(");\n")
  468.             ->outdent()
  469.             ->write("}\n")
  470.         ;
  471.     }
  473.     protected function compileLoadTemplate(Compiler $compiler, $node, $var)
  474.     {
  475.         if ($node instanceof ConstantExpression) {
  476.             $compiler
  477.                 ->write(\sprintf('%s = $this->loadTemplate(', $var))
  478.                 ->subcompile($node)
  479.                 ->raw(', ')
  480.                 ->repr($node->getTemplateName())
  481.                 ->raw(', ')
  482.                 ->repr($node->getTemplateLine())
  483.                 ->raw(");\n")
  484.             ;
  485.         } else {
  486.             throw new \LogicException('Trait templates can only be constant nodes.');
  487.         }
  488.     }
  489. }