Source for file DisallowComparisonAssignmentSniff.php
Documentation is available at DisallowComparisonAssignmentSniff.php
* Ensures that the value of a comparison is not assigned to a variable.
* @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\PHP;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
class DisallowComparisonAssignmentSniff 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 ();
// Ignore default value assignments in function definitions.
$function = $phpcsFile->findPrevious (T_FUNCTION , ($stackPtr - 1 ), null , false , null , true );
if ($function !== false ) {
$opener = $tokens[$function]['parenthesis_opener'];
$closer = $tokens[$function]['parenthesis_closer'];
if ($opener < $stackPtr && $closer > $stackPtr) {
// Ignore values in array definitions.
$array = $phpcsFile->findNext (
// Ignore function calls.
$next = $phpcsFile->findNext ($ignore, ($stackPtr + 1 ), null , true );
&& $tokens[($next - 1 )]['code'] === T_STRING
// Code will look like: $var = myFunction(
$endStatement = $phpcsFile->findNext (T_SEMICOLON, ($stackPtr + 1 ));
if ($tokens[$stackPtr]['conditions'] !== $tokens[$endStatement]['conditions']) {
// This statement doesn't end with a semicolon, which is the case for
// the last expression in a for loop.
for ($i = ($stackPtr + 1 ); $i < $endStatement; $i++ ) {
if (isset (Tokens ::$comparisonTokens[$tokens[$i]['code']]) === true
$error = 'The value of a comparison must not be assigned to a variable';
$phpcsFile->addError ($error, $stackPtr, 'AssignedComparison');
if (isset (Tokens ::$booleanOperators[$tokens[$i]['code']]) === true
$error = 'The value of a boolean operation must not be assigned to a variable';
$phpcsFile->addError ($error, $stackPtr, 'AssignedBool');
Documentation generated on Mon, 11 Mar 2019 15:27:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|