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
|
<?php
/**
* PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@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
*/
/**
* PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff.
*
* Checks that object operators are indented 4 spaces if they are the first
* thing on a line.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@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 PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff implements PHP_CodeSniffer_Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_OBJECT_OPERATOR);
}//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document.
* @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();
// Make sure this is the first object operator in a chain of them.
$varToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
if ($varToken === false || $tokens[$varToken]['code'] !== T_VARIABLE) {
return;
}
// Make sure this is a chained call.
$next = $phpcsFile->findNext(
T_OBJECT_OPERATOR,
($stackPtr + 1),
null,
false,
null,
true
);
if ($next === false) {
// Not a chained call.
return;
}
// Determine correct indent.
for ($i = ($varToken - 1); $i >= 0; $i--) {
if ($tokens[$i]['line'] !== $tokens[$varToken]['line']) {
$i++;
break;
}
}
$requiredIndent = 0;
if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
$requiredIndent = strlen($tokens[$i]['content']);
}
$requiredIndent += 4;
// Determine the scope of the original object operator.
$origBrackets = null;
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
$origBrackets = $tokens[$stackPtr]['nested_parenthesis'];
}
$origConditions = null;
if (isset($tokens[$stackPtr]['conditions']) === true) {
$origConditions = $tokens[$stackPtr]['conditions'];
}
// Check indentation of each object operator in the chain.
// If the first object operator is on a different line than
// the variable, make sure we check its indentation too.
if ($tokens[$stackPtr]['line'] > $tokens[$varToken]['line']) {
$next = $stackPtr;
}
while ($next !== false) {
// Make sure it is in the same scope, otherwise dont check indent.
$brackets = null;
if (isset($tokens[$next]['nested_parenthesis']) === true) {
$brackets = $tokens[$next]['nested_parenthesis'];
}
$conditions = null;
if (isset($tokens[$next]['conditions']) === true) {
$conditions = $tokens[$next]['conditions'];
}
if ($origBrackets === $brackets && $origConditions === $conditions) {
// Make sure it starts a line, otherwise dont check indent.
$indent = $tokens[($next - 1)];
if ($indent['code'] === T_WHITESPACE) {
if ($indent['line'] === $tokens[$next]['line']) {
$foundIndent = strlen($indent['content']);
} else {
$foundIndent = 0;
}
if ($foundIndent !== $requiredIndent) {
$error = 'Object operator not indented correctly; expected %s spaces but found %s';
$data = array(
$requiredIndent,
$foundIndent,
);
$phpcsFile->addError($error, $next, 'Incorrect', $data);
}
}
// It cant be the last thing on the line either.
$content = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
if ($tokens[$content]['line'] !== $tokens[$next]['line']) {
$error = 'Object operator must be at the start of the line, not the end';
$phpcsFile->addError($error, $next, 'StartOfLine');
}
}//end if
$next = $phpcsFile->findNext(
T_OBJECT_OPERATOR,
($next + 1),
null,
false,
null,
true
);
}//end while
}//end process()
}//end class
?>
|