Support method FormRequest::scene() which used to rewrite different rules according to different scenes. (#4002)

Co-authored-by: codelin <[email protected]>
Co-authored-by: 李铭昕 <[email protected]>

Author: 3 people

src/Request/FormRequest.php

@@ -40,6 +40,13 @@ class FormRequest extends Request implements ValidatesWhenResolved
      */
     protected $errorBag = 'default';
 
+    /**
+     * The scenes defined by developer.
+     *
+     * @var array
+     */
+    protected $scenes = [];
+
     /**
      * The input keys that should not be flashed on redirect.
      *
@@ -52,6 +59,20 @@ public function __construct(ContainerInterface $container)
         $this->setContainer($container);
     }
 
+    /**
+     * @return $this
+     */
+    public function scene(string $scene)
+    {
+        Context::set($this->getContextValidatorKey('scene'), $scene);
+        return $this;
+    }
+
+    public function getScene(): ?string
+    {
+        return Context::get($this->getContextValidatorKey('scene'));
+    }
+
     /**
      * Get the proper failed validation response for the request.
      */
@@ -104,7 +125,7 @@ public function setContainer(ContainerInterface $container)
      */
     protected function getValidatorInstance(): ValidatorInterface
     {
-        return Context::getOrSet($this->getContextValidatorKey(), function () {
+        return Context::getOrSet($this->getContextValidatorKey(ValidatorInterface::class), function () {
             $factory = $this->container->get(ValidationFactory::class);
 
             if (method_exists($this, 'validator')) {
@@ -128,7 +149,7 @@ protected function createDefaultValidator(ValidationFactory $factory): Validator
     {
         return $factory->make(
             $this->validationData(),
-            call_user_func_array([$this, 'rules'], []),
+            $this->getRules(),
             $this->messages(),
             $this->attributes()
         );
@@ -183,8 +204,27 @@ protected function failedAuthorization()
     /**
      * Get context validator key.
      */
-    protected function getContextValidatorKey(): string
+    protected function getContextValidatorKey(string $key): string
     {
-        return sprintf('%s:%s', get_called_class(), ValidatorInterface::class);
+        return sprintf('%s:%s', spl_object_hash($this), $key);
+    }
+
+    /**
+     * Get scene rules.
+     */
+    protected function getRules()
+    {
+        $rules = call_user_func_array([$this, 'rules'], []);
+        $scene = $this->getScene();
+        if ($scene && isset($this->scenes[$scene]) && is_array($this->scenes[$scene])) {
+            $newRules = [];
+            foreach ($this->scenes[$scene] as $field) {
+                if (array_key_exists($field, $rules)) {
+                    $newRules[$field] = $rules[$field];
+                }
+            }
+            return $newRules;
+        }
+        return $rules;
     }
 }

tests/Cases/FormRequestTest.php

@@ -12,8 +12,14 @@
 namespace HyperfTest\Validation\Cases;
 
 use Hyperf\HttpMessage\Upload\UploadedFile;
+use Hyperf\Translation\ArrayLoader;
+use Hyperf\Translation\Translator;
 use Hyperf\Utils\Context;
+use Hyperf\Validation\Contract\ValidatorFactoryInterface;
+use Hyperf\Validation\ValidationException;
+use Hyperf\Validation\ValidatorFactory;
 use HyperfTest\Validation\Cases\Stub\DemoRequest;
+use HyperfTest\Validation\Cases\Stub\FooSceneRequest;
 use Mockery;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
@@ -67,4 +73,42 @@ public function testRequestValidationDataWithSameKey()
 
         $this->assertEquals(['file' => ['Invalid File.', $file]], $request->getValidationData());
     }
+
+    public function testSceneForFormRequest()
+    {
+        $psrRequest = Mockery::mock(ServerRequestInterface::class);
+        $psrRequest->shouldReceive('getQueryParams')->andReturn([]);
+        $psrRequest->shouldReceive('getUploadedFiles')->andReturn([]);
+        $psrRequest->shouldReceive('getParsedBody')->andReturn([
+            'mobile' => '12345',
+            'name' => '',
+        ]);
+
+        Context::set(ServerRequestInterface::class, $psrRequest);
+        $container = Mockery::mock(ContainerInterface::class);
+        $translator = new Translator(new ArrayLoader(), 'en');
+        $container->shouldReceive('get')->with(ValidatorFactoryInterface::class)->andReturn(new ValidatorFactory($translator));
+
+        $request = new FooSceneRequest($container);
+        $res = $request->scene('info')->validated();
+        $this->assertSame(['mobile' => '12345'], $res);
+
+        wait(function () use ($request, $psrRequest) {
+            Context::set(ServerRequestInterface::class, $psrRequest);
+            try {
+                $request->validated();
+                $this->assertTrue(false);
+            } catch (\Throwable $exception) {
+                $this->assertInstanceOf(ValidationException::class, $exception);
+            }
+        });
+
+        try {
+            $request = new FooSceneRequest($container);
+            $request->validated();
+            $this->assertTrue(false);
+        } catch (\Throwable $exception) {
+            $this->assertInstanceOf(ValidationException::class, $exception);
+        }
+    }
 }

tests/Cases/Stub/FooSceneRequest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\Validation\Cases\Stub;
+
+use Hyperf\Validation\Request\FormRequest;
+
+class FooSceneRequest extends FormRequest
+{
+    public $scenes = [
+        'save' => ['mobile', 'name'],
+        'info' => ['mobile'],
+    ];
+
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    public function rules(): array
+    {
+        return [
+            'mobile' => 'required',
+            'name' => 'required',
+        ];
+    }
+}