Subversion-Projekte lars-tiefland.php_share

Revision

Details | Letzte Änderung | Log anzeigen | RSS feed

Revision Autor Zeilennr. Zeile
1 lars 1
<?php
2
/**
3
 * Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff.
4
 *
5
 * PHP version 5
6
 *
7
 * @category  PHP
8
 * @package   PHP_CodeSniffer
9
 * @author    Greg Sherwood <gsherwood@squiz.net>
10
 * @author    Marc McIntyre <mmcintyre@squiz.net>
11
 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
12
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
13
 * @version   CVS: $Id: LowercaseClassKeywordsSniff.php 240175 2007-07-23 01:47:54Z squiz $
14
 * @link      http://pear.php.net/package/PHP_CodeSniffer
15
 */
16
 
17
/**
18
 * Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff.
19
 *
20
 * Ensures all class keywords are lowercase.
21
 *
22
 * @category  PHP
23
 * @package   PHP_CodeSniffer
24
 * @author    Greg Sherwood <gsherwood@squiz.net>
25
 * @author    Marc McIntyre <mmcintyre@squiz.net>
26
 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
27
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
28
 * @version   Release: 1.2.1
29
 * @link      http://pear.php.net/package/PHP_CodeSniffer
30
 */
31
class Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff implements PHP_CodeSniffer_Sniff
32
{
33
 
34
 
35
    /**
36
     * Returns an array of tokens this test wants to listen for.
37
     *
38
     * @return array
39
     */
40
    public function register()
41
    {
42
        return array(
43
                T_CLASS,
44
                T_INTERFACE,
45
                T_EXTENDS,
46
                T_IMPLEMENTS,
47
                T_ABSTRACT,
48
                T_FINAL,
49
                T_VAR,
50
                T_CONST,
51
               );
52
 
53
    }//end register()
54
 
55
 
56
    /**
57
     * Processes this test, when one of its tokens is encountered.
58
     *
59
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
60
     * @param int                  $stackPtr  The position of the current token in
61
     *                                        the stack passed in $tokens.
62
     *
63
     * @return void
64
     */
65
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
66
    {
67
        $tokens = $phpcsFile->getTokens();
68
 
69
        $content = $tokens[$stackPtr]['content'];
70
        if ($content !== strtolower($content)) {
71
            $type     = strtoupper($content);
72
            $expected = strtolower($content);
73
            $error    = "$type keyword must be lowercase; expected \"$expected\" but found \"$content\"";
74
            $phpcsFile->addError($error, $stackPtr);
75
        }
76
 
77
    }//end process()
78
 
79
 
80
}//end class
81
 
82
?>