On this page
Caution
The documentation you are viewing is for an older version of this component.
Switch to the latest (v3) version.
File Validators
Size
Laminas\Validator\File\Size
checks for the size of a file.
Supported Options
The following set of options are supported:
min
: Minimum file size in integer bytes, or in string SI notation;null
indicates no minimum required.max
: maximum file size in integer bytes, or in string SI notation;null
indicates no maximum required.useByteString
: Boolean flag indicating whether to dispaly error messages using SI notation (default,true
), or in bytes (false
).
SI units supported are: kB, MB, GB, TB, PB, and EB. All sizes are converted using 1024 as the base value (ie. 1kB == 1024 bytes, 1MB == 1024kB).
Basic Usage
use Laminas\Validator\File\Size;
// Limit the file size to 40000 bytes
$validator = new Size(40000);
// Limit the file size to between 10kB and 4MB
$validator = new Size([
'min' => '10kB',
'max' => '4MB',
]);
// Perform validation with file path
if ($validator->isValid('./myfile.txt')) {
// file is valid
}