annotate vendor/nikic/php-parser/lib/PhpParser/NodeVisitor/FindingVisitor.php @ 0:c75dbcec494b

Initial commit from drush-created site
author Chris Cannam
date Thu, 05 Jul 2018 14:24:15 +0000
parents
children
rev   line source
Chris@0 1 <?php declare(strict_types=1);
Chris@0 2
Chris@0 3 namespace PhpParser\NodeVisitor;
Chris@0 4
Chris@0 5 use PhpParser\Node;
Chris@0 6 use PhpParser\NodeVisitorAbstract;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * This visitor can be used to find and collect all nodes satisfying some criterion determined by
Chris@0 10 * a filter callback.
Chris@0 11 */
Chris@0 12 class FindingVisitor extends NodeVisitorAbstract
Chris@0 13 {
Chris@0 14 /** @var callable Filter callback */
Chris@0 15 protected $filterCallback;
Chris@0 16 /** @var Node[] Found nodes */
Chris@0 17 protected $foundNodes;
Chris@0 18
Chris@0 19 public function __construct(callable $filterCallback) {
Chris@0 20 $this->filterCallback = $filterCallback;
Chris@0 21 }
Chris@0 22
Chris@0 23 /**
Chris@0 24 * Get found nodes satisfying the filter callback.
Chris@0 25 *
Chris@0 26 * Nodes are returned in pre-order.
Chris@0 27 *
Chris@0 28 * @return Node[] Found nodes
Chris@0 29 */
Chris@0 30 public function getFoundNodes() : array {
Chris@0 31 return $this->foundNodes;
Chris@0 32 }
Chris@0 33
Chris@0 34 public function beforeTraverse(array $nodes) {
Chris@0 35 $this->foundNodes = [];
Chris@0 36
Chris@0 37 return null;
Chris@0 38 }
Chris@0 39
Chris@0 40 public function enterNode(Node $node) {
Chris@0 41 $filterCallback = $this->filterCallback;
Chris@0 42 if ($filterCallback($node)) {
Chris@0 43 $this->foundNodes[] = $node;
Chris@0 44 }
Chris@0 45
Chris@0 46 return null;
Chris@0 47 }
Chris@0 48 }