← Back to branch summary

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

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.0RC2/CodeSniffer/Standards/Squiz/Sniffs/Files/FileExtensionSniff.php

  • Committer: Package Import Robot
  • Author(s): Thomas Goirand
  • Date: 2013-07-12 15:16:25 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20130712151625-4autdc0twzbueha9
Tags: 1.5.0~rc2-1
* New upstream release.
* Refreshed patch.
* Standards-Version is now 3.9.4.
* Canonical VCS URLs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.0RC2/CodeSniffer/Standards/Squiz/Sniffs/Files/FileExtensionSniff.php
 
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-2012 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 the stars in a doc comment align correctly.
 
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-2012 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.0RC2
 
28
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
29
 */
 
30
class 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(
 
42
                T_OPEN_TAG,
 
43
               );
 
44
 
 
45
    }//end register()
 
46
 
 
47
 
 
48
    /**
 
49
     * Processes this test, when one of its tokens is encountered.
 
50
     *
 
51
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
52
     * @param int                  $stackPtr  The position of the current token in the
 
53
     *                                        stack passed in $tokens.
 
54
     *
 
55
     * @return void
 
56
     */
 
57
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
58
    {
 
59
        $tokens = $phpcsFile->getTokens();
 
60
 
 
61
        // Make sure this is the first PHP open tag so we don't process
 
62
        // the same file twice.
 
63
        $prevOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1));
 
64
        if ($prevOpenTag !== false) {
 
65
            return;
 
66
        }
 
67
 
 
68
        $fileName  = $phpcsFile->getFileName();
 
69
        $extension = substr($fileName, strrpos($fileName, '.'));
 
70
        $nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE), $stackPtr);
 
71
 
 
72
        if ($extension === '.php') {
 
73
            if ($nextClass !== false) {
 
74
                $error = '%s found in ".php" file; use ".inc" extension instead';
 
75
                $data  = array(ucfirst($tokens[$nextClass]['content']));
 
76
                $phpcsFile->addError($error, $stackPtr, 'ClassFound', $data);
 
77
            }
 
78
        } else if ($extension === '.inc') {
 
79
            if ($nextClass === false) {
 
80
                $error = 'No interface or class found in ".inc" file; use ".php" extension instead';
 
81
                $phpcsFile->addError($error, $stackPtr, 'NoClass');
 
82
            }
 
83
        }
 
84
 
 
85
    }//end process()
 
86
 
 
87
 
 
88
}//end class
 
89
 
 
90
 
 
91
?>