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
|
<?php
/**
* Squiz_Sniffs_ControlStructures_ForLoopDeclarationSniff.
*
* 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_ForLoopDeclarationSniff.
*
* Verifies that there is a space between each condition of for loops.
*
* @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_ControlStructures_ForLoopDeclarationSniff implements PHP_CodeSniffer_Sniff
{
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = array(
'PHP',
'JS',
);
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_FOR);
}//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();
$openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
if ($openingBracket === false) {
$error = 'Possible parse error: no opening parenthesis for FOR keyword';
$phpcsFile->addWarning($error, $stackPtr, 'NoOpenBracket');
return;
}
$closingBracket = $tokens[$openingBracket]['parenthesis_closer'];
if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
$error = 'Space found after opening bracket of FOR loop';
$phpcsFile->addError($error, $stackPtr, 'SpacingAfterOpen');
}
if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
$error = 'Space found before closing bracket of FOR loop';
$phpcsFile->addError($error, $stackPtr, 'SpacingBeforeClose');
}
$firstSemicolon = $phpcsFile->findNext(T_SEMICOLON, $openingBracket, $closingBracket);
// Check whitespace around each of the tokens.
if ($firstSemicolon !== false) {
if ($tokens[($firstSemicolon - 1)]['code'] === T_WHITESPACE) {
$error = 'Space found before first semicolon of FOR loop';
$phpcsFile->addError($error, $stackPtr, 'SpacingBeforeFirst');
}
if ($tokens[($firstSemicolon + 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space after first semicolon of FOR loop; 0 found';
$phpcsFile->addError($error, $stackPtr, 'NoSpaceAfterFirst');
} else {
if (strlen($tokens[($firstSemicolon + 1)]['content']) !== 1) {
$spaces = strlen($tokens[($firstSemicolon + 1)]['content']);
$error = 'Expected 1 space after first semicolon of FOR loop; %s found';
$data = array($spaces);
$phpcsFile->addError($error, $stackPtr, 'SpacingAfterFirst', $data);
}
}
$secondSemicolon = $phpcsFile->findNext(T_SEMICOLON, ($firstSemicolon + 1));
if ($secondSemicolon !== false) {
if ($tokens[($secondSemicolon - 1)]['code'] === T_WHITESPACE) {
$error = 'Space found before second semicolon of FOR loop';
$phpcsFile->addError($error, $stackPtr, 'SpacingBeforeSecond');
}
if ($tokens[($secondSemicolon + 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space after second semicolon of FOR loop; 0 found';
$phpcsFile->addError($error, $stackPtr, 'NoSpaceAfterSecond');
} else {
if (strlen($tokens[($secondSemicolon + 1)]['content']) !== 1) {
$spaces = strlen($tokens[($firstSemicolon + 1)]['content']);
$error = 'Expected 1 space after second semicolon of FOR loop; %s found';
$data = array($spaces);
$phpcsFile->addError($error, $stackPtr, 'SpacingAfterSecond', $data);
}
}
}//end if
}//end if
}//end process()
}//end class
?>
|
