\PHP_CodeSniffer\Standards\Squiz\Sniffs\CSSDisallowMultipleStyleDefinitionsSniff

Summary

Methods
Properties
Constants
register()
process()
$supportedTokenizers
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$supportedTokenizers

$supportedTokenizers : array

A list of tokenizers this sniff supports.

Type

array

Methods

register()

register() : array<mixed,integer>

Returns the token types that this sniff is interested in.

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

array<mixed,integer>

process()

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

Processes the tokens that this sniff is interested in.

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

\PHP_CodeSniffer\Files\File $phpcsFile

The file where the token was found.

integer $stackPtr

The position in the stack where the token was found.