vendor/twig/twig/src/Node/Node.php line 87

Open in your IDE?
  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\Source;
  19. /**
  20.  * Represents a node in the AST.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  */
  24. #[YieldReady]
  25. class Node implements \Countable, \IteratorAggregate
  26. {
  27.     protected $nodes;
  28.     protected $attributes;
  29.     protected $lineno;
  30.     protected $tag;
  32.     private $sourceContext;
  34.     /**
  35.      * @param array  $nodes      An array of named nodes
  36.      * @param array  $attributes An array of attributes (should not be nodes)
  37.      * @param int    $lineno     The line number
  38.      * @param string $tag        The tag name associated with the Node
  39.      */
  40.     public function __construct(array $nodes = [], array $attributes = [], int $lineno = 0, ?string $tag = null)
  41.     {
  42.         foreach ($nodes as $name => $node) {
  43.             if (!$node instanceof self) {
  44.                 throw new \InvalidArgumentException(sprintf('Using "%s" for the value of node "%s" of "%s" is not supported. You must pass a \Twig\Node\Node instance.', \is_object($node) ? \get_class($node) : (null === $node ? 'null' : \gettype($node)), $name, static::class));
  45.             }
  46.         }
  47.         $this->nodes = $nodes;
  48.         $this->attributes = $attributes;
  49.         $this->lineno = $lineno;
  50.         $this->tag = $tag;
  51.     }
  53.     public function __toString()
  54.     {
  55.         $attributes = [];
  56.         foreach ($this->attributes as $name => $value) {
  57.             $attributes[] = sprintf('%s: %s', $name, str_replace("\n", '', var_export($value, true)));
  58.         }
  60.         $repr = [static::class.'('.implode(', ', $attributes)];
  62.         if (\count($this->nodes)) {
  63.             foreach ($this->nodes as $name => $node) {
  64.                 $len = \strlen($name) + 4;
  65.                 $noderepr = [];
  66.                 foreach (explode("\n", (string) $node) as $line) {
  67.                     $noderepr[] = str_repeat(' ', $len).$line;
  68.                 }
  70.                 $repr[] = sprintf('  %s: %s', $name, ltrim(implode("\n", $noderepr)));
  71.             }
  73.             $repr[] = ')';
  74.         } else {
  75.             $repr[0] .= ')';
  76.         }
  78.         return implode("\n", $repr);
  79.     }
  81.     /**
  82.      * @return void
  83.      */
  84.     public function compile(Compiler $compiler)
  85.     {
  86.         foreach ($this->nodes as $node) {
  87.             $compiler->subcompile($node);
  88.         }
  89.     }
  91.     public function getTemplateLine(): int
  92.     {
  93.         return $this->lineno;
  94.     }
  96.     public function getNodeTag(): ?string
  97.     {
  98.         return $this->tag;
  99.     }
  101.     public function hasAttribute(string $name): bool
  102.     {
  103.         return \array_key_exists($name, $this->attributes);
  104.     }
  106.     public function getAttribute(string $name)
  107.     {
  108.         if (!\array_key_exists($name, $this->attributes)) {
  109.             throw new \LogicException(sprintf('Attribute "%s" does not exist for Node "%s".', $name, static::class));
  110.         }
  112.         return $this->attributes[$name];
  113.     }
  115.     public function setAttribute(string $name, $value): void
  116.     {
  117.         $this->attributes[$name] = $value;
  118.     }
  120.     public function removeAttribute(string $name): void
  121.     {
  122.         unset($this->attributes[$name]);
  123.     }
  125.     public function hasNode(string $name): bool
  126.     {
  127.         return isset($this->nodes[$name]);
  128.     }
  130.     public function getNode(string $name): self
  131.     {
  132.         if (!isset($this->nodes[$name])) {
  133.             throw new \LogicException(sprintf('Node "%s" does not exist for Node "%s".', $name, static::class));
  134.         }
  136.         return $this->nodes[$name];
  137.     }
  139.     public function setNode(string $name, self $node): void
  140.     {
  141.         $this->nodes[$name] = $node;
  142.     }
  144.     public function removeNode(string $name): void
  145.     {
  146.         unset($this->nodes[$name]);
  147.     }
  149.     /**
  150.      * @return int
  151.      */
  152.     #[\ReturnTypeWillChange]
  153.     public function count()
  154.     {
  155.         return \count($this->nodes);
  156.     }
  158.     public function getIterator(): \Traversable
  159.     {
  160.         return new \ArrayIterator($this->nodes);
  161.     }
  163.     public function getTemplateName(): ?string
  164.     {
  165.         return $this->sourceContext ? $this->sourceContext->getName() : null;
  166.     }
  168.     public function setSourceContext(Source $source): void
  169.     {
  170.         $this->sourceContext = $source;
  171.         foreach ($this->nodes as $node) {
  172.             $node->setSourceContext($source);
  173.         }
  174.     }
  176.     public function getSourceContext(): ?Source
  177.     {
  178.         return $this->sourceContext;
  179.     }
  180. }