Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
NestedFunctionsSniff
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 2
30
0.00% covered (danger)
0.00%
0 / 1
 register
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 process
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
20
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21namespace MediaWiki\Sniffs\Usage;
22
23use PHP_CodeSniffer\Files\File;
24use PHP_CodeSniffer\Sniffs\Sniff;
25
26class NestedFunctionsSniff implements Sniff {
27
28    /**
29     * @inheritDoc
30     */
31    public function register(): array {
32        return [ T_FUNCTION ];
33    }
34
35    /**
36     * @param File $phpcsFile
37     * @param int $stackPtr The current token index.
38     */
39    public function process( File $phpcsFile, $stackPtr ) {
40        $functionName = $phpcsFile->getDeclarationName( $stackPtr );
41        if ( $functionName === false ) {
42            return;
43        }
44
45        // Walk through parent scopes, looking for functions/closures that are not in an
46        // anonymous class
47        if (
48            $phpcsFile->hasCondition( $stackPtr, [ T_FUNCTION, T_CLOSURE ] ) &&
49            !$phpcsFile->hasCondition( $stackPtr, [ T_ANON_CLASS ] )
50        ) {
51            $error = 'Function %s is nested inside of another function or closure';
52            $phpcsFile->addError( $error, $stackPtr, 'NestedFunction', [ $functionName ] );
53        }
54    }
55}