mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 06:45:44 +01:00
16148e9593
- Remove redundant "valid" prefix: Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version. - Remove redundant "value" suffix ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal. - Standardize "consist only of" phrasing Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit. - Improve file accessibility messages Directory, Executable, File, Image, Readable, SymbolicLink, Writable. - Improve grammar and article usage CreditCard, Extension, Mimetype, Regex, Size.
69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
-->
|
|
|
|
# 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()->assert([]);
|
|
// Validation passes successfully
|
|
|
|
v::arrayVal()->assert(new ArrayObject);
|
|
// Validation passes successfully
|
|
|
|
v::arrayVal()->assert(new SimpleXMLElement('<xml></xml>'));
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `ArrayVal::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :------------------------------- |
|
|
| `default` | {{subject}} must be an array |
|
|
| `inverted` | {{subject}} must not be an array |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Arrays
|
|
- Types
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :------------------------------------------------------------------------------------------- |
|
|
| 3.0.0 | Templates changed |
|
|
| 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)
|
|
- [Unique](Unique.md)
|