Source for file DisallowObjectStringIndexSniff.php
Documentation is available at DisallowObjectStringIndexSniff.php
* Ensures that object indexes are written in dot notation.
* @author Sertan Danis <sdanis@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Objects;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class DisallowObjectStringIndexSniff implements Sniff
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array ('JS');
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this test, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
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 ) {
// Make sure it is the only thing in the square brackets.
$next = $phpcsFile->findNext (T_WHITESPACE , ($index + 1 ), null , true );
// Allow indexes that have dots in them because we can't write
$content = trim($tokens[$index]['content'], '"\' ');
if (strpos($content, '.') !== false ) {
// Also ignore reserved words.
if ($content === 'super') {
// 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');
Documentation generated on Mon, 11 Mar 2019 15:27:23 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|