-
Notifications
You must be signed in to change notification settings - Fork 19
/
OneLineCommentSniff.php
60 lines (56 loc) · 1.68 KB
/
OneLineCommentSniff.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
<?php
/**
* Kohana_Sniffs_Commenting_OneLineCommentSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Matthew Turland <matt@ishouldbecoding.com>
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version CVS: $Id$
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
/**
* This sniff prohibits the use of parentheses for constructor calls that
* do not accept parameters.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Matthew Turland <matt@ishouldbecoding.com>
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version Release: @package_version@
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Kohana_Sniffs_Commenting_OneLineCommentSniff implements PHP_CodeSniffer_Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(
T_COMMENT
);
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile File being scanned
* @param int $stackPtr Position of the current token in the stack
* passed in $tokens.
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
$content = $tokens[$stackPtr]['content'];
if (preg_match('/^\s*(?:\/\/[^ ]|#)/', $content)) {
$error = 'Single-line comments must begin with "// " (e.g. // My comment)';
$phpcsFile->addError($error, $stackPtr);
}
}
}
?>