-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
LanguageConstructSpacingSniff.php
146 lines (125 loc) · 5.13 KB
/
LanguageConstructSpacingSniff.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
<?php
/**
* Ensures all language constructs contain a single space between themselves and their content.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2017 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\Generic\Sniffs\WhiteSpace;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Common;
use PHP_CodeSniffer\Util\Tokens;
class LanguageConstructSpacingSniff implements Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return [
T_ECHO,
T_PRINT,
T_RETURN,
T_INCLUDE,
T_INCLUDE_ONCE,
T_REQUIRE,
T_REQUIRE_ONCE,
T_NEW,
T_YIELD,
T_YIELD_FROM,
T_THROW,
T_NAMESPACE,
T_USE,
];
}//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)
{
$tokens = $phpcsFile->getTokens();
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
if ($nextToken === false) {
// Skip when at end of file.
return;
}
if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) {
// No content for this language construct.
return;
}
$content = $tokens[$stackPtr]['content'];
if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
if ($nextNonEmpty !== false && $tokens[$nextNonEmpty]['code'] === T_NS_SEPARATOR) {
// Namespace keyword used as operator, not as the language construct.
return;
}
}
if ($tokens[$stackPtr]['code'] === T_YIELD_FROM
&& strtolower($content) !== 'yield from'
) {
if ($tokens[($stackPtr - 1)]['code'] === T_YIELD_FROM) {
// A multi-line statements that has already been processed.
return;
}
$found = $content;
if ($tokens[($stackPtr + 1)]['code'] === T_YIELD_FROM) {
// This yield from statement is split over multiple lines.
$i = ($stackPtr + 1);
do {
$found .= $tokens[$i]['content'];
$i++;
} while ($tokens[$i]['code'] === T_YIELD_FROM);
}
$error = 'Language constructs must be followed by a single space; expected 1 space between YIELD FROM found "%s"';
$data = [Common::prepareForOutput($found)];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);
if ($fix === true) {
preg_match('/yield/i', $found, $yield);
preg_match('/from/i', $found, $from);
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->replaceToken($stackPtr, $yield[0].' '.$from[0]);
if ($tokens[($stackPtr + 1)]['code'] === T_YIELD_FROM) {
$i = ($stackPtr + 1);
do {
$phpcsFile->fixer->replaceToken($i, '');
$i++;
} while ($tokens[$i]['code'] === T_YIELD_FROM);
}
$phpcsFile->fixer->endChangeset();
}
return;
}//end if
if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
$content = $tokens[($stackPtr + 1)]['content'];
if ($content !== ' ') {
$error = 'Language constructs must be followed by a single space; expected 1 space but found "%s"';
$data = [Common::prepareForOutput($content)];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectSingle', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
}
}
} else if ($tokens[($stackPtr + 1)]['code'] !== T_OPEN_PARENTHESIS) {
$error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';
$data = [
$tokens[$stackPtr]['content'].' '.$tokens[($stackPtr + 1)]['content'],
$tokens[$stackPtr]['content'].$tokens[($stackPtr + 1)]['content'],
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
if ($fix === true) {
$phpcsFile->fixer->addContent($stackPtr, ' ');
}
}//end if
}//end process()
}//end class