← 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/Classes/ClassFileNameSniff.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/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-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_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-2014 Squiz Pty Ltd (ABN 77 084 670 600)
27
 
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
28
 
 * @version   Release: 1.5.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
55
 
     *                                        the stack passed in $tokens.
56
 
     *
57
 
     * @return void
58
 
     */
59
 
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
60
 
    {
61
 
        $fullPath = basename($phpcsFile->getFilename());
62
 
        $fileName = substr($fullPath, 0, strrpos($fullPath, '.'));
63
 
        if ($fileName === '') {
64
 
            // No filename probably means STDIN, so we can't do this check.
65
 
            return;
66
 
        }
67
 
 
68
 
        $tokens  = $phpcsFile->getTokens();
69
 
        $decName = $phpcsFile->findNext(T_STRING, $stackPtr);
70
 
 
71
 
        if ($tokens[$decName]['content'] !== $fileName) {
72
 
            $error = '%s name doesn\'t match filename; expected "%s %s"';
73
 
            $data  = array(
74
 
                      ucfirst($tokens[$stackPtr]['content']),
75
 
                      $tokens[$stackPtr]['content'],
76
 
                      $fileName,
77
 
                     );
78
 
            $phpcsFile->addError($error, $stackPtr, 'NoMatch', $data);
79
 
        }
80
 
 
81
 
    }//end process()
82
 
 
83
 
 
84
 
}//end class
85
 
 
86
 
?>