Skip to content

Commit 8c2d317

Browse files
improve readme
1 parent 11bf0c4 commit 8c2d317

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

Diff for: README.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Validate an email address to ensure it is not null and matches the standard emai
2626

2727
```php
2828
use PhpDevCommunity\Validator\Validation;
29-
use PhpDevCommunity\Validator\Rules\NotNull;
30-
use PhpDevCommunity\Validator\Rules\Email;
29+
use PhpDevCommunity\Validator\Assert\NotNull;
30+
use PhpDevCommunity\Validator\Assert\Email;
3131

3232
// Instantiate Validation object for email validation
3333
$validation = new Validation([
@@ -52,8 +52,8 @@ Validate the age to ensure it is a non-null integer and is 18 or older.
5252

5353
```php
5454
use PhpDevCommunity\Validator\Validation;
55-
use PhpDevCommunity\Validator\Rules\NotNull;
56-
use PhpDevCommunity\Validator\Rules\Integer;
55+
use PhpDevCommunity\Validator\Assert\NotNull;
56+
use PhpDevCommunity\Validator\Assert\Integer;
5757

5858
// Instantiate Validation object for age validation
5959
$validation = new Validation([
@@ -82,9 +82,9 @@ Ensure that a username is not null, has a minimum length of 3 characters, and co
8282

8383
```php
8484
use PhpDevCommunity\Validator\Validation;
85-
use PhpDevCommunity\Validator\Rules\NotNull;
86-
use PhpDevCommunity\Validator\Rules\Alphanumeric;
87-
use PhpDevCommunity\Validator\Rules\StringLength;
85+
use PhpDevCommunity\Validator\Assert\NotNull;
86+
use PhpDevCommunity\Validator\Assert\Alphanumeric;
87+
use PhpDevCommunity\Validator\Assert\StringLength;
8888

8989
// Instantiate Validation object for username validation
9090
$validation = new Validation([
@@ -109,10 +109,10 @@ The `Item` rule allows you to validate nested objects or associative arrays with
109109

110110
```php
111111
use PhpDevCommunity\Validator\Validation;
112-
use PhpDevCommunity\Validator\Rules\NotNull;
113-
use PhpDevCommunity\Validator\Rules\Item;
114-
use PhpDevCommunity\Validator\Rules\StringLength;
115-
use PhpDevCommunity\Validator\Rules\Alphabetic;
112+
use PhpDevCommunity\Validator\Assert\NotNull;
113+
use PhpDevCommunity\Validator\Assert\Item;
114+
use PhpDevCommunity\Validator\Assert\StringLength;
115+
use PhpDevCommunity\Validator\Assert\Alphabetic;
116116

117117
// Define validation rules for a nested object (e.g., a "person" object)
118118
$validation = new Validation([
@@ -145,11 +145,11 @@ The `Collection` rule is used to validate arrays where each item in the array mu
145145

146146
```php
147147
use PhpDevCommunity\Validator\Validation;
148-
use PhpDevCommunity\Validator\Rules\NotEmpty;
149-
use PhpDevCommunity\Validator\Rules\Collection;
150-
use PhpDevCommunity\Validator\Rules\Item;
151-
use PhpDevCommunity\Validator\Rules\NotNull;
152-
use PhpDevCommunity\Validator\Rules\StringLength;
148+
use PhpDevCommunity\Validator\Assert\NotEmpty;
149+
use PhpDevCommunity\Validator\Assert\Collection;
150+
use PhpDevCommunity\Validator\Assert\Item;
151+
use PhpDevCommunity\Validator\Assert\NotNull;
152+
use PhpDevCommunity\Validator\Assert\StringLength;
153153

154154
// Define validation rules for a collection of articles
155155
$validation = new Validation([
@@ -184,8 +184,8 @@ Validate a URL to ensure it is not null and is a valid URL format.
184184

185185
```php
186186
use PhpDevCommunity\Validator\Validation;
187-
use PhpDevCommunity\Validator\Rules\NotNull;
188-
use PhpDevCommunity\Validator\Rules\Url;
187+
use PhpDevCommunity\Validator\Assert\NotNull;
188+
use PhpDevCommunity\Validator\Assert\Url;
189189

190190
// Instantiate Validation object for URL validation
191191
$validation = new Validation([
@@ -210,8 +210,8 @@ Validate a numeric value to ensure it is not null and represents a valid numeric
210210

211211
```php
212212
use PhpDevCommunity\Validator\Validation;
213-
use PhpDevCommunity\Validator\Rules\NotNull;
214-
use PhpDevCommunity\Validator\Rules\Numeric;
213+
use PhpDevCommunity\Validator\Assert\NotNull;
214+
use PhpDevCommunity\Validator\Assert\Numeric;
215215

216216
// Instantiate Validation object for numeric value validation
217217
$validation = new Validation([
@@ -236,8 +236,8 @@ Implement a custom validation rule using a callback function.
236236

237237
```php
238238
use PhpDevCommunity\Validator\Validation;
239-
use PhpDevCommunity\Validator\Rules\NotNull;
240-
use PhpDevCommunity\Validator\Rules\Custom;
239+
use PhpDevCommunity\Validator\Assert\NotNull;
240+
use PhpDevCommunity\Validator\Assert\Custom;
241241

242242
// Custom validation function to check if the value is a boolean
243243
$isBoolean = function ($value) {
@@ -273,9 +273,9 @@ Suppose you have a user registration form with fields like `username`, `email`,
273273

274274
```php
275275
use PhpDevCommunity\Validator\Validation;
276-
use PhpDevCommunity\Validator\Rules\NotNull;
277-
use PhpDevCommunity\Validator\Rules\Email;
278-
use PhpDevCommunity\Validator\Rules\Integer;
276+
use PhpDevCommunity\Validator\Assert\NotNull;
277+
use PhpDevCommunity\Validator\Assert\Email;
278+
use PhpDevCommunity\Validator\Assert\Integer;
279279

280280
// Define validation rules for each field
281281
$validation = new Validation([
@@ -315,8 +315,8 @@ Consider validating input data received via an API endpoint. Here's how you can
315315

316316
```php
317317
use PhpDevCommunity\Validator\Validation;
318-
use PhpDevCommunity\Validator\Rules\NotNull;
319-
use PhpDevCommunity\Validator\Rules\Numeric;
318+
use PhpDevCommunity\Validator\Assert\NotNull;
319+
use PhpDevCommunity\Validator\Assert\Numeric;
320320

321321
// Define validation rules for API input data
322322
$validation = new Validation([
@@ -351,7 +351,7 @@ In this example:
351351
### Additional Features
352352

353353
- **Simple Interface**: Easily define validation rules using a straightforward interface.
354-
- **Extensible**: Extend the library with custom validation rules by implementing the `RuleInterface`.
354+
- **Extensible**: Extend the library with custom validation rules by implementing the `ValidatorInterface`.
355355
- **Error Handling**: Retrieve detailed validation errors for each field.
356356

357357
---

0 commit comments

Comments
 (0)