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: @package_version@
29 * @link      http://pear.php.net/package/PHP_CodeSniffer
30 */
31class 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