function DuplicateClassNameSniff::process

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php, line 48

Class

DuplicateClassNameSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Classes

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $namespace = '';
    $findTokens = [
        T_CLASS,
        T_INTERFACE,
        T_TRAIT,
        T_ENUM,
        T_NAMESPACE,
    ];
    $stackPtr = $phpcsFile->findNext($findTokens, $stackPtr + 1);
    while ($stackPtr !== false) {
        // Keep track of what namespace we are in.
        if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
            $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
            if ($nextNonEmpty !== false && $tokens[$nextNonEmpty]['code'] !== T_NS_SEPARATOR) {
                $namespace = '';
                for ($i = $nextNonEmpty; $i < $phpcsFile->numTokens; $i++) {
                    if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
                        continue;
                    }
                    if ($tokens[$i]['code'] !== T_STRING && $tokens[$i]['code'] !== T_NS_SEPARATOR) {
                        break;
                    }
                    $namespace .= $tokens[$i]['content'];
                }
                $stackPtr = $i;
            }
        }
        else {
            $name = $phpcsFile->getDeclarationName($stackPtr);
            if (empty($name) === false) {
                if ($namespace !== '') {
                    $name = $namespace . '\\' . $name;
                }
                $compareName = strtolower($name);
                if (isset($this->foundClasses[$compareName]) === true) {
                    $type = strtolower($tokens[$stackPtr]['content']);
                    $file = $this->foundClasses[$compareName]['file'];
                    $line = $this->foundClasses[$compareName]['line'];
                    $error = 'Duplicate %s name "%s" found; first defined in %s on line %s';
                    $data = [
                        $type,
                        $name,
                        $file,
                        $line,
                    ];
                    $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
                }
                else {
                    $this->foundClasses[$compareName] = [
                        'file' => $phpcsFile->getFilename(),
                        'line' => $tokens[$stackPtr]['line'],
                    ];
                }
            }
            
            //end if
            if (isset($tokens[$stackPtr]['scope_closer']) === true) {
                $stackPtr = $tokens[$stackPtr]['scope_closer'];
            }
        }
        
        //end if
        $stackPtr = $phpcsFile->findNext($findTokens, $stackPtr + 1);
    }
    
    //end while
    return $phpcsFile->numTokens;
}