function PostStatementCommentSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php \Drupal\Sniffs\Commenting\PostStatementCommentSniff::process()

Processes this sniff, 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/PostStatementCommentSniff.php, line 68

Class

PostStatementCommentSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
        return;
    }
    $commentLine = $tokens[$stackPtr]['line'];
    $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
    if ($lastContent === false || $tokens[$lastContent]['line'] !== $commentLine || $tokens[$stackPtr]['column'] === 1) {
        return;
    }
    if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
        return;
    }
    // Special case for JS files and PHP closures.
    if ($tokens[$lastContent]['code'] === T_COMMA || $tokens[$lastContent]['code'] === T_SEMICOLON) {
        $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, $lastContent - 1, null, true);
        if ($lastContent === false || $tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
            return;
        }
    }
    // Special case for (trailing) comments within multi-line control structures.
    if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
        $nestedParens = $tokens[$stackPtr]['nested_parenthesis'];
        foreach ($nestedParens as $open => $close) {
            if (isset($tokens[$open]['parenthesis_owner']) === true && isset($this->controlStructureExceptions[$tokens[$tokens[$open]['parenthesis_owner']]['code']]) === true) {
                return;
            }
        }
    }
    if ($phpcsFile->tokenizerType === 'PHP' && preg_match('|^//[ \\t]*@[^\\s]+|', $tokens[$stackPtr]['content']) === 1) {
        $error = 'Annotations may not appear after statements';
        $phpcsFile->addError($error, $stackPtr, 'AnnotationFound');
        return;
    }
    $error = 'Comments may not appear after statements';
    $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
    if ($fix === true) {
        $phpcsFile->fixer
            ->addNewlineBefore($stackPtr);
    }
}