respect-validation/docs/validators/IterableVal.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I ran the `bin/console spdx --fix` with different strategies for
different files. For most of the core classes, since they've been
drastically rebuilt, I've run it with the `git-blame` strategy, for for
the `src/Validators`, in which the API changed completely but the logic
remains the same, I use the `git-log` strategy.
2026-02-03 15:23:23 +01:00

2 KiB

IterableVal

  • IterableVal()

Validates whether the input is an iterable value, in other words, if you can iterate over it with the foreach language construct.

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