class SplObjectStorageComparator in Zircon Profile 8

Compares \SplObjectStorage instances for equality.

Hierarchy

• class \SebastianBergmann\Comparator\Comparator
  • class \SebastianBergmann\Comparator\SplObjectStorageComparator

File

vendor/sebastian/comparator/src/SplObjectStorageComparator.php, line 16

Namespace

SebastianBergmann\Comparator

class SplObjectStorageComparator extends 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 bool
   */
  public function accepts($expected, $actual) {
    return $expected instanceof \SplObjectStorage && $actual instanceof \SplObjectStorage;
  }

  /**
   * 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 ComparisonFailure Thrown when the comparison
   *                                        fails. Contains information about the
   *                                        specific errors that lead to the failure.
   */
  public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false) {
    foreach ($actual as $object) {
      if (!$expected
        ->contains($object)) {
        throw new ComparisonFailure($expected, $actual, $this->exporter
          ->export($expected), $this->exporter
          ->export($actual), false, 'Failed asserting that two objects are equal.');
      }
    }
    foreach ($expected as $object) {
      if (!$actual
        ->contains($object)) {
        throw new ComparisonFailure($expected, $actual, $this->exporter
          ->export($expected), $this->exporter
          ->export($actual), false, 'Failed asserting that two objects are equal.');
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Comparator::$exporter	protected	property
Comparator::$factory	protected	property
Comparator::setFactory	public	function
Comparator::__construct	public	function
SplObjectStorageComparator::accepts	public	function	Returns whether the comparator can compare two values. Overrides Comparator::accepts
SplObjectStorageComparator::assertEquals	public	function	Asserts that two values are equal. Overrides Comparator::assertEquals