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

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.3.4/CodeSniffer/Standards/Generic/Sniffs/PHP/DisallowShortOpenTagSniff.php

  • Committer: Package Import Robot
  • Author(s): Thomas Goirand
  • Date: 2012-05-31 16:37:24 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20120531163724-u6aiaubu8ks5dh5z
Tags: 1.3.4-0.1
* Non-maintainer upload.
* New upstream release (Closes: #599617, #634825).
* Swtiched debian/copyright to format 1.0 (rewrite was needed anyway, as the
upstream license changed).
* Switched package to pkg-php-tools and debhelper 8 sequencer.
* Now running unit tests at build time (so depends on phpunit (>= 3.6)).
* Section is now PHP.
* Added missing Build-Depends-Indep: php-pear.
* Added missing ${misc:Depends}.
* Added Vcs fields.
* Added homepage field.
* Reviewed short and long description.
* Added dependency on php-timer.
* Standards-Version: is now 3.9.3 (lots of changes, see above...).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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-2011 Squiz Pty Ltd (ABN 77 084 670 600)
 
12
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
 
13
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
14
 */
 
15
 
 
16
/**
 
17
 * Generic_Sniffs_PHP_DisallowShortOpenTagSniff.
 
18
 *
 
19
 * Makes sure that shorthand PHP open tags are not used.
 
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-2011 Squiz Pty Ltd (ABN 77 084 670 600)
 
26
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
 
27
 * @version   Release: 1.3.4
 
28
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
29
 */
 
30
class Generic_Sniffs_PHP_DisallowShortOpenTagSniff 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
                T_OPEN_TAG_WITH_ECHO,
 
44
               );
 
45
 
 
46
    }//end register()
 
47
 
 
48
 
 
49
    /**
 
50
     * Processes this test, when one of its tokens is encountered.
 
51
     *
 
52
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
53
     * @param int                  $stackPtr  The position of the current token
 
54
     *                                        in the stack passed in $tokens.
 
55
     *
 
56
     * @return void
 
57
     */
 
58
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
59
    {
 
60
        $tokens  = $phpcsFile->getTokens();
 
61
        $openTag = $tokens[$stackPtr];
 
62
 
 
63
        if ($openTag['content'] === '<?') {
 
64
            $error = 'Short PHP opening tag used; expected "<?php" but found "%s"';
 
65
            $data  = array($openTag['content']);
 
66
            $phpcsFile->addError($error, $stackPtr, 'Found', $data);
 
67
        }
 
68
 
 
69
        if ($openTag['code'] === T_OPEN_TAG_WITH_ECHO) {
 
70
            $nextVar = $tokens[$phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true)];
 
71
            $error   = 'Short PHP opening tag used with echo; expected "<?php echo %s ..." but found "%s %s ..."';
 
72
            $data = array(
 
73
                     $nextVar['content'],
 
74
                     $openTag['content'],
 
75
                     $nextVar['content'],
 
76
                    );
 
77
            $phpcsFile->addError($error, $stackPtr, 'EchoFound', $data);
 
78
        }
 
79
 
 
80
    }//end process()
 
81
 
 
82
 
 
83
}//end class
 
84
 
 
85
?>