1<?php 2/** 3 * Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff. 4 * 5 * PHP version 5 6 * 7 * @category PHP 8 * @package PHP_CodeSniffer 9 * @author Greg Sherwood <gsherwood@squiz.net> 10 * @author Marc McIntyre <mmcintyre@squiz.net> 11 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) 12 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 13 * @link http://pear.php.net/package/PHP_CodeSniffer 14 */ 15 16/** 17 * Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff. 18 * 19 * Ensures all function keywords are lowercase. 20 * 21 * @category PHP 22 * @package PHP_CodeSniffer 23 * @author Greg Sherwood <gsherwood@squiz.net> 24 * @author Marc McIntyre <mmcintyre@squiz.net> 25 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) 26 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence 27 * @version Release: @package_version@ 28 * @link http://pear.php.net/package/PHP_CodeSniffer 29 */ 30class Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff implements PHP_CodeSniffer_Sniff 31{ 32 33 34 /** 35 * Returns an array of tokens this test wants to listen for. 36 * 37 * @return array 38 */ 39 public function register() 40 { 41 return array( 42 T_FUNCTION, 43 T_PUBLIC, 44 T_PRIVATE, 45 T_PROTECTED, 46 T_STATIC, 47 ); 48 49 }//end register() 50 51 52 /** 53 * Processes this test, when one of its tokens is encountered. 54 * 55 * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. 56 * @param int $stackPtr The position of the current token in 57 * the stack passed in $tokens. 58 * 59 * @return void 60 */ 61 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) 62 { 63 $tokens = $phpcsFile->getTokens(); 64 65 $content = $tokens[$stackPtr]['content']; 66 if ($content !== strtolower($content)) { 67 $error = '%s keyword must be lowercase; expected "%s" but found "%s"'; 68 $data = array( 69 strtoupper($content), 70 strtolower($content), 71 $content, 72 ); 73 $phpcsFile->addError($error, $stackPtr, 'FoundUppercase', $data); 74 } 75 76 }//end process() 77 78 79}//end class 80