~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/Squiz/Sniffs/Functions/GlobalFunctionSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot
  • Date: 2014-07-21 14:42:41 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20140721144241-g4orlcuk4jzn9mhs
Tags: 1.5.3-1
* Team upload
* Focus on stable release
* Update copyright
* Bump standards version to 3.9.5
* Update Homepage
* Use ${phppear:…} instead of hardcoding them
* Run tests in dh_auto_test
* Update patch with gbp pq
* Simplify configuration installation
* Edit package.xml to move script
* Add DEP-8 tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?php
2
 
/**
3
 
 * Squiz_Sniffs_Functions_GlobalFunctionSniff.
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
 
 * Squiz_Sniffs_Functions_GlobalFunctionSniff.
18
 
 *
19
 
 * Tests for functions outside of classes.
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 Squiz_Sniffs_Functions_GlobalFunctionSniff 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_FUNCTION);
42
 
 
43
 
    }//end register()
44
 
 
45
 
 
46
 
    /**
47
 
     * Processes this test, 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 the
51
 
     *                                        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
 
        if (empty($tokens[$stackPtr]['conditions']) === true) {
60
 
            $functionName = $phpcsFile->getDeclarationName($stackPtr);
61
 
            if ($functionName === null) {
62
 
                return;
63
 
            }
64
 
 
65
 
            // Special exception for __autoload as it needs to be global.
66
 
            if ($functionName !== '__autoload') {
67
 
                $error = 'Consider putting global function "%s" in a static class';
68
 
                $data  = array($functionName);
69
 
                $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
70
 
            }
71
 
        }
72
 
 
73
 
    }//end process()
74
 
 
75
 
 
76
 
}//end class
77
 
 
78
 
?>