annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.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@17 3 * \Drupal\Sniffs\Commenting\DocCommentStarSniff
Chris@0 4 *
Chris@0 5 * @category PHP
Chris@0 6 * @package PHP_CodeSniffer
Chris@0 7 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 8 */
Chris@0 9
Chris@17 10 namespace Drupal\Sniffs\Commenting;
Chris@17 11
Chris@17 12 use PHP_CodeSniffer\Files\File;
Chris@17 13 use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17 14
Chris@0 15 /**
Chris@0 16 * Checks that a doc comment block has a doc comment star on every line.
Chris@0 17 *
Chris@0 18 * @category PHP
Chris@0 19 * @package PHP_CodeSniffer
Chris@0 20 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 21 */
Chris@17 22 class DocCommentStarSniff implements Sniff
Chris@0 23 {
Chris@0 24
Chris@0 25
Chris@0 26 /**
Chris@0 27 * Returns an array of tokens this test wants to listen for.
Chris@0 28 *
Chris@0 29 * @return array
Chris@0 30 */
Chris@0 31 public function register()
Chris@0 32 {
Chris@0 33 return array(T_DOC_COMMENT_OPEN_TAG);
Chris@0 34
Chris@0 35 }//end register()
Chris@0 36
Chris@0 37
Chris@0 38 /**
Chris@0 39 * Processes this test, when one of its tokens is encountered.
Chris@0 40 *
Chris@17 41 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17 42 * @param int $stackPtr The position of the current token
Chris@17 43 * in the stack passed in $tokens.
Chris@0 44 *
Chris@0 45 * @return void
Chris@0 46 */
Chris@17 47 public function process(File $phpcsFile, $stackPtr)
Chris@0 48 {
Chris@0 49 $tokens = $phpcsFile->getTokens();
Chris@0 50
Chris@0 51 $lastLineChecked = $tokens[$stackPtr]['line'];
Chris@0 52 for ($i = ($stackPtr + 1); $i < ($tokens[$stackPtr]['comment_closer'] - 1); $i++) {
Chris@0 53 // We are only interested in the beginning of the line.
Chris@0 54 if ($tokens[$i]['line'] === $lastLineChecked) {
Chris@0 55 continue;
Chris@0 56 }
Chris@0 57
Chris@0 58 // The first token on the line must be a whitespace followed by a star.
Chris@0 59 if ($tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE) {
Chris@0 60 if ($tokens[($i + 1)]['code'] !== T_DOC_COMMENT_STAR) {
Chris@0 61 $error = 'Doc comment star missing';
Chris@0 62 $fix = $phpcsFile->addFixableError($error, $i, 'StarMissing');
Chris@0 63 if ($fix === true) {
Chris@0 64 if (strpos($tokens[$i]['content'], $phpcsFile->eolChar) !== false) {
Chris@0 65 $phpcsFile->fixer->replaceToken($i, str_repeat(' ', $tokens[$stackPtr]['column'])."* \n");
Chris@0 66 } else {
Chris@0 67 $phpcsFile->fixer->replaceToken($i, str_repeat(' ', $tokens[$stackPtr]['column']).'* ');
Chris@0 68 }
Chris@0 69
Chris@0 70 // Ordering of lines might have changed - stop here. The
Chris@0 71 // fixer will restart the sniff if there are remaining fixes.
Chris@0 72 return;
Chris@0 73 }
Chris@0 74 }
Chris@0 75 } else if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR) {
Chris@0 76 $error = 'Doc comment star missing';
Chris@0 77 $fix = $phpcsFile->addFixableError($error, $i, 'StarMissing');
Chris@0 78 if ($fix === true) {
Chris@0 79 $phpcsFile->fixer->addContentBefore($i, str_repeat(' ', $tokens[$stackPtr]['column']).'* ');
Chris@0 80 }
Chris@0 81 }//end if
Chris@0 82
Chris@0 83 $lastLineChecked = $tokens[$i]['line'];
Chris@0 84 }//end for
Chris@0 85
Chris@0 86 }//end process()
Chris@0 87
Chris@0 88
Chris@0 89 }//end class