1<?php
2/**
3 * Squiz_Sniffs_Files_FileExtensionSniff.
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_Files_FileExtensionSniff.
18 *
19 * Tests that classes and interfaces are not declared in .php files
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: @package_version@
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class Squiz_Sniffs_Files_FileExtensionSniff 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(T_OPEN_TAG);
42
43    }//end register()
44
45
46    /**
47     * Processes this test, when one of its tokens is encountered.
48     *
49     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
50     * @param int                  $stackPtr  The position of the current token in the
51     *                                        stack passed in $tokens.
52     *
53     * @return int
54     */
55    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
56    {
57        $tokens    = $phpcsFile->getTokens();
58        $fileName  = $phpcsFile->getFileName();
59        $extension = substr($fileName, strrpos($fileName, '.'));
60        $nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE, T_TRAIT), $stackPtr);
61
62        if ($nextClass !== false) {
63            $phpcsFile->recordMetric($stackPtr, 'File extension for class files', $extension);
64            if ($extension === '.php') {
65                $error = '%s found in ".php" file; use ".inc" extension instead';
66                $data  = array(ucfirst($tokens[$nextClass]['content']));
67                $phpcsFile->addError($error, $stackPtr, 'ClassFound', $data);
68            }
69        } else {
70            $phpcsFile->recordMetric($stackPtr, 'File extension for non-class files', $extension);
71            if ($extension === '.inc') {
72                $error = 'No interface or class found in ".inc" file; use ".php" extension instead';
73                $phpcsFile->addError($error, $stackPtr, 'NoClass');
74            }
75        }
76
77        // Ignore the rest of the file.
78        return ($phpcsFile->numTokens + 1);
79
80    }//end process()
81
82
83}//end class
84