class NamespaceDeclarationSniff
Same name in this branch
- 11.1.x vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceDeclarationSniff.php \SlevomatCodingStandard\Sniffs\Namespaces\NamespaceDeclarationSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\NamespaceDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of NamespaceDeclarationSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ PSR2/ Sniffs/ Namespaces/ NamespaceDeclarationSniff.php, line 16
Namespace
PHP_CodeSniffer\Standards\PSR2\Sniffs\NamespacesView source
class NamespaceDeclarationSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_NAMESPACE,
];
}
//end register()
/**
* 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.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
if ($tokens[$nextNonEmpty]['code'] === T_NS_SEPARATOR) {
// Namespace keyword as operator. Not a declaration.
return;
}
$end = $phpcsFile->findEndOfStatement($stackPtr);
for ($i = $end + 1; $i < $phpcsFile->numTokens - 1; $i++) {
if ($tokens[$i]['line'] === $tokens[$end]['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()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
NamespaceDeclarationSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
NamespaceDeclarationSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |