Source for file DebugCodeSniff.php
Documentation is available at DebugCodeSniff.php
* Warns about the use of debug code.
* @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\Standards\MySource\Sniffs\Debug;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class DebugCodeSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
return array (T_DOUBLE_COLON );
* Processes this sniff, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in
* the stack passed in $tokens.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
$className = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 1 ), null , true );
if (strtolower($tokens[$className]['content']) === 'debug') {
$method = $phpcsFile->findNext (T_WHITESPACE , ($stackPtr + 1 ), null , true );
$error = 'Call to debug function Debug::%s() must be removed';
$data = array ($tokens[$method]['content']);
$phpcsFile->addError ($error, $stackPtr, 'Found', $data);
Documentation generated on Mon, 11 Mar 2019 15:27:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|