respect-validation/docs/rules/TrueVal.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.2 KiB

TrueVal

  • TrueVal()

Validates if a value is considered as true.

v::trueVal()->isValid(true); // true
v::trueVal()->isValid(1); // true
v::trueVal()->isValid('1'); // true
v::trueVal()->isValid('true'); // true
v::trueVal()->isValid('on'); // true
v::trueVal()->isValid('yes'); // true
v::trueVal()->isValid('0.5'); // false
v::trueVal()->isValid('2'); // false

Templates

TrueVal::TEMPLATE_STANDARD

Mode Template
default {{name}} must evaluate to true
inverted {{name}} must not evaluate to true

Template placeholders

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

Categorization

  • Booleans

Changelog

Version Description
1.0.0 Renamed from True to TrueVal
0.8.0 Created as True

See also: