function LongConditionClosingCommentSniff::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/Squiz/Sniffs/Commenting/LongConditionClosingCommentSniff.php, line 83

Class

LongConditionClosingCommentSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['scope_condition']) === false) {
        // No scope condition. It is a function closer.
        return;
    }
    $startCondition = $tokens[$tokens[$stackPtr]['scope_condition']];
    $startBrace = $tokens[$tokens[$stackPtr]['scope_opener']];
    $endBrace = $tokens[$stackPtr];
    // We are only interested in some code blocks.
    if (in_array($startCondition['code'], self::$openers, true) === false) {
        return;
    }
    if ($startCondition['code'] === T_IF) {
        // If this is actually an ELSE IF, skip it as the brace
        // will be checked by the original IF.
        $else = $phpcsFile->findPrevious(T_WHITESPACE, $tokens[$stackPtr]['scope_condition'] - 1, null, true);
        if ($tokens[$else]['code'] === T_ELSE) {
            return;
        }
        // IF statements that have an ELSE block need to use
        // "end if" rather than "end else" or "end elseif".
        do {
            $nextToken = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
            if ($tokens[$nextToken]['code'] === T_ELSE || $tokens[$nextToken]['code'] === T_ELSEIF) {
                // Check for ELSE IF (2 tokens) as opposed to ELSEIF (1 token).
                if ($tokens[$nextToken]['code'] === T_ELSE && isset($tokens[$nextToken]['scope_closer']) === false) {
                    $nextToken = $phpcsFile->findNext(T_WHITESPACE, $nextToken + 1, null, true);
                    if ($tokens[$nextToken]['code'] !== T_IF || isset($tokens[$nextToken]['scope_closer']) === false) {
                        // Not an ELSE IF or is an inline ELSE IF.
                        break;
                    }
                }
                if (isset($tokens[$nextToken]['scope_closer']) === false) {
                    // There isn't going to be anywhere to print the "end if" comment
                    // because there is no closer.
                    return;
                }
                // The end brace becomes the ELSE's end brace.
                $stackPtr = $tokens[$nextToken]['scope_closer'];
                $endBrace = $tokens[$stackPtr];
            }
            else {
                break;
            }
            
            //end if
        } while (isset($tokens[$nextToken]['scope_closer']) === true);
    }
    
    //end if
    if ($startCondition['code'] === T_TRY) {
        // TRY statements need to check until the end of all CATCH statements.
        do {
            $nextToken = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
            if ($tokens[$nextToken]['code'] === T_CATCH || $tokens[$nextToken]['code'] === T_FINALLY) {
                // The end brace becomes the CATCH end brace.
                $stackPtr = $tokens[$nextToken]['scope_closer'];
                $endBrace = $tokens[$stackPtr];
            }
            else {
                break;
            }
        } while (isset($tokens[$nextToken]['scope_closer']) === true);
    }
    if ($startCondition['code'] === T_MATCH) {
        // Move the stackPtr to after the semicolon/comma if there is one.
        $nextToken = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($nextToken !== false && ($tokens[$nextToken]['code'] === T_SEMICOLON || $tokens[$nextToken]['code'] === T_COMMA)) {
            $stackPtr = $nextToken;
        }
    }
    $lineDifference = $endBrace['line'] - $startBrace['line'];
    $expected = sprintf($this->commentFormat, $startCondition['content']);
    $comment = $phpcsFile->findNext([
        T_COMMENT,
    ], $stackPtr, null, false);
    if ($comment === false || $tokens[$comment]['line'] !== $endBrace['line']) {
        if ($lineDifference >= $this->lineLimit) {
            $error = 'End comment for long condition not found; expected "%s"';
            $data = [
                $expected,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Missing', $data);
            if ($fix === true) {
                $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
                if ($next !== false && $tokens[$next]['line'] === $tokens[$stackPtr]['line']) {
                    $expected .= $phpcsFile->eolChar;
                }
                $phpcsFile->fixer
                    ->addContent($stackPtr, $expected);
            }
        }
        return;
    }
    if ($comment - $stackPtr !== 1) {
        $error = 'Space found before closing comment; expected "%s"';
        $data = [
            $expected,
        ];
        $phpcsFile->addError($error, $stackPtr, 'SpacingBefore', $data);
    }
    if (trim($tokens[$comment]['content']) !== $expected) {
        $found = trim($tokens[$comment]['content']);
        $error = 'Incorrect closing comment; expected "%s" but found "%s"';
        $data = [
            $expected,
            $found,
        ];
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Invalid', $data);
        if ($fix === true) {
            $phpcsFile->fixer
                ->replaceToken($comment, $expected . $phpcsFile->eolChar);
        }
        return;
    }
}