← Back to branch summary

~ubuntu-branches/ubuntu/vivid/php-codesniffer/vivid

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.5/CodeSniffer/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot, Greg Sherwood, Alexey, Emily, David Prévot
  • Date: 2014-09-26 13:44:35 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140926134435-wvjq16miqq4d60y0
Tags: 1.5.5-1
[ Greg Sherwood ]
* Improved closure support in Generic ScopeIndentSniff
* Improved indented PHP tag support in Generic ScopeIndentSniff
* Standards can now be located within hidden directories
 (further fix for bug #20323)
* Fixed bug #20373 : Inline comment sniff tab handling way
* Fixed bug #20378 : Report appended to existing file if no errors
  found in run
* Fixed bug #20381 : Invalid "Comment closer must be on a new line"
* PHP tokenizer no longer converts class/function names to special
  tokens types
* Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore
  thrown if first block comment
* Squiz and PEAR FunctionCommentSnif now support _()
* PEAR ValidFunctionNameSniff no longer throws an error for _()
* Fixed bug #248 : FunctionCommentSniff expects ampersand on param name
* Fixed bug #248 in Squiz sniff as well
* Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff
* Prepare for 1.5.5 release

[ Alexey ]
* Allowed single undersored methods and functions

[ Emily ]
* Added var_dump to discouraged functions sniff

[ David Prévot ]
* Revert "Add XS-Testsuite still needed for ci.d.n"
* Add self to uploaders
* Bump standards version to 3.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.5/CodeSniffer/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php
 
1
<?php
 
2
/**
 
3
 * Squiz_Sniffs_CSS_ShorthandSizeSniff.
 
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_ShorthandSizeSniff.
 
17
 *
 
18
 * Ensure sizes are defined using shorthand notation where possible, except in the
 
19
 * case where shorthand becomes 3 values.
 
20
 *
 
21
 * @category  PHP
 
22
 * @package   PHP_CodeSniffer
 
23
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
24
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
25
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
26
 * @version   Release: 1.5.5
 
27
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
28
 */
 
29
class Squiz_Sniffs_CSS_ShorthandSizeSniff implements PHP_CodeSniffer_Sniff
 
30
{
 
31
 
 
32
    /**
 
33
     * A list of tokenizers this sniff supports.
 
34
     *
 
35
     * @var array
 
36
     */
 
37
    public $supportedTokenizers = array('CSS');
 
38
 
 
39
    /**
 
40
     * A list of styles that we shouldn't check.
 
41
     *
 
42
     * These have values that looks like sizes, but are not.
 
43
     *
 
44
     * @var array
 
45
     */
 
46
    public $excludeStyles = array(
 
47
                             'background-position',
 
48
                             'box-shadow',
 
49
                             'transform-origin',
 
50
                             '-webkit-transform-origin',
 
51
                             '-ms-transform-origin',
 
52
                            );
 
53
 
 
54
 
 
55
    /**
 
56
     * Returns the token types that this sniff is interested in.
 
57
     *
 
58
     * @return int[]
 
59
     */
 
60
    public function register()
 
61
    {
 
62
        return array(T_STYLE);
 
63
 
 
64
    }//end register()
 
65
 
 
66
 
 
67
    /**
 
68
     * Processes the tokens that this sniff is interested in.
 
69
     *
 
70
     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
 
71
     * @param int                  $stackPtr  The position in the stack where
 
72
     *                                        the token was found.
 
73
     *
 
74
     * @return void
 
75
     */
 
76
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
77
    {
 
78
        $tokens = $phpcsFile->getTokens();
 
79
 
 
80
        // Some styles look like shorthand but are not actually a set of 4 sizes.
 
81
        $style = strtolower($tokens[$stackPtr]['content']);
 
82
        if (in_array($style, $this->excludeStyles) === true) {
 
83
            return;
 
84
        }
 
85
 
 
86
        // Get the whole style content.
 
87
        $end     = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
 
88
        $content = $phpcsFile->getTokensAsString(($stackPtr + 1), ($end - $stackPtr - 1));
 
89
        $content = trim($content, ': ');
 
90
 
 
91
        // Account for a !important annotation.
 
92
        if (substr($content, -10) === '!important') {
 
93
            $content = substr($content, 0, -10);
 
94
            $content = trim($content);
 
95
        }
 
96
 
 
97
        // Check if this style value is a set of numbers with optional prefixes.
 
98
        $content = preg_replace('/\s+/', ' ', $content);
 
99
        $values  = array();
 
100
        $num     = preg_match_all(
 
101
            '/([0-9]+)([a-zA-Z]{2}\s+|%\s+|\s+)/',
 
102
            $content.' ',
 
103
            $values,
 
104
            PREG_SET_ORDER
 
105
        );
 
106
 
 
107
        // Only interested in styles that have multiple sizes defined.
 
108
        if ($num < 2) {
 
109
            return;
 
110
        }
 
111
 
 
112
        // Rebuild the content we matched to ensure we got everything.
 
113
        $matched = '';
 
114
        foreach ($values as $value) {
 
115
            $matched .= $value[0];
 
116
        }
 
117
 
 
118
        if ($content !== trim($matched)) {
 
119
            return;
 
120
        }
 
121
 
 
122
        if ($num === 3) {
 
123
            $expected = trim($content.' '.$values[1][1].$values[1][2]);
 
124
            $error = 'Shorthand syntax not allowed here; use %s instead';
 
125
            $data  = array($expected);
 
126
            $phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data);
 
127
            return;
 
128
        }
 
129
 
 
130
        if ($num === 2) {
 
131
            if ($values[0][0] !== $values[1][0]) {
 
132
                // Both values are different, so it is already shorthand.
 
133
                return;
 
134
            }
 
135
        } else if ($values[0][0] !== $values[2][0] || $values[1][0] !== $values[3][0]) {
 
136
            // Can't shorthand this.
 
137
            return;
 
138
        }
 
139
 
 
140
        if ($values[0][0] === $values[1][0]) {
 
141
            // All values are the same.
 
142
            $expected = $values[0][0];
 
143
        } else {
 
144
            $expected = $values[0][0].' '.$values[1][0];
 
145
        }
 
146
 
 
147
        $expected = preg_replace('/\s+/', ' ', trim($expected));
 
148
 
 
149
        $error = 'Size definitions must use shorthand if available; expected "%s" but found "%s"';
 
150
        $data  = array(
 
151
                  $expected,
 
152
                  $content,
 
153
                 );
 
154
 
 
155
        $phpcsFile->addError($error, $stackPtr, 'NotUsed', $data);
 
156
 
 
157
    }//end process()
 
158
 
 
159
 
 
160
}//end class
 
161
?>