annotate vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /**
Chris@17 4 * \DrupalPractice\Sniffs\Commenting\CommentEmptyLineSniff
Chris@0 5 *
Chris@0 6 * @category PHP
Chris@0 7 * @package PHP_CodeSniffer
Chris@0 8 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 9 */
Chris@0 10
Chris@17 11 namespace DrupalPractice\Sniffs\Commenting;
Chris@17 12
Chris@17 13 use PHP_CodeSniffer\Files\File;
Chris@17 14 use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17 15
Chris@0 16 /**
Chris@0 17 * Throws a warning if there is a blank line after an inline comment.
Chris@0 18 *
Chris@0 19 * @category PHP
Chris@0 20 * @package PHP_CodeSniffer
Chris@0 21 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 22 */
Chris@17 23 class CommentEmptyLineSniff implements Sniff
Chris@0 24 {
Chris@0 25
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Returns an array of tokens this test wants to listen for.
Chris@0 29 *
Chris@0 30 * @return array
Chris@0 31 */
Chris@0 32 public function register()
Chris@0 33 {
Chris@0 34 return array(T_COMMENT);
Chris@0 35
Chris@0 36 }//end register()
Chris@0 37
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Processes this test, when one of its tokens is encountered.
Chris@0 41 *
Chris@17 42 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17 43 * @param int $stackPtr The position of the current token
Chris@17 44 * in the stack passed in $tokens.
Chris@0 45 *
Chris@0 46 * @return void
Chris@0 47 */
Chris@17 48 public function process(File $phpcsFile, $stackPtr)
Chris@0 49 {
Chris@0 50 $tokens = $phpcsFile->getTokens();
Chris@0 51
Chris@0 52 $comment = rtrim($tokens[$stackPtr]['content']);
Chris@0 53
Chris@0 54 // Only want inline comments.
Chris@0 55 if (substr($comment, 0, 2) !== '//') {
Chris@0 56 return;
Chris@0 57 }
Chris@0 58
Chris@0 59 // The line below the last comment cannot be empty.
Chris@0 60 for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
Chris@0 61 if ($tokens[$i]['line'] === ($tokens[$stackPtr]['line'] + 1)) {
Chris@0 62 if ($tokens[$i]['code'] !== T_WHITESPACE) {
Chris@0 63 return;
Chris@0 64 }
Chris@0 65 } else if ($tokens[$i]['line'] > ($tokens[$stackPtr]['line'] + 1)) {
Chris@0 66 break;
Chris@0 67 }
Chris@0 68 }
Chris@0 69
Chris@0 70 $warning = 'There must be no blank line following an inline comment';
Chris@0 71 $phpcsFile->addWarning($warning, $stackPtr, 'SpacingAfter');
Chris@0 72
Chris@0 73 }//end process()
Chris@0 74
Chris@0 75
Chris@0 76 }//end class