Merge pull request #62 from programmatordev/1.x

1.x

Author: andrepimpao

README.md

@@ -6,13 +6,6 @@
 
 PHP validator with expressive error messages.
 
-> [!NOTE]
-> This library is not in version 1.x mainly because there are few available rules.
-> Hopefully, that will change in the near future.
-
-> [!IMPORTANT]
-> Expect some breaking changes until version `1.0`.
-
 ## Requirements
 
 - PHP 8.1 or higher.

docs/03-rules.md

@@ -6,6 +6,7 @@
 - [Date Rules](#date-rules)
 - [Choice Rules](#choice-rules)
 - [Iterable Rules](#iterable-rules)
+- [Other Rules](#other-rules)
 
 ## Basic Rules
 
@@ -41,5 +42,10 @@
 
 ## Iterable Rules
 
+- [Collection](03-rules_collection.md)
 - [EachValue](03-rules_each-value.md)
-- [EachKey](03-rules_each-key.md)
+- [EachKey](03-rules_each-key.md)
+
+## Other Rules
+
+- [Optional](03-rules_optional.md)

docs/03-rules_choice.md

@@ -18,23 +18,23 @@ Choice(
 ## Basic Usage
 
 ```php
-// Single choice
+// single choice
 Validator::choice(['red', 'green', 'blue'])->validate('green'); // true
 Validator::choice(['red', 'green', 'blue'])->validate('yellow'); // false
 
-// Multiple choices
+// multiple choices
 Validator::choice(['red', 'green', 'blue'], multiple: true)->validate(['red', 'blue']); // true;
 Validator::choice(['red', 'green', 'blue'], multiple: true)->validate(['red', 'yellow']); // false;
 
-// Multiple with minimum number of choices
+// multiple with minimum number of choices
 Validator::choice(['red', 'green', 'blue'], multiple: true, min: 2)->validate(['red', 'blue']); // true
 Validator::choice(['red', 'green', 'blue'], multiple: true, min: 2)->validate(['red']); // false
 
-// Multiple with maximum number of choices
+// multiple with maximum number of choices
 Validator::choice(['red', 'green', 'blue'], multiple: true, max: 2)->validate(['red', 'blue']); // true
 Validator::choice(['red', 'green', 'blue'], multiple: true, max: 2)->validate(['red', 'green', 'blue']); // false
 
-// Multiple with minimum and maximum number of choices
+// multiple with minimum and maximum number of choices
 Validator::choice(['red', 'green', 'blue'], multiple: true, min: 2, max: 3)->validate(['red', 'blue']); // true
 Validator::choice(['red', 'green', 'blue'], multiple: true, min: 2, max: 3)->validate(['red']); // false
 ```

docs/03-rules_collection.md

@@ -0,0 +1,145 @@
+# Collection
+
+Validates each key of an `array`, or object implementing `\Traversable`, with a set of validation constraints.
+
+```php
+/** @var array<mixed, Validator> $fields */
+Collection(
+    array $fields, 
+    bool $allowExtraFields = false,
+    ?string $message = null,
+    ?string $extraFieldsMessage = null,
+    ?string $missingFieldsMessage = null
+);
+```
+
+## Basic Usage
+
+```php
+Validator::collection(fields: [
+    'name' => Validator::notBlank(),
+    'age' => Validator::type('int')->greaterThanOrEqual(18)
+])->validate([
+    'name' => 'Name',
+    'age' => 25
+]); // true
+
+Validator::collection(fields: [
+    'name' => Validator::notBlank(),
+    'age' => Validator::type('int')->greaterThanOrEqual(18)
+])->validate([
+    'name' => '',
+    'age' => 25
+]); // false ("name" is blank)
+
+///////////////////////////////
+
+// by default, extra fields are not allowed
+Validator::collection(fields: [
+    'name' => Validator::notBlank(),
+    'age' => Validator::type('int')->greaterThanOrEqual(18)
+])->validate([
+    'name' => 'Name',
+    'age' => 25,
+    'email' => 'mail@example.com'
+]); // false ("email" field is not allowed)
+
+// to allow extra fields, set option to true
+Validator::collection(
+    fields: [
+        'name' => Validator::notBlank(),
+        'age' => Validator::type('int')->greaterThanOrEqual(18)
+    ], 
+    allowExtraFields: true
+)->validate([
+    'name' => 'Name',
+    'age' => 25,
+    'email' => 'mail@example.com'
+]); // true
+
+///////////////////////////////
+
+// by default, missing fields are not allowed
+Validator::collection(fields: [
+    'name' => Validator::notBlank(),
+    'age' => Validator::type('int')->greaterThanOrEqual(18)
+])->validate([
+    'age' => 25
+]); // false ("name" is missing)
+
+// but it is possible to use the Optional validation for optional fields
+Validator::collection(fields: [
+    'name' => Validator::optional(
+        Validator::notBlank()
+    ),
+    'age' => Validator::type('int')->greaterThanOrEqual(18)
+])->validate([
+    'age' => 25
+]); // true ("name" is optional)
+```
+
+> [!NOTE]
+> An `UnexpectedValueException` will be thrown when a value in the `fields` associative array is not an instance of `Validator`.
+
+> [!NOTE]
+> An `UnexpectedValueException` will be thrown when the input value is not an `array` or an object implementing `\Traversable`.
+
+## Options
+
+### `fields`
+
+type: `array<mixed, Validator>` `required`
+
+Associative array with a set of validation constraints for each key.
+
+### `allowExtraFields`
+
+type: `bool` default: `false`
+
+By default, it is not allowed to have fields (array keys) that are not defined in the `fields` option.
+If set to `true`, it will be allowed (but not validated).
+
+### `message`
+
+type: `?string` default: `{{ message }}`
+
+Message that will be shown when one of the fields is invalid.
+
+The following parameters are available:
+
+| Parameter       | Description                           |
+|-----------------|---------------------------------------|
+| `{{ name }}`    | Name of the invalid value             |
+| `{{ field }}`   | Name of the invalid field (array key) |
+| `{{ message }}` | The rule message of the invalid field |
+
+### `extraFieldsMessage`
+
+type: `?string` default: `The {{ field }} field is not allowed.`
+
+Message that will be shown when the input value has a field that is not defined in the `fields` option
+and `allowExtraFields` is set to `false`.
+
+The following parameters are available:
+
+| Parameter       | Description                           |
+|-----------------|---------------------------------------|
+| `{{ name }}`    | Name of the invalid value             |
+| `{{ field }}`   | Name of the invalid field (array key) |
+
+### `missingFieldsMessage`
+
+type: `?string` default: `The {{ field }} field is missing.`
+
+Message that will be shown when the input value *does not* have a field that is defined in the `fields` option.
+
+The following parameters are available:
+
+| Parameter       | Description                           |
+|-----------------|---------------------------------------|
+| `{{ name }}`    | Name of the invalid value             |
+| `{{ field }}`   | Name of the invalid field (array key) |
+
+## Changelog
+
+- `1.0.0` Created

docs/03-rules_country.md

@@ -12,12 +12,11 @@ Country(
 ## Basic Usage
 
 ```php
-// Default alpha-2 code
-Validator::country()->validate('PT'); // true
-Validator::country(code: 'alpha-2')->validate('PT'); // true
+// default alpha-2 code
+Validator::country()->validate('pt'); // true
 
-// Alpha-3 code
-Validator::country(code: 'alpha-3')->validate('PRT'); // true
+// alpha-3 code
+Validator::country(code: 'alpha-3')->validate('prt'); // true
 ```
 
 > [!NOTE]

docs/03-rules_each-key.md

@@ -13,11 +13,11 @@ EachKey(
 
 ```php
 Validator::eachKey(
-    Validator::notBlank()->type('string')
+    Validator::type('string')->notBlank()
 )->validate(['red' => '#f00', 'green' => '#0f0']); // true
 
 Validator::eachKey(
-    Validator::notBlank()->type('string')
+    Validator::type('string')->notBlank()
 )->validate(['red' => '#f00', 1 => '#0f0']); // false
 ```
 

docs/03-rules_each-value.md

@@ -13,11 +13,11 @@ EachValue(
 
 ```php
 Validator::eachValue(
-    Validator::notBlank()->greaterThan(1)->lessThan(10)
+    Validator::type('int')->range(1, 10)
 )->validate([4, 5, 6]); // true
 
 Validator::eachValue(
-    Validator::notBlank()->greaterThan(1)->lessThan(10)
+    Validator::type('int')->range(1, 10)
 )->validate([4, 5, 20]); // false
 ```
 

docs/03-rules_email.md

@@ -13,7 +13,7 @@ Email(
 ## Basic Usage
 
 ```php
-// html5 mode (default)
+// default html5 mode
 Validator::email()->validate('test@example.com'); // true
 Validator::email()->validate('test@example'); // false
 

docs/03-rules_optional.md

@@ -0,0 +1,37 @@
+# Optional
+
+Validates only if value is *not* `null`.
+
+```php
+Optional(
+    Validator $validator,
+);
+```
+
+## Basic Usage
+
+```php
+Validator::optional(
+    Validator::type('int')->greaterThanEqualTo(18)
+)->validate(null); // true
+
+Validator::optional(
+    Validator::type('int')->greaterThanEqualTo(18)
+)->validate(20); // true
+
+Validator::optional(
+    Validator::type('int')->greaterThanEqualTo(18)
+)->validate(16); // false
+```
+
+## Options
+
+### `validator`
+
+type: `Validator` `required`
+
+Validator that will validate the input value only when it is *not* `null`.
+
+## Changelog
+
+- `1.0.0` Created

docs/03-rules_timezone.md

@@ -13,16 +13,16 @@ Timezone(
 ## Basic Usage
 
 ```php
-// All timezone identifiers
+// all timezone identifiers
 Validator::timezone()->validate('Europe/Lisbon'); // true
 
-// Restrict timezone identifiers to a specific geographical zone
+// restrict timezone identifiers to a specific geographical zone
 Validator::timezone(timezoneGroup: \DateTimeZone::EUROPE)->validate('Europe/Lisbon'); // true
 Validator::timezone(timezoneGroup: \DateTimeZone::AFRICA)->validate('Europe/Lisbon'); // false
-// Or multiple geographical zones
+// or multiple geographical zones
 Validator::timezone(timezoneGroup: \DateTimeZone::AFRICA | \DateTimeZone::EUROPE)->validate('Europe/Lisbon'); // true
 
-// Restrict timezone identifiers to a specific country
+// restrict timezone identifiers to a specific country
 Validator::timezone(timezoneGroup: \DateTimeZone::PER_COUNTRY, countryCode: 'pt')->validate('Europe/Lisbon'); // true
 Validator::timezone(timezoneGroup: \DateTimeZone::PER_COUNTRY, countryCode: 'en')->validate('Europe/Lisbon'); // false
 ```