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/PEAR/Sniffs/Commenting/ClassCommentSniff.php \PHP_CodeSniffer\Standards\PEAR\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 Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php, line 48

Class

ClassCommentSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $find = [
        T_ABSTRACT => T_ABSTRACT,
        T_FINAL => T_FINAL,
        T_READONLY => T_READONLY,
        T_WHITESPACE => T_WHITESPACE,
    ];
    $previousContent = null;
    for ($commentEnd = $stackPtr - 1; $commentEnd >= 0; $commentEnd--) {
        if (isset($find[$tokens[$commentEnd]['code']]) === true) {
            continue;
        }
        if ($previousContent === null) {
            $previousContent = $commentEnd;
        }
        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) {
        $class = $phpcsFile->getDeclarationName($stackPtr);
        $phpcsFile->addError('Missing doc comment for class %s', $stackPtr, 'Missing', [
            $class,
        ]);
        $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 class comment', $stackPtr, 'WrongStyle');
        return;
    }
    if ($tokens[$previousContent]['line'] !== $tokens[$stackPtr]['line'] - 1) {
        $error = 'There must be no blank lines after the class comment';
        $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
    }
    $commentStart = $tokens[$commentEnd]['comment_opener'];
    foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
        $error = '%s tag is not allowed in class comment';
        $data = [
            $tokens[$tag]['content'],
        ];
        $phpcsFile->addWarning($error, $tag, 'TagNotAllowed', $data);
    }
}