Allow passing visitors to NodeTraverser constructor

nikic · Jul 9, 2023 · c48ee36 · c48ee36
1 parent 8b13719
commit c48ee36
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 24 deletions.
diff --git a/doc/component/FAQ.markdown b/doc/component/FAQ.markdown
@@ -16,8 +16,7 @@ use PhpParser\ParserFactory;
 
 $code = '...';
 
-$traverser = new NodeTraverser;
-$traverser->addVisitor(new ParentConnectingVisitor);
+$traverser = new NodeTraverser(new ParentConnectingVisitor);
 
 $parser = (new ParserFactory())->createForHostVersion();
 $ast    = $parser->parse($code);
@@ -39,8 +38,7 @@ use PhpParser\ParserFactory;
 
 $code = '...';
 
-$traverser = new NodeTraverser;
-$traverser->addVisitor(new NodeConnectingVisitor);
+$traverser = new NodeTraverser(new NodeConnectingVisitor);
 
 $parser = (new ParserFactory())->createForHostVersion();
 $ast    = $parser->parse($code);

diff --git a/doc/component/Lexer.markdown b/doc/component/Lexer.markdown
@@ -81,8 +81,7 @@ $lexerOptions = array(
 $parser = (new PhpParser\ParserFactory())->createForHostVersion($lexerOptions);
 
 $visitor = new MyNodeVisitor();
-$traverser = new PhpParser\NodeTraverser();
-$traverser->addVisitor($visitor);
+$traverser = new PhpParser\NodeTraverser($visitor);
 
 try {
     $stmts = $parser->parse($code);

diff --git a/doc/component/Pretty_printing.markdown b/doc/component/Pretty_printing.markdown
@@ -75,8 +75,7 @@ $lexerOptions = new [
 ];
 $parser = (new ParserFactory())->createForHostVersion($lexerOptions);
 
-$traverser = new NodeTraverser();
-$traverser->addVisitor(new NodeVisitor\CloningVisitor());
+$traverser = new NodeTraverser(new NodeVisitor\CloningVisitor());
 
 $printer = new PrettyPrinter\Standard();
 

diff --git a/doc/component/Walking_the_AST.markdown b/doc/component/Walking_the_AST.markdown
@@ -21,6 +21,18 @@ $stmts = ...;
 $modifiedStmts = $traverser->traverse($stmts);
 ```
 
+Visitors can be either passed to the `NodeTraverser` constructor, or added using `addVisitor()`:
+
+```php
+$traverser = new NodeTraverser($visitor1, $visitor2, $visitor3);
+
+// Equivalent to:
+$traverser = new NodeTraverser();
+$traverser->addVisitor($visitor1);
+$traverser->addVisitor($visitor2);
+$traverser->addVisitor($visitor3);
+```
+
 Node visitors
 -------------
 

diff --git a/lib/PhpParser/NodeFinder.php b/lib/PhpParser/NodeFinder.php
@@ -21,8 +21,7 @@ public function find($nodes, callable $filter): array {
 
         $visitor = new FindingVisitor($filter);
 
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor($visitor);
+        $traverser = new NodeTraverser($visitor);
         $traverser->traverse($nodes);
 
         return $visitor->getFoundNodes();
@@ -59,8 +58,7 @@ public function findFirst($nodes, callable $filter): ?Node {
 
         $visitor = new FirstFindingVisitor($filter);
 
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor($visitor);
+        $traverser = new NodeTraverser($visitor);
         $traverser->traverse($nodes);
 
         return $visitor->getFoundNode();

diff --git a/lib/PhpParser/NodeTraverser.php b/lib/PhpParser/NodeTraverser.php
@@ -29,8 +29,13 @@ class NodeTraverser implements NodeTraverserInterface {
     /** @var bool Whether traversal should be stopped */
     protected $stopTraversal;
 
-    public function __construct() {
-        // for BC
+    /**
+     * Create a traverser with the given visitors.
+     *
+     * @param NodeVisitor ...$visitors Node visitors
+     */
+    public function __construct(NodeVisitor... $visitors) {
+        $this->visitors = $visitors;
     }
 
     /**

diff --git a/test/PhpParser/CodeParsingTest.php b/test/PhpParser/CodeParsingTest.php
@@ -69,8 +69,7 @@ private function checkAttributes($stmts) {
             return;
         }
 
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor(new class () extends NodeVisitorAbstract {
+        $traverser = new NodeTraverser(new class () extends NodeVisitorAbstract {
             public function enterNode(Node $node) {
                 $startLine = $node->getStartLine();
                 $endLine = $node->getEndLine();

diff --git a/test/PhpParser/NodeTraverserTest.php b/test/PhpParser/NodeTraverserTest.php
@@ -49,10 +49,7 @@ public function testModifying() {
         ]);
         $visitor3 = new NodeVisitorForTesting();
 
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor($visitor1);
-        $traverser->addVisitor($visitor2);
-        $traverser->addVisitor($visitor3);
+        $traverser = new NodeTraverser($visitor1, $visitor2, $visitor3);
 
         // as all operations are reversed we end where we start
         $this->assertEquals([], $traverser->traverse([]));

diff --git a/test/PhpParser/PrettyPrinterTest.php b/test/PhpParser/PrettyPrinterTest.php
@@ -193,8 +193,7 @@ public function testFormatPreservingPrint($name, $code, $modification, $expected
         ]);
 
         $parser = new Parser\Php7($lexer);
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor(new NodeVisitor\CloningVisitor());
+        $traverser = new NodeTraverser(new NodeVisitor\CloningVisitor());
 
         $printer = new PrettyPrinter\Standard();
 
@@ -244,8 +243,7 @@ public function testRoundTripPrint($name, $code, $expected, $modeLine) {
 
         $parser = new Php7($lexer);
 
-        $traverser = new NodeTraverser();
-        $traverser->addVisitor(new NodeVisitor\CloningVisitor());
+        $traverser = new NodeTraverser(new NodeVisitor\CloningVisitor());
 
         $printer = new PrettyPrinter\Standard();