respect-validation/docs/validators/ArrayVal.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.8 KiB

ArrayVal

  • ArrayVal()

Validates if the input is an array or if the input can be used as an array (instance of ArrayAccess or SimpleXMLElement).

v::arrayVal()->assert([]);
// Validation passes successfully

v::arrayVal()->assert(new ArrayObject);
// Validation passes successfully

v::arrayVal()->assert(new SimpleXMLElement('<xml></xml>'));
// Validation passes successfully

Templates

ArrayVal::TEMPLATE_STANDARD

Mode Template
default {{subject}} must be an array value
inverted {{subject}} must not be an array value

Template placeholders

Placeholder Description
subject The validated input or the custom validator name (if specified).

Categorization

  • Arrays
  • Types

Changelog

Version Description
2.0.0 SimpleXMLElement is also considered as valid
1.0.0 Renamed from Arr to ArrayVal and validate only if the input can be used as an array (#1)
0.3.9 Created as Arr

See also: