function DisallowObjectStringIndexSniff::process

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

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php, line 49

Class

DisallowObjectStringIndexSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Objects

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    // Check if the next non whitespace token is a string.
    $index = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
    if ($tokens[$index]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
        return;
    }
    // Make sure it is the only thing in the square brackets.
    $next = $phpcsFile->findNext(T_WHITESPACE, $index + 1, null, true);
    if ($tokens[$next]['code'] !== T_CLOSE_SQUARE_BRACKET) {
        return;
    }
    // Allow indexes that have dots in them because we can't write
    // them in dot notation.
    $content = trim($tokens[$index]['content'], '"\' ');
    if (strpos($content, '.') !== false) {
        return;
    }
    // Also ignore reserved words.
    if ($content === 'super') {
        return;
    }
    // Token before the opening square bracket cannot be a var name.
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
    if ($tokens[$prev]['code'] === T_STRING) {
        $error = 'Object indexes must be written in dot notation';
        $phpcsFile->addError($error, $prev, 'Found');
    }
}