Source for file ArrayBracketSpacingSniff.php
Documentation is available at ArrayBracketSpacingSniff.php
* Ensure that there are no spaces around square brackets.
* @author Greg Sherwood <gsherwood@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\Arrays;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
class ArrayBracketSpacingSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this sniff, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
&& isset ($tokens[$stackPtr]['bracket_closer']) === false )
&& isset ($tokens[$stackPtr]['bracket_opener']) === false )
// Bow out for parse error/during live coding.
// Square brackets can not have a space before them.
$prevType = $tokens[($stackPtr - 1 )]['code'];
if ($prevType === T_WHITESPACE ) {
$nonSpace = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 2 ), null , true );
$expected = $tokens[$nonSpace]['content']. $tokens[$stackPtr]['content'];
$found = $phpcsFile->getTokensAsString ($nonSpace, ($stackPtr - $nonSpace)). $tokens[$stackPtr]['content'];
$error = 'Space found before square bracket; expected "%s" but found "%s"';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'SpaceBeforeBracket', $data);
$phpcsFile->fixer ->replaceToken (($stackPtr - 1 ), '');
// Open square brackets can't ever have spaces after them.
$nextType = $tokens[($stackPtr + 1 )]['code'];
if ($nextType === T_WHITESPACE ) {
$nonSpace = $phpcsFile->findNext (T_WHITESPACE , ($stackPtr + 2 ), null , true );
$expected = $tokens[$stackPtr]['content']. $tokens[$nonSpace]['content'];
$found = $phpcsFile->getTokensAsString ($stackPtr, ($nonSpace - $stackPtr + 1 ));
$error = 'Space found after square bracket; expected "%s" but found "%s"';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'SpaceAfterBracket', $data);
$phpcsFile->fixer ->replaceToken (($stackPtr + 1 ), '');
Documentation generated on Mon, 11 Mar 2019 15:27:14 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|