<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
SPDX-FileContributor: William Espindola <oi@williamespindola.com.br>
-->

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

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

## 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                 |
|   2.0.0 | Validates PHP's `Directory` class |
|   0.4.4 | Created                           |

## See Also

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