Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@0
|
3 * Class Declaration Test.
|
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\Classes;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2ClassDeclarationSniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Class Declaration Test.
|
Chris@0
|
18 *
|
Chris@0
|
19 * Checks the declaration of the class is correct.
|
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 ClassDeclarationSniff extends PSR2ClassDeclarationSniff
|
Chris@0
|
26 {
|
Chris@0
|
27
|
Chris@0
|
28
|
Chris@0
|
29 /**
|
Chris@0
|
30 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
31 *
|
Chris@0
|
32 * @return array
|
Chris@0
|
33 */
|
Chris@0
|
34 public function register()
|
Chris@0
|
35 {
|
Chris@0
|
36 return array(
|
Chris@0
|
37 T_CLASS,
|
Chris@0
|
38 T_INTERFACE,
|
Chris@0
|
39 T_TRAIT,
|
Chris@0
|
40 );
|
Chris@0
|
41
|
Chris@0
|
42 }//end register()
|
Chris@0
|
43
|
Chris@0
|
44
|
Chris@0
|
45 /**
|
Chris@0
|
46 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
47 *
|
Chris@17
|
48 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
49 * @param integer $stackPtr The position of the current token in the
|
Chris@17
|
50 * stack passed in $tokens.
|
Chris@0
|
51 *
|
Chris@0
|
52 * @return void
|
Chris@0
|
53 */
|
Chris@17
|
54 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
55 {
|
Chris@0
|
56 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
57 $errorData = array(strtolower($tokens[$stackPtr]['content']));
|
Chris@0
|
58
|
Chris@0
|
59 if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
Chris@0
|
60 $error = 'Possible parse error: %s missing opening or closing brace';
|
Chris@0
|
61 $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);
|
Chris@0
|
62 return;
|
Chris@0
|
63 }
|
Chris@0
|
64
|
Chris@0
|
65 $openingBrace = $tokens[$stackPtr]['scope_opener'];
|
Chris@0
|
66
|
Chris@0
|
67 $next = $phpcsFile->findNext(T_WHITESPACE, ($openingBrace + 1), null, true);
|
Chris@0
|
68 if ($tokens[$next]['line'] === $tokens[$openingBrace]['line'] && $tokens[$next]['code'] !== T_CLOSE_CURLY_BRACKET) {
|
Chris@0
|
69 $error = 'Opening brace must be the last content on the line';
|
Chris@0
|
70 $fix = $phpcsFile->addFixableError($error, $openingBrace, 'ContentAfterBrace');
|
Chris@0
|
71 if ($fix === true) {
|
Chris@0
|
72 $phpcsFile->fixer->addNewline($openingBrace);
|
Chris@0
|
73 }
|
Chris@0
|
74 }
|
Chris@0
|
75
|
Chris@0
|
76 $previous = $phpcsFile->findPrevious(T_WHITESPACE, ($openingBrace - 1), null, true);
|
Chris@0
|
77 $decalrationLine = $tokens[$previous]['line'];
|
Chris@0
|
78 $braceLine = $tokens[$openingBrace]['line'];
|
Chris@0
|
79
|
Chris@0
|
80 $lineDifference = ($braceLine - $decalrationLine);
|
Chris@0
|
81
|
Chris@0
|
82 if ($lineDifference > 0) {
|
Chris@0
|
83 $error = 'Opening brace should be on the same line as the declaration';
|
Chris@0
|
84 $fix = $phpcsFile->addFixableError($error, $openingBrace, 'BraceOnNewLine');
|
Chris@0
|
85 if ($fix === true) {
|
Chris@0
|
86 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
87 for ($i = ($previous + 1); $i < $openingBrace; $i++) {
|
Chris@0
|
88 $phpcsFile->fixer->replaceToken($i, '');
|
Chris@0
|
89 }
|
Chris@0
|
90
|
Chris@0
|
91 $phpcsFile->fixer->addContent($previous, ' ');
|
Chris@0
|
92 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
93 }
|
Chris@0
|
94
|
Chris@0
|
95 return;
|
Chris@0
|
96 }
|
Chris@0
|
97
|
Chris@0
|
98 $openingBrace = $tokens[$stackPtr]['scope_opener'];
|
Chris@0
|
99 if ($tokens[($openingBrace - 1)]['code'] !== T_WHITESPACE) {
|
Chris@0
|
100 $length = 0;
|
Chris@0
|
101 } else if ($tokens[($openingBrace - 1)]['content'] === "\t") {
|
Chris@0
|
102 $length = '\t';
|
Chris@0
|
103 } else {
|
Chris@0
|
104 $length = strlen($tokens[($openingBrace - 1)]['content']);
|
Chris@0
|
105 }
|
Chris@0
|
106
|
Chris@0
|
107 if ($length !== 1) {
|
Chris@0
|
108 $error = 'Expected 1 space before opening brace; found %s';
|
Chris@0
|
109 $data = array($length);
|
Chris@0
|
110 $fix = $phpcsFile->addFixableError($error, $openingBrace, 'SpaceBeforeBrace', $data);
|
Chris@0
|
111 if ($fix === true) {
|
Chris@0
|
112 if ($length === 0) {
|
Chris@0
|
113 $phpcsFile->fixer->replaceToken(($openingBrace), ' {');
|
Chris@0
|
114 } else {
|
Chris@0
|
115 $phpcsFile->fixer->replaceToken(($openingBrace - 1), ' ');
|
Chris@0
|
116 }
|
Chris@0
|
117 }
|
Chris@0
|
118 }
|
Chris@0
|
119
|
Chris@0
|
120 // Now call the open spacing method from PSR2.
|
Chris@0
|
121 $this->processOpen($phpcsFile, $stackPtr);
|
Chris@0
|
122
|
Chris@0
|
123 $this->processClose($phpcsFile, $stackPtr);
|
Chris@0
|
124
|
Chris@0
|
125 }//end process()
|
Chris@0
|
126
|
Chris@0
|
127
|
Chris@0
|
128 /**
|
Chris@0
|
129 * Processes the closing section of a class declaration.
|
Chris@0
|
130 *
|
Chris@17
|
131 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
132 * @param int $stackPtr The position of the current token
|
Chris@17
|
133 * in the stack passed in $tokens.
|
Chris@0
|
134 *
|
Chris@0
|
135 * @return void
|
Chris@0
|
136 */
|
Chris@17
|
137 public function processClose(File $phpcsFile, $stackPtr)
|
Chris@0
|
138 {
|
Chris@0
|
139 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
140
|
Chris@0
|
141 // Just in case.
|
Chris@0
|
142 if (isset($tokens[$stackPtr]['scope_closer']) === false) {
|
Chris@0
|
143 return;
|
Chris@0
|
144 }
|
Chris@0
|
145
|
Chris@0
|
146 // Check that the closing brace comes right after the code body.
|
Chris@0
|
147 $closeBrace = $tokens[$stackPtr]['scope_closer'];
|
Chris@0
|
148 $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), null, true);
|
Chris@0
|
149 if ($prevContent !== $tokens[$stackPtr]['scope_opener']
|
Chris@0
|
150 && $tokens[$prevContent]['line'] !== ($tokens[$closeBrace]['line'] - 2)
|
Chris@0
|
151 // If the class only contains a comment no extra line is needed.
|
Chris@17
|
152 && isset(Tokens::$commentTokens[$tokens[$prevContent]['code']]) === false
|
Chris@0
|
153 ) {
|
Chris@0
|
154 $error = 'The closing brace for the %s must have an empty line before it';
|
Chris@0
|
155 $data = array($tokens[$stackPtr]['content']);
|
Chris@0
|
156 $fix = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceAfterBody', $data);
|
Chris@0
|
157
|
Chris@0
|
158 if ($fix === true) {
|
Chris@0
|
159 $phpcsFile->fixer->beginChangeset();
|
Chris@0
|
160 for ($i = ($prevContent + 1); $i < $closeBrace; $i++) {
|
Chris@0
|
161 $phpcsFile->fixer->replaceToken($i, '');
|
Chris@0
|
162 }
|
Chris@0
|
163
|
Chris@0
|
164 $phpcsFile->fixer->replaceToken($closeBrace, $phpcsFile->eolChar.$phpcsFile->eolChar.$tokens[$closeBrace]['content']);
|
Chris@0
|
165
|
Chris@0
|
166 $phpcsFile->fixer->endChangeset();
|
Chris@0
|
167 }
|
Chris@0
|
168 }//end if
|
Chris@0
|
169
|
Chris@0
|
170 // Check the closing brace is on it's own line, but allow
|
Chris@0
|
171 // for comments like "//end class".
|
Chris@0
|
172 $nextContent = $phpcsFile->findNext(T_COMMENT, ($closeBrace + 1), null, true);
|
Chris@0
|
173 if ($tokens[$nextContent]['content'] !== $phpcsFile->eolChar
|
Chris@0
|
174 && $tokens[$nextContent]['line'] === $tokens[$closeBrace]['line']
|
Chris@0
|
175 ) {
|
Chris@0
|
176 $type = strtolower($tokens[$stackPtr]['content']);
|
Chris@0
|
177 $error = 'Closing %s brace must be on a line by itself';
|
Chris@0
|
178 $data = array($tokens[$stackPtr]['content']);
|
Chris@0
|
179 $phpcsFile->addError($error, $closeBrace, 'CloseBraceSameLine', $data);
|
Chris@0
|
180 }
|
Chris@0
|
181
|
Chris@0
|
182 }//end processClose()
|
Chris@0
|
183
|
Chris@0
|
184
|
Chris@0
|
185 }//end class
|