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
|
<?php
/**
* Squiz_Sniffs_ControlStructures_LongConditionClosingCommentSniff.
*
* 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
*/
/**
* Squiz_Sniffs_ControlStructures_LongConditionClosingCommentSniff.
*
* @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_Commenting_LongConditionClosingCommentSniff implements PHP_CodeSniffer_Sniff
{
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = array(
'PHP',
'JS',
);
/**
* The openers that we are interested in.
*
* @var array(int)
*/
private static $_openers = array(
T_SWITCH,
T_IF,
T_FOR,
T_FOREACH,
T_WHILE,
T_TRY,
T_CASE,
);
/**
* The length that a code block must be before
* requiring a closing comment.
*
* @var int
*/
protected $lineLimit = 20;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_CLOSE_CURLY_BRACKET);
}//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)
{
$tokens = $phpcsFile->getTokens();
if (isset($tokens[$stackPtr]['scope_condition']) === false) {
// No scope condition. It is a function closer.
return;
}
$startCondition = $tokens[$tokens[$stackPtr]['scope_condition']];
$startBrace = $tokens[$tokens[$stackPtr]['scope_opener']];
$endBrace = $tokens[$stackPtr];
// We are only interested in some code blocks.
if (in_array($startCondition['code'], self::$_openers) === false) {
return;
}
if ($startCondition['code'] === T_IF) {
// If this is actually and ELSE IF, skip it as the brace
// will be checked by the original IF.
$else = $phpcsFile->findPrevious(T_WHITESPACE, ($tokens[$stackPtr]['scope_condition'] - 1), null, true);
if ($tokens[$else]['code'] === T_ELSE) {
return;
}
// IF statements that have an ELSE block need to use
// "end if" rather than "end else" or "end elseif".
do {
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
if ($tokens[$nextToken]['code'] === T_ELSE || $tokens[$nextToken]['code'] === T_ELSEIF) {
// Check for ELSE IF (2 tokens) as opposed to ELSEIF (1 token).
if ($tokens[$nextToken]['code'] === T_ELSE
&& isset($tokens[$nextToken]['scope_closer']) === false
) {
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true);
if ($tokens[$nextToken]['code'] !== T_IF
|| isset($tokens[$nextToken]['scope_closer']) === false
) {
// Not an ELSE IF or is an inline ELSE IF.
break;
}
}
// The end brace becomes the ELSE's end brace.
$stackPtr = $tokens[$nextToken]['scope_closer'];
$endBrace = $tokens[$stackPtr];
} else {
break;
}
} while (isset($tokens[$nextToken]['scope_closer']) === true);
}//end if
if ($startCondition['code'] === T_TRY) {
// TRY statements need to check until the end of all CATCH statements.
do {
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
if ($tokens[$nextToken]['code'] === T_CATCH) {
// The end brace becomes the CATCH's end brace.
$stackPtr = $tokens[$nextToken]['scope_closer'];
$endBrace = $tokens[$stackPtr];
} else {
break;
}
} while (isset($tokens[$nextToken]['scope_closer']) === true);
}
$lineDifference = ($endBrace['line'] - $startBrace['line']);
$expected = '//end '.$startCondition['content'];
$comment = $phpcsFile->findNext(array(T_COMMENT), $stackPtr, null, false);
if (($comment === false) || ($tokens[$comment]['line'] !== $endBrace['line'])) {
if ($lineDifference >= $this->lineLimit) {
$error = 'End comment for long condition not found; expected "%s"';
$data = array($expected);
$phpcsFile->addError($error, $stackPtr, 'Missing', $data);
}
return;
}
if (($comment - $stackPtr) !== 1) {
$error = 'Space found before closing comment; expected "%s"';
$data = array($expected);
$phpcsFile->addError($error, $stackPtr, 'SpacingBefore', $data);
}
if (trim($tokens[$comment]['content']) !== $expected) {
$found = trim($tokens[$comment]['content']);
$error = 'Incorrect closing comment; expected "%s" but found "%s"';
$data = array(
$expected,
$found,
);
$phpcsFile->addError($error, $stackPtr, 'Invalid', $data);
return;
}
}//end process()
}//end class
?>
|
