respect-validation/docs/rules/Size.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

2.5 KiB

Size

  • Size(string $minSize)
  • Size(string $minSize, string $maxSize)
  • Size(null, string $maxSize)

Validates whether the input is a file that is of a certain size or not.

v::size('1KB')->isValid($filename); // Must have at least 1KB size
v::size('1MB', '2MB')->isValid($filename); // Must have the size between 1MB and 2MB
v::size(null, '1GB')->isValid($filename); // Must not be greater than 1GB

Sizes are not case-sensitive and the accepted values are:

  • B
  • KB
  • MB
  • GB
  • TB
  • PB
  • EB
  • ZB
  • YB

This validator will consider SplFileInfo instances, like:

v::size('1.5mb')->isValid(new SplFileInfo($filename)); // Will return true or false

Message template for this validator includes {{minSize}} and {{maxSize}}.

Templates

Size::TEMPLATE_BOTH

Mode Template
default {{name}} must be between {{minSize}} and {{maxSize}}
inverted {{name}} must not be between {{minSize}} and {{maxSize}}

Size::TEMPLATE_LOWER

Mode Template
default {{name}} must be greater than {{minSize}}
inverted {{name}} must not be greater than {{minSize}}

Size::TEMPLATE_GREATER

Mode Template
default {{name}} must be lower than {{maxSize}}
inverted {{name}} must not be lower than {{maxSize}}

Template placeholders

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

Categorization

  • File system

Changelog

Version Description
2.1.0 Add PSR-7 support
1.0.0 Created

See also: