function ClassCommentSniff::process

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php \PHP_CodeSniffer\Standards\Squiz\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/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php, line 54

Class

ClassCommentSniff

Checks that comment doc blocks exist on classes, interfaces and traits. Largely copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff.

Namespace

Drupal\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $find = Tokens::$methodPrefixes;
    $find[T_WHITESPACE] = T_WHITESPACE;
    $find[T_READONLY] = T_READONLY;
    $name = $tokens[$stackPtr]['content'];
    $classCodeStart = $stackPtr;
    $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 = $classCodeStart = $tokens[$commentEnd]['attribute_opener'];
            continue;
        }
        break;
    }
    if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT) {
        $fix = $phpcsFile->addFixableError('Missing %s doc comment', $classCodeStart, 'Missing', [
            $name,
        ]);
        if ($fix === true) {
            $phpcsFile->fixer
                ->addContent($commentEnd, "\n\n/**\n *\n */");
        }
        return;
    }
    // Try and determine if this is a file comment instead of a class comment.
    if ($tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
        $start = $tokens[$commentEnd]['comment_opener'] - 1;
    }
    else {
        $start = $commentEnd - 1;
    }
    $fileTag = $phpcsFile->findNext(T_DOC_COMMENT_TAG, $start + 1, $commentEnd, false, '@file');
    if ($fileTag !== false) {
        // This is a file comment.
        $fix = $phpcsFile->addFixableError('Missing %s doc comment', $classCodeStart, 'Missing', [
            $name,
        ]);
        if ($fix === true) {
            $phpcsFile->fixer
                ->addContent($commentEnd, "\n/**\n *\n */");
        }
        return;
    }
    if ($tokens[$commentEnd]['code'] === T_COMMENT) {
        $fix = $phpcsFile->addFixableError('You must use "/**" style comments for a %s comment', $classCodeStart, 'WrongStyle', [
            $name,
        ]);
        if ($fix === true) {
            // Convert the comment into a doc comment.
            $phpcsFile->fixer
                ->beginChangeset();
            $comment = '';
            for ($i = $commentEnd; $tokens[$i]['code'] === T_COMMENT; $i--) {
                $comment = ' *' . ltrim($tokens[$i]['content'], '/* ') . $comment;
                $phpcsFile->fixer
                    ->replaceToken($i, '');
            }
            $phpcsFile->fixer
                ->replaceToken($commentEnd, "/**\n" . rtrim($comment, "*/\n") . "\n */");
            $phpcsFile->fixer
                ->endChangeset();
        }
        return;
    }
    if ($tokens[$commentEnd]['line'] !== $tokens[$classCodeStart]['line'] - 1) {
        $error = 'There must be exactly one newline after the %s comment';
        $fix = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter', [
            $name,
        ]);
        if ($fix === true) {
            $phpcsFile->fixer
                ->beginChangeset();
            for ($i = $commentEnd + 1; $tokens[$i]['code'] === T_WHITESPACE && $i < $classCodeStart; $i++) {
                $phpcsFile->fixer
                    ->replaceToken($i, '');
            }
            $phpcsFile->fixer
                ->addContent($commentEnd, "\n");
            $phpcsFile->fixer
                ->endChangeset();
        }
    }
    $comment = [];
    for ($i = $start; $i < $commentEnd; $i++) {
        if ($tokens[$i]['code'] === T_DOC_COMMENT_TAG) {
            break;
        }
        if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
            $comment[] = $tokens[$i]['content'];
        }
    }
    $words = explode(' ', implode(' ', $comment));
    if (count($words) <= 2) {
        $className = $phpcsFile->getDeclarationName($stackPtr);
        foreach ($words as $word) {
            // Check if the comment contains the class name.
            if (strpos($word, $className) !== false) {
                $error = 'The class short comment should describe what the class does and not simply repeat the class name';
                $phpcsFile->addWarning($error, $commentEnd, 'Short');
                break;
            }
        }
    }
}