Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\WhiteSpace\OpenBracketSpacingSniff.
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@0:  * Checks that there is no white space after an opening bracket, for "(" and "{".
Chris@17:  * Square Brackets are handled by
Chris@17:  * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayBracketSpacingSniff.
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 OpenBracketSpacingSniff 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(
Chris@0:                                    'PHP',
Chris@0:                                    'JS',
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(
Chris@0:                 T_OPEN_CURLY_BRACKET,
Chris@0:                 T_OPEN_PARENTHESIS,
Chris@0:                 T_OPEN_SHORT_ARRAY,
Chris@0:                );
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:         // Ignore curly brackets in javascript files.
Chris@0:         if ($tokens[$stackPtr]['code'] === T_OPEN_CURLY_BRACKET
Chris@0:             && $phpcsFile->tokenizerType === 'JS'
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($tokens[($stackPtr + 1)]) === true
Chris@0:             && $tokens[($stackPtr + 1)]['code'] === T_WHITESPACE
Chris@0:             && strpos($tokens[($stackPtr + 1)]['content'], $phpcsFile->eolChar) === false
Chris@0:             // Allow spaces in template files where the PHP close tag is used.
Chris@0:             && isset($tokens[($stackPtr + 2)]) === true
Chris@0:             && $tokens[($stackPtr + 2)]['code'] !== T_CLOSE_TAG
Chris@0:         ) {
Chris@0:             $error = 'There should be no white space after an opening "%s"';
Chris@0:             $fix   = $phpcsFile->addFixableError(
Chris@0:                 $error,
Chris@0:                 ($stackPtr + 1),
Chris@0:                 'OpeningWhitespace',
Chris@0:                 array($tokens[$stackPtr]['content'])
Chris@0:             );
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