1<?php
2/**
3 * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
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-2014 Squiz Pty Ltd (ABN 77 084 670 600)
12 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
13 * @link      http://pear.php.net/package/PHP_CodeSniffer
14 */
15
16/**
17 * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
18 *
19 * Checks that no perl-style comments are used.
20 *
21 * @category  PHP
22 * @package   PHP_CodeSniffer
23 * @author    Greg Sherwood <gsherwood@squiz.net>
24 * @author    Marc McIntyre <mmcintyre@squiz.net>
25 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
26 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
27 * @version   Release: @package_version@
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class PEAR_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff
31{
32
33
34    /**
35     * Returns an array of tokens this test wants to listen for.
36     *
37     * @return array
38     */
39    public function register()
40    {
41        return array(T_COMMENT);
42
43    }//end register()
44
45
46    /**
47     * Processes this test, when one of its tokens is encountered.
48     *
49     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
50     * @param int                  $stackPtr  The position of the current token
51     *                                        in the stack passed in $tokens.
52     *
53     * @return void
54     */
55    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
56    {
57        $tokens = $phpcsFile->getTokens();
58
59        if ($tokens[$stackPtr]['content']{0} === '#') {
60            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '# ...');
61
62            $error  = 'Perl-style comments are not allowed. Use "// Comment."';
63            $error .= ' or "/* comment */" instead.';
64            $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle');
65            if ($fix === true) {
66                $newComment = ltrim($tokens[$stackPtr]['content'], '# ');
67                $newComment = '// '.$newComment;
68                $phpcsFile->fixer->replaceToken($stackPtr, $newComment);
69            }
70        } else if ($tokens[$stackPtr]['content']{0} === '/'
71            && $tokens[$stackPtr]['content']{1} === '/'
72        ) {
73            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '// ...');
74        } else if ($tokens[$stackPtr]['content']{0} === '/'
75            && $tokens[$stackPtr]['content']{1} === '*'
76        ) {
77            $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '/* ... */');
78        }
79
80    }//end process()
81
82
83}//end class
84