1<?php
2/**
3 * Squiz_Sniffs_Commenting_PostStatementCommentSniff.
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 * Squiz_Sniffs_Commenting_PostStatementCommentSniff.
18 *
19 * Checks to ensure that there are no comments after statements.
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 Squiz_Sniffs_Commenting_PostStatementCommentSniff implements PHP_CodeSniffer_Sniff
31{
32
33    /**
34     * A list of tokenizers this sniff supports.
35     *
36     * @var array
37     */
38    public $supportedTokenizers = array(
39                                   'PHP',
40                                   'JS',
41                                  );
42
43
44    /**
45     * Returns an array of tokens this test wants to listen for.
46     *
47     * @return array
48     */
49    public function register()
50    {
51        return array(T_COMMENT);
52
53    }//end register()
54
55
56    /**
57     * Processes this sniff, when one of its tokens is encountered.
58     *
59     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
60     * @param int                  $stackPtr  The position of the current token in the
61     *                                        stack passed in $tokens.
62     *
63     * @return void
64     */
65    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
66    {
67        $tokens = $phpcsFile->getTokens();
68
69        if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
70            return;
71        }
72
73        $commentLine = $tokens[$stackPtr]['line'];
74        $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
75
76        if ($tokens[$lastContent]['line'] !== $commentLine) {
77            return;
78        }
79
80        if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
81            return;
82        }
83
84        // Special case for JS files.
85        if ($tokens[$lastContent]['code'] === T_COMMA
86            || $tokens[$lastContent]['code'] === T_SEMICOLON
87        ) {
88            $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($lastContent - 1), null, true);
89            if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
90                return;
91            }
92        }
93
94        $error = 'Comments may not appear after statements';
95        $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
96        if ($fix === true) {
97            $phpcsFile->fixer->addNewlineBefore($stackPtr);
98        }
99
100    }//end process()
101
102
103}//end class
104