respect-validation/docs/validators/Readable.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I ran the `bin/console spdx --fix` with different strategies for
different files. For most of the core classes, since they've been
drastically rebuilt, I've run it with the `git-blame` strategy, for for
the `src/Validators`, in which the API changed completely but the logic
remains the same, I use the `git-log` strategy.
2026-02-03 15:23:23 +01:00

56 lines
1.3 KiB
Markdown

<!--
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>
-->
# Readable
- `Readable()`
Validates if the given data is a file exists and is readable.
```php
v::readable()->assert('/path/to/file.txt');
// Validation passes successfully
```
## Templates
### `Readable::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :------------------------------- |
| `default` | {{subject}} must be readable |
| `inverted` | {{subject}} must not be readable |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- File system
## Changelog
| Version | Description |
| ------: | :---------------- |
| 2.1.0 | Add PSR-7 support |
| 0.5.0 | Created |
## See Also
- [Directory](Directory.md)
- [Executable](Executable.md)
- [Exists](Exists.md)
- [Extension](Extension.md)
- [File](File.md)
- [Image](Image.md)
- [Mimetype](Mimetype.md)
- [Size](Size.md)
- [SymbolicLink](SymbolicLink.md)
- [Writable](Writable.md)