Merge pull request #91 from sunrise-php/release/v2.12.0

v2.12.0

Author: fenric

README.md

@@ -448,6 +448,27 @@ final class EntryUpdateRequestHandler implements RequestHandlerInterface
 
 ## Useful to know
 
+### Get a current route
+
+#### Through Router
+
+> Available from version 2.12.
+
+```php
+$router->getMatchedRoute();
+```
+
+#### Through Request
+
+> Available from version 1.x, but wasn't documented before...
+
+```php
+$request->getAttribute('@route');
+
+// or
+$request->getAttribute(\Sunrise\Http\Router\RouteInterface::ATTR_ROUTE);
+```
+
 ### Generation a route URI
 
 ```php

composer.json

@@ -63,7 +63,7 @@
     "scripts": {
         "test": [
             "phpcs",
-            "XDEBUG_MODE=coverage phpunit --coverage-text"
+            "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always"
         ],
         "build": [
             "phpdoc -d src/ -t phpdoc/",

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<phpunit colors="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
     <coverage>
         <include>
             <directory>./src</directory>

src/RouteCollection.php

@@ -148,18 +148,6 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteCollec
         return $this;
     }
 
-    /**
-     * Alias to the addMiddleware method
-     *
-     * @param MiddlewareInterface ...$middlewares
-     *
-     * @return RouteCollectionInterface
-     */
-    public function appendMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface
-    {
-        return $this->addMiddleware(...$middlewares);
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -172,6 +160,14 @@ public function prependMiddleware(MiddlewareInterface ...$middlewares) : RouteCo
         return $this;
     }
 
+    /**
+     * @deprecated 2.12.0 Use the addMiddleware method.
+     */
+    public function appendMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface
+    {
+        return $this->addMiddleware(...$middlewares);
+    }
+
     /**
      * @deprecated 2.10.0 Use the prependMiddleware method.
      */

src/Router.php

@@ -83,6 +83,13 @@ class Router implements MiddlewareInterface, RequestHandlerInterface, RequestMet
      */
     private $middlewares = [];
 
+    /**
+     * The router's matched route
+     *
+     * @var RouteInterface|null
+     */
+    private $matchedRoute = null;
+
     /**
      * Gets the router host table
      *
@@ -115,6 +122,16 @@ public function getMiddlewares() : array
         return array_values($this->middlewares);
     }
 
+    /**
+     * Gets the router's matched route
+     *
+     * @return RouteInterface|null
+     */
+    public function getMatchedRoute() : ?RouteInterface
+    {
+        return $this->matchedRoute;
+    }
+
     /**
      * Adds the given patterns to the router
      *
@@ -355,7 +372,9 @@ public function run(ServerRequestInterface $request) : ResponseInterface
     {
         // lazy resolving of the given request...
         $routing = new CallableRequestHandler(function (ServerRequestInterface $request) : ResponseInterface {
-            return $this->match($request)->handle($request);
+            $route = $this->match($request);
+            $this->matchedRoute = $route;
+            return $route->handle($request);
         });
 
         $middlewares = $this->getMiddlewares();
@@ -375,6 +394,7 @@ public function run(ServerRequestInterface $request) : ResponseInterface
     public function handle(ServerRequestInterface $request) : ResponseInterface
     {
         $route = $this->match($request);
+        $this->matchedRoute = $route;
 
         $middlewares = $this->getMiddlewares();
         if (empty($middlewares)) {

tests/RouterTest.php

@@ -428,6 +428,8 @@ public function testRun() : void
                 $routes[1]->getPath()
             ));
 
+        $this->assertNotNull($router->getMatchedRoute());
+        $this->assertSame($routes[1]->getName(), $router->getMatchedRoute()->getName());
         $this->assertTrue($routes[1]->getRequestHandler()->isRunned());
     }
 
@@ -509,6 +511,8 @@ public function testHandle() : void
                 $routes[2]->getPath()
             ));
 
+        $this->assertNotNull($router->getMatchedRoute());
+        $this->assertSame($routes[2]->getName(), $router->getMatchedRoute()->getName());
         $this->assertTrue($routes[2]->getRequestHandler()->isRunned());
     }