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

Source for file LowercaseFunctionKeywordsSniff.php

Documentation is available at LowercaseFunctionKeywordsSniff.php

  1. <?php
  2. /**
  3.  * Ensures all function 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\Functions;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14.  
  15. class LowercaseFunctionKeywordsSniff 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_FUNCTION,
  28.                 T_PUBLIC,
  29.                 T_PRIVATE,
  30.                 T_PROTECTED,
  31.                 T_STATIC,
  32.                );
  33.  
  34.     }//end register()
  35.  
  36.  
  37.     /**
  38.      * Processes this test, when one of its tokens is encountered.
  39.      *
  40.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  41.      * @param int                         $stackPtr  The position of the current token in
  42.      *                                                the stack passed in $tokens.
  43.      *
  44.      * @return void 
  45.      */
  46.     public function process(File $phpcsFile$stackPtr)
  47.     {
  48.         $tokens $phpcsFile->getTokens();
  49.  
  50.         $content $tokens[$stackPtr]['content'];
  51.         if ($content !== strtolower($content)) {
  52.             $error '%s keyword must be lowercase; expected "%s" but found "%s"';
  53.             $data  = array(
  54.                       strtoupper($content),
  55.                       strtolower($content),
  56.                       $content,
  57.                      );
  58.             $phpcsFile->addError($error$stackPtr'FoundUppercase'$data);
  59.         }
  60.  
  61.     }//end process()
  62.  
  63.  
  64. }//end class

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