function ValidVariableNameSniff::processVariable

Same name in this branch

11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/NamingConventions/ValidVariableNameSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()
11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php \PHP_CodeSniffer\Standards\Zend\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()
11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.php \PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()

Processes normal variables.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.:

int $stackPtr The position where the token was found.:

Return value

void

Overrides AbstractVariableSniff::processVariable

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php, line 104

Class

ValidVariableNameSniff: \Drupal\Sniffs\NamingConventions\ValidVariableNameSniff.

Namespace

Drupal\Sniffs\NamingConventions

Code

protected function processVariable(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $varName = ltrim($tokens[$stackPtr]['content'], '$');
    $phpReservedVars = [
        '_SERVER',
        '_GET',
        '_POST',
        '_REQUEST',
        '_SESSION',
        '_ENV',
        '_COOKIE',
        '_FILES',
        'GLOBALS',
    ];
    // If it's a php reserved var, then its ok.
    if (in_array($varName, $phpReservedVars) === true) {
        return;
    }
    // If it is a static public variable of a class, then its ok.
    if ($tokens[$stackPtr - 1]['code'] === T_DOUBLE_COLON) {
        return;
    }
    if (preg_match('/^[A-Z]/', $varName) === 1) {
        $error = "Variable \"{$varName}\" starts with a capital letter, but only \$lowerCamelCase or \$snake_case is allowed";
        $phpcsFile->addError($error, $stackPtr, 'LowerStart');
    }
}