← 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.4/CodeSniffer/Standards/Squiz/Sniffs/CSS/IndentationSniff.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.4/CodeSniffer/Standards/Squiz/Sniffs/CSS/IndentationSniff.php
1
 
<?php
2
 
/**
3
 
 * Squiz_Sniffs_CSS_IndentationSniff.
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_IndentationSniff.
17
 
 *
18
 
 * Ensures styles are indented 4 spaces.
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: 1.5.4
26
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
27
 
 */
28
 
class Squiz_Sniffs_CSS_IndentationSniff 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
 
    * The number of spaces code should be indented.
40
 
    *
41
 
    * @var int
42
 
    */
43
 
    public $indent = 4;
44
 
 
45
 
 
46
 
    /**
47
 
     * Returns the token types that this sniff is interested in.
48
 
     *
49
 
     * @return int[]
50
 
     */
51
 
    public function register()
52
 
    {
53
 
        return array(T_OPEN_TAG);
54
 
 
55
 
    }//end register()
56
 
 
57
 
 
58
 
    /**
59
 
     * Processes the tokens that this sniff is interested in.
60
 
     *
61
 
     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
62
 
     * @param int                  $stackPtr  The position in the stack where
63
 
     *                                        the token was found.
64
 
     *
65
 
     * @return void
66
 
     */
67
 
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
68
 
    {
69
 
        $tokens = $phpcsFile->getTokens();
70
 
 
71
 
        $numTokens    = (count($tokens) - 2);
72
 
        $indentLevel  = 0;
73
 
        $nestingLevel = 0;
74
 
        for ($i = 1; $i < $numTokens; $i++) {
75
 
            if ($tokens[$i]['code'] === T_COMMENT) {
76
 
                // Don't check the indent of comments.
77
 
                continue;
78
 
            }
79
 
 
80
 
            if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) {
81
 
                $indentLevel++;
82
 
 
83
 
                // Check for nested class definitions.
84
 
                $found  = $phpcsFile->findNext(
85
 
                    T_OPEN_CURLY_BRACKET,
86
 
                    ($i + 1),
87
 
                    $tokens[$i]['bracket_closer']
88
 
                );
89
 
                if ($found !== false) {
90
 
                    $nestingLevel = $indentLevel;
91
 
                }
92
 
            } else if ($tokens[($i + 1)]['code'] === T_CLOSE_CURLY_BRACKET) {
93
 
                $indentLevel--;
94
 
            }
95
 
 
96
 
            if ($tokens[$i]['column'] !== 1) {
97
 
                continue;
98
 
            }
99
 
 
100
 
            // We started a new line, so check indent.
101
 
            if ($tokens[$i]['code'] === T_WHITESPACE) {
102
 
                $content     = str_replace($phpcsFile->eolChar, '', $tokens[$i]['content']);
103
 
                $foundIndent = strlen($content);
104
 
            } else {
105
 
                $foundIndent = 0;
106
 
            }
107
 
 
108
 
            $expectedIndent = ($indentLevel * $this->indent);
109
 
            if ($expectedIndent > 0
110
 
                && strpos($tokens[$i]['content'], $phpcsFile->eolChar) !== false
111
 
            ) {
112
 
                if ($nestingLevel !== $indentLevel) {
113
 
                    $error = 'Blank lines are not allowed in class definitions';
114
 
                    $phpcsFile->addError($error, $i, 'BlankLine');
115
 
                }
116
 
            } else if ($foundIndent !== $expectedIndent) {
117
 
                $error = 'Line indented incorrectly; expected %s spaces, found %s';
118
 
                $data  = array(
119
 
                          $expectedIndent,
120
 
                          $foundIndent,
121
 
                         );
122
 
                $phpcsFile->addError($error, $i, 'Incorrect', $data);
123
 
            }
124
 
        }//end foreach
125
 
    }//end process()
126
 
 
127
 
}//end class
128
 
?>