function LanguageConstructSpacingSniff::process

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\LanguageConstructSpacingSniff::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/WhiteSpace/LanguageConstructSpacingSniff.php, line 56

Class

LanguageConstructSpacingSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $nextToken = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
    if ($nextToken === false) {
        // Skip when at end of file.
        return;
    }
    if ($tokens[$stackPtr + 1]['code'] === T_SEMICOLON) {
        // No content for this language construct.
        return;
    }
    $content = $tokens[$stackPtr]['content'];
    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 keyword used as operator, not as the language construct.
            return;
        }
    }
    if ($tokens[$stackPtr]['code'] === T_YIELD_FROM && strtolower($content) !== 'yield from') {
        $found = $content;
        $hasComment = false;
        $yieldFromEnd = $stackPtr;
        // Handle potentially multi-line/multi-token "yield from" expressions.
        if (preg_match('`yield\\s+from`i', $content) !== 1) {
            for ($i = $stackPtr + 1; $i < $phpcsFile->numTokens; $i++) {
                if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false && $tokens[$i]['code'] !== T_YIELD_FROM) {
                    break;
                }
                if (isset(Tokens::$commentTokens[$tokens[$i]['code']]) === true) {
                    $hasComment = true;
                }
                $found .= $tokens[$i]['content'];
                if ($tokens[$i]['code'] === T_YIELD_FROM && strtolower(trim($tokens[$i]['content'])) === 'from') {
                    break;
                }
            }
            $yieldFromEnd = $i;
        }
        
        //end if
        $error = 'Language constructs must be followed by a single space; expected 1 space between YIELD FROM found "%s"';
        $data = [
            Common::prepareForOutput($found),
        ];
        if ($hasComment === true) {
            $phpcsFile->addError($error, $stackPtr, 'IncorrectYieldFromWithComment', $data);
        }
        else {
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);
            if ($fix === true) {
                preg_match('/yield/i', $found, $yield);
                preg_match('/from/i', $found, $from);
                $phpcsFile->fixer
                    ->beginChangeset();
                $phpcsFile->fixer
                    ->replaceToken($stackPtr, $yield[0] . ' ' . $from[0]);
                for ($i = $stackPtr + 1; $i <= $yieldFromEnd; $i++) {
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
        
        //end if
        return $yieldFromEnd + 1;
    }
    
    //end if
    if ($tokens[$stackPtr + 1]['code'] === T_WHITESPACE) {
        $content = $tokens[$stackPtr + 1]['content'];
        if ($content !== ' ') {
            $error = 'Language constructs must be followed by a single space; expected 1 space but found "%s"';
            $data = [
                Common::prepareForOutput($content),
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectSingle', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr + 1, ' ');
            }
        }
    }
    else {
        if ($tokens[$stackPtr + 1]['code'] !== T_OPEN_PARENTHESIS) {
            $error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';
            $data = [
                $tokens[$stackPtr]['content'] . ' ' . $tokens[$stackPtr + 1]['content'],
                $tokens[$stackPtr]['content'] . $tokens[$stackPtr + 1]['content'],
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->addContent($stackPtr, ' ');
            }
        }
    }
    
    //end if
}