respect-validation/docs/rules/ArrayVal.md
Henrique Moody 061a3c9c09
Rename method "validate()" to "isValid()"
The method has been renamed some time ago, but I haven't updated the
documentation to cause less confusion. Now that I want to start updating
the documentation, I switched the default branch on GitHub to the latest
stable version, so I assume there will be less confusion in the
documentation, and I can start updating the docs for the next version.
2024-12-02 22:11:57 +01:00

45 lines
1 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
```
## 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`
1. Previously this rule considered `Traversable` and `Countable` as valid inputs.
***
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)