mirror of
https://github.com/Respect/Validation.git
synced 2026-03-17 07:45:45 +01:00
d9cdc118b2
This commit introduces REUSE compliance by annotating all files with SPDX information and placing the reused licences in the LICENSES folder. We additionally removed the docheader tool which is made obsolete by this change. The main LICENSE and copyright text of the project is now not under my personal name anymore, and it belongs to "The Respect Project Contributors" instead. This change restores author names to several files, giving the appropriate attribution for contributions.
66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# 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)
|