Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
33.33% covered (danger)
33.33%
1 / 3
CRAP
15.38% covered (danger)
15.38%
4 / 26
ClassMatchesFilenameSniff
0.00% covered (danger)
0.00%
0 / 1
33.33% covered (danger)
33.33%
1 / 3
115.38
15.38% covered (danger)
15.38%
4 / 26
 register
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 process
0.00% covered (danger)
0.00%
0 / 1
34.37
17.65% covered (danger)
17.65%
3 / 17
 isMaintenanceScript
0.00% covered (danger)
0.00%
0 / 1
30
0.00% covered (danger)
0.00%
0 / 8
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */
namespace MediaWiki\Sniffs\Files;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
class ClassMatchesFilenameSniff implements Sniff {
    /**
     * @inheritDoc
     */
    public function register() : array {
        return [ T_CLASS, T_INTERFACE, T_TRAIT ];
    }
    /**
     * Check the class name against the filename
     * This check is only done once, the rest of the file is always ignored.
     *
     * @param File $phpcsFile
     * @param int $stackPtr
     * @return int
     */
    public function process( File $phpcsFile, $stackPtr ) {
        $fname = $phpcsFile->getFilename();
        if ( $fname === 'STDIN' ) {
            return $phpcsFile->numTokens;
        }
        $base = basename( $fname );
        $name = $phpcsFile->getDeclarationName( $stackPtr );
        if ( $base !== "$name.php" ) {
            $wrongCase = strcasecmp( $base, "$name.php" ) === 0;
            if ( $wrongCase && $this->isMaintenanceScript( $phpcsFile ) ) {
                // Maintenance scripts follow the class name, but the first
                // letter is lowercase.
                $expected = lcfirst( $name );
                if ( $base === "$expected.php" ) {
                    // OK!
                    return $phpcsFile->numTokens;
                }
            }
            $phpcsFile->addError(
                'Class name \'%s\' does not match filename \'%s\'',
                $stackPtr,
                $wrongCase ? 'WrongCase' : 'NotMatch',
                [ $name, $base ]
            );
        }
        return $phpcsFile->numTokens;
    }
    /**
     * Figure out whether the file is a MediaWiki maintenance script
     *
     * @param File $phpcsFile
     *
     * @return bool
     */
    private function isMaintenanceScript( File $phpcsFile ) : bool {
        $tokens = $phpcsFile->getTokens();
        // Per convention the line we are looking for is the last in all maintenance scripts
        for ( $i = $phpcsFile->numTokens; $i--; ) {
            if ( $tokens[$i]['level'] !== 0 ) {
                // Only look into the global scope
                return false;
            }
            if ( $tokens[$i]['code'] === T_STRING
                && $tokens[$i]['content'] === 'RUN_MAINTENANCE_IF_MAIN'
            ) {
                return true;
            }
        }
        return false;
    }
}