Fix #242: Document that rule handler should not be called directly (#256

)
yiisoft · Jul 17, 2022 · 5677329 · 5677329
1 parent 4a4f19e
commit 5677329
Show file tree

Hide file tree

Showing 22 changed files with 26 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -644,6 +644,8 @@ final class CompanyNameHandler implements Rule\RuleHandlerInterface
 }
 ```
 
+> Note: Do not call handler's `validate()` method directly. It must be used via Validator only. 
+
 ##### Resolving rule handler dependencies
 
 Basically, you can use `SimpleRuleHandlerResolver` to resolve rule handler.

diff --git a/src/Rule/RuleHandlerInterface.php b/src/Rule/RuleHandlerInterface.php
@@ -19,6 +19,8 @@ interface RuleHandlerInterface
      * @param object $rule Rule containing validation parameters.
      * @param ValidationContext|null $context Optional validation context.
      *
+     * @internal Should be never called directly. Use {@see ValidatorInterface}.
+     *
      * @return Result
      */
     public function validate(mixed $value, object $rule, ?ValidationContext $context = null): Result;

diff --git a/tests/Rule/AbstractRuleValidatorTest.php b/tests/Rule/AbstractRuleValidatorTest.php
@@ -59,10 +59,10 @@ public function testDifferentRule(): void
 
     protected function validate(mixed $value, object $config): Result
     {
-        $ruleValidator = $this->getValidator();
+        $ruleHandler = $this->getRuleHandler();
         $context = $this->getValidationContext();
 
-        return $ruleValidator->validate($value, $config, $context);
+        return $ruleHandler->validate($value, $config, $context);
     }
 
     protected function formatMessage(string $message, array $params): string
@@ -76,7 +76,7 @@ abstract public function passedValidationProvider(): array;
 
     abstract public function failedValidationProvider(): array;
 
-    abstract protected function getValidator(): RuleHandlerInterface;
+    abstract protected function getRuleHandler(): RuleHandlerInterface;
 
     protected function getValidationContext(): ValidationContext
     {

diff --git a/tests/Rule/AtLeastHandlerTest.php b/tests/Rule/AtLeastHandlerTest.php
@@ -53,7 +53,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new AtLeastHandler();
     }

diff --git a/tests/Rule/BooleanHandlerTest.php b/tests/Rule/BooleanHandlerTest.php
@@ -69,7 +69,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new BooleanHandler();
     }

diff --git a/tests/Rule/CallbackHandlerTest.php b/tests/Rule/CallbackHandlerTest.php
@@ -75,7 +75,7 @@ public function testThrowExceptionWithInvalidReturn(): void
         $this->validate(null, $rule);
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new CallbackHandler();
     }

diff --git a/tests/Rule/CompareToHandlerTest.php b/tests/Rule/CompareToHandlerTest.php
@@ -92,7 +92,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new CompareToHandler();
     }

diff --git a/tests/Rule/CompositeHandlerTest.php b/tests/Rule/CompositeHandlerTest.php
@@ -72,7 +72,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new CompositeHandler();
     }

diff --git a/tests/Rule/CountHandlerTest.php b/tests/Rule/CountHandlerTest.php
@@ -122,7 +122,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new CountHandler();
     }

diff --git a/tests/Rule/EachHandlerTest.php b/tests/Rule/EachHandlerTest.php
@@ -75,7 +75,7 @@ public function indexedByPathErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new EachHandler();
     }

diff --git a/tests/Rule/EmailHandlerTest.php b/tests/Rule/EmailHandlerTest.php
@@ -152,7 +152,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new EmailHandler();
     }

diff --git a/tests/Rule/GroupRuleHandlerTest.php b/tests/Rule/GroupRuleHandlerTest.php
@@ -49,7 +49,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new GroupRuleHandler();
     }

diff --git a/tests/Rule/HasLengthHandlerTest.php b/tests/Rule/HasLengthHandlerTest.php
@@ -85,7 +85,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): HasLengthHandler
+    protected function getRuleHandler(): HasLengthHandler
     {
         return new HasLengthHandler();
     }

diff --git a/tests/Rule/InRangeHandlerTest.php b/tests/Rule/InRangeHandlerTest.php
@@ -80,7 +80,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new InRangeHandler();
     }

diff --git a/tests/Rule/IpHandlerTest.php b/tests/Rule/IpHandlerTest.php
@@ -238,7 +238,7 @@ public function testInitException(): void
         $this->validate('', $rule);
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new IpHandler();
     }

diff --git a/tests/Rule/JsonHandlerTest.php b/tests/Rule/JsonHandlerTest.php
@@ -124,7 +124,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new JsonHandler();
     }

diff --git a/tests/Rule/NestedHandlerTest.php b/tests/Rule/NestedHandlerTest.php
@@ -214,7 +214,7 @@ public function indexedByPathErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new NestedHandler();
     }

diff --git a/tests/Rule/NumberHandlerTest.php b/tests/Rule/NumberHandlerTest.php
@@ -123,7 +123,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new NumberHandler();
     }

diff --git a/tests/Rule/RegexHandlerTest.php b/tests/Rule/RegexHandlerTest.php
@@ -59,7 +59,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new RegexHandler();
     }

diff --git a/tests/Rule/RequiredHandlerTest.php b/tests/Rule/RequiredHandlerTest.php
@@ -38,7 +38,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new RequiredHandler();
     }

diff --git a/tests/Rule/SubsetHandlerTest.php b/tests/Rule/SubsetHandlerTest.php
@@ -50,7 +50,7 @@ public function customErrorMessagesProvider(): array
         ];
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new SubsetHandler();
     }

diff --git a/tests/Rule/UrlHandlerTest.php b/tests/Rule/UrlHandlerTest.php
@@ -95,7 +95,7 @@ public function testEnableIdnException(): void
         new Url(enableIDN: true);
     }
 
-    protected function getValidator(): RuleHandlerInterface
+    protected function getRuleHandler(): RuleHandlerInterface
     {
         return new UrlHandler();
     }