Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. CommentEmptyLineSniff.php

class CommentEmptyLineSniff

Throws a warning if there is a blank line after an inline comment.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

  • class \DrupalPractice\Sniffs\Commenting\CommentEmptyLineSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of CommentEmptyLineSniff

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php, line 23

Namespace

DrupalPractice\Sniffs\Commenting
View source
class CommentEmptyLineSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_COMMENT,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $comment = rtrim($tokens[$stackPtr]['content']);
        // Only want inline comments.
        if (substr($comment, 0, 2) !== '//') {
            return;
        }
        // The line below the last comment cannot be empty.
        for ($i = $stackPtr + 1; $i < $phpcsFile->numTokens; $i++) {
            if ($tokens[$i]['line'] === $tokens[$stackPtr]['line'] + 1) {
                if ($tokens[$i]['code'] !== T_WHITESPACE) {
                    return;
                }
            }
            else {
                if ($tokens[$i]['line'] > $tokens[$stackPtr]['line'] + 1) {
                    break;
                }
            }
        }
        $warning = 'There must be no blank line following an inline comment';
        $phpcsFile->addWarning($warning, $stackPtr, 'SpacingAfter');
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
CommentEmptyLineSniff::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
CommentEmptyLineSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal