docs: improved examples

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_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

@@ -67,7 +67,7 @@ Validator::collection(fields: [
     'age' => 25
 ]); // false ("name" is missing)
 
-// but it is possible to use the Optional validation for optiona fields
+// but it is possible to use the Optional validation for optional fields
 Validator::collection(fields: [
     'name' => Validator::optional(
         Validator::notBlank()

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_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
 ```

docs/03-rules_type.md

@@ -15,17 +15,17 @@ Type(
 ## Basic Usage
 
 ```php
-// Single type
+// single type
 Validator::type('string')->validate('green'); // true
 Validator::type('alphanumeric')->validate('gr33n'); // true
 
-// Multiple types
-// Validates if value is of at least one of the provided types
+// multiple types
+// validates if value is of at least one of the provided types
 Validator::type(['alpha', 'numeric'])->validate('green'); // true (alpha)
 Validator::type(['alpha', 'numeric'])->validate('33'); // true (numeric)
 Validator::type(['alpha', 'numeric'])->validate('gr33n'); // false (not alpha nor numeric)
 
-// Class or interface type
+// class or interface type
 Validator::type(\DateTime::class)->validate(new \DateTime()); // true
 Validator::type(\DateTimeInterface::class)->validate(new \DateTime()); // true
 ```

docs/03-rules_url.md

@@ -16,12 +16,12 @@ Url(
 ```php
 Validator::url()->validate('https://example.com'); // true
 
-// Only allow the https protocol
+// only allow the https protocol
 Validator::url(protocols: ['https'])->validate('http://example.com'); // false
-// Or allow the ftp protocol too
+// or allow the ftp protocol too
 Validator::url(protocols: ['https', 'ftp'])->validate('ftp://example.com'); // true
 
-// Allow relative protocol
+// allow relative protocol
 Validator::url()->validate('//example.com'); // false
 Validator::url(allowRelativeProtocol: true)->validate('//example.com'); // true
 Validator::url(allowRelativeProtocol: true)->validate('https://example.com'); // true