class UpperCaseConstantSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseConstantSniff implements \PHP_CodeSniffer\Sniffs\Sniff
- class \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\UpperCaseConstantSniff extends \PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseConstantSniff
Expanded class hierarchy of UpperCaseConstantSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Generic/ Sniffs/ PHP/ UpperCaseConstantSniff.php, line 14
Namespace
PHP_CodeSniffer\Standards\Generic\Sniffs\PHPView source
class UpperCaseConstantSniff extends LowerCaseConstantSniff {
/**
* Processes a non-type declaration constant.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
*
* @return void
*/
protected function processConstant(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$keyword = $tokens[$stackPtr]['content'];
$expected = strtoupper($keyword);
if ($keyword !== $expected) {
if ($keyword === strtolower($keyword)) {
$phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'lower');
}
else {
$phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'mixed');
}
$error = 'TRUE, FALSE and NULL must be uppercase; expected "%s" but found "%s"';
$data = [
$expected,
$keyword,
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data);
if ($fix === true) {
$phpcsFile->fixer
->replaceToken($stackPtr, $expected);
}
}
else {
$phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'upper');
}
}
//end processConstant()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
LowerCaseConstantSniff::$propertyTypeTokens | private | property | Token types which can be encountered in a property type declaration. | |
LowerCaseConstantSniff::$supportedTokenizers | public | property | A list of tokenizers this sniff supports. | |
LowerCaseConstantSniff::$targets | private | property | The tokens this sniff is targetting. | |
LowerCaseConstantSniff::process | public | function | Processes this sniff, when one of its tokens is encountered. | Overrides Sniff::process |
LowerCaseConstantSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |
UpperCaseConstantSniff::processConstant | protected | function | Processes a non-type declaration constant. | Overrides LowerCaseConstantSniff::processConstant |