ContextQMD
Back to Validation

File

docs/validators/File.md

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

File

  • File()

Validates whether file input is as a regular filename.

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

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

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

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

Templates

File::TEMPLATE_STANDARD

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

Template placeholders

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

Categorization

  • File system

Changelog

VersionDescription
3.0.0Templates changed
0.5.0Created

See Also