respect-validation/docs/rules/Size.md

Size

• Size(string $unit, Rule $rule)

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

v::size('KB', v::greaterThan(1))->isValid($filename);
v::size('MB', v::between(1, 2))->isValid($filename);
v::size('GB', v::lessThan(1))->isValid($filename);

Accepted data storage units are B, KB, MB, GB, TB, PB, EB, ZB, and YB.

This validator will accept:

• string file paths
• SplFileInfo objects (see SplFileInfo)
• Psr\Http\Message\UploadedFileInterface objects (see PSR-7)
• Psr\Http\Message\StreamInterface objects (see PSR-7)

Templates

Size::TEMPLATE_STANDARD

Mode	Template
default	The size in {{unit|trans}} of
inverted	The size in {{unit|trans}} of

This template serve as message prefix:

v::size('MB', v::equals(2))->assert('filename.txt')
// Message: The size in megabytes of "filename.txt" must be equal to 2

v::size('KB', v::not(v::equals(56)))->assert('filename.txt')
// Message: The size in kilobytes of "filename.txt" must not be equal to 56

Size::TEMPLATE_WRONG_TYPE

Used when the input is not a valid file path, a SplFileInfo object, or a PSR-7 interface.

Mode	Template
default	{{name}} must be a filename or an instance of SplFileInfo or a PSR-7 interface
inverted	{{name}} must not be a filename or an instance of SplFileInfo or a PSR-7 interface

Template placeholders

Placeholder	Description
name	The validated input or the custom validator name (if specified).
unit	The name of the storage unit (bytes, kilobytes, etc.)

Categorization

• File system
• Transformations

Changelog

Version	Description
3.0.0	Became a transformation
2.1.0	Add PSR-7 support
1.0.0	Created

---

See also:

• Directory
• Executable
• Exists
• Extension
• File
• Image
• Mimetype
• Readable
• SymbolicLink
• Uploaded
• Writable