respect-validation/docs/rules/StringVal.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.4 KiB

StringVal

  • StringVal()

Validates whether the input can be used as a string.

v::stringVal()->isValid('6'); // true
v::stringVal()->isValid('String'); // true
v::stringVal()->isValid(1.0); // true
v::stringVal()->isValid(42); // true
v::stringVal()->isValid(false); // true
v::stringVal()->isValid(true); // true
v::stringVal()->isValid(new ClassWithToString()); // true if ClassWithToString implements `__toString`

Templates

StringVal::TEMPLATE_STANDARD

Mode Template
default {{name}} must be a string value
inverted {{name}} must not be a string value

Template placeholders

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

Categorization

  • Strings
  • Types

Changelog

Version Description
2.0.0 Created

See also: