Subversion Repositories Applications.framework

Rev

Rev 5 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 aurelien 1
<?php
2
/**
3
 * Generic_Sniffs_PHP_DisallowShortOpenTagSniff.
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 Squiz Pty Ltd (ABN 77 084 670 600)
12
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
34 aurelien 13
 * @version   CVS: $Id: DisallowShortOpenTagSniff.php 34 2009-04-09 07:34:39Z aurelien $
5 aurelien 14
 * @link      http://pear.php.net/package/PHP_CodeSniffer
15
 */
16
 
17
/**
18
 * Generic_Sniffs_PHP_DisallowShortOpenTagSniff.
19
 *
20
 * Makes sure that shorthand PHP open tags are not used.
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 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.2.0RC1
29
 * @link      http://pear.php.net/package/PHP_CodeSniffer
30
 */
31
class Generic_Sniffs_PHP_DisallowShortOpenTagSniff 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_OPEN_TAG,
44
                T_OPEN_TAG_WITH_ECHO,
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
55
     *                                        in the stack passed in $tokens.
56
     *
57
     * @return void
58
     */
59
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
60
    {
61
        // If short open tags are off, then any short open tags will be converted
62
        // to inline_html tags so we can just ignore them.
63
        // If its on, then we want to ban the use of them.
64
        $option = ini_get('short_open_tag');
65
 
66
        // Ini_get returns a string "0" if short open tags is off.
67
        if ($option === '0') {
68
            return;
69
        }
70
 
71
        $tokens  = $phpcsFile->getTokens();
72
        $openTag = $tokens[$stackPtr];
73
 
74
        if ($openTag['content'] === '<?') {
75
            $error = 'Short PHP opening tag used. Found "'.$openTag['content'].'" Expected "<?php".';
76
            $phpcsFile->addError($error, $stackPtr);
77
        }
78
 
79
        if ($openTag['code'] === T_OPEN_TAG_WITH_ECHO) {
80
            $nextVar = $tokens[$phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true)];
81
            $error   = 'Short PHP opening tag used with echo. Found "';
82
            $error  .= $openTag['content'].' '.$nextVar['content'].' ..." but expected "<?php echo '.$nextVar['content'].' ...".';
83
            $phpcsFile->addError($error, $stackPtr);
84
        }
85
 
86
    }//end process()
87
 
88
 
89
}//end class
90
 
91
?>