Copied!

This visitor can be used to find and collect all nodes satisfying some criterion determined by a filter callback.

CloneableInstantiable
Constants
public PhpParser\NodeVisitor::DONT_TRAVERSE_CHILDREN = 1
 

If NodeVisitor::enterNode() returns DONT_TRAVERSE_CHILDREN, child nodes of the current node will not be traversed for any visitors.

For subsequent visitors enterNode() will still be called on the current node and leaveNode() will also be invoked for the current node.

public PhpParser\NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN = 4
 

If NodeVisitor::enterNode() returns DONT_TRAVERSE_CURRENT_AND_CHILDREN, child nodes of the current node will not be traversed for any visitors.

For subsequent visitors enterNode() will not be called as well. leaveNode() will be invoked for visitors that has enterNode() method invoked.

public PhpParser\NodeVisitor::REMOVE_NODE = 3
 

If NodeVisitor::leaveNode() returns REMOVE_NODE for a node that occurs in an array, it will be removed from the array.

For subsequent visitors leaveNode() will still be invoked for the removed node.

public PhpParser\NodeVisitor::REPLACE_WITH_NULL = 5
 

If NodeVisitor::enterNode() or NodeVisitor::leaveNode() returns REPLACE_WITH_NULL, the node will be replaced with null. This is not a legal return value if the node is part of an array, rather than another node.

public PhpParser\NodeVisitor::STOP_TRAVERSAL = 2
 

If NodeVisitor::enterNode() or NodeVisitor::leaveNode() returns STOP_TRAVERSAL, traversal is aborted.

The afterTraverse() method will still be invoked.

Methods
public __construct(callable $filterCallback)
public PhpParser\NodeVisitorAbstract::afterTraverse(array $nodes)
public beforeTraverse(array $nodes) : ?array
public enterNode(PhpParser\Node $node)
public getFoundNodes() : array
 

Get found nodes satisfying the filter callback.

Nodes are returned in pre-order.

  • return \Node[] Found nodes
public PhpParser\NodeVisitorAbstract::leaveNode(PhpParser\Node $node)
Properties
protected $filterCallback = NULL
 
  • var callable Filter callback
protected array $foundNodes
 
  • var \Node[] Found nodes
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration