Support WeakReferences in ParentConnectingVisitor

nikic · Jan 1, 2025 · e002a95 · e002a95
1 parent 4cac2f2
commit e002a95
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/lib/PhpParser/NodeVisitor/ParentConnectingVisitor.php b/lib/PhpParser/NodeVisitor/ParentConnectingVisitor.php
@@ -20,13 +20,23 @@ final class ParentConnectingVisitor extends NodeVisitorAbstract {
      */
     private array $stack = [];
 
+    private bool $weakReferences;
+
+    public function __construct(bool $weakReferences = false) {
+        $this->weakReferences = $weakReferences;
+    }
+
     public function beforeTraverse(array $nodes) {
         $this->stack = [];
     }
 
     public function enterNode(Node $node) {
         if (!empty($this->stack)) {
-            $node->setAttribute('parent', $this->stack[count($this->stack) - 1]);
+            $parent = $this->stack[count($this->stack) - 1];
+            if ($this->weakReferences) {
+                $parent = \WeakReference::create($parent);
+            }
+            $node->setAttribute('parent', $parent);
         }
 
         $this->stack[] = $node;

diff --git a/test/PhpParser/NodeVisitor/ParentConnectingVisitorTest.php b/test/PhpParser/NodeVisitor/ParentConnectingVisitorTest.php
@@ -23,4 +23,22 @@ public function testConnectsChildNodeToParentNode(): void {
 
         $this->assertSame('C', $node->getAttribute('parent')->name->toString());
     }
+
+    public function testWeakReferences(): void {
+        $ast = (new ParserFactory())->createForNewestSupportedVersion()->parse(
+            '<?php class C { public function m() {} }'
+        );
+
+        $traverser = new NodeTraverser();
+
+        $traverser->addVisitor(new ParentConnectingVisitor(true));
+
+        $ast = $traverser->traverse($ast);
+
+        $node = (new NodeFinder())->findFirstInstanceof($ast, ClassMethod::class);
+
+        $weakReference = $node->getAttribute('parent');
+        $this->assertInstanceOf(\WeakReference::class, $weakReference);
+        $this->assertSame('C', $weakReference->get()->name->toString());
+    }
 }