-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
ForEachLoopDeclarationSniff.php
236 lines (208 loc) · 9.5 KB
/
ForEachLoopDeclarationSniff.php
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
<?php
/**
* Verifies that there is a space between each condition of foreach loops.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
class ForEachLoopDeclarationSniff implements Sniff
{
/**
* How many spaces should follow the opening bracket.
*
* @var integer
*/
public $requiredSpacesAfterOpen = 0;
/**
* How many spaces should precede the closing bracket.
*
* @var integer
*/
public $requiredSpacesBeforeClose = 0;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register()
{
return [T_FOREACH];
}//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\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(File $phpcsFile, $stackPtr)
{
$this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen;
$this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
$tokens = $phpcsFile->getTokens();
$openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
if ($openingBracket === false) {
$error = 'Possible parse error: FOREACH has no opening parenthesis';
$phpcsFile->addWarning($error, $stackPtr, 'MissingOpenParenthesis');
return;
}
if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) {
$error = 'Possible parse error: FOREACH has no closing parenthesis';
$phpcsFile->addWarning($error, $stackPtr, 'MissingCloseParenthesis');
return;
}
$closingBracket = $tokens[$openingBracket]['parenthesis_closer'];
if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
$error = 'Space found after opening bracket of FOREACH loop';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen');
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($openingBracket + 1), '');
}
} else if ($this->requiredSpacesAfterOpen > 0) {
$spaceAfterOpen = 0;
if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
$spaceAfterOpen = $tokens[($openingBracket + 1)]['length'];
}
if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
$error = 'Expected %s spaces after opening bracket; %s found';
$data = [
$this->requiredSpacesAfterOpen,
$spaceAfterOpen,
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterOpen', $data);
if ($fix === true) {
$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
if ($spaceAfterOpen === 0) {
$phpcsFile->fixer->addContent($openingBracket, $padding);
} else {
$phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding);
}
}
}
}//end if
if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
$error = 'Space found before closing bracket of FOREACH loop';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose');
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($closingBracket - 1), '');
}
} else if ($this->requiredSpacesBeforeClose > 0) {
$spaceBeforeClose = 0;
if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
$spaceBeforeClose = $tokens[($closingBracket - 1)]['length'];
}
if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
$error = 'Expected %s spaces before closing bracket; %s found';
$data = [
$this->requiredSpacesBeforeClose,
$spaceBeforeClose,
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data);
if ($fix === true) {
$padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
if ($spaceBeforeClose === 0) {
$phpcsFile->fixer->addContentBefore($closingBracket, $padding);
} else {
$phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding);
}
}
}
}//end if
$asToken = $phpcsFile->findNext(T_AS, $openingBracket);
if ($asToken === false) {
$error = 'Possible parse error: FOREACH has no AS statement';
$phpcsFile->addWarning($error, $stackPtr, 'MissingAs');
return;
}
$content = $tokens[$asToken]['content'];
if ($content !== strtolower($content)) {
$expected = strtolower($content);
$error = 'AS keyword must be lowercase; expected "%s" but found "%s"';
$data = [
$expected,
$content,
];
$fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken($asToken, $expected);
}
}
$doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket);
if ($doubleArrow !== false) {
if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space before "=>"; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow');
if ($fix === true) {
$phpcsFile->fixer->addContentBefore($doubleArrow, ' ');
}
} else {
if ($tokens[($doubleArrow - 1)]['length'] !== 1) {
$spaces = $tokens[($doubleArrow - 1)]['length'];
$error = 'Expected 1 space before "=>"; %s found';
$data = [$spaces];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' ');
}
}
}
if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space after "=>"; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow');
if ($fix === true) {
$phpcsFile->fixer->addContent($doubleArrow, ' ');
}
} else {
if ($tokens[($doubleArrow + 1)]['length'] !== 1) {
$spaces = $tokens[($doubleArrow + 1)]['length'];
$error = 'Expected 1 space after "=>"; %s found';
$data = [$spaces];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' ');
}
}
}
}//end if
if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space before "as"; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs');
if ($fix === true) {
$phpcsFile->fixer->addContentBefore($asToken, ' ');
}
} else {
if ($tokens[($asToken - 1)]['length'] !== 1) {
$spaces = $tokens[($asToken - 1)]['length'];
$error = 'Expected 1 space before "as"; %s found';
$data = [$spaces];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($asToken - 1), ' ');
}
}
}
if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space after "as"; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs');
if ($fix === true) {
$phpcsFile->fixer->addContent($asToken, ' ');
}
} else {
if ($tokens[($asToken + 1)]['length'] !== 1) {
$spaces = $tokens[($asToken + 1)]['length'];
$error = 'Expected 1 space after "as"; %s found';
$data = [$spaces];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($asToken + 1), ' ');
}
}
}
}//end process()
}//end class