You are here

public function PHPUnit_Framework_Constraint_IsEqual::evaluate in Zircon Profile 8

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

Overrides PHPUnit_Framework_Constraint::evaluate

File

vendor/phpunit/phpunit/src/Framework/Constraint/IsEqual.php, line 105

Class

PHPUnit_Framework_Constraint_IsEqual
Constraint that checks if one value is equal to another.

Code

public function evaluate($other, $description = '', $returnResult = false) {

  // If $this->value and $other are identical, they are also equal.
  // This is the most common path and will allow us to skip
  // initialization of all the comparators.
  if ($this->value === $other) {
    return true;
  }
  $comparatorFactory = SebastianBergmann\Comparator\Factory::getInstance();
  try {
    $comparator = $comparatorFactory
      ->getComparatorFor($this->value, $other);
    $comparator
      ->assertEquals($this->value, $other, $this->delta, $this->canonicalize, $this->ignoreCase);
  } catch (SebastianBergmann\Comparator\ComparisonFailure $f) {
    if ($returnResult) {
      return false;
    }
    throw new PHPUnit_Framework_ExpectationFailedException(trim($description . "\n" . $f
      ->getMessage()), $f);
  }
  return true;
}