mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 23:35: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.
69 lines
1.8 KiB
Markdown
69 lines
1.8 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# IterableVal
|
|
|
|
- `IterableVal()`
|
|
|
|
Validates whether the input is an iterable value, in other words, if you can iterate over it with the [foreach][] language construct.
|
|
|
|
```php
|
|
v::iterableVal()->assert([]);
|
|
// Validation passes successfully
|
|
|
|
v::iterableVal()->assert(new ArrayObject());
|
|
// Validation passes successfully
|
|
|
|
v::iterableVal()->assert(new stdClass());
|
|
// Validation passes successfully
|
|
|
|
v::iterableVal()->assert('string');
|
|
// → "string" must be an iterable value
|
|
```
|
|
|
|
## Note
|
|
|
|
This validator doesn't behave as PHP's [is_iterable()][] function because it considers that you can iterate over any object.
|
|
|
|
## Templates
|
|
|
|
### `IterableVal::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------- | ----------------------------------------- |
|
|
| `default` | {{subject}} must be an iterable value |
|
|
| `inverted` | {{subject}} must not be an iterable value |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Types
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | -------------------------------------------- |
|
|
| 3.0.0 | Renamed from `IterableType` to `IterableVal` |
|
|
| 1.0.8 | Renamed from `Iterable` to `IterableType` |
|
|
| 1.0.0 | Created as `Iterable` |
|
|
|
|
---
|
|
|
|
See also:
|
|
|
|
- [ArrayType](ArrayType.md)
|
|
- [ArrayVal](ArrayVal.md)
|
|
- [Countable](Countable.md)
|
|
- [Each](Each.md)
|
|
- [Instance](Instance.md)
|
|
- [IterableType](IterableType.md)
|
|
|
|
[is_iterable()]: https://www.php.net/is_iterable
|
|
[foreach]: http://php.net/foreach
|