You are here

public function PHPUnit_Framework_Constraint::evaluate in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/phpunit/phpunit/src/Framework/Constraint.php \PHPUnit_Framework_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.

Parameters

mixed $other Value or object to evaluate.:

string $description Additional information about the test:

bool $returnResult Whether to return a result or throw an exception:

Return value

mixed

Throws

PHPUnit_Framework_ExpectationFailedException

9 methods override PHPUnit_Framework_Constraint::evaluate()
PHPUnit_Framework_Constraint_And::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/And.php
Evaluates the constraint for parameter $other
PHPUnit_Framework_Constraint_Composite::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/Composite.php
Evaluates the constraint for parameter $other
PHPUnit_Framework_Constraint_IsAnything::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php
Evaluates the constraint for parameter $other
PHPUnit_Framework_Constraint_IsEqual::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/IsEqual.php
Evaluates the constraint for parameter $other
PHPUnit_Framework_Constraint_IsIdentical::evaluate in vendor/phpunit/phpunit/src/Framework/Constraint/IsIdentical.php
Evaluates the constraint for parameter $other

... See full list

File

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

Class

PHPUnit_Framework_Constraint
Abstract base class for constraints. which are placed upon any value.

Code

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