1<?php
2/**
3 * Squiz_Sniffs_PHP_InnerFunctionsSniff.
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-2014 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_PHP_InnerFunctionsSniff.
18 *
19 * Ensures that functions within functions are never used.
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-2014 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: @package_version@
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class Squiz_Sniffs_PHP_InnerFunctionsSniff 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        $function = $phpcsFile->getCondition($stackPtr, T_FUNCTION);
60        if ($function === false) {
61            // Not a nested function.
62            return;
63        }
64
65        $class = $phpcsFile->getCondition($stackPtr, T_ANON_CLASS);
66        if ($class !== false && $class > $function) {
67            // Ignore methods in anon classes.
68            return;
69        }
70
71        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
72        if ($tokens[$prev]['code'] === T_EQUAL) {
73            // Ignore closures.
74            return;
75        }
76
77        $error = 'The use of inner functions is forbidden';
78        $phpcsFile->addError($error, $stackPtr, 'NotAllowed');
79
80    }//end process()
81
82
83}//end class
84