<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Danilo Correa <danilosilva87@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
-->

# 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`

|       Mode | Template                                            |
| ---------: | :-------------------------------------------------- |
|  `default` | {{subject}} must be an accessible existing file     |
| `inverted` | {{subject}} must not be an accessible existing file |

## Template placeholders

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

## Categorization

- File system

## Changelog

| Version | Description       |
| ------: | :---------------- |
|   3.0.0 | Templates changed |
|   0.5.0 | Created           |

## See Also

- [Directory](Directory.md)
- [Executable](Executable.md)
- [Exists](Exists.md)
- [Extension](Extension.md)
- [Image](Image.md)
- [Mimetype](Mimetype.md)
- [Readable](Readable.md)
- [Size](Size.md)
- [SymbolicLink](SymbolicLink.md)
- [Writable](Writable.md)