respect-validation/docs/rules/Image.md
Henrique Moody be72a54845
Add templates to each rule documentation
They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.
2024-12-06 00:21:47 +01:00

1.4 KiB

Image

  • Image()
  • Image(finfo $fileInfo)

Validates if the file is a valid image by checking its MIME type.

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 PHP extension.

Templates

Image::TEMPLATE_STANDARD

Mode Template
default {{name}} must be a valid image file
inverted {{name}} must not be a valid image file

Template placeholders

Placeholder Description
name The validated input or the custom validator name (if specified).

Categorization

  • File system

Changelog

Version Description
1.1.0 Created

See also: