81 lines
2.7 KiB
PHP
81 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* Represents a PHP_CodeSniffer sniff for sniffing coding standards.
|
|
*
|
|
* A sniff registers what token types it wishes to listen for, then, when
|
|
* PHP_CodeSniffer encounters that token, the sniff is invoked and passed
|
|
* information about where the token was found in the stack, and the
|
|
* PHP_CodeSniffer file in which the token was found.
|
|
*
|
|
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
|
|
*/
|
|
|
|
namespace PHP_CodeSniffer\Sniffs;
|
|
|
|
use PHP_CodeSniffer\Files\File;
|
|
|
|
interface Sniff
|
|
{
|
|
|
|
|
|
/**
|
|
* 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:
|
|
*
|
|
* <code>
|
|
* return array(
|
|
* T_WHITESPACE,
|
|
* T_DOC_COMMENT,
|
|
* T_COMMENT,
|
|
* );
|
|
* </code>
|
|
*
|
|
* @return mixed[]
|
|
* @see Tokens.php
|
|
*/
|
|
public function register();
|
|
|
|
|
|
/**
|
|
* Called when one of the token types that this sniff is listening for
|
|
* is found.
|
|
*
|
|
* 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:
|
|
*
|
|
* <code>
|
|
* $tokens = $phpcsFile->getTokens();
|
|
* echo 'Encountered a '.$tokens[$stackPtr]['type'].' token';
|
|
* echo 'token information: ';
|
|
* print_r($tokens[$stackPtr]);
|
|
* </code>
|
|
*
|
|
* 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:
|
|
*
|
|
* <code>
|
|
* $phpcsFile->addError('Encountered an error', $stackPtr);
|
|
* </code>
|
|
*
|
|
* @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the
|
|
* token was found.
|
|
* @param int $stackPtr The position in the PHP_CodeSniffer
|
|
* file's token stack where the token
|
|
* was found.
|
|
*
|
|
* @return void|int Optionally returns a stack pointer. The sniff will not be
|
|
* called again on the current file until the returned stack
|
|
* pointer is reached. Return (count($tokens) + 1) to skip
|
|
* the rest of the file.
|
|
*/
|
|
public function process(File $phpcsFile, $stackPtr);
|
|
|
|
|
|
}//end interface
|