← Back to branch summary

~ubuntu-branches/ubuntu/trusty/php-codesniffer/trusty

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.0RC2/CodeSniffer/Standards/PSR2/Sniffs/Namespaces/NamespaceDeclarationSniff.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/PSR2/Sniffs/Namespaces/NamespaceDeclarationSniff.php
 
1
<?php
 
2
/**
 
3
 * PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff.
 
4
 *
 
5
 * PHP version 5
 
6
 *
 
7
 * @category  PHP
 
8
 * @package   PHP_CodeSniffer
 
9
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
10
 * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600)
 
11
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
12
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
13
 */
 
14
 
 
15
/**
 
16
 * PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff.
 
17
 *
 
18
 * Ensures namespaces are declared correctly.
 
19
 *
 
20
 * @category  PHP
 
21
 * @package   PHP_CodeSniffer
 
22
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
23
 * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600)
 
24
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
25
 * @version   Release: 1.5.0RC2
 
26
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
27
 */
 
28
class PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff implements PHP_CodeSniffer_Sniff
 
29
{
 
30
 
 
31
 
 
32
    /**
 
33
     * Returns an array of tokens this test wants to listen for.
 
34
     *
 
35
     * @return array
 
36
     */
 
37
    public function register()
 
38
    {
 
39
        return array(T_NAMESPACE);
 
40
 
 
41
    }//end register()
 
42
 
 
43
 
 
44
    /**
 
45
     * Processes this test, when one of its tokens is encountered.
 
46
     *
 
47
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
48
     * @param int                  $stackPtr  The position of the current token in
 
49
     *                                        the stack passed in $tokens.
 
50
     *
 
51
     * @return void
 
52
     */
 
53
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
54
    {
 
55
        $tokens = $phpcsFile->getTokens();
 
56
 
 
57
        for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
 
58
            if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
 
59
                continue;
 
60
            }
 
61
 
 
62
            break;
 
63
        }
 
64
 
 
65
        // The $i var now points to the first token on the line after the
 
66
        // namespace declaration, which must be a blank line.
 
67
        $next = $phpcsFile->findNext(T_WHITESPACE, $i, $phpcsFile->numTokens, true);
 
68
        if ($tokens[$next]['line'] === $tokens[$i]['line']) {
 
69
            $error = 'There must be one blank line after the namespace declaration';
 
70
            $phpcsFile->addError($error, $stackPtr, 'BlankLineAfter');
 
71
        }
 
72
 
 
73
    }//end process()
 
74
 
 
75
 
 
76
}//end class
 
77
 
 
78
 
 
79
?>