respect-validation/docs/validators/File.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

1.3 KiB

File

  • File()

Validates whether file input is as a regular filename.

v::file()->assert(__FILE__);
// Validation passes successfully

v::file()->assert(__DIR__);
// → "/path/to/dir" must be a valid file

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

v::file()->assert(new SplFileInfo('/path/to/file.txt'));
// Validation passes successfully

Templates

File::TEMPLATE_STANDARD

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

Template placeholders

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

Categorization

  • File system

Changelog

Version Description
0.5.0 Created

See also: