ContextQMD
Back to Validation

Directory

docs/validators/Directory.md

3.1.11.9 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> SPDX-FileContributor: William Espindola <[email protected]> -->

Directory

  • Directory()

Validates if the given path is a directory.

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

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

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

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

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

Templates

Directory::TEMPLATE_STANDARD

ModeTemplate
default{{subject}} must be an accessible existing directory
inverted{{subject}} must not be an accessible existing directory

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • File system

Changelog

VersionDescription
3.0.0Templates changed
2.0.0Validates PHP's Directory class
0.4.4Created

See Also