PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file LowercasedFilenameSniff.php

Documentation is available at LowercasedFilenameSniff.php

  1. <?php
  2. /**
  3.  * Checks that all file names are lowercased.
  4.  *
  5.  * @author    Andy Grunwald <andygrunwald@gmail.com>
  6.  * @copyright 2010-2014 Andy Grunwald
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\Generic\Sniffs\Files;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class LowercasedFilenameSniff implements Sniff
  16. {
  17.  
  18.  
  19.     /**
  20.      * Returns an array of tokens this test wants to listen for.
  21.      *
  22.      * @return array 
  23.      */
  24.     public function register()
  25.     {
  26.         return array(T_OPEN_TAG);
  27.  
  28.     }//end register()
  29.  
  30.  
  31.     /**
  32.      * Processes this sniff, when one of its tokens is encountered.
  33.      *
  34.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  35.      * @param int                         $stackPtr  The position of the current token in
  36.      *                                                the stack passed in $tokens.
  37.      *
  38.      * @return int 
  39.      */
  40.     public function process(File $phpcsFile$stackPtr)
  41.     {
  42.         $filename $phpcsFile->getFilename();
  43.         if ($filename === 'STDIN'{
  44.             return;
  45.         }
  46.  
  47.         $filename          basename($filename);
  48.         $lowercaseFilename strtolower($filename);
  49.         if ($filename !== $lowercaseFilename{
  50.             $data  = array(
  51.                       $filename,
  52.                       $lowercaseFilename,
  53.                      );
  54.             $error 'Filename "%s" doesn\'t match the expected filename "%s"';
  55.             $phpcsFile->addError($error$stackPtr'NotFound'$data);
  56.             $phpcsFile->recordMetric($stackPtr'Lowercase filename''no');
  57.         else {
  58.             $phpcsFile->recordMetric($stackPtr'Lowercase filename''yes');
  59.         }
  60.  
  61.         // Ignore the rest of the file.
  62.         return ($phpcsFile->numTokens + 1);
  63.  
  64.     }//end process()
  65.  
  66.  
  67. }//end class

Documentation generated on Mon, 11 Mar 2019 15:27:37 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.