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

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.0RC2/CodeSniffer/Standards/Zend/Sniffs/Files/ClosingTagSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot
  • Date: 2014-07-21 14:42:41 UTC
  • mto: This revision was merged to the branch mainline in revision 7.
  • Revision ID: package-import@ubuntu.com-20140721144241-t0v9knmgtzftbsw6
Tags: upstream-1.5.3
Import upstream version 1.5.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?php
2
 
/**
3
 
 * Zend_Sniffs_Files_ClosingTagsSniff.
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
 
 * Zend_Sniffs_Files_LineEndingsSniff.
18
 
 *
19
 
 * Checks that the file does not end with a closing tag.
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 Zend_Sniffs_Files_ClosingTagSniff 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_CLOSE_TAG);
42
 
 
43
 
    }//end register()
44
 
 
45
 
 
46
 
    /**
47
 
     * Processes this sniff, 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
51
 
     *                                        the stack passed in $tokens.
52
 
     *
53
 
     * @return void
54
 
     */
55
 
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
56
 
    {
57
 
        $tokens = $phpcsFile->getTokens();
58
 
 
59
 
        $next = $phpcsFile->findNext(T_INLINE_HTML, ($stackPtr + 1), null, true);
60
 
        if ($next !== false) {
61
 
            return;
62
 
        }
63
 
 
64
 
        // We've found the last closing tag in the file so the only thing
65
 
        // potentially remaining is inline HTML. Now we need to figure out
66
 
        // whether or not it's just a bunch of whitespace.
67
 
        $content = '';
68
 
        for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
69
 
            $content .= $tokens[$i]['content'];
70
 
        }
71
 
 
72
 
        // Check if the remaining inline HTML is just whitespace.
73
 
        $content = trim($content);
74
 
        if (empty($content) === true) {
75
 
            $error = 'A closing tag is not permitted at the end of a PHP file';
76
 
            $phpcsFile->addError($error, $stackPtr, 'NotAllowed');
77
 
        }
78
 
 
79
 
    }//end process()
80
 
 
81
 
 
82
 
}//end class
83
 
 
84
 
?>