respect-validation/docs/validators/IterableVal.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
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.
2026-01-21 06:28:11 +00:00

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