class PHPUnit_Framework_Comparator_Scalar

Compares scalar or NULL values for equality.

@package PHPUnit @subpackage Framework_Comparator @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.6.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Comparator_Scalar

1 string reference to 'PHPUnit_Framework_Comparator_Scalar'
Framework_ComparatorTest::instanceProvider in drupal/core/vendor/phpunit/phpunit/Tests/Framework/ComparatorTest.php

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Comparator/Scalar.php, line 57

View source
class PHPUnit_Framework_Comparator_Scalar extends PHPUnit_Framework_Comparator {

  /**
   * Returns whether the comparator can compare two values.
   *
   * @param  mixed $expected The first value to compare
   * @param  mixed $actual The second value to compare
   * @return boolean
   * @since  Method available since Release 3.6.0
   */
  public function accepts($expected, $actual) {
    return (is_scalar($expected) xor NULL === $expected) && (is_scalar($actual) xor NULL === $actual) || is_string($expected) && is_object($actual) && method_exists($actual, '__toString') || is_object($expected) && method_exists($expected, '__toString') && is_string($actual);
  }

  /**
   * Asserts that two values are equal.
   *
   * @param  mixed $expected The first value to compare
   * @param  mixed $actual The second value to compare
   * @param  float $delta The allowed numerical distance between two values to
   *                      consider them equal
   * @param  bool  $canonicalize If set to TRUE, arrays are sorted before
   *                             comparison
   * @param  bool  $ignoreCase If set to TRUE, upper- and lowercasing is
   *                           ignored when comparing string values
   * @throws PHPUnit_Framework_ComparisonFailure Thrown when the comparison
   *                           fails. Contains information about the
   *                           specific errors that lead to the failure.
   */
  public function assertEquals($expected, $actual, $delta = 0, $canonicalize = FALSE, $ignoreCase = FALSE) {
    $expectedToCompare = $expected;
    $actualToCompare = $actual;

    // always compare as strings to avoid strange behaviour
    // otherwise 0 == 'Foobar'
    if (is_string($expected) || is_string($actual)) {
      $expectedToCompare = (string) $expectedToCompare;
      $actualToCompare = (string) $actualToCompare;
      if ($ignoreCase) {
        $expectedToCompare = strtolower($expectedToCompare);
        $actualToCompare = strtolower($actualToCompare);
      }
    }
    if ($expectedToCompare != $actualToCompare) {
      if (is_string($expected) && is_string($actual)) {
        throw new PHPUnit_Framework_ComparisonFailure($expected, $actual, PHPUnit_Util_Type::export($expected), PHPUnit_Util_Type::export($actual), FALSE, 'Failed asserting that two strings are equal.');
      }
      throw new PHPUnit_Framework_ComparisonFailure($expected, $actual, '', '', FALSE, sprintf('Failed asserting that %s matches expected %s.', PHPUnit_Util_Type::export($actual), PHPUnit_Util_Type::export($expected)));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Comparator::$factory protected property
PHPUnit_Framework_Comparator::setFactory public function
PHPUnit_Framework_Comparator_Scalar::accepts public function Returns whether the comparator can compare two values. Overrides PHPUnit_Framework_Comparator::accepts 1
PHPUnit_Framework_Comparator_Scalar::assertEquals public function Asserts that two values are equal. Overrides PHPUnit_Framework_Comparator::assertEquals 1