Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \DrupalPractice\Sniffs\Objects\UnusedPrivateMethodSniff.
|
Chris@0
|
4 *
|
Chris@0
|
5 * @category PHP
|
Chris@0
|
6 * @package PHP_CodeSniffer
|
Chris@0
|
7 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@17
|
10 namespace DrupalPractice\Sniffs\Objects;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Checks that private methods are actually used in a class.
|
Chris@0
|
18 *
|
Chris@0
|
19 * @category PHP
|
Chris@0
|
20 * @package PHP_CodeSniffer
|
Chris@0
|
21 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
22 */
|
Chris@17
|
23 class UnusedPrivateMethodSniff extends AbstractScopeSniff
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Constructor.
|
Chris@0
|
29 */
|
Chris@0
|
30 public function __construct()
|
Chris@0
|
31 {
|
Chris@0
|
32 parent::__construct([T_CLASS], [T_FUNCTION], false);
|
Chris@0
|
33
|
Chris@0
|
34 }//end __construct()
|
Chris@0
|
35
|
Chris@0
|
36
|
Chris@0
|
37 /**
|
Chris@0
|
38 * Processes the tokens within the scope.
|
Chris@0
|
39 *
|
Chris@17
|
40 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being processed.
|
Chris@17
|
41 * @param int $stackPtr The position where this token was
|
Chris@17
|
42 * found.
|
Chris@17
|
43 * @param int $currScope The position of the current scope.
|
Chris@0
|
44 *
|
Chris@0
|
45 * @return void
|
Chris@0
|
46 */
|
Chris@17
|
47 protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
|
Chris@0
|
48 {
|
Chris@0
|
49 // Only check private methods.
|
Chris@0
|
50 $methodProperties = $phpcsFile->getMethodProperties($stackPtr);
|
Chris@0
|
51 if ($methodProperties['scope'] !== 'private' || $methodProperties['is_static'] === true) {
|
Chris@0
|
52 return;
|
Chris@0
|
53 }
|
Chris@0
|
54
|
Chris@0
|
55 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
56 $methodName = $phpcsFile->getDeclarationName($stackPtr);
|
Chris@0
|
57
|
Chris@0
|
58 $classPtr = key($tokens[$stackPtr]['conditions']);
|
Chris@0
|
59
|
Chris@0
|
60 // Search for direct $this->methodCall() or indirect callbacks [$this,
|
Chris@0
|
61 // 'methodCall'].
|
Chris@0
|
62 $current = $tokens[$classPtr]['scope_opener'];
|
Chris@0
|
63 $end = $tokens[$classPtr]['scope_closer'];
|
Chris@0
|
64 while (($current = $phpcsFile->findNext(T_VARIABLE, ($current + 1), $end)) !== false) {
|
Chris@0
|
65 if ($tokens[$current]['content'] !== '$this') {
|
Chris@0
|
66 continue;
|
Chris@0
|
67 }
|
Chris@0
|
68
|
Chris@17
|
69 $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($current + 1), null, true);
|
Chris@0
|
70 if ($next === false) {
|
Chris@0
|
71 continue;
|
Chris@0
|
72 }
|
Chris@0
|
73
|
Chris@0
|
74 if ($tokens[$next]['code'] === T_OBJECT_OPERATOR) {
|
Chris@17
|
75 $call = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true);
|
Chris@0
|
76 if ($call === false || $tokens[$call]['content'] !== $methodName) {
|
Chris@0
|
77 continue;
|
Chris@0
|
78 }
|
Chris@0
|
79
|
Chris@17
|
80 $parenthesis = $phpcsFile->findNext(Tokens::$emptyTokens, ($call + 1), null, true);
|
Chris@0
|
81 if ($parenthesis === false || $tokens[$parenthesis]['code'] !== T_OPEN_PARENTHESIS) {
|
Chris@0
|
82 continue;
|
Chris@0
|
83 }
|
Chris@0
|
84
|
Chris@0
|
85 // At this point this is a method call to the private method, so we
|
Chris@0
|
86 // can stop.
|
Chris@0
|
87 return;
|
Chris@0
|
88 } else if ($tokens[$next]['code'] === T_COMMA) {
|
Chris@17
|
89 $call = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true);
|
Chris@0
|
90 if ($call === false || substr($tokens[$call]['content'], 1, -1) !== $methodName) {
|
Chris@0
|
91 continue;
|
Chris@0
|
92 }
|
Chris@0
|
93
|
Chris@0
|
94 // At this point this is likely the private method as callback on a
|
Chris@0
|
95 // function such as array_filter().
|
Chris@0
|
96 return;
|
Chris@0
|
97 }//end if
|
Chris@0
|
98 }//end while
|
Chris@0
|
99
|
Chris@0
|
100 $warning = 'Unused private method %s()';
|
Chris@0
|
101 $data = [$methodName];
|
Chris@0
|
102 $phpcsFile->addWarning($warning, $stackPtr, 'UnusedMethod', $data);
|
Chris@0
|
103
|
Chris@0
|
104 }//end processTokenWithinScope()
|
Chris@0
|
105
|
Chris@0
|
106
|
Chris@17
|
107 /**
|
Chris@17
|
108 * Process tokens outside of scope.
|
Chris@17
|
109 *
|
Chris@17
|
110 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being processed.
|
Chris@17
|
111 * @param int $stackPtr The position where this token was
|
Chris@17
|
112 * found.
|
Chris@17
|
113 *
|
Chris@17
|
114 * @return void
|
Chris@17
|
115 */
|
Chris@17
|
116 protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
|
Chris@17
|
117 {
|
Chris@17
|
118
|
Chris@17
|
119 }//end processTokenOutsideScope()
|
Chris@17
|
120
|
Chris@17
|
121
|
Chris@0
|
122 }//end class
|