respect-validation/docs/rules/Instance.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.3 KiB

Instance

  • Instance(string $instanceName)

Validates if the input is an instance of the given class or interface.

v::instance('DateTime')->isValid(new DateTime); // true
v::instance('Traversable')->isValid(new ArrayObject); // true

Message template for this validator includes {{instanceName}}.

Templates

Instance::TEMPLATE_STANDARD

Mode Template
default {{name}} must be an instance of {{class|raw}}
inverted {{name}} must not be an instance of {{class|raw}}

Template placeholders

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

Categorization

  • Objects

Changelog

Version Description
0.3.9 Created

See also: