Generic_Sniffs_Metrics_NestingLevelSniff
in package
implements
PHP_CodeSniffer_Sniff
Checks the nesting level for methods.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $absoluteNestingLevel : int
- A nesting level higher than this value will throw an error.
- $nestingLevel : int
- A nesting level 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
$absoluteNestingLevel
A nesting level higher than this value will throw an error.
public
int
$absoluteNestingLevel
= 10
$nestingLevel
A nesting level higher than this value will throw a warning.
public
int
$nestingLevel
= 5
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>