Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Commenting\PostStatementCommentSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Commenting;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@17:  * Largely copied from
Chris@17:  * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\PostStatementCommentSniff
Chris@17:  * but we want the fixer to move the comment to the previous line.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class PostStatementCommentSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * A list of tokenizers this sniff supports.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public $supportedTokenizers = array('PHP');
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_COMMENT);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this sniff, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token in the
Chris@17:      *                                               stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $commentLine = $tokens[$stackPtr]['line'];
Chris@0:         $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
Chris@0: 
Chris@0:         if ($tokens[$lastContent]['line'] !== $commentLine) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // Special case for JS files.
Chris@0:         if ($tokens[$lastContent]['code'] === T_COMMA
Chris@0:             || $tokens[$lastContent]['code'] === T_SEMICOLON
Chris@0:         ) {
Chris@0:             $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($lastContent - 1), null, true);
Chris@0:             if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $error = 'Comments may not appear after statements';
Chris@0:         $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
Chris@0:         if ($fix === true) {
Chris@0:             if ($tokens[$lastContent]['code'] === T_OPEN_TAG) {
Chris@0:                 $phpcsFile->fixer->addNewlineBefore($stackPtr);
Chris@0:                 return;
Chris@0:             }
Chris@0: 
Chris@0:             $lineStart = $stackPtr;
Chris@0:             while ($tokens[$lineStart]['line'] === $tokens[$stackPtr]['line']
Chris@0:                 && $tokens[$lineStart]['code'] !== T_OPEN_TAG
Chris@0:             ) {
Chris@0:                 $lineStart--;
Chris@0:             }
Chris@0: 
Chris@0:             $phpcsFile->fixer->beginChangeset();
Chris@0:             $phpcsFile->fixer->addContent($lineStart, $tokens[$stackPtr]['content']);
Chris@0:             $phpcsFile->fixer->replaceToken($stackPtr, $phpcsFile->eolChar);
Chris@0:             $phpcsFile->fixer->endChangeset();
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class