function LowercasedFilenameSniff::process

Processes this sniff, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token in: the stack passed in $tokens.

Return value

int

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Files/LowercasedFilenameSniff.php, line 43

Class

LowercasedFilenameSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Files

Code

public function process(File $phpcsFile, $stackPtr) {
    $filename = $phpcsFile->getFilename();
    if ($filename === 'STDIN') {
        return $phpcsFile->numTokens;
    }
    $filename = basename($filename);
    $lowercaseFilename = strtolower($filename);
    if ($filename !== $lowercaseFilename) {
        $data = [
            $filename,
            $lowercaseFilename,
        ];
        $error = 'Filename "%s" doesn\'t match the expected filename "%s"';
        $phpcsFile->addError($error, $stackPtr, 'NotFound', $data);
        $phpcsFile->recordMetric($stackPtr, 'Lowercase filename', 'no');
    }
    else {
        $phpcsFile->recordMetric($stackPtr, 'Lowercase filename', 'yes');
    }
    // Ignore the rest of the file.
    return $phpcsFile->numTokens;
}