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
|
<?php
/**
* A Sniff to enforce the use of IDENTICAL type operators rather than EQUAL operators.
*
* 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
*/
/**
* A Sniff to enforce the use of IDENTICAL type operators rather than EQUAL operators.
*
* The use of === true is enforced over implicit true statements,
* for example:
*
* <code>
* if ($a)
* {
* ...
* }
* </code>
*
* should be:
*
* <code>
* if ($a === true)
* {
* ...
* }
* </code>
*
* It also enforces the use of === false over ! operators.
*
* @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_Operators_ComparisonOperatorUsageSniff implements PHP_CodeSniffer_Sniff
{
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = array(
'PHP',
'JS',
);
/**
* A list of valid comparison operators.
*
* @var array
*/
private static $_validOps = array(
T_IS_IDENTICAL,
T_IS_NOT_IDENTICAL,
T_LESS_THAN,
T_GREATER_THAN,
T_IS_GREATER_OR_EQUAL,
T_IS_SMALLER_OR_EQUAL,
T_INSTANCEOF,
);
/**
* A list of invalid operators with their alternatives.
*
* @var array(int => string)
*/
private static $_invalidOps = array(
'PHP' => array(
T_IS_EQUAL => '===',
T_IS_NOT_EQUAL => '!==',
T_BOOLEAN_NOT => '=== FALSE',
),
'JS' => array(
T_IS_EQUAL => '===',
T_IS_NOT_EQUAL => '!==',
),
);
/**
* Registers the token types that this sniff wishes to listen to.
*
* @return array
*/
public function register()
{
return array(
T_IF,
T_INLINE_THEN,
);
}//end register()
/**
* Process the tokens that this sniff is listening for.
*
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
* @param int $stackPtr The position in the stack where the token
* was found.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
$tokenizer = $phpcsFile->tokenizerType;
if ($tokens[$stackPtr]['code'] === T_INLINE_THEN) {
$end = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
if ($tokens[$end]['code'] !== T_CLOSE_PARENTHESIS) {
// This inline IF statement does not have its condition
// bracketed, so we need to guess where it starts.
for ($i = ($end - 1); $i >= 0; $i--) {
if ($tokens[$i]['code'] === T_SEMICOLON) {
// Stop here as we assume it is the end
// of the previous statement.
break;
} else if ($tokens[$i]['code'] === T_OPEN_TAG) {
// Stop here as this is the start of the file.
break;
} else if ($tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET) {
// Stop if this is the closing brace of
// a code block.
if (isset($tokens[$i]['scope_opener']) === true) {
break;
}
} else if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) {
// Stop if this is the opening brace of
// a code block.
if (isset($tokens[$i]['scope_closer']) === true) {
break;
}
}
}//end for
$start = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($i + 1), null, true);
} else {
$start = $tokens[$end]['parenthesis_opener'];
}
} else {
$start = $tokens[$stackPtr]['parenthesis_opener'];
$end = $tokens[$stackPtr]['parenthesis_closer'];
}
$requiredOps = 0;
$foundOps = 0;
for ($i = $start; $i <= $end; $i++) {
$type = $tokens[$i]['code'];
if (in_array($type, array_keys(self::$_invalidOps[$tokenizer])) === true) {
$error = 'Operator %s prohibited; use %s instead';
$data = array(
$tokens[$i]['content'],
self::$_invalidOps[$tokenizer][$type],
);
$phpcsFile->addError($error, $i, 'NotAllowed', $data);
$foundOps++;
} else if (in_array($type, self::$_validOps) === true) {
$foundOps++;
}
if ($phpcsFile->tokenizerType !== 'JS') {
if ($tokens[$i]['code'] === T_BOOLEAN_AND || $tokens[$i]['code'] === T_BOOLEAN_OR) {
$requiredOps++;
// If we get to here and we have not found the right number of
// comparison operators, then we must have had an implicit
// true operation ie. if ($a) instead of the required
// if ($a === true), so let's add an error.
if ($requiredOps !== $foundOps) {
$error = 'Implicit true comparisons prohibited; use === TRUE instead';
$phpcsFile->addError($error, $stackPtr, 'ImplicitTrue');
$foundOps++;
}
}
}//end if
}//end for
$requiredOps++;
if ($phpcsFile->tokenizerType !== 'JS') {
if ($foundOps < $requiredOps) {
$error = 'Implicit true comparisons prohibited; use === TRUE instead';
$phpcsFile->addError($error, $stackPtr, 'ImplicitTrue');
}
}
}//end process()
}//end class
?>
|
