chore: improved interfaces methods return value type

Author: andrepimpao

src/ChainedValidatorInterface.php

@@ -7,15 +7,6 @@
 
 interface ChainedValidatorInterface
 {
-    /**
-     * @throws ValidationException
-     */
-    public function assert(mixed $value, string $name): void;
-
-    public function validate(mixed $value): bool;
-
-    // --- Rules ---
-
     public function choice(
         array $constraints,
         bool $multiple = false,
@@ -25,59 +16,61 @@ public function choice(
         string $multipleMessage = 'The "{{ name }}" value has one or more invalid choices, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
         string $minMessage = 'The "{{ name }}" value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
         string $maxMessage = 'The "{{ name }}" value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function country(
         string $code = 'alpha-2',
         string $message = 'The "{{ name }}" value is not a valid "{{ code }}" country code, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function eachValue(
         Validator $validator,
         string $message = 'At key "{{ key }}": {{ message }}'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function greaterThan(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be greater than "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function greaterThanOrEqual(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be greater than or equal to "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function lessThan(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be less than "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function lessThanOrEqual(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be less than or equal to "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function notBlank(
         ?callable $normalizer = null,
         string $message = 'The "{{ name }}" value should not be blank, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function range(
         mixed $minConstraint,
         mixed $maxConstraint,
         string $message = 'The "{{ name }}" value should be between "{{ minConstraint }}" and "{{ maxConstraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
-    public function rule(RuleInterface $constraint): ChainedValidatorInterface;
+    public function rule(
+        RuleInterface $constraint
+    ): ChainedValidatorInterface&Validator;
 
     public function timezone(
         int $timezoneGroup = \DateTimeZone::ALL,
         ?string $countryCode = null,
         string $message = 'The "{{ name }}" value is not a valid timezone, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public function type(
         string|array $constraint,
         string $message = 'The "{{ name }}" value should be of type "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 }

src/StaticValidatorInterface.php

@@ -15,59 +15,61 @@ public static function choice(
         string $multipleMessage = 'The "{{ name }}" value has one or more invalid choices, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
         string $minMessage = 'The "{{ name }}" value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
         string $maxMessage = 'The "{{ name }}" value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function country(
         string $code = 'alpha-2',
         string $message = 'The "{{ name }}" value is not a valid "{{ code }}" country code, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function eachValue(
         Validator $validator,
         string $message = 'At key "{{ key }}": {{ message }}'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function greaterThan(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be greater than "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function greaterThanOrEqual(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be greater than or equal to "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function lessThan(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be less than "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function lessThanOrEqual(
         mixed $constraint,
         string $message = 'The "{{ name }}" value should be less than or equal to "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function notBlank(
         ?callable $normalizer = null,
         string $message = 'The "{{ name }}" value should not be blank, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function range(
         mixed $minConstraint,
         mixed $maxConstraint,
         string $message = 'The "{{ name }}" value should be between "{{ minConstraint }}" and "{{ maxConstraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
-    public static function rule(RuleInterface $constraint): ChainedValidatorInterface;
+    public static function rule(
+        RuleInterface $constraint
+    ): ChainedValidatorInterface&Validator;
 
     public static function timezone(
         int $timezoneGroup = \DateTimeZone::ALL,
         ?string $countryCode = null,
         string $message = 'The "{{ name }}" value is not a valid timezone, "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 
     public static function type(
         string|array $constraint,
         string $message = 'The "{{ name }}" value should be of type "{{ constraint }}", "{{ value }}" given.'
-    ): ChainedValidatorInterface;
+    ): ChainedValidatorInterface&Validator;
 }