1<?php
2/**
3 * Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff.
4 *
5 * PHP version 5
6 *
7 * @category  PHP
8 * @package   PHP_CodeSniffer
9 * @author    Greg Sherwood <gsherwood@squiz.net>
10 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
11 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
12 * @link      http://pear.php.net/package/PHP_CodeSniffer
13 */
14
15/**
16 * Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff.
17 *
18 * Ensure there is a single blank line after the closing brace of a class definition.
19 *
20 * @category  PHP
21 * @package   PHP_CodeSniffer
22 * @author    Greg Sherwood <gsherwood@squiz.net>
23 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
24 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
25 * @version   Release: @package_version@
26 * @link      http://pear.php.net/package/PHP_CodeSniffer
27 */
28class Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff implements PHP_CodeSniffer_Sniff
29{
30
31    /**
32     * A list of tokenizers this sniff supports.
33     *
34     * @var array
35     */
36    public $supportedTokenizers = array('CSS');
37
38
39    /**
40     * Returns the token types that this sniff is interested in.
41     *
42     * @return int[]
43     */
44    public function register()
45    {
46        return array(T_CLOSE_CURLY_BRACKET);
47
48    }//end register()
49
50
51    /**
52     * Processes the tokens that this sniff is interested in.
53     *
54     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
55     * @param int                  $stackPtr  The position in the stack where
56     *                                        the token was found.
57     *
58     * @return void
59     */
60    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
61    {
62        $tokens = $phpcsFile->getTokens();
63
64        $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
65        if ($next === false) {
66            return;
67        }
68
69        if ($tokens[$next]['code'] !== T_CLOSE_TAG) {
70            $found = (($tokens[$next]['line'] - $tokens[$stackPtr]['line']) - 1);
71            if ($found !== 1) {
72                $error = 'Expected one blank line after closing brace of class definition; %s found';
73                $data  = array($found);
74                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterClose', $data);
75
76                if ($fix === true) {
77                    if ($found === 0) {
78                        $phpcsFile->fixer->addNewline($stackPtr);
79                    } else {
80                        $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
81                        $phpcsFile->fixer->beginChangeset();
82                        for ($i = ($stackPtr + 1); $i < ($nextContent - 1); $i++) {
83                            $phpcsFile->fixer->replaceToken($i, '');
84                        }
85
86                        $phpcsFile->fixer->addNewline($i);
87                        $phpcsFile->fixer->endChangeset();
88                    }
89                }
90            }//end if
91        }//end if
92
93        // Ignore nested style definitions from here on. The spacing before the closing brace
94        // (a single blank line) will be enforced by the above check, which ensures there is a
95        // blank line after the last nested class.
96        $found = $phpcsFile->findPrevious(
97            T_CLOSE_CURLY_BRACKET,
98            ($stackPtr - 1),
99            $tokens[$stackPtr]['bracket_opener']
100        );
101
102        if ($found !== false) {
103            return;
104        }
105
106        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
107        if ($prev === false) {
108            return;
109        }
110
111        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
112            $error = 'Closing brace of class definition must be on new line';
113            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentBeforeClose');
114            if ($fix === true) {
115                $phpcsFile->fixer->addNewlineBefore($stackPtr);
116            }
117        }
118
119    }//end process()
120
121
122}//end class
123