\PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysisForLoopWithTestFunctionCallSniff

register()

register() : array<mixed,integer>

Registers the tokens that this sniff wants to listen for.

An example return value for a sniff that wants to listen for whitespace and any comments would be:

return array( T_WHITESPACE, T_DOC_COMMENT, T_COMMENT, );

Returns

process()

process(\PHP_CodeSniffer\Files\File  $phpcsFile, integer  $stackPtr) : void

Processes this test, when one of its tokens is encountered.

The stackPtr variable indicates where in the stack the token was found. A sniff can acquire information this token, along with all the other tokens within the stack by first acquiring the token stack:

$tokens = $phpcsFile->getTokens(); echo 'Encountered a '.$tokens[$stackPtr]['type'].' token'; echo 'token information: '; print_r($tokens[$stackPtr]);

If the sniff discovers an anomaly in the code, they can raise an error by calling addError() on the \PHP_CodeSniffer\Files\File object, specifying an error message and the position of the offending token:

$phpcsFile->addError('Encountered an error', $stackPtr);

Parameters