diff options
author | Michal Čihař <mcihar@suse.cz> | 2012-04-26 17:38:34 +0400 |
---|---|---|
committer | Michal Čihař <mcihar@suse.cz> | 2012-04-26 17:38:34 +0400 |
commit | 35711845494c6b02d1549488a99ff4ef937cd5bd (patch) | |
tree | fb5e32094a2cade42898c4891422dbb371554cf0 /PMAStandard/Sniffs/Commenting/InlineCommentSniff.php | |
parent | 76041ce9ca16ff9a5b3c7fe8e05b462a84912ae1 (diff) |
Include PEAR commenting rules
Diffstat (limited to 'PMAStandard/Sniffs/Commenting/InlineCommentSniff.php')
-rw-r--r-- | PMAStandard/Sniffs/Commenting/InlineCommentSniff.php | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/PMAStandard/Sniffs/Commenting/InlineCommentSniff.php b/PMAStandard/Sniffs/Commenting/InlineCommentSniff.php new file mode 100644 index 0000000000..3499be80d2 --- /dev/null +++ b/PMAStandard/Sniffs/Commenting/InlineCommentSniff.php @@ -0,0 +1,70 @@ +<?php +/** + * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff. + * + * PHP version 5 + * + * @category PHP + * @package PHP_CodeSniffer + * @author Greg Sherwood <gsherwood@squiz.net> + * @author Marc McIntyre <mmcintyre@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 + */ + +/** + * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff. + * + * Checks that no perl-style comments are used. + * + * @category PHP + * @package PHP_CodeSniffer + * @author Greg Sherwood <gsherwood@squiz.net> + * @author Marc McIntyre <mmcintyre@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_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff +{ + + + /** + * Returns an array of tokens this test wants to listen for. + * + * @return array + */ + public function register() + { + return array(T_COMMENT); + + }//end register() + + + /** + * Processes this test, 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(); + + if ($tokens[$stackPtr]['content']{0} === '#') { + $error = 'Perl-style comments are not allowed. Use "// Comment."'; + $error .= ' or "/* comment */" instead.'; + $phpcsFile->addError($error, $stackPtr, 'WrongStyle'); + } + + }//end process() + + +}//end class + +?> |