Add attributes support & improve MatchingResult

.phpstorm.meta.php/Group.php

@@ -11,9 +11,8 @@
         'host',
         'hosts',
         'corsMiddleware',
-        'items',
-        'middlewareDefinitions',
-        'hasDispatcher',
+        'routes',
+        'middlewares',
         'hasCorsMiddleware'
     );
-}
+}

.phpstorm.meta.php/Route.php

@@ -13,8 +13,7 @@
         'methods',
         'override',
         'defaults',
-        'dispatcherWithMiddlewares',
-        'hasDispatcher',
-        'hasMiddlewares'
+        'hasMiddlewares',
+        'builtMiddlewares'
     );
-}
+}

composer.json

@@ -31,6 +31,7 @@
     "require-dev": {
         "maglnet/composer-require-checker": "^4.4",
         "nyholm/psr7": "^1.5",
+        "olvlvl/composer-attribute-collector": "^2.0",
         "phpunit/phpunit": "^9.5",
         "psr/container": "^1.1|^2.0",
         "rector/rector": "^0.18.3",
@@ -53,7 +54,8 @@
         }
     },
     "suggest": {
-        "yiisoft/router-fastroute": "Router implementation based on nikic/FastRoute"
+        "yiisoft/router-fastroute": "Router implementation based on nikic/FastRoute",
+        "olvlvl/composer-attribute-collector": "Required to register routes using PHP attributes"
     },
     "extra": {
         "config-plugin-options": {
@@ -69,7 +71,8 @@
         "allow-plugins": {
             "infection/extension-installer": true,
             "composer/package-versions-deprecated": true,
-            "yiisoft/config": false
+            "yiisoft/config": false,
+            "olvlvl/composer-attribute-collector": true
         }
     },
     "scripts": {

src/Attribute/Delete.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Delete extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::DELETE],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Get.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Get extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::GET],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Head.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Head extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::HEAD],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Options.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Options extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::OPTIONS],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Patch.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Patch extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::PATCH],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Post.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Post extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::POST],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}

src/Attribute/Put.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Router\Attribute;
+
+use Attribute;
+use Yiisoft\Http\Method;
+use Yiisoft\Router\Route;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+final class Put extends 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(
+        string $pattern,
+        ?string $name = null,
+        array $middlewares = [],
+        array $defaults = [],
+        array $hosts = [],
+        bool $override = false,
+        array $disabledMiddlewares = []
+    ) {
+        parent::__construct(
+            methods: [Method::PUT],
+            pattern: $pattern,
+            name: $name,
+            middlewares: $middlewares,
+            defaults: $defaults,
+            hosts: $hosts,
+            override: $override,
+            disabledMiddlewares: $disabledMiddlewares
+        );
+    }
+}