mirror of https://github.com/Respect/Validation.git synced 2026-03-16 07:15:45 +01:00

Henrique Moody be72a54845

Add templates to each rule documentation

They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.

2024-12-06 00:21:47 +01:00

1.6 KiB

Raw Blame History

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()->isValid([]); // true
v::iterableVal()->isValid(new ArrayObject()); // true
v::iterableVal()->isValid(new stdClass()); // true
v::iterableVal()->isValid('string'); // false

Note

This rule 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`	{{name}} must be an iterable value
`inverted`	{{name}} must not be an iterable value

Template placeholders

Placeholder	Description
`name`	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`

1.6 KiB Raw Blame History