Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. LowerCaseKeywordSniff.php

function LowerCaseKeywordSniff::process

Processes this sniff, when one of its tokens is encountered.

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 Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/PHP/LowerCaseKeywordSniff.php, line 52

Class

LowerCaseKeywordSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\PHP

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $keyword = $tokens[$stackPtr]['content'];
    if (strtolower($keyword) !== $keyword) {
        if ($keyword === strtoupper($keyword)) {
            $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'upper');
        }
        else {
            $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'mixed');
        }
        $messageKeyword = Common::prepareForOutput($keyword);
        $error = 'PHP keywords must be lowercase; expected "%s" but found "%s"';
        $data = [
            strtolower($messageKeyword),
            $messageKeyword,
        ];
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data);
        if ($fix === true) {
            $phpcsFile->fixer
                ->replaceToken($stackPtr, strtolower($keyword));
        }
    }
    else {
        $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'lower');
    }
    
    //end if
}
RSS feed
Powered by Drupal