Chris@0: <?php
Chris@0: /*
Chris@14:  * This file is part of sebastian/comparator.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace SebastianBergmann\Comparator;
Chris@0: 
Chris@0: use SebastianBergmann\Exporter\Exporter;
Chris@0: 
Chris@0: /**
Chris@0:  * Abstract base class for comparators which compare values for equality.
Chris@0:  */
Chris@0: abstract class Comparator
Chris@0: {
Chris@0:     /**
Chris@0:      * @var Factory
Chris@0:      */
Chris@0:     protected $factory;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var Exporter
Chris@0:      */
Chris@0:     protected $exporter;
Chris@0: 
Chris@0:     public function __construct()
Chris@0:     {
Chris@0:         $this->exporter = new Exporter;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param Factory $factory
Chris@0:      */
Chris@0:     public function setFactory(Factory $factory)
Chris@0:     {
Chris@0:         $this->factory = $factory;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns whether the comparator can compare two values.
Chris@0:      *
Chris@14:      * @param mixed $expected The first value to compare
Chris@14:      * @param mixed $actual   The second value to compare
Chris@14:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     abstract public function accepts($expected, $actual);
Chris@0: 
Chris@0:     /**
Chris@0:      * Asserts that two values are equal.
Chris@0:      *
Chris@0:      * @param mixed $expected     First value to compare
Chris@0:      * @param mixed $actual       Second value to compare
Chris@0:      * @param float $delta        Allowed numerical distance between two values to consider them equal
Chris@0:      * @param bool  $canonicalize Arrays are sorted before comparison when set to true
Chris@0:      * @param bool  $ignoreCase   Case is ignored when set to true
Chris@0:      *
Chris@0:      * @throws ComparisonFailure
Chris@0:      */
Chris@0:     abstract public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false);
Chris@0: }