1<?php
2/**
3 * Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff.
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_ClassDefinitionNameSpacingSniff.
17 *
18 * Ensure there are no blank lines between the names of classes/IDs.
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_ClassDefinitionNameSpacingSniff 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_OPEN_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        // Do not check nested style definitions as, for example, in @media style rules.
65        $nested = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer']);
66        if ($nested !== false) {
67            return;
68        }
69
70        // Find the first blank line before this opening brace, unless we get
71        // to another style definition, comment or the start of the file.
72        $endTokens  = array(
73                       T_OPEN_CURLY_BRACKET  => T_OPEN_CURLY_BRACKET,
74                       T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET,
75                       T_OPEN_TAG            => T_OPEN_TAG,
76                      );
77        $endTokens += PHP_CodeSniffer_Tokens::$commentTokens;
78
79        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
80
81        $foundContent = false;
82        $currentLine  = $tokens[$prev]['line'];
83        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
84            if (isset($endTokens[$tokens[$i]['code']]) === true) {
85                break;
86            }
87
88            if ($tokens[$i]['line'] === $currentLine) {
89                if ($tokens[$i]['code'] !== T_WHITESPACE) {
90                    $foundContent = true;
91                }
92
93                continue;
94            }
95
96            // We changed lines.
97            if ($foundContent === false) {
98                // Before we throw an error, make sure we are not looking
99                // at a gap before the style definition.
100                $prev = $phpcsFile->findPrevious(T_WHITESPACE, $i, null, true);
101                if ($prev !== false
102                    && isset($endTokens[$tokens[$prev]['code']]) === false
103                ) {
104                    $error = 'Blank lines are not allowed between class names';
105                    $phpcsFile->addError($error, ($i + 1), 'BlankLinesFound');
106                }
107
108                break;
109            }
110
111            $foundContent = false;
112            $currentLine  = $tokens[$i]['line'];
113        }//end for
114
115    }//end process()
116
117
118}//end class
119