respect-validation/docs/validators/IterableVal.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

1.7 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: