Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\Commenting\PostStatementCommentSniff.
|
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\Commenting;
|
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@17
|
16 * Largely copied from
|
Chris@17
|
17 * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\PostStatementCommentSniff
|
Chris@17
|
18 * but we want the fixer to move the comment to the previous line.
|
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 PostStatementCommentSniff 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('PHP');
|
Chris@0
|
33
|
Chris@0
|
34
|
Chris@0
|
35 /**
|
Chris@0
|
36 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
37 *
|
Chris@0
|
38 * @return array
|
Chris@0
|
39 */
|
Chris@0
|
40 public function register()
|
Chris@0
|
41 {
|
Chris@0
|
42 return array(T_COMMENT);
|
Chris@0
|
43
|
Chris@0
|
44 }//end register()
|
Chris@0
|
45
|
Chris@0
|
46
|
Chris@0
|
47 /**
|
Chris@0
|
48 * Processes this sniff, when one of its tokens is encountered.
|
Chris@0
|
49 *
|
Chris@17
|
50 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
51 * @param int $stackPtr The position of the current token in the
|
Chris@17
|
52 * stack passed in $tokens.
|
Chris@0
|
53 *
|
Chris@0
|
54 * @return void
|
Chris@0
|
55 */
|
Chris@17
|
56 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
57 {
|
Chris@0
|
58 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
59
|
Chris@0
|
60 if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
|
Chris@0
|
61 return;
|
Chris@0
|
62 }
|
Chris@0
|
63
|
Chris@0
|
64 $commentLine = $tokens[$stackPtr]['line'];
|
Chris@0
|
65 $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
Chris@0
|
66
|
Chris@0
|
67 if ($tokens[$lastContent]['line'] !== $commentLine) {
|
Chris@0
|
68 return;
|
Chris@0
|
69 }
|
Chris@0
|
70
|
Chris@0
|
71 if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
|
Chris@0
|
72 return;
|
Chris@0
|
73 }
|
Chris@0
|
74
|
Chris@0
|
75 // Special case for JS files.
|
Chris@0
|
76 if ($tokens[$lastContent]['code'] === T_COMMA
|
Chris@0
|
77 || $tokens[$lastContent]['code'] === T_SEMICOLON
|
Chris@0
|
78 ) {
|
Chris@0
|
79 $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($lastContent - 1), null, true);
|
Chris@0
|
80 if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
|
Chris@0
|
81 return;
|
Chris@0
|
82 }
|
Chris@0
|
83 }
|
Chris@0
|
84
|
Chris@0
|
85 $error = 'Comments may not appear after statements';
|
Chris@0
|
86 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
|
Chris@0
|
87 if ($fix === true) {
|
Chris@0
|
88 if ($tokens[$lastContent]['code'] === T_OPEN_TAG) {
|
Chris@0
|
89 $phpcsFile->fixer->addNewlineBefore($stackPtr);
|
Chris@0
|
90 return;
|
Chris@0
|
91 }
|
Chris@0
|
92
|
Chris@0
|
93 $lineStart = $stackPtr;
|
Chris@0
|
94 while ($tokens[$lineStart]['line'] === $tokens[$stackPtr]['line']
|
Chris@0
|
95 && $tokens[$lineStart]['code'] !== T_OPEN_TAG
|
Chris@0
|
96 ) {
|
Chris@0
|
97 $lineStart--;
|
Chris@0
|
98 }
|
Chris@0
|
99
|
Chris@0
|
100 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
101 $phpcsFile->fixer->addContent($lineStart, $tokens[$stackPtr]['content']);
|
Chris@0
|
102 $phpcsFile->fixer->replaceToken($stackPtr, $phpcsFile->eolChar);
|
Chris@0
|
103 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
104 }
|
Chris@0
|
105
|
Chris@0
|
106 }//end process()
|
Chris@0
|
107
|
Chris@0
|
108
|
Chris@0
|
109 }//end class
|