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
|
<?php
/**
* Ensures that self is not used to call public method in action classes.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer_MySource
* @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
*/
/**
* Ensures that self is not used to call public method in action classes.
*
* @category PHP
* @package PHP_CodeSniffer_MySource
* @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.4
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class MySource_Sniffs_Channels_DisallowSelfActionsSniff implements PHP_CodeSniffer_Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_CLASS);
}//end register()
/**
* Processes this sniff, 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();
// We are not interested in abstract classes.
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
if ($prev !== false && $tokens[$prev]['code'] === T_ABSTRACT) {
return;
}
// We are only interested in Action classes.
$classNameToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
$className = $tokens[$classNameToken]['content'];
if (substr($className, -7) !== 'Actions') {
return;
}
$foundFunctions = array();
$foundCalls = array();
// Find all static method calls in the form self::method() in the class.
$classEnd = $tokens[$stackPtr]['scope_closer'];
for ($i = ($classNameToken + 1); $i < $classEnd; $i++) {
if ($tokens[$i]['code'] !== T_DOUBLE_COLON) {
if ($tokens[$i]['code'] === T_FUNCTION) {
// Cache the function information.
$funcName = $phpcsFile->findNext(T_STRING, ($i + 1));
$funcScope = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, ($i - 1));
$foundFunctions[$tokens[$funcName]['content']] = strtolower($tokens[$funcScope]['content']);
}
continue;
}
$prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true);
if ($tokens[$prevToken]['content'] !== 'self') {
continue;
}
$funcNameToken = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
if ($tokens[$funcNameToken]['code'] === T_VARIABLE) {
// We are only interested in function calls.
continue;
}
$funcName = $tokens[$funcNameToken]['content'];
// We've found the function, now we need to find it and see if it is
// public, private or protected. If it starts with an underscore we
// can assume it is private.
if ($funcName{0} === '_') {
continue;
}
$foundCalls[$i] = $funcName;
}//end for
$errorClassName = substr($className, 0, -7);
foreach ($foundCalls as $token => $funcName) {
if (isset($foundFunctions[$funcName]) === false) {
// Function was not in this class, might have come from the parent.
// Either way, we can't really check this.
continue;
} else if ($foundFunctions[$funcName] === 'public') {
$error = 'Static calls to public methods in Action classes must not use the self keyword; use %s::%s() instead';
$data = array(
$errorClassName,
$funcName,
);
$phpcsFile->addError($error, $token, 'Found', $data);
}
}
}//end process()
}//end class
?>
|
