1<?php
2/**
3 * Squiz_Sniffs_WhiteSpace_SemicolonSpacingSniff.
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_WhiteSpace_SemicolonSpacingSniff.
18 *
19 * Ensure there is no whitespace before a semicolon.
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_WhiteSpace_SemicolonSpacingSniff 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_SEMICOLON);
52
53    }//end register()
54
55
56    /**
57     * Processes this test, 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
61     *                                        in the 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        $prevType = $tokens[($stackPtr - 1)]['code'];
70        if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$prevType]) === false) {
71            return;
72        }
73
74        $nonSpace = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 2), null, true);
75        if ($tokens[$nonSpace]['code'] === T_SEMICOLON) {
76            // Empty statement.
77            return;
78        }
79
80        $expected = $tokens[$nonSpace]['content'].';';
81        $found    = $phpcsFile->getTokensAsString($nonSpace, ($stackPtr - $nonSpace)).';';
82        $error    = 'Space found before semicolon; expected "%s" but found "%s"';
83        $data     = array(
84                     $expected,
85                     $found,
86                    );
87
88        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
89        if ($fix === true) {
90            $phpcsFile->fixer->beginChangeset();
91            $i = ($stackPtr - 1);
92            while (($tokens[$i]['code'] === T_WHITESPACE) && ($i > $nonSpace)) {
93                $phpcsFile->fixer->replaceToken($i, '');
94                $i--;
95            }
96
97            $phpcsFile->fixer->addContent($nonSpace, ';');
98            $phpcsFile->fixer->replaceToken($stackPtr, '');
99
100            $phpcsFile->fixer->endChangeset();
101        }
102
103    }//end process()
104
105
106}//end class
107