feat (#30): custom route matcher support

divineniiquaye · Mar 12, 2022 · 545dab3 · 545dab3
2 parents e3faac0 + 75e0f11
commit 545dab3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
 * [BC Break] Refactored route matching algorithm
 * [BC Break] Updated and Renamed `RouteCollector` class to `RouteCollection`
 * Added benchmark to compare performance over time
+* Added custom route matcher support to the router class
 * Updated routes cache from serialization to var_export
 * Updated PHP minimum version to 7.4 and added PHP 8.1 support
 * Updated README file with documentation of new changes

diff --git a/src/Router.php b/src/Router.php
@@ -51,6 +51,7 @@ class Router implements RouteMatcherInterface, RequestMethodInterface, Middlewar
     private \SplQueue $pipeline;
     private ?RouteCompilerInterface $compiler;
     private ?RouteMatcherInterface $matcher = null;
+    private string $matcherClass = RouteMatcher::class;
 
     /** @var array<string,array<int,MiddlewareInterface>> */
     private array $middlewares = [];
@@ -187,12 +188,23 @@ public function isCached(): bool
         return ($cache instanceof CacheItemPoolInterface && $cache->hasItem(__FILE__)) || \file_exists($cache);
     }
 
+    /**
+     * Set a matcher class associated with this Router.
+     */
+    public function setMatcher(string $matcherClass): void
+    {
+        if (!\is_subclass_of($matcherClass, RouteMatcherInterface::class)) {
+            throw new \InvalidArgumentException(\sprintf('"%s" must be a subclass of "%s".', $matcherClass, RouteMatcherInterface::class));
+        }
+        $this->matcherClass = $matcherClass;
+    }
+
     /**
      * Gets the Route matcher instance associated with this Router.
      */
     public function getMatcher(): RouteMatcherInterface
     {
-        return $this->matcher ??= $this->cacheData ? $this->getCachedData($this->cacheData) : new RouteMatcher($this->getCollection(), $this->compiler);
+        return $this->matcher ??= $this->cacheData ? $this->getCachedData($this->cacheData) : new $this->matcherClass($this->getCollection(), $this->compiler);
     }
 
     /**
@@ -223,7 +235,7 @@ protected function getCachedData($cache): RouteMatcherInterface
 
             if (!$cachedData instanceof RouteMatcherInterface) {
                 $cache->deleteItem(__FILE__);
-                $cache->save($cacheItem->set($cachedData = new RouteMatcher($this->getCollection(), $this->compiler)));
+                $cache->save($cacheItem->set($cachedData = new $this->matcherClass($this->getCollection(), $this->compiler)));
             }
 
             return $cacheItem->get();
@@ -232,7 +244,7 @@ protected function getCachedData($cache): RouteMatcherInterface
         $cachedData = @include $cache;
 
         if (!$cachedData instanceof RouteMatcherInterface) {
-            $dumpData = "<<<'SERIALIZED'\n" . \serialize(new RouteMatcher($this->getCollection(), $this->compiler)) . "\nSERIALIZED";
+            $dumpData = "<<<'SERIALIZED'\n" . \serialize(new $this->matcherClass($this->getCollection(), $this->compiler)) . "\nSERIALIZED";
 
             if (!\is_dir($directory = \dirname($cache))) {
                 @\mkdir($directory, 0775, true);