Added Annotation Scene which use scene in FormRequest easily. (#4866)

Co-authored-by: awengan <goto8848@qq.com>
Co-authored-by: 李铭昕 <715557344@qq.com>

Author: 3 people

src/Annotation/Scene.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Validation\Annotation;
+
+use Attribute;
+use Hyperf\Di\Annotation\AbstractMultipleAnnotation;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+class Scene extends AbstractMultipleAnnotation
+{
+    public function __construct(public string $scene, public ?string $argument = null)
+    {
+    }
+}

src/Middleware/ValidationMiddleware.php

@@ -14,10 +14,14 @@
 use Closure;
 use FastRoute\Dispatcher;
 use Hyperf\Context\Context;
+use Hyperf\Di\Annotation\AnnotationCollector;
+use Hyperf\Di\Annotation\MultipleAnnotation;
 use Hyperf\Di\ReflectionManager;
 use Hyperf\HttpServer\Router\Dispatched;
 use Hyperf\Server\Exception\ServerException;
+use Hyperf\Validation\Annotation\Scene;
 use Hyperf\Validation\Contract\ValidatesWhenResolved;
+use Hyperf\Validation\Request\FormRequest;
 use Hyperf\Validation\UnauthorizedException;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -58,10 +62,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                         if ($parameter->getType() === null) {
                             continue;
                         }
-                        $classname = $parameter->getType()->getName();
-                        if ($this->isImplementedValidatesWhenResolved($classname)) {
-                            /** @var \Hyperf\Validation\Contract\ValidatesWhenResolved $formRequest */
-                            $formRequest = $this->container->get($classname);
+                        $className = $parameter->getType()->getName();
+                        if ($this->isImplementedValidatesWhenResolved($className)) {
+                            /** @var ValidatesWhenResolved $formRequest */
+                            $formRequest = $this->container->get($className);
+                            if ($formRequest instanceof FormRequest) {
+                                $this->handleSceneAnnotation($formRequest, $requestHandler, $method, $parameter->getName());
+                            }
                             $formRequest->validateResolved();
                         }
                     }
@@ -74,13 +81,35 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         return $handler->handle($request);
     }
 
-    public function isImplementedValidatesWhenResolved(string $classname): bool
+    public function isImplementedValidatesWhenResolved(string $className): bool
     {
-        if (! isset($this->implements[$classname]) && class_exists($classname)) {
-            $implements = class_implements($classname);
-            $this->implements[$classname] = in_array(ValidatesWhenResolved::class, $implements, true);
+        if (! isset($this->implements[$className]) && class_exists($className)) {
+            $implements = class_implements($className);
+            $this->implements[$className] = in_array(ValidatesWhenResolved::class, $implements, true);
+        }
+        return $this->implements[$className] ?? false;
+    }
+
+    protected function handleSceneAnnotation(FormRequest $request, string $class, string $method, string $argument): void
+    {
+        /** @var null|MultipleAnnotation $scene */
+        $scene = AnnotationCollector::getClassMethodAnnotation($class, $method)[Scene::class] ?? null;
+        if (! $scene) {
+            return;
+        }
+
+        $annotations = $scene->toAnnotations();
+        if (empty($annotations)) {
+            return;
+        }
+
+        /** @var Scene $annotation */
+        foreach ($annotations as $annotation) {
+            if ($annotation->argument === null || $annotation->argument === $argument) {
+                $request->scene($annotation->scene);
+                return;
+            }
         }
-        return $this->implements[$classname] ?? false;
     }
 
     /**