Move out getName() from RuleInterface (#640)

* Move out RuleInterface::getName()

* Adjust docs and rename interface

* Update CHANGELOG [skip ci]

* Fix Psalm and tests

* Apply fixes from StyleCI

* More removing

* Simplify getName() for abstract classes

---------

Co-authored-by: StyleCI Bot <[email protected]>

CHANGELOG.md

@@ -15,6 +15,10 @@
 - Bug #632: Fix property name usage in error messages of rules in `Nested` rule (@vjik) 
 - Enh #636: Improve psalm annotations in `Result` class (@vjik)
 - Enh #637: Add German translation (@took)
+- Chg #634: Move `getName()` method from `RuleInterface` to `RuleWithOptionsInterface` (@arogachev)
+- Chg #634: Rename `RuleWithOptionsInterface` to `DumpedRuleInterface` (@arogachev)
+- Chg #634: Use FQCN as a name for built-in rules during export with `RulesDumper` (@arogachev)
+- Chg #634: Use FQCN as a name for rules not implementing `DumpedRuleInterface` during export with `RulesDumper`
 - Enh #622: Use `json_validate()` built-in PHP function in `JsonHandler` if code is run with PHP 8.3 (@arogachev)
 - Enh #639: Simplify validation of JSON in `JsonHandler` using built-in PHP functions for PHP versions below 8.3 
   (@arogachev)

docs/guide/en/client-side-validation.md

@@ -31,7 +31,7 @@ the output will be:
 [  
     'name' => [  
         [  
-            'length',  
+            'Yiisoft\Validator\Rule\Length',  
             'min' => 4,  
             'max' => 10,  
             'exactly' => null,  

docs/guide/en/configuring-rules-via-php-attributes.md

@@ -289,11 +289,6 @@ final class Yaml implements RuleInterface
     ) {
     }
 
-    public function getName(): string
-    {
-        return 'yaml';
-    }
-
     public function getHandler(): string
     {
         return YamlHandler::class;

docs/guide/en/creating-custom-rules.md

@@ -31,12 +31,7 @@ final class RgbColor implements RuleInterface
     public function __construct(
         public readonly string $message = 'Invalid RGB color value.',  
     ) {  
-    }  
-
-    public function getName(): string  
-    {  
-        return 'rgbColor';  
-    }  
+    }
 
     public function getHandler(): string  
     {  
@@ -118,11 +113,6 @@ final class RgbColor implements RuleInterface
     ) {  
     }
 
-    public function getName(): string  
-    {  
-        return 'rgbColor';  
-    }  
-
     public function getHandler(): string  
     {  
         return RgbColorHandler::class;  
@@ -330,11 +320,6 @@ final class Yaml implements RuleInterface
     ) {  
     }
 
-    public function getName(): string  
-    {  
-        return 'yaml';  
-    }  
-
     public function getHandler(): string  
     {  
         return YamlHandler::class;  

src/RuleWithOptionsInterface.php → src/DumpedRuleInterface.php

@@ -5,12 +5,20 @@
 namespace Yiisoft\Validator;
 
 /**
- * An extended version of {@see RuleInterface} which allows exporting a rule options in addition to a rule name. It's
- * useful for passing to frontend for further identification and implementing client-side validation. If you don't need
- * that (for example for REST API), use {@see RuleInterface} instead.
+ * An extended version of {@see RuleInterface} which allows exporting a rule options and name customization. It's useful
+ * for passing to frontend for further identification and implementing client-side validation. If you don't need that
+ * (for example for REST API), use {@see RuleInterface} instead.
  */
-interface RuleWithOptionsInterface extends RuleInterface
+interface DumpedRuleInterface extends RuleInterface
 {
+    /**
+     * Returns the name of a rule used during conversion to array. It's used for identification on the frontend with
+     * further implementing of client-side validation.
+     *
+     * @return string A rule name.
+     */
+    public function getName(): string;
+
     /**
      * Gets a rule options as associative array. It's used for identification on the frontend with further implementing
      * of client-side validation. Usually it's just a mapping between rule property names and values.
@@ -46,7 +54,7 @@ interface RuleWithOptionsInterface extends RuleInterface
      * ```
      *
      * Note that the values that can't be serialized to frontend such as callable must be excluded because they will be
-     * useless on frontend. No exception will be thrown, so it's on the conscience of developer.
+     * useless on frontend. No exceptions are thrown in such cases.
      *
      * @return array A rule options.
      */

src/Helper/RulesDumper.php

@@ -6,7 +6,7 @@
 
 use InvalidArgumentException;
 use Yiisoft\Validator\RuleInterface;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 
 use function is_int;
 use function is_string;
@@ -16,7 +16,7 @@
  * The array is usually passed to the client to use it in client-side validation.
  *
  * @see RuleInterface
- * @see RuleWithOptionsInterface
+ * @see DumpedRuleInterface
  */
 final class RulesDumper
 {
@@ -96,10 +96,10 @@ private static function fetchOptions(iterable $rules): array
 
             if (is_iterable($rule)) {
                 $options = self::fetchOptions($rule);
-            } elseif ($rule instanceof RuleWithOptionsInterface) {
+            } elseif ($rule instanceof DumpedRuleInterface) {
                 $options = array_merge([$rule->getName()], $rule->getOptions());
             } elseif ($rule instanceof RuleInterface) {
-                $options = [$rule->getName()];
+                $options = [$rule::class];
             } else {
                 throw new InvalidArgumentException(sprintf(
                     'Every rule must implement "%s". Type "%s" given.',

src/Rule/AbstractCompare.php

@@ -11,7 +11,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -34,7 +34,7 @@
  * @psalm-import-type WhenType from WhenInterface
  */
 abstract class AbstractCompare implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnEmptyInterface,
     SkipOnErrorInterface,
     WhenInterface
@@ -169,6 +169,11 @@ public function __construct(
         }
     }
 
+    public function getName(): string
+    {
+        return self::class;
+    }
+
     /**
      * Get value to be compared with.
      *

src/Rule/AbstractNumber.php

@@ -9,7 +9,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -26,7 +26,7 @@
  * @psalm-import-type WhenType from WhenInterface
  */
 abstract class AbstractNumber implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnErrorInterface,
     WhenInterface,
     SkipOnEmptyInterface
@@ -113,6 +113,11 @@ public function __construct(
         $this->pattern = $pattern;
     }
 
+    public function getName(): string
+    {
+        return self::class;
+    }
+
     /**
      * Get lower limit of the number. `null` means no lower limit.
      *

src/Rule/AtLeast.php

@@ -10,7 +10,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -27,7 +27,7 @@
  * @psalm-import-type WhenType from WhenInterface
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class AtLeast implements RuleWithOptionsInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
+final class AtLeast implements DumpedRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
 {
     use SkipOnEmptyTrait;
     use SkipOnErrorTrait;
@@ -74,7 +74,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'atLeast';
+        return self::class;
     }
 
     /**

src/Rule/BooleanValue.php

@@ -9,7 +9,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -27,7 +27,7 @@
  * @psalm-import-type WhenType from WhenInterface
  */
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class BooleanValue implements RuleWithOptionsInterface, SkipOnEmptyInterface, SkipOnErrorInterface, WhenInterface
+final class BooleanValue implements DumpedRuleInterface, SkipOnEmptyInterface, SkipOnErrorInterface, WhenInterface
 {
     use SkipOnEmptyTrait;
     use SkipOnErrorTrait;
@@ -91,7 +91,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'boolean';
+        return self::class;
     }
 
     /**

src/Rule/Callback.php

@@ -12,7 +12,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -26,7 +26,7 @@
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 final class Callback implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnErrorInterface,
     WhenInterface,
     SkipOnEmptyInterface,
@@ -71,7 +71,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'callback';
+        return self::class;
     }
 
     /**

src/Rule/Compare.php

@@ -30,8 +30,4 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 final class Compare extends AbstractCompare
 {
-    public function getName(): string
-    {
-        return 'compare';
-    }
 }

src/Rule/Composite.php

@@ -13,7 +13,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
 use Yiisoft\Validator\Helper\RulesDumper;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\ValidatorInterface;
@@ -74,7 +74,7 @@
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class Composite implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnEmptyInterface,
     SkipOnErrorInterface,
     WhenInterface,
@@ -136,7 +136,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'composite';
+        return self::class;
     }
 
     #[ArrayShape([

src/Rule/Count.php

@@ -12,7 +12,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -27,7 +27,7 @@
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 final class Count implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnErrorInterface,
     WhenInterface,
     SkipOnEmptyInterface,
@@ -109,7 +109,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'count';
+        return self::class;
     }
 
     /**

src/Rule/Each.php

@@ -16,7 +16,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
 use Yiisoft\Validator\Helper\RulesDumper;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\ValidatorInterface;
@@ -63,7 +63,7 @@
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 final class Each implements
-    RuleWithOptionsInterface,
+    DumpedRuleInterface,
     SkipOnEmptyInterface,
     SkipOnErrorInterface,
     WhenInterface,
@@ -123,7 +123,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'each';
+        return self::class;
     }
 
     public function propagateOptions(): void

src/Rule/Email.php

@@ -11,7 +11,7 @@
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
 use Yiisoft\Validator\Rule\Trait\WhenTrait;
-use Yiisoft\Validator\RuleWithOptionsInterface;
+use Yiisoft\Validator\DumpedRuleInterface;
 use Yiisoft\Validator\SkipOnEmptyInterface;
 use Yiisoft\Validator\SkipOnErrorInterface;
 use Yiisoft\Validator\WhenInterface;
@@ -26,7 +26,7 @@
  * @psalm-import-type WhenType from WhenInterface
  */
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class Email implements RuleWithOptionsInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
+final class Email implements DumpedRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
 {
     use SkipOnEmptyTrait;
     use SkipOnErrorTrait;
@@ -126,7 +126,7 @@ public function __construct(
 
     public function getName(): string
     {
-        return 'email';
+        return self::class;
     }
 
     /**