1<?php
2/**
3 * Squiz_Sniffs_CSS_ColourDefinitionSniff.
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_ColourDefinitionSniff.
17 *
18 * Ensure colours are defined in upper-case and use shortcuts where possible.
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_ColourDefinitionSniff 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_COLOUR);
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        $colour = $tokens[$stackPtr]['content'];
64
65        $expected = strtoupper($colour);
66        if ($colour !== $expected) {
67            $error = 'CSS colours must be defined in uppercase; expected %s but found %s';
68            $data  = array(
69                      $expected,
70                      $colour,
71                     );
72
73            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotUpper', $data);
74            if ($fix === true) {
75                $phpcsFile->fixer->replaceToken($stackPtr, $expected);
76            }
77        }
78
79        // Now check if shorthand can be used.
80        if (strlen($colour) !== 7) {
81            return;
82        }
83
84        if ($colour{1} === $colour{2} && $colour{3} === $colour{4} && $colour{5} === $colour{6}) {
85            $expected = '#'.$colour{1}.$colour{3}.$colour{5};
86            $error    = 'CSS colours must use shorthand if available; expected %s but found %s';
87            $data     = array(
88                         $expected,
89                         $colour,
90                        );
91
92            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Shorthand', $data);
93            if ($fix === true) {
94                $phpcsFile->fixer->replaceToken($stackPtr, $expected);
95            }
96        }
97
98    }//end process()
99
100
101}//end class
102