function ValidVariableNameSniff::processVariable

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php \Drupal\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()
2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/NamingConventions/ValidVariableNameSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()
3. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.php \PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidVariableNameSniff::processVariable()

Processes this test, 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 AbstractVariableSniff::processVariable

File

vendor/squizlabs/php_codesniffer/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php, line 30

Class

ValidVariableNameSniff

Namespace

PHP_CodeSniffer\Standards\Zend\Sniffs\NamingConventions

Code

protected function processVariable(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $varName = ltrim($tokens[$stackPtr]['content'], '$');
    // If it's a php reserved var, then its ok.
    if (isset($this->phpReservedVars[$varName]) === true) {
        return;
    }
    $objOperator = $phpcsFile->findNext([
        T_WHITESPACE,
    ], $stackPtr + 1, null, true);
    if ($tokens[$objOperator]['code'] === T_OBJECT_OPERATOR || $tokens[$objOperator]['code'] === T_NULLSAFE_OBJECT_OPERATOR) {
        // Check to see if we are using a variable from an object.
        $var = $phpcsFile->findNext([
            T_WHITESPACE,
        ], $objOperator + 1, null, true);
        if ($tokens[$var]['code'] === T_STRING) {
            // Either a var name or a function call, so check for bracket.
            $bracket = $phpcsFile->findNext([
                T_WHITESPACE,
            ], $var + 1, null, true);
            if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) {
                $objVarName = $tokens[$var]['content'];
                // There is no way for us to know if the var is public or private,
                // so we have to ignore a leading underscore if there is one and just
                // check the main part of the variable name.
                $originalVarName = $objVarName;
                if (substr($objVarName, 0, 1) === '_') {
                    $objVarName = substr($objVarName, 1);
                }
                if (Common::isCamelCaps($objVarName, false, true, false) === false) {
                    $error = 'Variable "%s" is not in valid camel caps format';
                    $data = [
                        $originalVarName,
                    ];
                    $phpcsFile->addError($error, $var, 'NotCamelCaps', $data);
                }
                else {
                    if (preg_match('|\\d|', $objVarName) === 1) {
                        $warning = 'Variable "%s" contains numbers but this is discouraged';
                        $data = [
                            $originalVarName,
                        ];
                        $phpcsFile->addWarning($warning, $stackPtr, 'ContainsNumbers', $data);
                    }
                }
            }
            
            //end if
        }
        
        //end if
    }
    
    //end if
    // There is no way for us to know if the var is public or private,
    // so we have to ignore a leading underscore if there is one and just
    // check the main part of the variable name.
    $originalVarName = $varName;
    if (substr($varName, 0, 1) === '_') {
        $objOperator = $phpcsFile->findPrevious([
            T_WHITESPACE,
        ], $stackPtr - 1, null, true);
        if ($tokens[$objOperator]['code'] === T_DOUBLE_COLON) {
            // The variable lives within a class, and is referenced like
            // this: MyClass::$_variable, so we don't know its scope.
            $inClass = true;
        }
        else {
            $inClass = $phpcsFile->hasCondition($stackPtr, Tokens::$ooScopeTokens);
        }
        if ($inClass === true) {
            $varName = substr($varName, 1);
        }
    }
    if (Common::isCamelCaps($varName, false, true, false) === false) {
        $error = 'Variable "%s" is not in valid camel caps format';
        $data = [
            $originalVarName,
        ];
        $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data);
    }
    else {
        if (preg_match('|\\d|', $varName) === 1) {
            $warning = 'Variable "%s" contains numbers but this is discouraged';
            $data = [
                $originalVarName,
            ];
            $phpcsFile->addWarning($warning, $stackPtr, 'ContainsNumbers', $data);
        }
    }
}