respect-validation/docs/rules/Image.md
Henrique Moody 48405271c5
Replace placeholder "name" with "subject"
The `{{name}}` placeholder could represent different things depending on
the state of the Result, and referring to it as `{{name}}` seems
arbitrary. This commit changes it to `{{subject}}`, which is much more
generic and it describes well what that placeholder can mean.
2025-12-26 21:30:01 +01:00

58 lines
1.4 KiB
Markdown

# Image
- `Image()`
- `Image(finfo $fileInfo)`
Validates if the file is a valid image by checking its MIME type.
```php
v::image()->isValid('image.gif'); // true
v::image()->isValid('image.jpg'); // true
v::image()->isValid('image.png'); // true
```
All the validations above must return `false` if the input is not a valid file
or of the MIME doesn't match with the file extension.
This rule relies on [fileinfo](http://php.net/fileinfo) PHP extension.
## Templates
### `Image::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | ------------------------------------------ |
| `default` | {{subject}} must be a valid image file |
| `inverted` | {{subject}} must not be a valid image file |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- File system
## Changelog
| Version | Description |
| ------: | ----------- |
| 1.1.0 | Created |
---
See also:
- [Directory](Directory.md)
- [Executable](Executable.md)
- [Exists](Exists.md)
- [Extension](Extension.md)
- [File](File.md)
- [Mimetype](Mimetype.md)
- [Readable](Readable.md)
- [Size](Size.md)
- [SymbolicLink](SymbolicLink.md)
- [Uploaded](Uploaded.md)
- [Writable](Writable.md)