mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 06:45:44 +01:00
d2198dfd01There's more value on showing how `assert()` displays the validation messages than simply showing if `isValid()` returns `true` or `false`. However, that increases the chances of having outdated documentation, so I created a doc linter that updates the Markdown files with the correct message.
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# 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 a valid 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 a valid file |
|
|
| `inverted` | {{subject}} must be an invalid file |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- File system
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | ----------- |
|
|
| 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)
|
|
- [Uploaded](Uploaded.md)
|
|
- [Writable](Writable.md)
|