annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.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\WhiteSpace\OpenBracketSpacingSniff.
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\WhiteSpace;
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 there is no white space after an opening bracket, for "(" and "{".
Chris@17 17 * Square Brackets are handled by
Chris@17 18 * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayBracketSpacingSniff.
Chris@0 19 *
Chris@0 20 * @category PHP
Chris@0 21 * @package PHP_CodeSniffer
Chris@0 22 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 23 */
Chris@17 24 class OpenBracketSpacingSniff implements Sniff
Chris@0 25 {
Chris@0 26
Chris@0 27 /**
Chris@0 28 * A list of tokenizers this sniff supports.
Chris@0 29 *
Chris@0 30 * @var array
Chris@0 31 */
Chris@0 32 public $supportedTokenizers = array(
Chris@0 33 'PHP',
Chris@0 34 'JS',
Chris@0 35 );
Chris@0 36
Chris@0 37
Chris@0 38 /**
Chris@0 39 * Returns an array of tokens this test wants to listen for.
Chris@0 40 *
Chris@0 41 * @return array
Chris@0 42 */
Chris@0 43 public function register()
Chris@0 44 {
Chris@0 45 return array(
Chris@0 46 T_OPEN_CURLY_BRACKET,
Chris@0 47 T_OPEN_PARENTHESIS,
Chris@0 48 T_OPEN_SHORT_ARRAY,
Chris@0 49 );
Chris@0 50
Chris@0 51 }//end register()
Chris@0 52
Chris@0 53
Chris@0 54 /**
Chris@0 55 * Processes this test, when one of its tokens is encountered.
Chris@0 56 *
Chris@17 57 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17 58 * @param int $stackPtr The position of the current token
Chris@17 59 * in the stack passed in $tokens.
Chris@0 60 *
Chris@0 61 * @return void
Chris@0 62 */
Chris@17 63 public function process(File $phpcsFile, $stackPtr)
Chris@0 64 {
Chris@0 65 $tokens = $phpcsFile->getTokens();
Chris@0 66
Chris@0 67 // Ignore curly brackets in javascript files.
Chris@0 68 if ($tokens[$stackPtr]['code'] === T_OPEN_CURLY_BRACKET
Chris@0 69 && $phpcsFile->tokenizerType === 'JS'
Chris@0 70 ) {
Chris@0 71 return;
Chris@0 72 }
Chris@0 73
Chris@0 74 if (isset($tokens[($stackPtr + 1)]) === true
Chris@0 75 && $tokens[($stackPtr + 1)]['code'] === T_WHITESPACE
Chris@0 76 && strpos($tokens[($stackPtr + 1)]['content'], $phpcsFile->eolChar) === false
Chris@0 77 // Allow spaces in template files where the PHP close tag is used.
Chris@0 78 && isset($tokens[($stackPtr + 2)]) === true
Chris@0 79 && $tokens[($stackPtr + 2)]['code'] !== T_CLOSE_TAG
Chris@0 80 ) {
Chris@0 81 $error = 'There should be no white space after an opening "%s"';
Chris@0 82 $fix = $phpcsFile->addFixableError(
Chris@0 83 $error,
Chris@0 84 ($stackPtr + 1),
Chris@0 85 'OpeningWhitespace',
Chris@0 86 array($tokens[$stackPtr]['content'])
Chris@0 87 );
Chris@0 88 if ($fix === true) {
Chris@0 89 $phpcsFile->fixer->replaceToken(($stackPtr + 1), '');
Chris@0 90 }
Chris@0 91 }
Chris@0 92
Chris@0 93 }//end process()
Chris@0 94
Chris@0 95
Chris@0 96 }//end class