Rework attributes (#65)

README.md

@@ -30,8 +30,12 @@ The package could be installed with composer:
 composer require yiisoft/request-model
 ```
 
+According to [`yiisoft/middleware-dispatcher`](https://github.com/yiisoft/middleware-dispatcher) docs, you need to set
+the implementation of `ParametersResolverInterface` to `HandlerParametersResolver` via container or pass directly.
+
 ## General usage
 
+
 A simple version of the request model looks like the following:
 
 ```php
@@ -72,7 +76,7 @@ Middleware:
 ```php
  Route::post('/test')
     ->middleware(
-        fn(\Yiisoft\Middleware\Dispatcher\WrapperFactoryInterface $factory) => $factory->createActionWrapper(
+        fn(\Yiisoft\Middleware\Dispatcher\MiddlewareFactory $factory) => $factory->create(
             SimpleController::class,
             'action'
         )

composer.json

@@ -26,7 +26,7 @@
         "psr/http-server-middleware": "^1.0",
         "yiisoft/arrays": "^2.0|^3.0",
         "yiisoft/injector": "^1.0",
-        "yiisoft/middleware-dispatcher": "^3.0|^4.0",
+        "yiisoft/middleware-dispatcher": "^5.0",
         "yiisoft/router": "^1.2|^2.0",
         "yiisoft/validator": "dev-master"
     },

src/Attribute/Body.php

@@ -6,16 +6,20 @@
 
 use Attribute;
 
-#[Attribute(flags: Attribute::TARGET_PARAMETER)]
+#[Attribute(flags: Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)]
 final class Body implements HandlerParameterAttributeInterface
 {
-    public function getType(): string
+    public function __construct(private ?string $name = null)
     {
-        return self::REQUEST_BODY;
     }
 
     public function getName(): ?string
     {
-        return null;
+        return $this->name;
+    }
+
+    public function getResolverClassName(): string
+    {
+        return BodyResolver::class;
     }
 }

src/Attribute/BodyResolver.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class BodyResolver implements HandlerParameterResolverInterface
+{
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): mixed
+    {
+        if ($attribute::class !== Body::class) {
+            throw new \InvalidArgumentException(sprintf('Expected "%s", got "%s".', Body::class, $attribute::class));
+        }
+
+        if ($attribute->getName() !== null) {
+            return $request->getParsedBody()[$attribute->getName()] ?? null;
+        }
+
+        return $request->getParsedBody();
+    }
+}

src/Attribute/HandlerParameterAttributeInterface.php

@@ -9,13 +9,5 @@
  */
 interface HandlerParameterAttributeInterface
 {
-    public const ROUTE_PARAM = 'route_param';
-    public const REQUEST_BODY = 'request_body';
-    public const REQUEST_ATTRIBUTE = 'request_attribute';
-    public const UPLOADED_FILES = 'uploaded_files';
-    public const QUERY_PARAM = 'query_param';
-
-    public function getName(): ?string;
-
-    public function getType(): string;
+    public function getResolverClassName(): string;
 }

src/Attribute/HandlerParameterResolverInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * Represents action handler parameter [attribute](https://www.php.net/manual/en/language.attributes.php).
+ */
+interface HandlerParameterResolverInterface
+{
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): mixed;
+}

src/Attribute/Query.php

@@ -9,17 +9,17 @@
 #[Attribute(flags: Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)]
 final class Query implements HandlerParameterAttributeInterface
 {
-    public function __construct(private string $name)
+    public function __construct(private ?string $name = null)
     {
     }
 
-    public function getName(): string
+    public function getName(): ?string
     {
         return $this->name;
     }
 
-    public function getType(): string
+    public function getResolverClassName(): string
     {
-        return self::QUERY_PARAM;
+        return QueryResolver::class;
     }
 }

src/Attribute/QueryResolver.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class QueryResolver implements HandlerParameterResolverInterface
+{
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): mixed
+    {
+        if ($attribute::class !== Query::class) {
+            throw new \InvalidArgumentException(sprintf('Expected "%s", got "%s".', Query::class, $attribute::class));
+        }
+
+        if ($attribute->getName() !== null) {
+            return $request->getQueryParams()[$attribute->getName()] ?? null;
+        }
+
+        return $request->getQueryParams();
+    }
+}

src/Attribute/Request.php

@@ -13,13 +13,13 @@ public function __construct(private string $name)
     {
     }
 
-    public function getType(): string
+    public function getName(): string
     {
-        return self::REQUEST_ATTRIBUTE;
+        return $this->name;
     }
 
-    public function getName(): ?string
+    public function getResolverClassName(): string
     {
-        return $this->name;
+        return RequestResolver::class;
     }
 }

src/Attribute/RequestResolver.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class RequestResolver implements HandlerParameterResolverInterface
+{
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): mixed
+    {
+        if ($attribute::class !== Request::class) {
+            throw new \InvalidArgumentException(sprintf('Expected "%s", got "%s".', Request::class, $attribute::class));
+        }
+
+        return $request->getAttribute($attribute->getName());
+    }
+}

src/Attribute/Route.php

@@ -18,8 +18,8 @@ public function getName(): string
         return $this->name;
     }
 
-    public function getType(): string
+    public function getResolverClassName(): string
     {
-        return self::ROUTE_PARAM;
+        return RouteResolver::class;
     }
 }

src/Attribute/RouteResolver.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Yiisoft\Router\CurrentRoute;
+
+final class RouteResolver implements HandlerParameterResolverInterface
+{
+    public function __construct(private CurrentRoute $currentRoute)
+    {
+    }
+
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): mixed
+    {
+        if ($attribute::class !== Route::class) {
+            throw new \InvalidArgumentException(sprintf('Expected "%s", got "%s".', Route::class, $attribute::class));
+        }
+
+        return $this->currentRoute->getArgument($attribute->getName());
+    }
+}

src/Attribute/UploadedFiles.php

@@ -9,13 +9,8 @@
 #[Attribute(flags: Attribute::TARGET_PARAMETER)]
 final class UploadedFiles implements HandlerParameterAttributeInterface
 {
-    public function getType(): string
+    public function getResolverClassName(): string
     {
-        return self::UPLOADED_FILES;
-    }
-
-    public function getName(): ?string
-    {
-        return null;
+        return UploadedFilesResolver::class;
     }
 }

src/Attribute/UploadedFilesResolver.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\RequestModel\Attribute;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class UploadedFilesResolver implements HandlerParameterResolverInterface
+{
+    public function resolve(HandlerParameterAttributeInterface $attribute, ServerRequestInterface $request): array
+    {
+        if ($attribute::class !== UploadedFiles::class) {
+            throw new \InvalidArgumentException(sprintf('Expected "%s", got "%s".', UploadedFiles::class, $attribute::class));
+        }
+
+        return $request->getUploadedFiles();
+    }
+}