Class: PHP_CodeSniffer_Sniff

• Author: Marc McIntyre <mmcintyre@squiz.net>
• Author: Greg Sherwood <gsherwood@squiz.net>
• Version: Release: 1.0.0RC1
• Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
• Link: http://pear.php.net/package/PHP_CodeSniffer
• License: BSD Licence

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 anomilty in the code, they can raise an error by calling addError() on the PHP_CodeSniffer_File object, specifying an error message and the position of the offending token:

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

Parameters:

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,
      );