Skip to content

Commit 52026e9

Browse files
committed
Add doc for rule Name
1 parent 6d2641d commit 52026e9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ public function rules()
5454
- [`Float Number`](#floatnumber)
5555
- [`Hash`](#hash)
5656
- [`Image URL`](#imageurl)
57+
- [`Name`](#name)
5758
- [`Phone`](#phone)
5859
- [`Username`](#username)
5960
- [`Without Spaces`](#withoutspaces)
@@ -267,6 +268,27 @@ public function rules()
267268
}
268269
```
269270

271+
### `Name`
272+
273+
The field under validation must be a valid name.
274+
275+
- no emoji
276+
- no number (if $allowNumber flag is true, it will accept numbers, default is false)
277+
- special characters are allowed
278+
279+
public Arifszn\AdvancedValidation\Rules\Name::__construct(bool $allowNumber = false, string $errorMessage = null)
280+
281+
```php
282+
use Arifszn\AdvancedValidation\Rules\Name;
283+
284+
public function rules()
285+
{
286+
return [
287+
'name' => [new Name()],
288+
];
289+
}
290+
```
291+
270292
### `Phone`
271293

272294
The field under validation must be a valid phone number.

0 commit comments

Comments
 (0)