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
|
<?php
/**
* Squiz_Sniffs_PHP_InnerFunctionsSniff.
*
* 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_PHP_NonExecutableCodeSniff.
*
* Warns about code that can never been executed. This happens when a function
* returns before the code, or a break ends execution of a statement etc.
*
* @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.3
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Squiz_Sniffs_PHP_NonExecutableCodeSniff implements PHP_CodeSniffer_Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(
T_BREAK,
T_CONTINUE,
T_RETURN,
T_THROW,
T_EXIT,
);
}//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();
// Collect closure function parenthesises to use later for supressing some errors.
$closureReturnParenthesises = array();
$closureToken = $phpcsFile->findNext(T_CLOSURE, $stackPtr);
if ($closureToken !== false) {
$closureToken--;
while (($closureToken = $phpcsFile->findNext(T_CLOSURE, ($closureToken + 1))) !== false) {
$closureEndToken = $tokens[$closureToken]['scope_closer'];
$parenthesis = $phpcsFile->findNext(T_RETURN, $closureToken, $closureEndToken);
if (isset($tokens[$parenthesis]['nested_parenthesis']) === true) {
$closureReturnParenthesises[] = $tokens[$parenthesis]['nested_parenthesis'];
}
}
}
if ($tokens[$stackPtr]['code'] === T_RETURN) {
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
if ($tokens[$next]['code'] === T_SEMICOLON) {
$next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
if ($tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) {
// If this is the closing brace of a function
// then this return statement doesn't return anything
// and is not required anyway.
$owner = $tokens[$next]['scope_condition'];
if ($tokens[$owner]['code'] === T_FUNCTION) {
$warning = 'Empty return statement not required here';
$phpcsFile->addWarning($warning, $stackPtr, 'ReturnNotRequired');
return;
}
}
}
}
if ($tokens[$stackPtr]['code'] === T_BREAK
&& isset($tokens[$stackPtr]['scope_opener']) === true
) {
// This break closes the scope of a CASE or DEFAULT statement
// so any code between this token and the next CASE, DEFAULT or
// end of SWITCH token will not be executable.
$next = $phpcsFile->findNext(
array(T_CASE, T_DEFAULT, T_CLOSE_CURLY_BRACKET),
($stackPtr + 1)
);
if ($next !== false) {
$lastLine = $tokens[($stackPtr + 1)]['line'];
for ($i = ($stackPtr + 1); $i < $next; $i++) {
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
continue;
}
$line = $tokens[$i]['line'];
if ($line > $lastLine) {
$type = substr($tokens[$stackPtr]['type'], 2);
$warning = 'Code after %s statement cannot be executed';
$data = array($type);
$phpcsFile->addWarning($warning, $i, 'Unreachable', $data);
$lastLine = $line;
}
}
}//end if
// That's all we have to check for these types of BREAK statements.
return;
}//end if
// This token may be part of an inline condition.
// If we find a closing parenthesis that belongs to a condition
// we should ignore this token.
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
if (isset($tokens[$prev]['parenthesis_owner']) === true) {
$owner = $tokens[$prev]['parenthesis_owner'];
$ignore = array(
T_IF,
T_ELSE,
T_ELSEIF,
);
if (in_array($tokens[$owner]['code'], $ignore) === true) {
return;
}
}
$ourConditions = array_keys($tokens[$stackPtr]['conditions']);
if (empty($ourConditions) === false) {
$condition = array_pop($ourConditions);
if (isset($tokens[$condition]['scope_closer']) === false) {
return;
}
$closer = $tokens[$condition]['scope_closer'];
// If the closer for our condition is shared with other openers,
// we will need to throw errors from this token to the next
// shared opener (if there is one), not to the scope closer.
$nextOpener = null;
for ($i = ($stackPtr + 1); $i < $closer; $i++) {
if (isset($tokens[$i]['scope_closer']) === true) {
if ($tokens[$i]['scope_closer'] === $closer) {
// We found an opener that shares the same
// closing token as us.
$nextOpener = $i;
break;
}
}
}//end for
$start = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
if ($nextOpener === null) {
$end = $closer;
} else {
$end = ($nextOpener - 1);
}
} else {
// This token is in the global scope.
if ($tokens[$stackPtr]['code'] === T_BREAK) {
return;
}
// Throw an error for all lines until the end of the file.
$start = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
$end = ($phpcsFile->numTokens - 1);
}//end if
$lastLine = $tokens[$start]['line'];
for ($i = ($start + 1); $i < $end; $i++) {
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === true
|| in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$bracketTokens) === true
) {
continue;
}
// Skip returns found in closure functions.
if (isset($tokens[$i]['nested_parenthesis']) === true
&& in_array($tokens[$i]['nested_parenthesis'], $closureReturnParenthesises) === true
) {
return;
}
// Skip whole functions and classes because they are not
// technically executed code, but rather declarations that may be used.
if ($tokens[$i]['code'] === T_FUNCTION || $tokens[$i]['code'] === T_CLASS) {
$i = $tokens[$i]['scope_closer'];
continue;
}
$line = $tokens[$i]['line'];
if ($line > $lastLine) {
$type = substr($tokens[$stackPtr]['type'], 2);
$warning = 'Code after %s statement cannot be executed';
$data = array($type);
$phpcsFile->addWarning($warning, $i, 'Unreachable', $data);
$lastLine = $line;
}
}//end for
}//end process()
}//end class
?>
|