function DisallowComparisonAssignmentSniff::process

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/PHP/DisallowComparisonAssignmentSniff.php, line 41

Class

DisallowComparisonAssignmentSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP

Code

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) {
            return;
        }
    }
    // Ignore values in array definitions or match structures.
    $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
    if ($nextNonEmpty !== false && ($tokens[$nextNonEmpty]['code'] === T_ARRAY || $tokens[$nextNonEmpty]['code'] === T_MATCH)) {
        return;
    }
    // Ignore function calls.
    $ignore = [
        T_NULLSAFE_OBJECT_OPERATOR,
        T_OBJECT_OPERATOR,
        T_STRING,
        T_VARIABLE,
        T_WHITESPACE,
    ];
    $next = $phpcsFile->findNext($ignore, $stackPtr + 1, null, true);
    if ($tokens[$next]['code'] === T_CLOSURE || $tokens[$next]['code'] === T_OPEN_PARENTHESIS && $tokens[$next - 1]['code'] === T_STRING) {
        // Code will look like: $var = myFunction(
        // and will be ignored.
        return;
    }
    $endStatement = $phpcsFile->findEndOfStatement($stackPtr);
    for ($i = $stackPtr + 1; $i < $endStatement; $i++) {
        if (isset(Tokens::$comparisonTokens[$tokens[$i]['code']]) === true && $tokens[$i]['code'] !== T_COALESCE || $tokens[$i]['code'] === T_INLINE_THEN) {
            $error = 'The value of a comparison must not be assigned to a variable';
            $phpcsFile->addError($error, $stackPtr, 'AssignedComparison');
            break;
        }
        if (isset(Tokens::$booleanOperators[$tokens[$i]['code']]) === true || $tokens[$i]['code'] === T_BOOLEAN_NOT) {
            $error = 'The value of a boolean operation must not be assigned to a variable';
            $phpcsFile->addError($error, $stackPtr, 'AssignedBool');
            break;
        }
    }
}