Source for file ObjectOperatorSpacingSniff.php
Documentation is available at ObjectOperatorSpacingSniff.php
* Ensure there is no whitespace before/after an object operator.
* @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\WhiteSpace;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class ObjectOperatorSpacingSniff implements Sniff
* Allow newlines instead of spaces.
public $ignoreNewlines = false;
* 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 ();
if ($tokens[($stackPtr - 1 )]['code'] !== T_WHITESPACE ) {
if ($tokens[($stackPtr - 2 )]['line'] !== $tokens[$stackPtr]['line']) {
$before = $tokens[($stackPtr - 1 )]['length'];
if ($tokens[($stackPtr + 1 )]['code'] !== T_WHITESPACE ) {
if ($tokens[($stackPtr + 2 )]['line'] !== $tokens[$stackPtr]['line']) {
$after = $tokens[($stackPtr + 1 )]['length'];
$phpcsFile->recordMetric ($stackPtr, 'Spacing before object operator', $before);
$phpcsFile->recordMetric ($stackPtr, 'Spacing after object operator', $after);
$this->checkSpacingBeforeOperator ($phpcsFile, $stackPtr, $before);
$this->checkSpacingAfterOperator ($phpcsFile, $stackPtr, $after);
* Check the spacing before the operator.
* @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.
* @param mixed $before The number of spaces found before the
* operator or the string 'newline'.
* @return boolean true if there was no error, false otherwise.
protected function checkSpacingBeforeOperator (File $phpcsFile, $stackPtr, $before)
&& ($before !== 'newline' || $this->ignoreNewlines === false )
$error = 'Space found before object operator';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'Before');
$phpcsFile->fixer ->replaceToken (($stackPtr - 1 ), '');
}//end checkSpacingBeforeOperator()
* Check the spacing after the operator.
* @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.
* @param mixed $after The number of spaces found after the
* operator or the string 'newline'.
* @return boolean true if there was no error, false otherwise.
protected function checkSpacingAfterOperator (File $phpcsFile, $stackPtr, $after)
&& ($after !== 'newline' || $this->ignoreNewlines === false )
$error = 'Space found after object operator';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'After');
$phpcsFile->fixer ->replaceToken (($stackPtr + 1 ), '');
}//end checkSpacingAfterOperator()
Documentation generated on Mon, 11 Mar 2019 15:27:39 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|