Source for file IncrementDecrementUsageSniff.php
Documentation is available at IncrementDecrementUsageSniff.php
* Ensures that the ++ operators are used when possible.
* @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\Operators;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
class IncrementDecrementUsageSniff implements Sniff
* 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]['code'] === T_INC || $tokens[$stackPtr]['code'] === T_DEC ) {
$this->processIncDec ($phpcsFile, $stackPtr);
$this->processAssignment ($phpcsFile, $stackPtr);
* Checks to ensure increment and decrement operators are not confusing.
* @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.
protected function processIncDec ($phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
// Work out where the variable is so we know where to
// start looking for other operators.
if ($tokens[($stackPtr - 1 )]['code'] === T_VARIABLE
|| ($tokens[($stackPtr - 1 )]['code'] === T_STRING
&& $tokens[($stackPtr - 2 )]['code'] === T_OBJECT_OPERATOR )
$start = ($stackPtr + 1 );
$start = ($stackPtr + 2 );
$next = $phpcsFile->findNext (Tokens ::$emptyTokens, $start, null , true );
if (isset (Tokens ::$arithmeticTokens[$tokens[$next]['code']]) === true ) {
$error = 'Increment and decrement operators cannot be used in an arithmetic operation';
$phpcsFile->addError ($error, $stackPtr, 'NotAllowed');
$prev = $phpcsFile->findPrevious (Tokens ::$emptyTokens, ($start - 3 ), null , true );
// Check if this is in a string concat.
$error = 'Increment and decrement operators must be bracketed when used in string concatenation';
$phpcsFile->addError ($error, $stackPtr, 'NoBrackets');
* Checks to ensure increment and decrement operators are used.
* @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.
protected function processAssignment ($phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
$assignedVar = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 1 ), null , true );
// Not an assignment, return.
if ($tokens[$assignedVar]['code'] !== T_VARIABLE ) {
// If there is anything other than variables, numbers, spaces or operators we need to return.
$noiseTokens = $phpcsFile->findNext (array (T_LNUMBER , T_VARIABLE , T_WHITESPACE , T_PLUS, T_MINUS, T_OPEN_PARENTHESIS), ($stackPtr + 1 ), $statementEnd, true );
if ($noiseTokens !== false ) {
// If we are already using += or -=, we need to ignore
// the statement if a variable is being used.
if ($tokens[$stackPtr]['code'] !== T_EQUAL) {
$nextVar = $phpcsFile->findNext (T_VARIABLE , ($stackPtr + 1 ), $statementEnd);
if ($nextVar !== false ) {
if ($tokens[$stackPtr]['code'] === T_EQUAL) {
$nextVar = ($stackPtr + 1 );
$previousVariable = ($stackPtr + 1 );
while (($nextVar = $phpcsFile->findNext (T_VARIABLE , ($nextVar + 1 ), $statementEnd)) !== false ) {
$previousVariable = $nextVar;
if ($variableCount !== 1 ) {
$nextVar = $previousVariable;
if ($tokens[$nextVar]['content'] !== $tokens[$assignedVar]['content']) {
// We have only one variable, and it's the same as what is being assigned,
// so we need to check what is being added or subtracted.
$nextNumber = ($stackPtr + 1 );
$previousNumber = ($stackPtr + 1 );
while (($nextNumber = $phpcsFile->findNext (array (T_LNUMBER ), ($nextNumber + 1 ), $statementEnd, false )) !== false ) {
$previousNumber = $nextNumber;
if ($numberCount !== 1 ) {
$nextNumber = $previousNumber;
if ($tokens[$nextNumber]['content'] === '1') {
if ($tokens[$stackPtr]['code'] === T_EQUAL) {
$opToken = $phpcsFile->findNext (array (T_PLUS, T_MINUS), ($nextVar + 1 ), $statementEnd);
if ($opToken === false ) {
// Operator was before the variable, like:
$operator = $tokens[$opToken]['content'];
$operator = substr($tokens[$stackPtr]['content'], 0 , 1 );
// If we are adding or subtracting negative value, the operator
if ($tokens[$stackPtr]['code'] !== T_EQUAL) {
$negative = $phpcsFile->findPrevious (T_MINUS, ($nextNumber - 1 ), $stackPtr);
if ($negative !== false ) {
$expected = $tokens[$assignedVar]['content']. $operator. $operator;
$found = $phpcsFile->getTokensAsString ($assignedVar, ($statementEnd - $assignedVar + 1 ));
$error .= " operators should be used where possible; found \"$found\" but expected \"$expected\"";
$phpcsFile->addError ($error, $stackPtr, 'Found');
}//end processAssignment()
Documentation generated on Mon, 11 Mar 2019 15:27:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|