1<?php
2/**
3 * Squiz_Sniffs_CSS_OpacitySniff.
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_OpacitySniff.
17 *
18 * Ensure that opacity values start with a 0 if it is not a whole number.
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_OpacitySniff 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_STYLE);
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        if ($tokens[$stackPtr]['content'] !== 'opacity') {
65            return;
66        }
67
68        $next = $phpcsFile->findNext(array(T_COLON, T_WHITESPACE), ($stackPtr + 1), null, true);
69
70        if ($next === false
71            || ($tokens[$next]['code'] !== T_DNUMBER
72            && $tokens[$next]['code'] !== T_LNUMBER)
73        ) {
74            return;
75        }
76
77        $value = $tokens[$next]['content'];
78        if ($tokens[$next]['code'] === T_LNUMBER) {
79            if ($value !== '0' && $value !== '1') {
80                $error = 'Opacity values must be between 0 and 1';
81                $phpcsFile->addError($error, $next, 'Invalid');
82            }
83        } else {
84            if (strlen($value) > 3) {
85                $error = 'Opacity values must have a single value after the decimal point';
86                $phpcsFile->addError($error, $next, 'DecimalPrecision');
87            } else if ($value === '0.0' || $value === '1.0') {
88                $error = 'Opacity value does not require decimal point; use %s instead';
89                $data  = array($value{0});
90                $fix   = $phpcsFile->addFixableError($error, $next, 'PointNotRequired', $data);
91                if ($fix === true) {
92                    $phpcsFile->fixer->replaceToken($next, $value{0});
93                }
94            } else if ($value{0} === '.') {
95                $error = 'Opacity values must not start with a decimal point; use 0%s instead';
96                $data  = array($value);
97                $fix   = $phpcsFile->addFixableError($error, $next, 'StartWithPoint', $data);
98                if ($fix === true) {
99                    $phpcsFile->fixer->replaceToken($next, '0'.$value);
100                }
101            } else if ($value{0} !== '0') {
102                $error = 'Opacity values must be between 0 and 1';
103                $phpcsFile->addError($error, $next, 'Invalid');
104            }//end if
105        }//end if
106
107    }//end process()
108
109
110}//end class
111