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

  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;
  33.     /** @var array<string, NameDeprecation> */
  34.     private $nodeNameDeprecations = [];
  35.     /** @var array<string, NameDeprecation> */
  36.     private $attributeNameDeprecations = [];
  38.     /**
  39.      * @param array  $nodes      An array of named nodes
  40.      * @param array  $attributes An array of attributes (should not be nodes)
  41.      * @param int    $lineno     The line number
  42.      * @param string $tag        The tag name associated with the Node
  43.      */
  44.     public function __construct(array $nodes = [], array $attributes = [], int $lineno = 0, ?string $tag = null)
  45.     {
  46.         foreach ($nodes as $name => $node) {
  47.             if (!$node instanceof self) {
  48.                 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));
  49.             }
  50.         }
  51.         $this->nodes = $nodes;
  52.         $this->attributes = $attributes;
  53.         $this->lineno = $lineno;
  54.         $this->tag = $tag;
  55.     }
  57.     public function __toString()
  58.     {
  59.         $attributes = [];
  60.         foreach ($this->attributes as $name => $value) {
  61.             $attributes[] = \sprintf('%s: %s', $name, \is_callable($value) ? '\Closure' : str_replace("\n", '', var_export($value, true)));
  62.         }
  64.         $repr = [static::class.'('.implode(', ', $attributes)];
  66.         if (\count($this->nodes)) {
  67.             foreach ($this->nodes as $name => $node) {
  68.                 $len = \strlen($name) + 4;
  69.                 $noderepr = [];
  70.                 foreach (explode("\n", (string) $node) as $line) {
  71.                     $noderepr[] = str_repeat(' ', $len).$line;
  72.                 }
  74.                 $repr[] = \sprintf('  %s: %s', $name, ltrim(implode("\n", $noderepr)));
  75.             }
  77.             $repr[] = ')';
  78.         } else {
  79.             $repr[0] .= ')';
  80.         }
  82.         return implode("\n", $repr);
  83.     }
  85.     /**
  86.      * @return void
  87.      */
  88.     public function compile(Compiler $compiler)
  89.     {
  90.         foreach ($this->nodes as $node) {
  91.             $compiler->subcompile($node);
  92.         }
  93.     }
  95.     public function getTemplateLine(): int
  96.     {
  97.         return $this->lineno;
  98.     }
  100.     public function getNodeTag(): ?string
  101.     {
  102.         return $this->tag;
  103.     }
  105.     public function hasAttribute(string $name): bool
  106.     {
  107.         return \array_key_exists($name, $this->attributes);
  108.     }
  110.     public function getAttribute(string $name)
  111.     {
  112.         if (!\array_key_exists($name, $this->attributes)) {
  113.             throw new \LogicException(\sprintf('Attribute "%s" does not exist for Node "%s".', $name, static::class));
  114.         }
  116.         $triggerDeprecation = \func_num_args() > 1 ? func_get_arg(1) : true;
  117.         if ($triggerDeprecation && isset($this->attributeNameDeprecations[$name])) {
  118.             $dep = $this->attributeNameDeprecations[$name];
  119.             if ($dep->getNewName()) {
  120.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Getting attribute "%s" on a "%s" class is deprecated, get the "%s" attribute instead.', $name, static::class, $dep->getNewName());
  121.             } else {
  122.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Getting attribute "%s" on a "%s" class is deprecated.', $name, static::class);
  123.             }
  124.         }
  126.         return $this->attributes[$name];
  127.     }
  129.     public function setAttribute(string $name, $value): void
  130.     {
  131.         $triggerDeprecation = \func_num_args() > 2 ? func_get_arg(2) : true;
  132.         if ($triggerDeprecation && isset($this->attributeNameDeprecations[$name])) {
  133.             $dep = $this->attributeNameDeprecations[$name];
  134.             if ($dep->getNewName()) {
  135.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Setting attribute "%s" on a "%s" class is deprecated, set the "%s" attribute instead.', $name, static::class, $dep->getNewName());
  136.             } else {
  137.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Setting attribute "%s" on a "%s" class is deprecated.', $name, static::class);
  138.             }
  139.         }
  141.         $this->attributes[$name] = $value;
  142.     }
  144.     public function deprecateAttribute(string $name, NameDeprecation $dep): void
  145.     {
  146.         $this->attributeNameDeprecations[$name] = $dep;
  147.     }
  149.     public function removeAttribute(string $name): void
  150.     {
  151.         unset($this->attributes[$name]);
  152.     }
  154.     public function hasNode(string $name): bool
  155.     {
  156.         return isset($this->nodes[$name]);
  157.     }
  159.     public function getNode(string $name): self
  160.     {
  161.         if (!isset($this->nodes[$name])) {
  162.             throw new \LogicException(\sprintf('Node "%s" does not exist for Node "%s".', $name, static::class));
  163.         }
  165.         $triggerDeprecation = \func_num_args() > 1 ? func_get_arg(1) : true;
  166.         if ($triggerDeprecation && isset($this->nodeNameDeprecations[$name])) {
  167.             $dep = $this->nodeNameDeprecations[$name];
  168.             if ($dep->getNewName()) {
  169.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Getting node "%s" on a "%s" class is deprecated, get the "%s" node instead.', $name, static::class, $dep->getNewName());
  170.             } else {
  171.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Getting node "%s" on a "%s" class is deprecated.', $name, static::class);
  172.             }
  173.         }
  175.         return $this->nodes[$name];
  176.     }
  178.     public function setNode(string $name, self $node): void
  179.     {
  180.         $triggerDeprecation = \func_num_args() > 2 ? func_get_arg(2) : true;
  181.         if ($triggerDeprecation && isset($this->nodeNameDeprecations[$name])) {
  182.             $dep = $this->nodeNameDeprecations[$name];
  183.             if ($dep->getNewName()) {
  184.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Setting node "%s" on a "%s" class is deprecated, set the "%s" node instead.', $name, static::class, $dep->getNewName());
  185.             } else {
  186.                 trigger_deprecation($dep->getPackage(), $dep->getVersion(), 'Setting node "%s" on a "%s" class is deprecated.', $name, static::class);
  187.             }
  188.         }
  190.         if (null !== $this->sourceContext) {
  191.             $node->setSourceContext($this->sourceContext);
  192.         }
  193.         $this->nodes[$name] = $node;
  194.     }
  196.     public function removeNode(string $name): void
  197.     {
  198.         unset($this->nodes[$name]);
  199.     }
  201.     public function deprecateNode(string $name, NameDeprecation $dep): void
  202.     {
  203.         $this->nodeNameDeprecations[$name] = $dep;
  204.     }
  206.     /**
  207.      * @return int
  208.      */
  209.     #[\ReturnTypeWillChange]
  210.     public function count()
  211.     {
  212.         return \count($this->nodes);
  213.     }
  215.     public function getIterator(): \Traversable
  216.     {
  217.         return new \ArrayIterator($this->nodes);
  218.     }
  220.     public function getTemplateName(): ?string
  221.     {
  222.         return $this->sourceContext ? $this->sourceContext->getName() : null;
  223.     }
  225.     public function setSourceContext(Source $source): void
  226.     {
  227.         $this->sourceContext = $source;
  228.         foreach ($this->nodes as $node) {
  229.             $node->setSourceContext($source);
  230.         }
  231.     }
  233.     public function getSourceContext(): ?Source
  234.     {
  235.         return $this->sourceContext;
  236.     }
  237. }