Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ComplexityCalculatingVisitor.php

class ComplexityCalculatingVisitor

Hierarchy

  • class \PhpParser\NodeVisitorAbstract implements \PhpParser\NodeVisitor
    • class \SebastianBergmann\Complexity\ComplexityCalculatingVisitor extends \PhpParser\NodeVisitorAbstract

Expanded class hierarchy of ComplexityCalculatingVisitor

File

vendor/sebastian/complexity/src/Visitor/ComplexityCalculatingVisitor.php, line 26

Namespace

SebastianBergmann\Complexity
View source
final class ComplexityCalculatingVisitor extends NodeVisitorAbstract {
    
    /**
     * @psalm-var list<Complexity>
     */
    private array $result = [];
    private bool $shortCircuitTraversal;
    public function __construct(bool $shortCircuitTraversal) {
        $this->shortCircuitTraversal = $shortCircuitTraversal;
    }
    public function enterNode(Node $node) : ?int {
        if (!$node instanceof ClassMethod && !$node instanceof Function_) {
            return null;
        }
        if ($node instanceof ClassMethod) {
            if ($node->getAttribute('parent') instanceof Interface_) {
                return null;
            }
            if ($node->isAbstract()) {
                return null;
            }
            $name = $this->classMethodName($node);
        }
        else {
            $name = $this->functionName($node);
        }
        $statements = $node->getStmts();
        assert(is_array($statements));
        $this->result[] = new Complexity($name, $this->cyclomaticComplexity($statements));
        if ($this->shortCircuitTraversal) {
            return NodeTraverser::DONT_TRAVERSE_CHILDREN;
        }
        return null;
    }
    public function result() : ComplexityCollection {
        return ComplexityCollection::fromList(...$this->result);
    }
    
    /**
     * @param Stmt[] $statements
     *
     * @psalm-return positive-int
     */
    private function cyclomaticComplexity(array $statements) : int {
        $traverser = new NodeTraverser();
        $cyclomaticComplexityCalculatingVisitor = new CyclomaticComplexityCalculatingVisitor();
        $traverser->addVisitor($cyclomaticComplexityCalculatingVisitor);
        
        /* @noinspection UnusedFunctionResultInspection */
        $traverser->traverse($statements);
        return $cyclomaticComplexityCalculatingVisitor->cyclomaticComplexity();
    }
    
    /**
     * @psalm-return non-empty-string
     */
    private function classMethodName(ClassMethod $node) : string {
        $parent = $node->getAttribute('parent');
        assert($parent instanceof Class_ || $parent instanceof Trait_);
        if ($parent->getAttribute('parent') instanceof New_) {
            return 'anonymous class';
        }
        assert(isset($parent->namespacedName));
        assert($parent->namespacedName instanceof Name);
        return $parent->namespacedName
            ->toString() . '::' . $node->name
            ->toString();
    }
    
    /**
     * @psalm-return non-empty-string
     */
    private function functionName(Function_ $node) : string {
        assert(isset($node->namespacedName));
        assert($node->namespacedName instanceof Name);
        $functionName = $node->namespacedName
            ->toString();
        assert($functionName !== '');
        return $functionName;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ComplexityCalculatingVisitor::$result private property @psalm-var list&lt;Complexity&gt;
ComplexityCalculatingVisitor::$shortCircuitTraversal private property
ComplexityCalculatingVisitor::classMethodName private function @psalm-return non-empty-string
ComplexityCalculatingVisitor::cyclomaticComplexity private function @psalm-return positive-int
ComplexityCalculatingVisitor::enterNode public function Called when entering a node. Overrides NodeVisitorAbstract::enterNode
ComplexityCalculatingVisitor::functionName private function @psalm-return non-empty-string
ComplexityCalculatingVisitor::result public function
ComplexityCalculatingVisitor::__construct public function
NodeVisitor::DONT_TRAVERSE_CHILDREN public constant If NodeVisitor::enterNode() returns DONT_TRAVERSE_CHILDREN, child nodes
of the current node will not be traversed for any visitors.
NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN public constant If NodeVisitor::enterNode() returns DONT_TRAVERSE_CURRENT_AND_CHILDREN, child nodes
of the current node will not be traversed for any visitors.
NodeVisitor::REMOVE_NODE public constant If NodeVisitor::leaveNode() returns REMOVE_NODE for a node that occurs
in an array, it will be removed from the array.
NodeVisitor::REPLACE_WITH_NULL public constant 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.
NodeVisitor::STOP_TRAVERSAL public constant If NodeVisitor::enterNode() or NodeVisitor::leaveNode() returns
STOP_TRAVERSAL, traversal is aborted.
NodeVisitorAbstract::afterTraverse public function Called once after traversal. Overrides NodeVisitor::afterTraverse 1
NodeVisitorAbstract::beforeTraverse public function Called once before traversal. Overrides NodeVisitor::beforeTraverse 5
NodeVisitorAbstract::leaveNode public function Called when leaving a node. Overrides NodeVisitor::leaveNode 2

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal