/php/pear/PHP/CodeSniffer/Standards/Zend/Sniffs/Files/ClosingTagSniff.php

 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-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 * 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-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.3
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class 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_WHITESPACE, ($stackPtr + 1), null, true);
60        if ($next === false) {
61            $error = 'A closing tag is not permitted at the end of a PHP file';
62            $phpcsFile->addError($error, $stackPtr, 'NotAllowed');
63        }
64
65    }//end process()
66
67
68}//end class
69
70?>