abstract class Comparator in Zircon Profile 8

Abstract base class for comparators which compare values for equality.

Hierarchy

• class \SebastianBergmann\Comparator\Comparator

1 file declares its use of Comparator

ClosureComparator.php in vendor/phpspec/prophecy/src/Prophecy/Comparator/ClosureComparator.php

File

vendor/sebastian/comparator/src/Comparator.php, line 18

Namespace

SebastianBergmann\Comparator

abstract class Comparator {

  /**
   * @var Factory
   */
  protected $factory;

  /**
   * @var Exporter
   */
  protected $exporter;
  public function __construct() {
    $this->exporter = new Exporter();
  }

  /**
   * @param Factory $factory
   */
  public function setFactory(Factory $factory) {
    $this->factory = $factory;
  }

  /**
   * 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 abstract function accepts($expected, $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 ComparisonFailure Thrown when the comparison
   *                                        fails. Contains information about the
   *                                        specific errors that lead to the failure.
   */
  public abstract function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false);

}

Members

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