respect-validation/docs/validators/File.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.
2026-01-21 06:28:11 +00:00

1.4 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: