1<?php 2/** 3 * Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff. 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_Classes_LowercaseClassKeywordsSniff. 18 * 19 * Ensures all class 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_Classes_LowercaseClassKeywordsSniff 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_CLASS, 43 T_INTERFACE, 44 T_TRAIT, 45 T_EXTENDS, 46 T_IMPLEMENTS, 47 T_ABSTRACT, 48 T_FINAL, 49 T_VAR, 50 T_CONST, 51 ); 52 53 }//end register() 54 55 56 /** 57 * Processes this test, when one of its tokens is encountered. 58 * 59 * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. 60 * @param int $stackPtr The position of the current token in 61 * the stack passed in $tokens. 62 * 63 * @return void 64 */ 65 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) 66 { 67 $tokens = $phpcsFile->getTokens(); 68 69 $content = $tokens[$stackPtr]['content']; 70 if ($content !== strtolower($content)) { 71 $error = '%s keyword must be lowercase; expected "%s" but found "%s"'; 72 $data = array( 73 strtoupper($content), 74 strtolower($content), 75 $content, 76 ); 77 78 $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FoundUppercase', $data); 79 if ($fix === true) { 80 $phpcsFile->fixer->replaceToken($stackPtr, strtolower($content)); 81 } 82 } 83 84 }//end process() 85 86 87}//end class 88