Comparator
in package
Abstract base class for comparators which compare values for equality.
Table of Contents
- $exporter : Exporter
- $factory : Factory
- __construct() : mixed
- accepts() : bool
- Returns whether the comparator can compare two values.
- assertEquals() : mixed
- Asserts that two values are equal.
- setFactory() : mixed
Properties
$exporter
protected
Exporter
$exporter
$factory
protected
Factory
$factory
Methods
__construct()
public
__construct() : mixed
Return values
mixed —accepts()
Returns whether the comparator can compare two values.
public
abstract accepts(mixed $expected, mixed $actual) : bool
Parameters
- $expected : mixed
-
The first value to compare
- $actual : mixed
-
The second value to compare
Return values
bool —assertEquals()
Asserts that two values are equal.
public
abstract assertEquals(mixed $expected, mixed $actual[, float $delta = 0.0 ][, bool $canonicalize = false ][, bool $ignoreCase = false ]) : mixed
Parameters
- $expected : mixed
-
First value to compare
- $actual : mixed
-
Second value to compare
- $delta : float = 0.0
-
Allowed numerical distance between two values to consider them equal
- $canonicalize : bool = false
-
Arrays are sorted before comparison when set to true
- $ignoreCase : bool = false
-
Case is ignored when set to true
Tags
Return values
mixed —setFactory()
public
setFactory(Factory $factory) : mixed
Parameters
- $factory : Factory