Source for file NamespaceDeclarationSniff.php
Documentation is available at NamespaceDeclarationSniff.php
* Ensures namespaces are declared correctly.
* @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\PSR2\Sniffs\Namespaces;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class NamespaceDeclarationSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
return array (T_NAMESPACE );
* Processes this test, 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 ();
for ($i = ($stackPtr + 1 ); $i < ($phpcsFile->numTokens - 1 ); $i++ ) {
if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
// 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 );
$diff = ($tokens[$next]['line'] - $tokens[$i]['line']);
$error = 'There must be one blank line after the namespace declaration';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'BlankLineAfter');
$phpcsFile->fixer ->addNewlineBefore ($i);
$phpcsFile->fixer ->beginChangeset ();
for ($x = $i; $x < $next; $x++ ) {
if ($tokens[$x]['line'] === $tokens[$next]['line']) {
$phpcsFile->fixer ->replaceToken ($x, '');
$phpcsFile->fixer ->addNewline ($i);
$phpcsFile->fixer ->endChangeset ();
Documentation generated on Mon, 11 Mar 2019 15:27:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|