class CompoundNamespaceDepthSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\PSR12\Sniffs\Namespaces\CompoundNamespaceDepthSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of CompoundNamespaceDepthSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ PSR12/ Sniffs/ Namespaces/ CompoundNamespaceDepthSniff.php, line 15
Namespace
PHP_CodeSniffer\Standards\PSR12\Sniffs\NamespacesView source
class CompoundNamespaceDepthSniff implements Sniff {
/**
* The max depth for compound namespaces.
*
* @var integer
*/
public $maxDepth = 2;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_OPEN_USE_GROUP,
];
}
//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) {
$this->maxDepth = (int) $this->maxDepth;
$tokens = $phpcsFile->getTokens();
$end = $phpcsFile->findNext(T_CLOSE_USE_GROUP, $stackPtr + 1);
if ($end === false) {
return;
}
$depth = 1;
for ($i = $stackPtr + 1; $i <= $end; $i++) {
if ($tokens[$i]['code'] === T_NS_SEPARATOR) {
$depth++;
continue;
}
if ($i === $end || $tokens[$i]['code'] === T_COMMA) {
// End of a namespace.
if ($depth > $this->maxDepth) {
$error = 'Compound namespaces cannot have a depth more than %s';
$data = [
$this->maxDepth,
];
$phpcsFile->addError($error, $i, 'TooDeep', $data);
}
$depth = 1;
}
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
CompoundNamespaceDepthSniff::$maxDepth | public | property | The max depth for compound namespaces. | |
CompoundNamespaceDepthSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
CompoundNamespaceDepthSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |