Source for file LowercasedFilenameSniff.php
Documentation is available at LowercasedFilenameSniff.php
* Checks that all file names are lowercased.
* @author Andy Grunwald <andygrunwald@gmail.com>
* @copyright 2010-2014 Andy Grunwald
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Generic\Sniffs\Files;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class LowercasedFilenameSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
return array (T_OPEN_TAG );
* 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.
public function process (File $phpcsFile, $stackPtr)
$filename = $phpcsFile->getFilename ();
if ($filename === 'STDIN') {
if ($filename !== $lowercaseFilename) {
$error = 'Filename "%s" doesn\'t match the expected filename "%s"';
$phpcsFile->addError ($error, $stackPtr, 'NotFound', $data);
$phpcsFile->recordMetric ($stackPtr, 'Lowercase filename', 'no');
$phpcsFile->recordMetric ($stackPtr, 'Lowercase filename', 'yes');
// Ignore the rest of the file.
return ($phpcsFile->numTokens + 1 );
Documentation generated on Mon, 11 Mar 2019 15:27:37 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|