respect-validation/docs/rules/Directory.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.4 KiB

Directory

  • Directory()

Validates if the given path is a directory.

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

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

v::directory()->isValid(new SplFileInfo('library/'));
v::directory()->isValid(dir('/'));

Templates

Directory::TEMPLATE_STANDARD

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

Template placeholders

Placeholder Description
name 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: