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