mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 15:25:45 +01:00
d9cdc118b2
This commit introduces REUSE compliance by annotating all files with SPDX information and placing the reused licences in the LICENSES folder. We additionally removed the docheader tool which is made obsolete by this change. The main LICENSE and copyright text of the project is now not under my personal name anymore, and it belongs to "The Respect Project Contributors" instead. This change restores author names to several files, giving the appropriate attribution for contributions.
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# 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 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)
|
|
- [Unique](Unique.md)
|