class LowercasedFilenameSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LowercasedFilenameSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of LowercasedFilenameSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Generic/ Sniffs/ Files/ LowercasedFilenameSniff.php, line 15
Namespace
PHP_CodeSniffer\Standards\Generic\Sniffs\FilesView source
class LowercasedFilenameSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_OPEN_TAG,
T_OPEN_TAG_WITH_ECHO,
];
}
//end register()
/**
* Processes this sniff, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in
* the stack passed in $tokens.
*
* @return int
*/
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;
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
LowercasedFilenameSniff::process | public | function | Processes this sniff, when one of its tokens is encountered. | Overrides Sniff::process |
LowercasedFilenameSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |