Merge pull request #39 from programmatordev/1.x

1.x

Author: andrepimpao

docs/03-rules.md

@@ -4,7 +4,7 @@
 - [Comparison Rules](#comparison-rules)
 - [Date Rules](#date-rules)
 - [Choice Rules](#choice-rules)
-- [Other Rules](#other-rules)
+- [Iterable Rules](#iterable-rules)
 
 ## Basic Rules
 
@@ -28,6 +28,7 @@
 - [Choice](03x-rules-choice.md)
 - [Country](03x-rules-country.md)
 
-## Other Rules
+## Iterable Rules
 
-- [All](03x-rules-all.md)
+- [EachValue](03x-rules-each-value.md)
+- [EachKey](03x-rules-each-key.md)

docs/03x-rules-all.md

@@ -0,0 +1,49 @@
+## EachKey
+
+Validates every key of an `array` or object implementing `\Traversable` with a given set of rules.
+
+```php
+EachKey(
+    Validator $validator,
+    string $message = 'Invalid key: {{ message }}'
+);
+```
+
+## Basic Usage
+
+```php
+Validator::eachKey(Validator::notBlank()->type('string'))->validate(['red' => '#f00', 'green' => '#0f0']); // true
+Validator::eachKey(Validator::notBlank()->type('string'))->validate(['red' => '#f00', 1 => '#0f0']); // false
+```
+
+> **Note**
+> An `UnexpectedValueException` will be thrown when the input value is not an `array` or an object implementing `\Traversable`.
+
+## Options
+
+### `validator`
+
+type: `Validator` `required`
+
+Validator that will validate each key of an `array` or object implementing `\Traversable`.
+
+### `message`
+
+type: `string` default: `Invalid key: {{ message }}`
+
+Message that will be shown if at least one input value key is invalid according to the given `validator`.
+
+```php
+Validator::eachKey(Validator::notBlank())->assert(['red' => '#f00', 1 => '#0f0'], 'Test'); 
+// Throws: Invalid key: The "Test" key should be of type "string", "1" given.
+```
+
+The following parameters are available:
+
+| Parameter       | Description                                      |
+|-----------------|--------------------------------------------------|
+| `{{ value }}`   | The current invalid value                        |
+| `{{ name }}`    | Name of the invalid value                        |
+| `{{ key }}`     | The key of the invalid iterable element          |
+| `{{ element }}` | The value of the invalid iterable element        |
+| `{{ message }}` | The rule message of the invalid iterable element |

docs/03x-rules-each-key.md

@@ -0,0 +1,49 @@
+## EachValue
+
+Validates every element of an `array` or object implementing `\Traversable` with a given set of rules.
+
+```php
+EachValue(
+    Validator $validator,
+    string $message = 'At key "{{ key }}": {{ message }}'
+);
+```
+
+## Basic Usage
+
+```php
+Validator::eachValue(Validator::notBlank()->greaterThan(1)->lessThan(10))->validate([4, 5, 6]); // true
+Validator::eachValue(Validator::notBlank()->greaterThan(1)->lessThan(10))->validate([4, 5, 20]); // false
+```
+
+> **Note**
+> An `UnexpectedValueException` will be thrown when the input value is not an `array` or an object implementing `\Traversable`.
+
+## Options
+
+### `validator`
+
+type: `Validator` `required`
+
+Validator that will validate each element of an `array` or object implementing `\Traversable`. 
+
+### `message`
+
+type: `string` default: `At key "{{ key }}": {{ message }}`
+
+Message that will be shown if at least one input value element is invalid according to the given `validator`.
+
+```php
+Validator::eachValue(Validator::notBlank())->assert(['red', 'green', ''], 'Test'); 
+// Throws: At key "2": The "Test" value should not be blank, "" given.
+```
+
+The following parameters are available:
+
+| Parameter       | Description                                      |
+|-----------------|--------------------------------------------------|
+| `{{ value }}`   | The current invalid value                        |
+| `{{ name }}`    | Name of the invalid value                        |
+| `{{ key }}`     | The key of the invalid iterable element          |
+| `{{ element }}` | The value of the invalid iterable element        |
+| `{{ message }}` | The rule message of the invalid iterable element |

docs/03x-rules-each-value.md

@@ -7,20 +7,6 @@
 
 interface ChainedValidatorInterface
 {
-    /**
-     * @throws ValidationException
-     */
-    public function assert(mixed $value, string $name): void;
-
-    public function validate(mixed $value): bool;
-
-    // --- Rules ---
-
-    public function all(
-        array $constraints,
-        string $message = 'At "{{ key }}": {{ message }}'
-    ): ChainedValidatorInterface;
-
     public function choice(
         array $constraints,
         bool $multiple = false,
@@ -30,54 +16,66 @@ 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 eachKey(
+        Validator $validator,
+        string $message = 'Invalid key: {{ message }}'
+    ): ChainedValidatorInterface&Validator;
+
+    public function eachValue(
+        Validator $validator,
+        string $message = 'At key "{{ key }}": {{ message }}'
+    ): 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/ChainedValidatorInterface.php

@@ -2,4 +2,4 @@
 
 namespace ProgrammatorDev\YetAnotherPhpValidator\Exception;
 
-class AllException extends ValidationException {}
+class EachKeyException extends ValidationException {}

src/Exception/AllException.php renamed to src/Exception/EachKeyException.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Exception;
+
+class EachValueException extends ValidationException {}