1<?php
2/**
3 * Squiz_Sniffs_CSS_ColonSpacingSniff.
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_ColonSpacingSniff.
17 *
18 * Ensure there is no space before a colon and one space after it.
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_ColonSpacingSniff 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_COLON);
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        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
65        if ($tokens[$prev]['code'] !== T_STYLE) {
66            // The colon is not part of a style definition.
67            return;
68        }
69
70        if ($tokens[$prev]['content'] === 'progid') {
71            // Special case for IE filters.
72            return;
73        }
74
75        if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
76            $error = 'There must be no space before a colon in a style definition';
77            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Before');
78            if ($fix === true) {
79                $phpcsFile->fixer->replaceToken(($stackPtr - 1), '');
80            }
81        }
82
83        if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) {
84            // Empty style definition, ignore it.
85            return;
86        }
87
88        if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) {
89            $error = 'Expected 1 space after colon in style definition; 0 found';
90            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoneAfter');
91            if ($fix === true) {
92                $phpcsFile->fixer->addContent($stackPtr, ' ');
93            }
94        } else {
95            $content = $tokens[($stackPtr + 1)]['content'];
96            if (strpos($content, $phpcsFile->eolChar) === false) {
97                $length = strlen($content);
98                if ($length !== 1) {
99                    $error = 'Expected 1 space after colon in style definition; %s found';
100                    $data  = array($length);
101                    $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'After', $data);
102                    if ($fix === true) {
103                        $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
104                    }
105                }
106            } else {
107                $error = 'Expected 1 space after colon in style definition; newline found';
108                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'AfterNewline');
109                if ($fix === true) {
110                    $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
111                }
112            }
113        }//end if
114
115    }//end process()
116
117
118}//end class
119