Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

Commit

Permalink
Explode Introduction, Supported Options and Basic Usage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
renanliberato committed Dec 6, 2017
1 parent 010084d commit 79a9c85
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
30 changes: 30 additions & 0 deletions doc/book/validators/explode.md
@@ -0,0 +1,30 @@
# Explode Validator

`Zend\Validator\Explode` executes a validator for each item exploded.

## Supported options

The following options are supported for `Zend\Validator\Explode`:

- `valueDelimiter`: Defines the delimiter used to explode the value to an array. It defaults to `,`. If working with an array, this option isn't used.
- `validator`: Sets the validator that will be executed on each exploded item.

## Basic usage

To validate if every item in an array is into a certain haystack:

```php
$inArrayValidator = new Zend\Validator\InArray([
'haystack' => [1, 2, 3, 4, 5, 6]
]);

$explodeValidator = new Zend\Validator\Explode([
'validator' => $inArrayValidator
]);

$value = [1, 4, 6, 8];
$return = $valid->isValid($value);
// returns false
```

The above example returns `true` if all $value items are between 1 and 6.
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -17,6 +17,7 @@ pages:
- "Db\\RecordExists and Db\\NoRecordExists": validators/db.md
- Digits: validators/digits.md
- EmailAddress: validators/email-address.md
- Explode: validators/explode.md
- GreaterThan: validators/greater-than.md
- Hex: validators/hex.md
- Hostname: validators/hostname.md
Expand Down

0 comments on commit 79a9c85

Please sign in to comment.