function InlineControlStructureSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php \Drupal\Sniffs\ControlStructures\InlineControlStructureSniff::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|int

Overrides Sniff::process

2 calls to InlineControlStructureSniff::process()

InlineControlStructureSniff::process in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php

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

InlineControlStructureSniff::process in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php

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

1 method overrides InlineControlStructureSniff::process()

InlineControlStructureSniff::process in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php

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

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureSniff.php, line 67

Class

InlineControlStructureSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\ControlStructures

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['scope_opener']) === true) {
        $phpcsFile->recordMetric($stackPtr, 'Control structure defined inline', 'no');
        return;
    }
    // Ignore the ELSE in ELSE IF. We'll process the IF part later.
    if ($tokens[$stackPtr]['code'] === T_ELSE) {
        $next = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
        if ($tokens[$next]['code'] === T_IF) {
            return;
        }
    }
    if ($tokens[$stackPtr]['code'] === T_WHILE || $tokens[$stackPtr]['code'] === T_FOR) {
        // This could be from a DO WHILE, which doesn't have an opening brace or a while/for without body.
        if (isset($tokens[$stackPtr]['parenthesis_closer']) === true) {
            $afterParensCloser = $phpcsFile->findNext(Tokens::$emptyTokens, $tokens[$stackPtr]['parenthesis_closer'] + 1, null, true);
            if ($afterParensCloser === false) {
                // Live coding.
                return;
            }
            if ($tokens[$afterParensCloser]['code'] === T_SEMICOLON) {
                $phpcsFile->recordMetric($stackPtr, 'Control structure defined inline', 'no');
                return;
            }
        }
    }
    
    //end if
    if (isset($tokens[$stackPtr]['parenthesis_opener'], $tokens[$stackPtr]['parenthesis_closer']) === false && $tokens[$stackPtr]['code'] !== T_ELSE) {
        if ($tokens[$stackPtr]['code'] !== T_DO) {
            // Live coding or parse error.
            return;
        }
        $nextWhile = $phpcsFile->findNext(T_WHILE, $stackPtr + 1);
        if ($nextWhile !== false && isset($tokens[$nextWhile]['parenthesis_opener'], $tokens[$nextWhile]['parenthesis_closer']) === false) {
            // Live coding or parse error.
            return;
        }
        unset($nextWhile);
    }
    $start = $stackPtr;
    if (isset($tokens[$stackPtr]['parenthesis_closer']) === true) {
        $start = $tokens[$stackPtr]['parenthesis_closer'];
    }
    $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $start + 1, null, true);
    if ($nextNonEmpty === false) {
        // Live coding or parse error.
        return;
    }
    if ($tokens[$nextNonEmpty]['code'] === T_OPEN_CURLY_BRACKET || $tokens[$nextNonEmpty]['code'] === T_COLON) {
        // T_CLOSE_CURLY_BRACKET missing, or alternative control structure with
        // T_END... missing. Either live coding, parse error or end
        // tag in short open tags and scan run with short_open_tag=Off.
        // Bow out completely as any further detection will be unreliable
        // and create incorrect fixes or cause fixer conflicts.
        return $phpcsFile->numTokens;
    }
    unset($nextNonEmpty, $start);
    // This is a control structure without an opening brace,
    // so it is an inline statement.
    if ($this->error === true) {
        $fix = $phpcsFile->addFixableError('Inline control structures are not allowed', $stackPtr, 'NotAllowed');
    }
    else {
        $fix = $phpcsFile->addFixableWarning('Inline control structures are discouraged', $stackPtr, 'Discouraged');
    }
    $phpcsFile->recordMetric($stackPtr, 'Control structure defined inline', 'yes');
    // Stop here if we are not fixing the error.
    if ($fix !== true) {
        return;
    }
    $phpcsFile->fixer
        ->beginChangeset();
    if (isset($tokens[$stackPtr]['parenthesis_closer']) === true) {
        $closer = $tokens[$stackPtr]['parenthesis_closer'];
    }
    else {
        $closer = $stackPtr;
    }
    if ($tokens[$closer + 1]['code'] === T_WHITESPACE || $tokens[$closer + 1]['code'] === T_SEMICOLON) {
        $phpcsFile->fixer
            ->addContent($closer, ' {');
    }
    else {
        $phpcsFile->fixer
            ->addContent($closer, ' { ');
    }
    $fixableScopeOpeners = $this->register();
    $lastNonEmpty = $closer;
    for ($end = $closer + 1; $end < $phpcsFile->numTokens; $end++) {
        if ($tokens[$end]['code'] === T_SEMICOLON) {
            break;
        }
        if ($tokens[$end]['code'] === T_CLOSE_TAG) {
            $end = $lastNonEmpty;
            break;
        }
        if (in_array($tokens[$end]['code'], $fixableScopeOpeners, true) === true && isset($tokens[$end]['scope_opener']) === false) {
            // The best way to fix nested inline scopes is middle-out.
            // So skip this one. It will be detected and fixed on a future loop.
            $phpcsFile->fixer
                ->rollbackChangeset();
            return;
        }
        if (isset($tokens[$end]['scope_opener']) === true) {
            $type = $tokens[$end]['code'];
            $end = $tokens[$end]['scope_closer'];
            if ($type === T_DO || $type === T_IF || $type === T_ELSEIF || $type === T_TRY || $type === T_CATCH || $type === T_FINALLY) {
                $next = $phpcsFile->findNext(Tokens::$emptyTokens, $end + 1, null, true);
                if ($next === false) {
                    break;
                }
                $nextType = $tokens[$next]['code'];
                // Let additional conditions loop and find their ending.
                if (($type === T_IF || $type === T_ELSEIF) && ($nextType === T_ELSEIF || $nextType === T_ELSE)) {
                    continue;
                }
                // Account for TRY... CATCH/FINALLY statements.
                if (($type === T_TRY || $type === T_CATCH || $type === T_FINALLY) && ($nextType === T_CATCH || $nextType === T_FINALLY)) {
                    continue;
                }
                // Account for DO... WHILE conditions.
                if ($type === T_DO && $nextType === T_WHILE) {
                    $end = $phpcsFile->findNext(T_SEMICOLON, $next + 1);
                }
            }
            else {
                if ($type === T_CLOSURE) {
                    // There should be a semicolon after the closing brace.
                    $next = $phpcsFile->findNext(Tokens::$emptyTokens, $end + 1, null, true);
                    if ($next !== false && $tokens[$next]['code'] === T_SEMICOLON) {
                        $end = $next;
                    }
                }
            }
            
            //end if
            if ($tokens[$end]['code'] !== T_END_HEREDOC && $tokens[$end]['code'] !== T_END_NOWDOC) {
                break;
            }
        }
        
        //end if
        if (isset($tokens[$end]['parenthesis_closer']) === true) {
            $end = $tokens[$end]['parenthesis_closer'];
            $lastNonEmpty = $end;
            continue;
        }
        if ($tokens[$end]['code'] !== T_WHITESPACE) {
            $lastNonEmpty = $end;
        }
    }
    
    //end for
    if ($end === $phpcsFile->numTokens) {
        $end = $lastNonEmpty;
    }
    $nextContent = $phpcsFile->findNext(Tokens::$emptyTokens, $end + 1, null, true);
    if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
        // Looks for completely empty statements.
        $next = $phpcsFile->findNext(T_WHITESPACE, $closer + 1, $end + 1, true);
    }
    else {
        $next = $end + 1;
        $endLine = $end;
    }
    if ($next !== $end) {
        if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
            // Account for a comment on the end of the line.
            for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) {
                if (isset($tokens[$endLine + 1]) === false || $tokens[$endLine]['line'] !== $tokens[$endLine + 1]['line']) {
                    break;
                }
            }
            if (isset(Tokens::$commentTokens[$tokens[$endLine]['code']]) === false && ($tokens[$endLine]['code'] !== T_WHITESPACE || isset(Tokens::$commentTokens[$tokens[$endLine - 1]['code']]) === false)) {
                $endLine = $end;
            }
        }
        if ($endLine !== $end) {
            $endToken = $endLine;
            $addedContent = '';
        }
        else {
            $endToken = $end;
            $addedContent = $phpcsFile->eolChar;
            if ($tokens[$end]['code'] !== T_SEMICOLON && $tokens[$end]['code'] !== T_CLOSE_CURLY_BRACKET) {
                $phpcsFile->fixer
                    ->addContent($end, '; ');
            }
        }
        $next = $phpcsFile->findNext(T_WHITESPACE, $endToken + 1, null, true);
        if ($next !== false && ($tokens[$next]['code'] === T_ELSE || $tokens[$next]['code'] === T_ELSEIF)) {
            $phpcsFile->fixer
                ->addContentBefore($next, '} ');
        }
        else {
            $indent = '';
            for ($first = $stackPtr; $first > 0; $first--) {
                if ($tokens[$first]['column'] === 1) {
                    break;
                }
            }
            if ($tokens[$first]['code'] === T_WHITESPACE) {
                $indent = $tokens[$first]['content'];
            }
            else {
                if ($tokens[$first]['code'] === T_INLINE_HTML || $tokens[$first]['code'] === T_OPEN_TAG) {
                    $addedContent = '';
                }
            }
            $addedContent .= $indent . '}';
            if ($next !== false && $tokens[$endToken]['code'] === T_COMMENT) {
                $addedContent .= $phpcsFile->eolChar;
            }
            $phpcsFile->fixer
                ->addContent($endToken, $addedContent);
        }
        
        //end if
    }
    else {
        if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
            // Account for a comment on the end of the line.
            for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) {
                if (isset($tokens[$endLine + 1]) === false || $tokens[$endLine]['line'] !== $tokens[$endLine + 1]['line']) {
                    break;
                }
            }
            if ($tokens[$endLine]['code'] !== T_COMMENT && ($tokens[$endLine]['code'] !== T_WHITESPACE || $tokens[$endLine - 1]['code'] !== T_COMMENT)) {
                $endLine = $end;
            }
        }
        if ($endLine !== $end) {
            $phpcsFile->fixer
                ->replaceToken($end, '');
            $phpcsFile->fixer
                ->addNewlineBefore($endLine);
            $phpcsFile->fixer
                ->addContent($endLine, '}');
        }
        else {
            $phpcsFile->fixer
                ->replaceToken($end, '}');
        }
    }
    
    //end if
    $phpcsFile->fixer
        ->endChangeset();
}