respect-validation/docs/validators/ArrayVal.md
Henrique Moody 81310cc4d9
Rename namespace Rules to Validators
Since that namespace contains our “validators”, naming it as such makes
much more sense.
2026-01-05 17:36:35 +01:00

59 lines
1.8 KiB
Markdown

# ArrayVal
- `ArrayVal()`
Validates if the input is an array or if the input can be used as an array
(instance of `ArrayAccess` or `SimpleXMLElement`).
```php
v::arrayVal()->isValid([]); // true
v::arrayVal()->isValid(new ArrayObject); // true
v::arrayVal()->isValid(new SimpleXMLElement('<xml></xml>')); // true
```
## Templates
### `ArrayVal::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | -------------------------------------- |
| `default` | {{subject}} must be an array value |
| `inverted` | {{subject}} must not be an array value |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Arrays
- Types
## Changelog
| Version | Description |
| ------: | -------------------------------------------------------------------------------------------- |
| 2.0.0 | `SimpleXMLElement` is also considered as valid |
| 1.0.0 | Renamed from `Arr` to `ArrayVal` and validate only if the input can be used as an array (#1) |
| 0.3.9 | Created as `Arr` |
---
See also:
- [ArrayType](ArrayType.md)
- [Countable](Countable.md)
- [Each](Each.md)
- [IterableType](IterableType.md)
- [IterableVal](IterableVal.md)
- [Key](Key.md)
- [KeyExists](KeyExists.md)
- [KeyOptional](KeyOptional.md)
- [KeySet](KeySet.md)
- [ScalarVal](ScalarVal.md)
- [Sorted](Sorted.md)
- [Subset](Subset.md)
- [Type](Type.md)
- [Unique](Unique.md)