function UseDeclarationSniff::process

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PSR12/Sniffs/Traits/UseDeclarationSniff.php \PHP_CodeSniffer\Standards\PSR12\Sniffs\Traits\UseDeclarationSniff::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/PSR2/Sniffs/Namespaces/UseDeclarationSniff.php, line 41

Class

UseDeclarationSniff

Namespace

PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces

Code

public function process(File $phpcsFile, $stackPtr) {
    if ($this->shouldIgnoreUse($phpcsFile, $stackPtr) === true) {
        return;
    }
    $tokens = $phpcsFile->getTokens();
    // One space after the use keyword.
    if ($tokens[$stackPtr + 1]['content'] !== ' ') {
        $error = 'There must be a single space after the USE keyword';
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterUse');
        if ($fix === true) {
            $phpcsFile->fixer
                ->replaceToken($stackPtr + 1, ' ');
        }
    }
    // Only one USE declaration allowed per statement.
    $next = $phpcsFile->findNext([
        T_COMMA,
        T_SEMICOLON,
        T_OPEN_USE_GROUP,
        T_CLOSE_TAG,
    ], $stackPtr + 1);
    if ($next !== false && $tokens[$next]['code'] !== T_SEMICOLON && $tokens[$next]['code'] !== T_CLOSE_TAG) {
        $error = 'There must be one USE keyword per declaration';
        if ($tokens[$next]['code'] === T_COMMA) {
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MultipleDeclarations');
            if ($fix === true) {
                switch ($tokens[$stackPtr + 2]['content']) {
                    case 'const':
                        $baseUse = 'use const';
                        break;
                    case 'function':
                        $baseUse = 'use function';
                        break;
                    default:
                        $baseUse = 'use';
                }
                if ($tokens[$next + 1]['code'] !== T_WHITESPACE) {
                    $baseUse .= ' ';
                }
                $phpcsFile->fixer
                    ->replaceToken($next, ';' . $phpcsFile->eolChar . $baseUse);
            }
        }
        else {
            $closingCurly = $phpcsFile->findNext(T_CLOSE_USE_GROUP, $next + 1);
            if ($closingCurly === false) {
                // Parse error or live coding. Not auto-fixable.
                $phpcsFile->addError($error, $stackPtr, 'MultipleDeclarations');
            }
            else {
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MultipleDeclarations');
                if ($fix === true) {
                    $baseUse = rtrim($phpcsFile->getTokensAsString($stackPtr, $next - $stackPtr));
                    $lastNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, $closingCurly - 1, null, true);
                    $phpcsFile->fixer
                        ->beginChangeset();
                    // Remove base use statement.
                    for ($i = $stackPtr; $i <= $next; $i++) {
                        $phpcsFile->fixer
                            ->replaceToken($i, '');
                    }
                    if (preg_match('`^[\\r\\n]+$`', $tokens[$next + 1]['content']) === 1) {
                        $phpcsFile->fixer
                            ->replaceToken($next + 1, '');
                    }
                    // Convert grouped use statements into full use statements.
                    do {
                        $next = $phpcsFile->findNext(Tokens::$emptyTokens, $next + 1, $closingCurly, true);
                        if ($next === false) {
                            // Group use statement with trailing comma after last item.
                            break;
                        }
                        $nonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, $next - 1, null, true);
                        for ($i = $nonWhitespace + 1; $i < $next; $i++) {
                            if (preg_match('`^[\\r\\n]+$`', $tokens[$i]['content']) === 1) {
                                // Preserve new lines.
                                continue;
                            }
                            $phpcsFile->fixer
                                ->replaceToken($i, '');
                        }
                        if ($tokens[$next]['content'] === 'const' || $tokens[$next]['content'] === 'function') {
                            $phpcsFile->fixer
                                ->addContentBefore($next, 'use ');
                            $next = $phpcsFile->findNext(Tokens::$emptyTokens, $next + 1, $closingCurly, true);
                            $phpcsFile->fixer
                                ->addContentBefore($next, str_replace('use ', '', $baseUse));
                        }
                        else {
                            $phpcsFile->fixer
                                ->addContentBefore($next, $baseUse);
                        }
                        $next = $phpcsFile->findNext(T_COMMA, $next + 1, $closingCurly);
                        if ($next !== false) {
                            $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $next + 1, $closingCurly, true);
                            if ($nextNonEmpty !== false && $tokens[$nextNonEmpty]['line'] === $tokens[$next]['line']) {
                                $prevNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, $nextNonEmpty - 1, $next, true);
                                if ($prevNonWhitespace === $next) {
                                    $phpcsFile->fixer
                                        ->replaceToken($next, ';' . $phpcsFile->eolChar);
                                }
                                else {
                                    $phpcsFile->fixer
                                        ->replaceToken($next, ';');
                                    $phpcsFile->fixer
                                        ->addNewline($prevNonWhitespace);
                                }
                            }
                            else {
                                // Last item with trailing comma or next item already on new line.
                                $phpcsFile->fixer
                                    ->replaceToken($next, ';');
                            }
                        }
                        else {
                            // Last item without trailing comma.
                            $phpcsFile->fixer
                                ->addContent($lastNonWhitespace, ';');
                        }
                    } while ($next !== false);
                    // Remove closing curly, semicolon and any whitespace between last child and closing curly.
                    $next = $phpcsFile->findNext(Tokens::$emptyTokens, $closingCurly + 1, null, true);
                    if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) {
                        // Parse error, forgotten semicolon.
                        $next = $closingCurly;
                    }
                    for ($i = $lastNonWhitespace + 1; $i <= $next; $i++) {
                        $phpcsFile->fixer
                            ->replaceToken($i, '');
                    }
                    $phpcsFile->fixer
                        ->endChangeset();
                }
                
                //end if
            }
            
            //end if
        }
        
        //end if
    }
    
    //end if
    // Make sure this USE comes after the first namespace declaration.
    $prev = $phpcsFile->findPrevious(T_NAMESPACE, $stackPtr - 1);
    if ($prev === false) {
        $next = $phpcsFile->findNext(T_NAMESPACE, $stackPtr + 1);
        if ($next !== false) {
            $error = 'USE declarations must go after the namespace declaration';
            $phpcsFile->addError($error, $stackPtr, 'UseBeforeNamespace');
        }
    }
    // Only interested in the last USE statement from here onwards.
    $nextUse = $phpcsFile->findNext(T_USE, $stackPtr + 1);
    while ($this->shouldIgnoreUse($phpcsFile, $nextUse) === true) {
        $nextUse = $phpcsFile->findNext(T_USE, $nextUse + 1);
        if ($nextUse === false) {
            break;
        }
    }
    if ($nextUse !== false) {
        return;
    }
    $end = $phpcsFile->findNext([
        T_SEMICOLON,
        T_CLOSE_USE_GROUP,
        T_CLOSE_TAG,
    ], $stackPtr + 1);
    if ($end === false) {
        return;
    }
    if ($tokens[$end]['code'] === T_CLOSE_USE_GROUP) {
        $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $end + 1, null, true);
        if ($tokens[$nextNonEmpty]['code'] === T_SEMICOLON) {
            $end = $nextNonEmpty;
        }
    }
    // Find either the start of the next line or the beginning of the next statement,
    // whichever comes first.
    for ($end = ++$end; $end < $phpcsFile->numTokens; $end++) {
        if (isset(Tokens::$emptyTokens[$tokens[$end]['code']]) === false) {
            break;
        }
        if ($tokens[$end]['column'] === 1) {
            // Reached the next line.
            break;
        }
    }
    --$end;
    if (($tokens[$end]['code'] === T_COMMENT || isset(Tokens::$phpcsCommentTokens[$tokens[$end]['code']]) === true) && substr($tokens[$end]['content'], 0, 2) === '/*' && substr($tokens[$end]['content'], -2) !== '*/') {
        // Multi-line block comments are not allowed as trailing comment after a use statement.
        --$end;
    }
    $next = $phpcsFile->findNext(T_WHITESPACE, $end + 1, null, true);
    if ($next === false || $tokens[$next]['code'] === T_CLOSE_TAG) {
        return;
    }
    $diff = $tokens[$next]['line'] - $tokens[$end]['line'] - 1;
    if ($diff !== 1) {
        if ($diff < 0) {
            $diff = 0;
        }
        $error = 'There must be one blank line after the last USE statement; %s found;';
        $data = [
            $diff,
        ];
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterLastUse', $data);
        if ($fix === true) {
            if ($diff === 0) {
                $phpcsFile->fixer
                    ->addNewline($end);
            }
            else {
                $phpcsFile->fixer
                    ->beginChangeset();
                for ($i = $end + 1; $i < $next; $i++) {
                    if ($tokens[$i]['line'] === $tokens[$next]['line']) {
                        break;
                    }
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->addNewline($end);
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
    }
    
    //end if
}