SebastianBergmann\Comparator\Comparator Class Reference

Inheritance diagram for SebastianBergmann\Comparator\Comparator:

Detailed Description

Abstract base class for comparators which compare values for equality.

Public Member Functions
	__construct ()
	setFactory (Factory $factory)
	accepts ($expected, $actual)
	assertEquals ($expected, $actual, $delta=0.0, $canonicalize=false, $ignoreCase=false)

Protected Attributes
	$factory
	$exporter

Constructor & Destructor Documentation

__construct()

SebastianBergmann\Comparator\Comparator::__construct

(

)

Member Function Documentation

accepts()

SebastianBergmann\Comparator\Comparator::accepts (   $expected,   $actual  )

abstract

Returns whether the comparator can compare two values.

Parameters

mixed	$expected	The first value to compare
mixed	$actual	The second value to compare

Returns

bool

Reimplemented in SebastianBergmann\Comparator\DoubleComparator, SebastianBergmann\Comparator\DOMNodeComparator, SebastianBergmann\Comparator\ScalarComparator, SebastianBergmann\Comparator\ArrayComparator, SebastianBergmann\Comparator\DateTimeComparator, SebastianBergmann\Comparator\ExceptionComparator, SebastianBergmann\Comparator\MockObjectComparator, SebastianBergmann\Comparator\NumericComparator, SebastianBergmann\Comparator\ObjectComparator, SebastianBergmann\Comparator\ResourceComparator, SebastianBergmann\Comparator\SplObjectStorageComparator, SebastianBergmann\Comparator\TypeComparator, Prophecy\Comparator\ClosureComparator, and Prophecy\Comparator\ProphecyComparator.

assertEquals()

SebastianBergmann\Comparator\Comparator::assertEquals (   $expected,   $actual,   $delta = 0.0,   $canonicalize = false,   $ignoreCase = false  )

abstract

Asserts that two values are equal.

Parameters

mixed	$expected	First value to compare
mixed	$actual	Second value to compare
float	$delta	Allowed numerical distance between two values to consider them equal
bool	$canonicalize	Arrays are sorted before comparison when set to true
bool	$ignoreCase	Case is ignored when set to true

Exceptions

ComparisonFailure

Reimplemented in SebastianBergmann\Comparator\DoubleComparator, SebastianBergmann\Comparator\ScalarComparator, SebastianBergmann\Comparator\NumericComparator, SebastianBergmann\Comparator\ResourceComparator, SebastianBergmann\Comparator\SplObjectStorageComparator, and SebastianBergmann\Comparator\TypeComparator.

setFactory()

SebastianBergmann\Comparator\Comparator::setFactory

(

Factory

$factory

)

Member Data Documentation

$exporter

SebastianBergmann\Comparator\Comparator::$exporter

protected

$factory

SebastianBergmann\Comparator\Comparator::$factory

protected

---

The documentation for this class was generated from the following file:

• vendor/sebastian/comparator/src/Comparator.php