Skip to content

Add getVisitorsForNode() method to NodeTraverser #1122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add getVisitorsForNode() method to NodeTraverser #1122

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
861a7f4
Add getVisitorsForNode() method to NodeTraverser
samsonasik Oct 20, 2025
52fc358
cs fix
samsonasik Oct 20, 2025
5e72668
make getVisitorsForNode method protected
samsonasik Oct 21, 2025
540e5b1
add comment why the method is needed
samsonasik Oct 21, 2025
512d31d
add array return type
samsonasik Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions lib/PhpParser/NodeTraverser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,8 @@ protected function traverseNode(Node $node): void {
$traverseChildren = true;
$visitorIndex = -1;

foreach ($this->visitors as $visitorIndex => $visitor) {
$visitors = $this->getVisitorsForNode($subNode);
foreach ($visitors as $visitorIndex => $visitor) {
$return = $visitor->enterNode($subNode);
if (null !== $return) {
if ($return instanceof Node) {
Expand Down Expand Up @@ -143,7 +144,7 @@ protected function traverseNode(Node $node): void {
}

for (; $visitorIndex >= 0; --$visitorIndex) {
$visitor = $this->visitors[$visitorIndex];
$visitor = $visitors[$visitorIndex];
$return = $visitor->leaveNode($subNode);

if (null !== $return) {
Expand Down Expand Up @@ -192,7 +193,8 @@ protected function traverseArray(array $nodes): array {
$traverseChildren = true;
$visitorIndex = -1;

foreach ($this->visitors as $visitorIndex => $visitor) {
$visitors = $this->getVisitorsForNode($node);
foreach ($visitors as $visitorIndex => $visitor) {
$return = $visitor->enterNode($node);
if (null !== $return) {
if ($return instanceof Node) {
Expand Down Expand Up @@ -231,7 +233,7 @@ protected function traverseArray(array $nodes): array {
}

for (; $visitorIndex >= 0; --$visitorIndex) {
$visitor = $this->visitors[$visitorIndex];
$visitor = $visitors[$visitorIndex];
$return = $visitor->leaveNode($node);

if (null !== $return) {
Expand Down Expand Up @@ -268,6 +270,15 @@ protected function traverseArray(array $nodes): array {
return $nodes;
}

/**
* This method give ability to customize which visitors are applied to a given node in child class.
*
* @return NodeVisitor[]
*/
protected function getVisitorsForNode(Node $node): array {
return $this->visitors;
}

private function ensureReplacementReasonable(Node $old, Node $new): void {
if ($old instanceof Node\Stmt && $new instanceof Node\Expr) {
throw new \LogicException(
Expand Down