← Back to branch summary

~ubuntu-branches/ubuntu/saucy/php-codesniffer/saucy

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.1.0/CodeSniffer/Standards/Generic/Sniffs/PHP/ForbiddenFunctionsSniff.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
http://bugs.debian.org/599617
http://bugs.debian.org/634825
* 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:
PHP_CodeSniffer-1.1.0/CodeSniffer/Standards/Generic/Sniffs/PHP/ForbiddenFunctionsSniff.php
1
 
<?php
2
 
/**
3
 
 * Generic_Sniffs_PHP_ForbiddenFunctionsSniff.
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 Squiz Pty Ltd (ABN 77 084 670 600)
12
 
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
13
 
 * @version   CVS: $Id: ForbiddenFunctionsSniff.php,v 1.6 2008/02/01 03:19:54 squiz Exp $
14
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
15
 
 */
16
 
 
17
 
/**
18
 
 * Generic_Sniffs_PHP_ForbiddenFunctionsSniff.
19
 
 *
20
 
 * Discourages the use of alias functions that are kept in PHP for compatibility
21
 
 * with older versions. Can be used to forbid the use of any function.
22
 
 *
23
 
 * @category  PHP
24
 
 * @package   PHP_CodeSniffer
25
 
 * @author    Greg Sherwood <gsherwood@squiz.net>
26
 
 * @author    Marc McIntyre <mmcintyre@squiz.net>
27
 
 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
28
 
 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
29
 
 * @version   Release: 1.1.0
30
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
31
 
 */
32
 
class Generic_Sniffs_PHP_ForbiddenFunctionsSniff implements PHP_CodeSniffer_Sniff
33
 
{
34
 
 
35
 
    /**
36
 
     * A list of forbidden functions with their alternatives.
37
 
     *
38
 
     * The value is NULL if no alternative exists. IE, the
39
 
     * function should just not be used.
40
 
     *
41
 
     * @var array(string => string|null)
42
 
     */
43
 
    protected $forbiddenFunctions = array(
44
 
                                     'sizeof' => 'count',
45
 
                                     'delete' => 'unset',
46
 
                                    );
47
 
 
48
 
 
49
 
    /**
50
 
     * Returns an array of tokens this test wants to listen for.
51
 
     *
52
 
     * @return array
53
 
     */
54
 
    public function register()
55
 
    {
56
 
        return array(T_STRING);
57
 
 
58
 
    }//end register()
59
 
 
60
 
 
61
 
    /**
62
 
     * Processes this test, when one of its tokens is encountered.
63
 
     *
64
 
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
65
 
     * @param int                  $stackPtr  The position of the current token in the
66
 
     *                                        stack passed in $tokens.
67
 
     *
68
 
     * @return void
69
 
     */
70
 
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
71
 
    {
72
 
        $tokens = $phpcsFile->getTokens();
73
 
 
74
 
        $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
75
 
        if (in_array($tokens[$prevToken]['code'], array(T_DOUBLE_COLON, T_OBJECT_OPERATOR, T_FUNCTION)) === true) {
76
 
            // Not a call to a PHP function.
77
 
            return;
78
 
        }
79
 
 
80
 
        $function = strtolower($tokens[$stackPtr]['content']);
81
 
 
82
 
        if (in_array($function, array_keys($this->forbiddenFunctions)) === false) {
83
 
            return;
84
 
        }
85
 
 
86
 
        $error = "The use of function $function() is forbidden";
87
 
        if ($this->forbiddenFunctions[$function] !== null) {
88
 
            $error .= '; use '.$this->forbiddenFunctions[$function].'() instead';
89
 
        }
90
 
 
91
 
        $phpcsFile->addError($error, $stackPtr);
92
 
 
93
 
    }//end process()
94
 
 
95
 
 
96
 
}//end class
97
 
 
98
 
?>