Inheritance diagram for SebastianBergmann\Comparator\Factory:
Public Member Functions | |
| __construct () | |
| getComparatorFor ($expected, $actual) | |
| register (Comparator $comparator) | |
| unregister (Comparator $comparator) | |
| reset () | |
Static Public Member Functions | |
| static | getInstance () |
Detailed Description
Factory for comparators which compare values for equality.
Constructor & Destructor Documentation
◆ __construct()
| SebastianBergmann\Comparator\Factory::__construct | ( | ) |
Constructs a new factory.
Reimplemented in Prophecy\Comparator\Factory.
Member Function Documentation
◆ getComparatorFor()
| SebastianBergmann\Comparator\Factory::getComparatorFor | ( | $expected, | |
| $actual | |||
| ) |
Returns the correct comparator for comparing two values.
- Parameters
-
mixed $expected The first value to compare mixed $actual The second value to compare
- Returns
- Comparator
◆ getInstance()
|
static |
- Returns
- Factory
Reimplemented in Prophecy\Comparator\Factory.
◆ register()
| SebastianBergmann\Comparator\Factory::register | ( | Comparator | $comparator | ) |
Registers a new comparator.
This comparator will be returned by getComparatorFor() if its accept() method returns TRUE for the compared values. It has higher priority than the existing comparators, meaning that its accept() method will be invoked before those of the other comparators.
- Parameters
-
Comparator $comparator The comparator to be registered
◆ reset()
| SebastianBergmann\Comparator\Factory::reset | ( | ) |
Unregisters all non-default comparators.
◆ unregister()
| SebastianBergmann\Comparator\Factory::unregister | ( | Comparator | $comparator | ) |
Unregisters a comparator.
This comparator will no longer be considered by getComparatorFor().
- Parameters
-
Comparator $comparator The comparator to be unregistered
The documentation for this class was generated from the following file:
- vendor/sebastian/comparator/src/Factory.php
