function ValidVariableNameSniff::processMemberVar

Same name in this branch

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

Processes class member variables.

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::processMemberVar

File

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

Class

ValidVariableNameSniff

Namespace

PHP_CodeSniffer\Standards\Zend\Sniffs\NamingConventions

Code

protected function processMemberVar(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $varName = ltrim($tokens[$stackPtr]['content'], '$');
    $memberProps = $phpcsFile->getMemberProperties($stackPtr);
    if (empty($memberProps) === true) {
        // Exception encountered.
        return;
    }
    $public = $memberProps['scope'] === 'public';
    if ($public === true) {
        if (substr($varName, 0, 1) === '_') {
            $error = 'Public member variable "%s" must not contain a leading underscore';
            $data = [
                $varName,
            ];
            $phpcsFile->addError($error, $stackPtr, 'PublicHasUnderscore', $data);
        }
    }
    else {
        if (substr($varName, 0, 1) !== '_') {
            $scope = ucfirst($memberProps['scope']);
            $error = '%s member variable "%s" must contain a leading underscore';
            $data = [
                $scope,
                $varName,
            ];
            $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $data);
        }
    }
    // Remove a potential underscore prefix for testing CamelCaps.
    $varName = ltrim($varName, '_');
    if (Common::isCamelCaps($varName, false, true, false) === false) {
        $error = 'Member variable "%s" is not in valid camel caps format';
        $data = [
            $varName,
        ];
        $phpcsFile->addError($error, $stackPtr, 'MemberVarNotCamelCaps', $data);
    }
    else {
        if (preg_match('|\\d|', $varName) === 1) {
            $warning = 'Member variable "%s" contains numbers but this is discouraged';
            $data = [
                $varName,
            ];
            $phpcsFile->addWarning($warning, $stackPtr, 'MemberVarContainsNumbers', $data);
        }
    }
}