1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
<?php
/**
* Class Declaration Test.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
if (class_exists('PEAR_Sniffs_Classes_ClassDeclarationSniff', true) === false) {
$error = 'Class PEAR_Sniffs_Classes_ClassDeclarationSniff not found';
throw new PHP_CodeSniffer_Exception($error);
}
/**
* Class Declaration Test.
*
* Checks the declaration of the class and its inheritance is correct.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version Release: 1.3.4
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Squiz_Sniffs_Classes_ClassDeclarationSniff extends PEAR_Sniffs_Classes_ClassDeclarationSniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(
T_CLASS,
T_INTERFACE,
);
}//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
// We want all the errors from the PEAR standard, plus some of our own.
parent::process($phpcsFile, $stackPtr);
$tokens = $phpcsFile->getTokens();
/*
Check that this is the only class or interface in the file.
*/
$nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE), ($stackPtr + 1));
if ($nextClass !== false) {
// We have another, so an error is thrown.
$error = 'Only one interface or class is allowed in a file';
$phpcsFile->addError($error, $nextClass, 'MultipleClasses');
}
/*
Check alignment of the keyword and braces.
*/
if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
$prevContent = $tokens[($stackPtr - 1)]['content'];
if ($prevContent !== $phpcsFile->eolChar) {
$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
$spaces = strlen($blankSpace);
if (in_array($tokens[($stackPtr - 2)]['code'], array(T_ABSTRACT, T_FINAL)) === false) {
if ($spaces !== 0) {
$type = strtolower($tokens[$stackPtr]['content']);
$error = 'Expected 0 spaces before %s keyword; %s found';
$data = array(
$type,
$spaces,
);
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeKeyword', $data);
}
} else {
if ($spaces !== 1) {
$type = strtolower($tokens[$stackPtr]['content']);
$prevContent = strtolower($tokens[($stackPtr - 2)]['content']);
$error = 'Expected 1 space between %s and %s keywords; %s found';
$data = array(
$prevContent,
$type,
$spaces,
);
$phpcsFile->addError($error, $stackPtr, 'SpacesBeforeKeyword', $data);
}
}
}
}//end if
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
$error = 'Possible parse error: %s missing opening or closing brace';
$data = array($tokens[$stackPtr]['content']);
$phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data);
return;
}
$closeBrace = $tokens[$stackPtr]['scope_closer'];
if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) {
$prevContent = $tokens[($closeBrace - 1)]['content'];
if ($prevContent !== $phpcsFile->eolChar) {
$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
$spaces = strlen($blankSpace);
if ($spaces !== 0) {
if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) {
$error = 'Expected 0 spaces before closing brace; newline found';
$phpcsFile->addError($error, $closeBrace, 'NewLineBeforeCloseBrace');
} else {
$error = 'Expected 0 spaces before closing brace; %s found';
$data = array($spaces);
$phpcsFile->addError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);
}
}
}
}
// Check that the closing brace has one blank line after it.
$nextContent = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($closeBrace + 1), null, true);
if ($nextContent === false) {
// No content found, so we reached the end of the file.
// That means there was no closing tag either.
$error = 'Closing brace of a %s must be followed by a blank line and then a closing PHP tag';
$data = array($tokens[$stackPtr]['content']);
$phpcsFile->addError($error, $closeBrace, 'EndFileAfterCloseBrace', $data);
} else {
$nextLine = $tokens[$nextContent]['line'];
$braceLine = $tokens[$closeBrace]['line'];
if ($braceLine === $nextLine) {
$error = 'Closing brace of a %s must be followed by a single blank line';
$data = array($tokens[$stackPtr]['content']);
$phpcsFile->addError($error, $closeBrace, 'NoNewlineAfterCloseBrace', $data);
} else if ($nextLine !== ($braceLine + 2)) {
$difference = ($nextLine - $braceLine - 1);
$error = 'Closing brace of a %s must be followed by a single blank line; found %s';
$data = array(
$tokens[$stackPtr]['content'],
$difference,
);
$phpcsFile->addError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);
}
}//end if
// Check the closing brace is on it's own line, but allow
// for comments like "//end class".
$nextContent = $phpcsFile->findNext(T_COMMENT, ($closeBrace + 1), null, true);
if ($tokens[$nextContent]['content'] !== $phpcsFile->eolChar && $tokens[$nextContent]['line'] === $tokens[$closeBrace]['line']) {
$type = strtolower($tokens[$stackPtr]['content']);
$error = 'Closing %s brace must be on a line by itself';
$data = array($tokens[$stackPtr]['content']);
$phpcsFile->addError($error, $closeBrace, 'CloseBraceSameLine', $data);
}
/*
Check that each of the parent classes or interfaces specified
are spaced correctly.
*/
// We need to map out each of the possible tokens in the declaration.
$keyword = $stackPtr;
$openingBrace = $tokens[$stackPtr]['scope_opener'];
$className = $phpcsFile->findNext(T_STRING, $stackPtr);
/*
Now check the spacing of each token.
*/
$name = strtolower($tokens[$keyword]['content']);
// Spacing of the keyword.
$gap = $tokens[($stackPtr + 1)]['content'];
if (strlen($gap) !== 1) {
$found = strlen($gap);
$error = 'Expected 1 space between %s keyword and %s name; %s found';
$data = array(
$name,
$name,
$found,
);
$phpcsFile->addError($error, $stackPtr, 'SpaceAfterKeyword', $data);
}
// Check after the name.
$gap = $tokens[($className + 1)]['content'];
if (strlen($gap) !== 1) {
$found = strlen($gap);
$error = 'Expected 1 space after %s name; %s found';
$data = array(
$name,
$found,
);
$phpcsFile->addError($error, $stackPtr, 'SpaceAfterName', $data);
}
// Now check each of the parents.
$parents = array();
$nextParent = ($className + 1);
while (($nextParent = $phpcsFile->findNext(array(T_STRING, T_IMPLEMENTS), ($nextParent + 1), ($openingBrace - 1))) !== false) {
$parents[] = $nextParent;
}
$parentCount = count($parents);
for ($i = 0; $i < $parentCount; $i++) {
if ($tokens[$parents[$i]]['code'] === T_IMPLEMENTS) {
continue;
}
if ($tokens[($parents[$i] - 1)]['code'] === T_COMMA
|| ($tokens[($parents[$i] - 1)]['code'] === T_NS_SEPARATOR
&& $tokens[($parents[$i] - 2)]['code'] === T_COMMA)
) {
$name = $tokens[$parents[$i]]['content'];
$error = 'Expected 1 space before "%s"; 0 found';
$data = array($name);
$phpcsFile->addError($error, ($nextComma + 1), 'NoSpaceBeforeName', $data);
} else {
$spaceBefore = strlen($tokens[($parents[$i] - 1)]['content']);
if ($spaceBefore !== 1) {
$name = $tokens[$parents[$i]]['content'];
$error = 'Expected 1 space before "%s"; %s found';
$data = array(
$name,
$spaceBefore,
);
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeName', $data);
}
}
if ($tokens[($parents[$i] + 1)]['code'] !== T_COMMA) {
if ($i !== ($parentCount - 1)) {
// This is not the last parent, and the comma
// is not where we expect it to be.
if ($tokens[($parents[$i] + 2)]['code'] !== T_IMPLEMENTS) {
$found = strlen($tokens[($parents[$i] + 1)]['content']);
$name = $tokens[$parents[$i]]['content'];
$error = 'Expected 0 spaces between "%s" and comma; $%s found';
$data = array(
$name,
$found,
);
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeComma', $data);
}
}
$nextComma = $phpcsFile->findNext(T_COMMA, $parents[$i]);
} else {
$nextComma = ($parents[$i] + 1);
}
}//end for
}//end process()
}//end class
?>
|
