Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\WhiteSpace\CommaSniff.
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\WhiteSpace;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\WhiteSpace\CommaSniff.
Chris@0:  *
Chris@0:  * Checks that there is one space after a comma.
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 CommaSniff implements Sniff
Chris@0: {
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_COMMA);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, 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
Chris@17:      *                                               in the 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 (isset($tokens[($stackPtr + 1)]) === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE
Chris@0:             && $tokens[($stackPtr + 1)]['code'] !== T_COMMA
Chris@0:             && $tokens[($stackPtr + 1)]['code'] !== T_CLOSE_PARENTHESIS
Chris@0:         ) {
Chris@0:             $error = 'Expected one space after the comma, 0 found';
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpace');
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->addContent($stackPtr, ' ');
Chris@0:             }
Chris@0: 
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE
Chris@0:             && isset($tokens[($stackPtr + 2)]) === true
Chris@0:             && $tokens[($stackPtr + 2)]['line'] === $tokens[($stackPtr + 1)]['line']
Chris@0:             && $tokens[($stackPtr + 1)]['content'] !== ' '
Chris@0:         ) {
Chris@0:             $error = 'Expected one space after the comma, %s found';
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'TooManySpaces', array(strlen($tokens[($stackPtr + 1)]['content'])));
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class