← 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/Classes/LowercaseClassKeywordsSniff.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/Classes/LowercaseClassKeywordsSniff.php
 
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-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
12
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
13
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
14
 */
 
15
 
 
16
/**
 
17
 * Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff.
 
18
 *
 
19
 * Ensures all class keywords are lowercase.
 
20
 *
 
21
 * @category  PHP
 
22
 * @package   PHP_CodeSniffer
 
23
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
24
 * @author    Marc McIntyre <mmcintyre@squiz.net>
 
25
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
26
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
27
 * @version   Release: 1.5.5
 
28
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
29
 */
 
30
class Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff implements PHP_CodeSniffer_Sniff
 
31
{
 
32
 
 
33
 
 
34
    /**
 
35
     * Returns an array of tokens this test wants to listen for.
 
36
     *
 
37
     * @return array
 
38
     */
 
39
    public function register()
 
40
    {
 
41
        return array(
 
42
                T_CLASS,
 
43
                T_INTERFACE,
 
44
                T_TRAIT,
 
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
            $error = '%s keyword must be lowercase; expected "%s" but found "%s"';
 
72
            $data  = array(
 
73
                      strtoupper($content),
 
74
                      strtolower($content),
 
75
                      $content,
 
76
                     );
 
77
            $phpcsFile->addError($error, $stackPtr, 'FoundUppercase', $data);
 
78
        }
 
79
 
 
80
    }//end process()
 
81
 
 
82
 
 
83
}//end class
 
84
 
 
85
?>