1<?php
2/**
3 * Squiz_Sniffs_CSS_LowercaseStyleDefinitionSniff.
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_LowercaseStyleDefinitionSniff.
17 *
18 * Ensure that all style definitions are in lowercase.
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_LowercaseStyleDefinitionSniff 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        $start   = ($stackPtr + 1);
64        $end     = ($tokens[$stackPtr]['bracket_closer'] - 1);
65        $inStyle = null;
66
67        for ($i = $start; $i <= $end; $i++) {
68            // Skip nested definitions as they are checked individually.
69            if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) {
70                $i = $tokens[$i]['bracket_closer'];
71                continue;
72            }
73
74            if ($tokens[$i]['code'] === T_STYLE) {
75                $inStyle = $tokens[$i]['content'];
76            }
77
78            if ($tokens[$i]['code'] === T_SEMICOLON) {
79                $inStyle = null;
80            }
81
82            if ($inStyle === 'progid') {
83                // Special case for IE filters.
84                continue;
85            }
86
87            if ($tokens[$i]['code'] === T_STYLE
88                || ($inStyle !== null
89                && $tokens[$i]['code'] === T_STRING)
90            ) {
91                $expected = strtolower($tokens[$i]['content']);
92                if ($expected !== $tokens[$i]['content']) {
93                    $error = 'Style definitions must be lowercase; expected %s but found %s';
94                    $data  = array(
95                              $expected,
96                              $tokens[$i]['content'],
97                             );
98
99                    $fix = $phpcsFile->addFixableError($error, $i, 'FoundUpper', $data);
100                    if ($fix === true) {
101                        $phpcsFile->fixer->replaceToken($i, $expected);
102                    }
103                }
104            }
105        }//end for
106
107    }//end process()
108
109
110}//end class
111