function ControlStructureSpacingSniff::process

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ControlStructureSpacingSniff::process()
2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PSR2/Sniffs/ControlStructures/ControlStructureSpacingSniff.php \PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff::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/PSR12/Sniffs/ControlStructures/ControlStructureSpacingSniff.php, line 75

Class

ControlStructureSpacingSniff

Namespace

PHP_CodeSniffer\Standards\PSR12\Sniffs\ControlStructures

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['parenthesis_opener']) === false || isset($tokens[$stackPtr]['parenthesis_closer']) === false) {
        return;
    }
    $parenOpener = $tokens[$stackPtr]['parenthesis_opener'];
    $parenCloser = $tokens[$stackPtr]['parenthesis_closer'];
    if ($tokens[$parenOpener]['line'] === $tokens[$parenCloser]['line']) {
        // Conditions are all on the same line, so follow PSR2.
        return $this->psr2ControlStructureSpacing
            ->process($phpcsFile, $stackPtr);
    }
    $next = $phpcsFile->findNext(T_WHITESPACE, $parenOpener + 1, $parenCloser, true);
    if ($next === false) {
        // No conditions; parse error.
        return;
    }
    // Check the first expression.
    if ($tokens[$next]['line'] !== $tokens[$parenOpener]['line'] + 1) {
        $error = 'The first expression of a multi-line control structure must be on the line after the opening parenthesis';
        $fix = $phpcsFile->addFixableError($error, $next, 'FirstExpressionLine');
        if ($fix === true) {
            $phpcsFile->fixer
                ->beginChangeset();
            if ($tokens[$next]['line'] > $tokens[$parenOpener]['line'] + 1) {
                for ($i = $parenOpener + 1; $i < $next; $i++) {
                    if ($tokens[$next]['line'] === $tokens[$i]['line']) {
                        break;
                    }
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
            }
            $phpcsFile->fixer
                ->addNewline($parenOpener);
            $phpcsFile->fixer
                ->endChangeset();
        }
    }
    // Check the indent of each line.
    $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true);
    $requiredIndent = $tokens[$first]['column'] + $this->indent - 1;
    for ($i = $parenOpener; $i < $parenCloser; $i++) {
        if ($tokens[$i]['column'] !== 1 || $tokens[$i + 1]['line'] > $tokens[$i]['line'] || isset(Tokens::$commentTokens[$tokens[$i]['code']]) === true) {
            continue;
        }
        if ($i + 1 === $parenCloser) {
            break;
        }
        // Leave indentation inside multi-line strings.
        if (isset(Tokens::$textStringTokens[$tokens[$i]['code']]) === true || isset(Tokens::$heredocTokens[$tokens[$i]['code']]) === true) {
            continue;
        }
        if ($tokens[$i]['code'] !== T_WHITESPACE) {
            $foundIndent = 0;
        }
        else {
            $foundIndent = $tokens[$i]['length'];
        }
        if ($foundIndent < $requiredIndent) {
            $error = 'Each line in a multi-line control structure must be indented at least once; expected at least %s spaces, but found %s';
            $data = [
                $requiredIndent,
                $foundIndent,
            ];
            $fix = $phpcsFile->addFixableError($error, $i, 'LineIndent', $data);
            if ($fix === true) {
                $padding = str_repeat(' ', $requiredIndent);
                if ($foundIndent === 0) {
                    $phpcsFile->fixer
                        ->addContentBefore($i, $padding);
                }
                else {
                    $phpcsFile->fixer
                        ->replaceToken($i, $padding);
                }
            }
        }
    }
    
    //end for
    // Check the closing parenthesis.
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $parenCloser - 1, $parenOpener, true);
    if ($tokens[$parenCloser]['line'] !== $tokens[$prev]['line'] + 1) {
        $error = 'The closing parenthesis of a multi-line control structure must be on the line after the last expression';
        $fix = $phpcsFile->addFixableError($error, $parenCloser, 'CloseParenthesisLine');
        if ($fix === true) {
            if ($tokens[$parenCloser]['line'] === $tokens[$prev]['line']) {
                $phpcsFile->fixer
                    ->addNewlineBefore($parenCloser);
            }
            else {
                $phpcsFile->fixer
                    ->beginChangeset();
                for ($i = $prev + 1; $i < $parenCloser; $i++) {
                    // Maintain existing newline.
                    if ($tokens[$i]['line'] === $tokens[$prev]['line']) {
                        continue;
                    }
                    // Maintain existing indent.
                    if ($tokens[$i]['line'] === $tokens[$parenCloser]['line']) {
                        break;
                    }
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
        
        //end if
    }
    
    //end if
    if ($tokens[$parenCloser]['line'] !== $tokens[$prev]['line']) {
        $requiredIndent = $tokens[$first]['column'] - 1;
        $foundIndent = $tokens[$parenCloser]['column'] - 1;
        if ($foundIndent !== $requiredIndent) {
            $error = 'The closing parenthesis of a multi-line control structure must be indented to the same level as start of the control structure; expected %s spaces but found %s';
            $data = [
                $requiredIndent,
                $foundIndent,
            ];
            $fix = $phpcsFile->addFixableError($error, $parenCloser, 'CloseParenthesisIndent', $data);
            if ($fix === true) {
                $padding = str_repeat(' ', $requiredIndent);
                if ($foundIndent === 0) {
                    $phpcsFile->fixer
                        ->addContentBefore($parenCloser, $padding);
                }
                else {
                    $phpcsFile->fixer
                        ->replaceToken($parenCloser - 1, $padding);
                }
            }
        }
    }
}