Generic_Sniffs_Metrics_CyclomaticComplexitySniff
in package
implements
PHP_CodeSniffer_Sniff
Checks the cyclomatic complexity (McCabe) for functions.
The cyclomatic complexity (also called McCabe code metrics) indicates the complexity within a function by counting the different paths the function includes.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $absoluteComplexity : int
- A complexity higher than this value will throw an error.
- $complexity : int
- A complexity higher than this value will throw a warning.
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$absoluteComplexity
A complexity higher than this value will throw an error.
public
int
$absoluteComplexity
= 20
$complexity
A complexity higher than this value will throw a warning.
public
int
$complexity
= 10
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>