| 1 |
lars |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff.
|
|
|
4 |
*
|
|
|
5 |
* PHP version 5
|
|
|
6 |
*
|
|
|
7 |
* @category PHP
|
|
|
8 |
* @package PHP_CodeSniffer
|
|
|
9 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
10 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
11 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
12 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
13 |
* @version CVS: $Id: ClosingDeclarationCommentSniff.php 259960 2008-05-19 05:59:25Z squiz $
|
|
|
14 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
15 |
*/
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff.
|
|
|
19 |
*
|
|
|
20 |
* Checks the //end ... comments on classes, interfaces and functions.
|
|
|
21 |
*
|
|
|
22 |
* @category PHP
|
|
|
23 |
* @package PHP_CodeSniffer
|
|
|
24 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
25 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
26 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
27 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
28 |
* @version Release: 1.2.1
|
|
|
29 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
30 |
*/
|
|
|
31 |
class Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff implements PHP_CodeSniffer_Sniff
|
|
|
32 |
{
|
|
|
33 |
|
|
|
34 |
|
|
|
35 |
/**
|
|
|
36 |
* Returns an array of tokens this test wants to listen for.
|
|
|
37 |
*
|
|
|
38 |
* @return array
|
|
|
39 |
*/
|
|
|
40 |
public function register()
|
|
|
41 |
{
|
|
|
42 |
return array(
|
|
|
43 |
T_FUNCTION,
|
|
|
44 |
T_CLASS,
|
|
|
45 |
T_INTERFACE,
|
|
|
46 |
);
|
|
|
47 |
|
|
|
48 |
}//end register()
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
/**
|
|
|
52 |
* Processes this test, when one of its tokens is encountered.
|
|
|
53 |
*
|
|
|
54 |
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
|
|
55 |
* @param int $stackPtr The position of the current token in the
|
|
|
56 |
* stack passed in $tokens..
|
|
|
57 |
*
|
|
|
58 |
* @return void
|
|
|
59 |
*/
|
|
|
60 |
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
|
|
61 |
{
|
|
|
62 |
$tokens = $phpcsFile->getTokens();
|
|
|
63 |
|
|
|
64 |
if ($tokens[$stackPtr]['code'] === T_FUNCTION) {
|
|
|
65 |
|
|
|
66 |
$methodProps = $phpcsFile->getMethodProperties($stackPtr);
|
|
|
67 |
|
|
|
68 |
// Abstract methods do not require a closing comment.
|
|
|
69 |
if ($methodProps['is_abstract'] === true) {
|
|
|
70 |
return;
|
|
|
71 |
}
|
|
|
72 |
|
|
|
73 |
// If this function is in an interface then we don't require
|
|
|
74 |
// a closing comment.
|
|
|
75 |
if ($phpcsFile->hasCondition($stackPtr, T_INTERFACE) === true) {
|
|
|
76 |
return;
|
|
|
77 |
}
|
|
|
78 |
|
|
|
79 |
if (isset($tokens[$stackPtr]['scope_closer']) === false) {
|
|
|
80 |
$error = 'Possible parse error: non-abstract method defined as abstract';
|
|
|
81 |
$phpcsFile->addWarning($error, $stackPtr);
|
|
|
82 |
return;
|
|
|
83 |
}
|
|
|
84 |
|
|
|
85 |
$decName = $phpcsFile->getDeclarationName($stackPtr);
|
|
|
86 |
$comment = '//end '.$decName.'()';
|
|
|
87 |
} else if ($tokens[$stackPtr]['code'] === T_CLASS) {
|
|
|
88 |
$comment = '//end class';
|
|
|
89 |
} else {
|
|
|
90 |
$comment = '//end interface';
|
|
|
91 |
}//end if
|
|
|
92 |
|
|
|
93 |
if (isset($tokens[$stackPtr]['scope_closer']) === false) {
|
|
|
94 |
$error = 'Possible parse error: ';
|
|
|
95 |
$error .= $tokens[$stackPtr]['content'];
|
|
|
96 |
$error .= ' missing opening or closing brace';
|
|
|
97 |
$phpcsFile->addWarning($error, $stackPtr);
|
|
|
98 |
return;
|
|
|
99 |
}
|
|
|
100 |
|
|
|
101 |
$closingBracket = $tokens[$stackPtr]['scope_closer'];
|
|
|
102 |
|
|
|
103 |
if ($closingBracket === null) {
|
|
|
104 |
// Possible inline structure. Other tests will handle it.
|
|
|
105 |
return;
|
|
|
106 |
}
|
|
|
107 |
|
|
|
108 |
$error = 'Expected '.$comment;
|
|
|
109 |
if (isset($tokens[($closingBracket + 1)]) === false || $tokens[($closingBracket + 1)]['code'] !== T_COMMENT) {
|
|
|
110 |
$phpcsFile->addError($error, $closingBracket);
|
|
|
111 |
return;
|
|
|
112 |
}
|
|
|
113 |
|
|
|
114 |
if (rtrim($tokens[($closingBracket + 1)]['content']) !== $comment) {
|
|
|
115 |
$phpcsFile->addError($error, $closingBracket);
|
|
|
116 |
return;
|
|
|
117 |
}
|
|
|
118 |
|
|
|
119 |
}//end process()
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
}//end class
|
|
|
123 |
|
|
|
124 |
?>
|