respect-validation/docs/rules/ArrayVal.md
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.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()->isValid([]); // true
v::arrayVal()->isValid(new ArrayObject); // true
v::arrayVal()->isValid(new SimpleXMLElement('<xml></xml>')); // true

Templates

ArrayVal::TEMPLATE_STANDARD

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

Template placeholders

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