Add RouteAttributeInterface (#221)

yiisoft · Oct 15, 2023 · 6a2bd4c · 6a2bd4c
1 parent 2c38b06
commit 6a2bd4c
Show file tree

Hide file tree

Showing 18 changed files with 199 additions and 54 deletions.
diff --git a/src/Attribute/Delete.php b/src/Attribute/Delete.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Delete extends Route
+final class Delete implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::DELETE],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Get.php b/src/Attribute/Get.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Get extends Route
+final class Get implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::GET],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Head.php b/src/Attribute/Head.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Head extends Route
+final class Head implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::HEAD],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Options.php b/src/Attribute/Options.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Options extends Route
+final class Options implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::OPTIONS],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Patch.php b/src/Attribute/Patch.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Patch extends Route
+final class Patch implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::PATCH],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Post.php b/src/Attribute/Post.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Post extends Route
+final class Post implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::POST],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Put.php b/src/Attribute/Put.php
@@ -5,14 +5,17 @@
 namespace Yiisoft\Router\Attribute;
 
 use Attribute;
+use Stringable;
 use Yiisoft\Http\Method;
 use Yiisoft\Router\Route;
 
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Put extends Route
+final class Put implements RouteAttributeInterface
 {
+    private Route $route;
+
     /**
-     * @param array<string,scalar|\Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
      * @param bool $override Marks route as override. When added it will replace existing route with the same name.
      * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
      * It is useful to avoid invoking one of the parent group middleware for
@@ -27,7 +30,7 @@ public function __construct(
         bool $override = false,
         array $disabledMiddlewares = []
     ) {
-        parent::__construct(
+        $this->route = new Route(
             methods: [Method::PUT],
             pattern: $pattern,
             name: $name,
@@ -38,4 +41,9 @@ public function __construct(
             disabledMiddlewares: $disabledMiddlewares
         );
     }
+
+    public function getRoute(): Route
+    {
+        return $this->route;
+    }
 }
diff --git a/src/Attribute/Route.php b/src/Attribute/Route.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Stringable;
+use Yiisoft\Router\Route as RouteObject;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Route implements RouteAttributeInterface
+{
+    private RouteObject $route;
+
+    /**
+     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
+     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
+     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
+     * It is useful to avoid invoking one of the parent group middleware for
+     * a certain route.
+     */
+    public function __construct(
+        array $methods,
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        $this->route = new RouteObject(
+            methods: $methods,
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+
+    public function getRoute(): RouteObject
+    {
+        return $this->route;
+    }
+}
diff --git a/src/Attribute/RouteAttributeInterface.php b/src/Attribute/RouteAttributeInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Yiisoft\Router\Route;
+
+interface RouteAttributeInterface
+{
+    public function getRoute(): Route;
+}
diff --git a/src/Provider/AttributeRoutesProvider.php b/src/Provider/AttributeRoutesProvider.php
@@ -5,38 +5,40 @@
 namespace Yiisoft\Router\Provider;
 
 use olvlvl\ComposerAttributeCollector\Attributes;
+use ReflectionAttribute;
+use ReflectionClass;
+use Yiisoft\Router\Attribute\RouteAttributeInterface;
 use Yiisoft\Router\Group;
 use Yiisoft\Router\Route;
 
 /**
  * An attribute provider provides routes that declared via PHP Attributes.
  * Currently, uses `olvlvl/composer-attribute-collector`. {@link https://github.com/olvlvl/composer-attribute-collector}.
- *
- * @codeCoverageIgnore
  */
 final class AttributeRoutesProvider implements RoutesProviderInterface
 {
     /**
-     * @var array<class-string, \ReflectionClass>
+     * @var array<class-string, ReflectionClass>
      */
     private static array $reflectionsCache = [];
 
     public function getRoutes(): array
     {
         $routes = [];
         $groupRoutes = [];
-        $routePredicate = Attributes::predicateForAttributeInstanceOf(Route::class);
+        $routePredicate = Attributes::predicateForAttributeInstanceOf(RouteAttributeInterface::class);
         $targetMethods = Attributes::filterTargetMethods($routePredicate);
         foreach ($targetMethods as $targetMethod) {
-            /** @var Route $route */
-            $route = $targetMethod->attribute;
-            $targetMethodReflection = self::$reflectionsCache[$targetMethod->class] ??= new \ReflectionClass(
+            /** @var RouteAttributeInterface $routeAttribute */
+            $routeAttribute = $targetMethod->attribute;
+            $route = $routeAttribute->getRoute();
+            $targetMethodReflection = self::$reflectionsCache[$targetMethod->class] ??= new ReflectionClass(
                 $targetMethod->class
             );
             /** @var Group[] $groupAttributes */
             $groupAttributes = $targetMethodReflection->getAttributes(
                 Group::class,
-                \ReflectionAttribute::IS_INSTANCEOF
+                ReflectionAttribute::IS_INSTANCEOF
             );
             if (!empty($groupAttributes)) {
                 $groupRoutes[$targetMethod->class][] = $route->action([$targetMethod->class, $targetMethod->name]);