function ClassCommentSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php \Drupal\Sniffs\Commenting\ClassCommentSniff::process()
2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff::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 FileCommentSniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/Commenting/ClassCommentSniff.php, line 44

Class

ClassCommentSniff

Namespace

PHP_CodeSniffer\Standards\PEAR\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $type = strtolower($tokens[$stackPtr]['content']);
    $errorData = [
        $type,
    ];
    $find = [
        T_ABSTRACT => T_ABSTRACT,
        T_FINAL => T_FINAL,
        T_READONLY => T_READONLY,
        T_WHITESPACE => T_WHITESPACE,
    ];
    for ($commentEnd = $stackPtr - 1; $commentEnd >= 0; $commentEnd--) {
        if (isset($find[$tokens[$commentEnd]['code']]) === true) {
            continue;
        }
        if ($tokens[$commentEnd]['code'] === T_ATTRIBUTE_END && isset($tokens[$commentEnd]['attribute_opener']) === true) {
            $commentEnd = $tokens[$commentEnd]['attribute_opener'];
            continue;
        }
        break;
    }
    if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT) {
        $errorData[] = $phpcsFile->getDeclarationName($stackPtr);
        $phpcsFile->addError('Missing doc comment for %s %s', $stackPtr, 'Missing', $errorData);
        $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
        return;
    }
    $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');
    if ($tokens[$commentEnd]['code'] === T_COMMENT) {
        $phpcsFile->addError('You must use "/**" style comments for a %s comment', $stackPtr, 'WrongStyle', $errorData);
        return;
    }
    // Check each tag.
    $this->processTags($phpcsFile, $stackPtr, $tokens[$commentEnd]['comment_opener']);
}