← Back to branch summary

~ubuntu-branches/ubuntu/utopic/php-codesniffer/utopic

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.3.4/CodeSniffer/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php

  • Committer: Package Import Robot
  • Author(s): Thomas Goirand
  • Date: 2012-05-31 16:37:24 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20120531163724-u6aiaubu8ks5dh5z
Tags: 1.3.4-0.1
http://bugs.debian.org/599617
http://bugs.debian.org/634825
* Non-maintainer upload.
* New upstream release (Closes: #599617, #634825).
* Swtiched debian/copyright to format 1.0 (rewrite was needed anyway, as the
upstream license changed).
* Switched package to pkg-php-tools and debhelper 8 sequencer.
* Now running unit tests at build time (so depends on phpunit (>= 3.6)).
* Section is now PHP.
* Added missing Build-Depends-Indep: php-pear.
* Added missing ${misc:Depends}.
* Added Vcs fields.
* Added homepage field.
* Reviewed short and long description.
* Added dependency on php-timer.
* Standards-Version: is now 3.9.3 (lots of changes, see above...).

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.3.4/CodeSniffer/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php
 
1
<?php
 
2
/**
 
3
 * Squiz_Sniffs_Classes_ClassFileNameSniff.
 
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-2011 Squiz Pty Ltd (ABN 77 084 670 600)
 
12
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
 
13
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
14
 */
 
15
 
 
16
/**
 
17
 * Squiz_Sniffs_Classes_ClassFileNameSniff.
 
18
 *
 
19
 * Tests that the file name and the name of the class contained within the file
 
20
 * match.
 
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-2011 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.3.4
 
29
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
30
 */
 
31
class Squiz_Sniffs_Classes_ClassFileNameSniff 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
               );
 
46
 
 
47
    }//end register()
 
48
 
 
49
 
 
50
    /**
 
51
     * Processes this test, when one of its tokens is encountered.
 
52
     *
 
53
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
54
     * @param int                  $stackPtr  The position of the current token in the
 
55
     *                                        stack passed in $tokens.
 
56
     *
 
57
     * @return void
 
58
     */
 
59
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
60
    {
 
61
        $tokens   = $phpcsFile->getTokens();
 
62
        $decName  = $phpcsFile->findNext(T_STRING, $stackPtr);
 
63
        $fullPath = basename($phpcsFile->getFilename());
 
64
        $fileName = substr($fullPath, 0, strrpos($fullPath, '.'));
 
65
 
 
66
        if ($tokens[$decName]['content'] !== $fileName) {
 
67
            $error = '%s name doesn\'t match filename; expected "%s %s"';
 
68
            $data  = array(
 
69
                      ucfirst($tokens[$stackPtr]['content']),
 
70
                      $tokens[$stackPtr]['content'],
 
71
                      $fileName,
 
72
                     );
 
73
            $phpcsFile->addError($error, $stackPtr, 'NoMatch', $data);
 
74
        }
 
75
 
 
76
    }//end process()
 
77
 
 
78
 
 
79
}//end class
 
80
 
 
81
?>