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

Source for file LowercaseClassKeywordsSniff.php

Documentation is available at LowercaseClassKeywordsSniff.php

  1. <?php
  2. /**
  3.  * Ensures all class keywords are lowercase.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class LowercaseClassKeywordsSniff 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(
  27.                 T_CLASS,
  28.                 T_INTERFACE,
  29.                 T_TRAIT,
  30.                 T_EXTENDS,
  31.                 T_IMPLEMENTS,
  32.                 T_ABSTRACT,
  33.                 T_FINAL,
  34.                 T_VAR,
  35.                 T_CONST,
  36.                );
  37.  
  38.     }//end register()
  39.  
  40.  
  41.     /**
  42.      * Processes this test, when one of its tokens is encountered.
  43.      *
  44.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  45.      * @param int                         $stackPtr  The position of the current token in
  46.      *                                                the stack passed in $tokens.
  47.      *
  48.      * @return void 
  49.      */
  50.     public function process(File $phpcsFile$stackPtr)
  51.     {
  52.         $tokens $phpcsFile->getTokens();
  53.  
  54.         $content $tokens[$stackPtr]['content'];
  55.         if ($content !== strtolower($content)) {
  56.             $error '%s keyword must be lowercase; expected "%s" but found "%s"';
  57.             $data  = array(
  58.                       strtoupper($content),
  59.                       strtolower($content),
  60.                       $content,
  61.                      );
  62.  
  63.             $fix $phpcsFile->addFixableError($error$stackPtr'FoundUppercase'$data);
  64.             if ($fix === true{
  65.                 $phpcsFile->fixer->replaceToken($stackPtrstrtolower($content));
  66.             }
  67.         }
  68.  
  69.     }//end process()
  70.  
  71.  
  72. }//end class

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