respect-validation/docs/rules/File.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

File

  • File()

Validates whether file input is as a regular filename.

v::file()->isValid(__FILE__); // true
v::file()->isValid(__DIR__); // false

This validator will consider SplFileInfo instances, so you can do something like:

v::file()->isValid(new SplFileInfo('file.txt'));

Templates

File::TEMPLATE_STANDARD

Mode Template
default {{name}} must be a valid file
inverted {{name}} must be an invalid file

Template placeholders

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

Categorization

  • File system

Changelog

Version Description
0.5.0 Created

See also: