function Constraint::evaluate

Evaluates the constraint for parameter $other.

If $returnResult is set to false (the default), an exception is thrown in case of a failure. null is returned otherwise.

If $returnResult is true, the result of the evaluation is returned as a boolean value instead: true in case of success, false in case of a failure.

Throws

ExpectationFailedException

7 methods override Constraint::evaluate()

IsAnything::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php: Evaluates the constraint for parameter $other.
IsEqual::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqual.php: Evaluates the constraint for parameter $other.
IsEqualCanonicalizing::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqualCanonicalizing.php: Evaluates the constraint for parameter $other.
IsEqualIgnoringCase::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqualIgnoringCase.php: Evaluates the constraint for parameter $other.
IsEqualWithDelta::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqualWithDelta.php: Evaluates the constraint for parameter $other.

... See full list

File

vendor/phpunit/phpunit/src/Framework/Constraint/Constraint.php, line 38

Class

Constraint: @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

Namespace

PHPUnit\Framework\Constraint

Code

public function evaluate(mixed $other, string $description = '', bool $returnResult = false) : ?bool {
    $success = false;
    if ($this->matches($other)) {
        $success = true;
    }
    if ($returnResult) {
        return $success;
    }
    if (!$success) {
        $this->fail($other, $description);
    }
    return null;
}