summaryrefslogtreecommitdiff
path: root/vendor/sebastian/comparator/src/Factory.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/sebastian/comparator/src/Factory.php')
-rw-r--r--vendor/sebastian/comparator/src/Factory.php142
1 files changed, 142 insertions, 0 deletions
diff --git a/vendor/sebastian/comparator/src/Factory.php b/vendor/sebastian/comparator/src/Factory.php
new file mode 100644
index 000000000..5b16366f0
--- /dev/null
+++ b/vendor/sebastian/comparator/src/Factory.php
@@ -0,0 +1,142 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/comparator.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\Comparator;
+
+use function array_unshift;
+
+/**
+ * Factory for comparators which compare values for equality.
+ */
+class Factory
+{
+ /**
+ * @var Factory
+ */
+ private static $instance;
+
+ /**
+ * @var Comparator[]
+ */
+ private $customComparators = [];
+
+ /**
+ * @var Comparator[]
+ */
+ private $defaultComparators = [];
+
+ /**
+ * @return Factory
+ */
+ public static function getInstance()
+ {
+ if (self::$instance === null) {
+ self::$instance = new self; // @codeCoverageIgnore
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Constructs a new factory.
+ */
+ public function __construct()
+ {
+ $this->registerDefaultComparators();
+ }
+
+ /**
+ * Returns the correct comparator for comparing two values.
+ *
+ * @param mixed $expected The first value to compare
+ * @param mixed $actual The second value to compare
+ *
+ * @return Comparator
+ */
+ public function getComparatorFor($expected, $actual)
+ {
+ foreach ($this->customComparators as $comparator) {
+ if ($comparator->accepts($expected, $actual)) {
+ return $comparator;
+ }
+ }
+
+ foreach ($this->defaultComparators as $comparator) {
+ if ($comparator->accepts($expected, $actual)) {
+ return $comparator;
+ }
+ }
+
+ throw new RuntimeException('No suitable Comparator implementation found');
+ }
+
+ /**
+ * 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.
+ *
+ * @param Comparator $comparator The comparator to be registered
+ */
+ public function register(Comparator $comparator)/*: void*/
+ {
+ array_unshift($this->customComparators, $comparator);
+
+ $comparator->setFactory($this);
+ }
+
+ /**
+ * Unregisters a comparator.
+ *
+ * This comparator will no longer be considered by getComparatorFor().
+ *
+ * @param Comparator $comparator The comparator to be unregistered
+ */
+ public function unregister(Comparator $comparator)/*: void*/
+ {
+ foreach ($this->customComparators as $key => $_comparator) {
+ if ($comparator === $_comparator) {
+ unset($this->customComparators[$key]);
+ }
+ }
+ }
+
+ /**
+ * Unregisters all non-default comparators.
+ */
+ public function reset()/*: void*/
+ {
+ $this->customComparators = [];
+ }
+
+ private function registerDefaultComparators(): void
+ {
+ $this->registerDefaultComparator(new MockObjectComparator);
+ $this->registerDefaultComparator(new DateTimeComparator);
+ $this->registerDefaultComparator(new DOMNodeComparator);
+ $this->registerDefaultComparator(new SplObjectStorageComparator);
+ $this->registerDefaultComparator(new ExceptionComparator);
+ $this->registerDefaultComparator(new ObjectComparator);
+ $this->registerDefaultComparator(new ResourceComparator);
+ $this->registerDefaultComparator(new ArrayComparator);
+ $this->registerDefaultComparator(new DoubleComparator);
+ $this->registerDefaultComparator(new NumericComparator);
+ $this->registerDefaultComparator(new ScalarComparator);
+ $this->registerDefaultComparator(new TypeComparator);
+ }
+
+ private function registerDefaultComparator(Comparator $comparator): void
+ {
+ $this->defaultComparators[] = $comparator;
+
+ $comparator->setFactory($this);
+ }
+}