class PHPUnit_Framework_Constraint_IsEqual

Constraint that checks if one value is equal to another.

Equality is checked with PHP's == operator, the operator is explained in detail at {@url http://www.php.net/manual/en/types.comparisons.php}. Two values are equal if they have the same value disregarding type.

The expected value is passed in the constructor.

@package PHPUnit @subpackage Framework_Constraint @author Kore Nordmann <kn@ez.no> @author Sebastian Bergmann <sebastian@phpunit.de> @author Bernhard Schussek <bschussek@2bepublished.at> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_IsEqual

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/IsEqual.php, line 67

View source
class PHPUnit_Framework_Constraint_IsEqual extends PHPUnit_Framework_Constraint {

  /**
   * @var mixed
   */
  protected $value;

  /**
   * @var float
   */
  protected $delta = 0;

  /**
   * @var integer
   */
  protected $maxDepth = 10;

  /**
   * @var boolean
   */
  protected $canonicalize = FALSE;

  /**
   * @var boolean
   */
  protected $ignoreCase = FALSE;

  /**
   * @var PHPUnit_Framework_ComparisonFailure
   */
  protected $lastFailure;

  /**
   * @param mixed   $value
   * @param float   $delta
   * @param integer $maxDepth
   * @param boolean $canonicalize
   * @param boolean $ignoreCase
   */
  public function __construct($value, $delta = 0, $maxDepth = 10, $canonicalize = FALSE, $ignoreCase = FALSE) {
    if (!is_numeric($delta)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'numeric');
    }
    if (!is_int($maxDepth)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(3, 'integer');
    }
    if (!is_bool($canonicalize)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(4, 'boolean');
    }
    if (!is_bool($ignoreCase)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(5, 'boolean');
    }
    $this->value = $value;
    $this->delta = $delta;
    $this->maxDepth = $maxDepth;
    $this->canonicalize = $canonicalize;
    $this->ignoreCase = $ignoreCase;
  }

  /**
   * 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.
   *
   * @param  mixed $other Value or object to evaluate.
   * @param  string $description Additional information about the test
   * @param  bool $returnResult Whether to return a result or throw an exception
   * @return mixed
   * @throws PHPUnit_Framework_ExpectationFailedException
   */
  public function evaluate($other, $description = '', $returnResult = FALSE) {
    $comparatorFactory = PHPUnit_Framework_ComparatorFactory::getDefaultInstance();
    try {
      $comparator = $comparatorFactory
        ->getComparatorFor($other, $this->value);
      $comparator
        ->assertEquals($this->value, $other, $this->delta, $this->canonicalize, $this->ignoreCase);
    } catch (PHPUnit_Framework_ComparisonFailure $f) {
      if ($returnResult) {
        return FALSE;
      }
      throw new PHPUnit_Framework_ExpectationFailedException(trim($description . "\n" . $f
        ->getMessage()), $f);
    }
    return TRUE;
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    $delta = '';
    if (is_string($this->value)) {
      if (strpos($this->value, "\n") !== FALSE) {
        return 'is equal to <text>';
      }
      else {
        return sprintf('is equal to <string:%s>', $this->value);
      }
    }
    else {
      if ($this->delta != 0) {
        $delta = sprintf(' with delta <%F>', $this->delta);
      }
      return sprintf('is equal to %s%s', PHPUnit_Util_Type::export($this->value), $delta);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Constraint::additionalFailureDescription protected function Return additional failure description where needed 1
PHPUnit_Framework_Constraint::count public function Counts the number of constraint elements. 6
PHPUnit_Framework_Constraint::fail protected function Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint::failureDescription protected function Returns the description of the failure 15
PHPUnit_Framework_Constraint::matches protected function Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise. 23
PHPUnit_Framework_Constraint_IsEqual::$canonicalize protected property
PHPUnit_Framework_Constraint_IsEqual::$delta protected property
PHPUnit_Framework_Constraint_IsEqual::$ignoreCase protected property
PHPUnit_Framework_Constraint_IsEqual::$lastFailure protected property
PHPUnit_Framework_Constraint_IsEqual::$maxDepth protected property
PHPUnit_Framework_Constraint_IsEqual::$value protected property
PHPUnit_Framework_Constraint_IsEqual::evaluate public function Evaluates the constraint for parameter $other Overrides PHPUnit_Framework_Constraint::evaluate
PHPUnit_Framework_Constraint_IsEqual::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_IsEqual::__construct public function