* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff. * * Ensures namespaces are declared correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_NAMESPACE); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); for ($i = ($stackPtr + 1); $i < ($phpcsFile->numTokens - 1); $i++) { if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) { continue; } break; } // The $i var now points to the first token on the line after the // namespace declaration, which must be a blank line. $next = $phpcsFile->findNext(T_WHITESPACE, $i, $phpcsFile->numTokens, true); if ($next === false) { return; } $diff = ($tokens[$next]['line'] - $tokens[$i]['line']); if ($diff === 1) { return; } if ($diff < 0) { $diff = 0; } $error = 'There must be one blank line after the namespace declaration'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'BlankLineAfter'); if ($fix === true) { if ($diff === 0) { $phpcsFile->fixer->addNewlineBefore($i); } else { $phpcsFile->fixer->beginChangeset(); for ($x = $i; $x < $next; $x++) { if ($tokens[$x]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($x, ''); } $phpcsFile->fixer->addNewline($i); $phpcsFile->fixer->endChangeset(); } } }//end process() }//end class