respect-validation/docs/validators/Directory.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.5 KiB

Directory

  • Directory()

Validates if the given path is a directory.

v::directory()->assert(__DIR__);
// Validation passes successfully

v::directory()->assert(__FILE__);
// → "/path/to/file" must be a directory

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

v::directory()->assert(new SplFileInfo('library/'));
// Validation passes successfully

v::directory()->assert(dir('/'));
// Validation passes successfully

Templates

Directory::TEMPLATE_STANDARD

Mode Template
default {{subject}} must be a directory
inverted {{subject}} must not be a directory

Template placeholders

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

Categorization

  • File system

Changelog

Version Description
2.0.0 Validates PHP's Directory class
0.4.4 Created

See also: