function UpperCaseConstantSniff::processConstant

Processes a non-type declaration constant.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token in the: stack passed in $tokens.

Return value

void

Overrides LowerCaseConstantSniff::processConstant

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/PHP/UpperCaseConstantSniff.php, line 27

Class

UpperCaseConstantSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\PHP

Code

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');
    }
}