ComplexityCalculatingVisitor
extends NodeVisitorAbstract
in package
FinalYes
Table of Contents
Properties
- $result : array<string|int, mixed>
- $shortCircuitTraversal : bool
Methods
- __construct() : mixed
- afterTraverse() : null|array<string|int, Node>
- Called once after traversal.
- beforeTraverse() : null|array<string|int, Node>
- Called once before traversal.
- enterNode() : null|int|Node|array<string|int, Node>
- Called when entering a node.
- leaveNode() : null|int|Node|array<string|int, Node>
- Called when leaving a node.
- result() : ComplexityCollection
- classMethodName() : string
- cyclomaticComplexity() : int
- functionName() : string
Properties
$result
private
array<string|int, mixed>
$result
= []
Tags
$shortCircuitTraversal
private
bool
$shortCircuitTraversal
Methods
__construct()
public
__construct(bool $shortCircuitTraversal) : mixed
Parameters
- $shortCircuitTraversal : bool
afterTraverse()
Called once after traversal.
public
afterTraverse(array<string|int, mixed> $nodes) : null|array<string|int, Node>
Return value semantics:
- null: $nodes stays as-is
- otherwise: $nodes is set to the return value
Parameters
- $nodes : array<string|int, mixed>
-
Array of nodes
Return values
null|array<string|int, Node> —Array of nodes
beforeTraverse()
Called once before traversal.
public
beforeTraverse(array<string|int, mixed> $nodes) : null|array<string|int, Node>
Return value semantics:
- null: $nodes stays as-is
- otherwise: $nodes is set to the return value
Parameters
- $nodes : array<string|int, mixed>
-
Array of nodes
Return values
null|array<string|int, Node> —Array of nodes
enterNode()
Called when entering a node.
public
enterNode(Node $node) : null|int|Node|array<string|int, Node>
Return value semantics:
- null => $node stays as-is
- array (of Nodes) => The return value is merged into the parent array (at the position of the $node)
- NodeVisitor::REMOVE_NODE => $node is removed from the parent array
- NodeVisitor::REPLACE_WITH_NULL => $node is replaced with null
- NodeVisitor::DONT_TRAVERSE_CHILDREN => Children of $node are not traversed. $node stays as-is
- NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN => Further visitors for the current node are skipped, and its children are not traversed. $node stays as-is.
- NodeVisitor::STOP_TRAVERSAL => Traversal is aborted. $node stays as-is
- otherwise => $node is set to the return value
Parameters
- $node : Node
-
Node
Return values
null|int|Node|array<string|int, Node> —Replacement node (or special return value)
leaveNode()
Called when leaving a node.
public
leaveNode(Node $node) : null|int|Node|array<string|int, Node>
Return value semantics:
- null => $node stays as-is
- NodeVisitor::REMOVE_NODE => $node is removed from the parent array
- NodeVisitor::REPLACE_WITH_NULL => $node is replaced with null
- NodeVisitor::STOP_TRAVERSAL => Traversal is aborted. $node stays as-is
- array (of Nodes) => The return value is merged into the parent array (at the position of the $node)
- otherwise => $node is set to the return value
Parameters
- $node : Node
-
Node
Return values
null|int|Node|array<string|int, Node> —Replacement node (or special return value)
result()
public
result() : ComplexityCollection
Return values
ComplexityCollectionclassMethodName()
private
classMethodName(ClassMethod $node) : string
Parameters
- $node : ClassMethod
Tags
Return values
stringcyclomaticComplexity()
private
cyclomaticComplexity(array<string|int, Stmt> $statements) : int
Parameters
- $statements : array<string|int, Stmt>
Tags
Return values
intfunctionName()
private
functionName(Function_ $node) : string
Parameters
- $node : Function_