Laravel ZIP file validator

Custom Laravel validation rule for checking ZIP file content.

Requirements

• Laravel 6 or higher
• PHP 7.2 or higher with

  zip

  extension enabled

Installation

You can install the package via composer:

composer require orkhanahmadov/laravel-zip-validator

Usage

Use

ZipContent

use Orkhanahmadov\ZipValidator\Rules\ZipContent;

public function rules()
{
    return [
        'file' => [
            'required',
            'file',
            'mimes:zip',
            new ZipContent('thumb.jpg', 'assets/logo.png'),
        ],
    ];
}

Pass list of required files/folders to the constructor of the validator.

You can pass files as different constructor arguments or as array. If files are nested inside folders, pass relative path to file.

Validator will fail if any of the passed files does not exist in ZIP archive.

Validating maximum file size

Validator also allows checking maximum size of each file inside ZIP archive.

Simply pass file name as array key and maximum size as value:

php
new ZipContent(['thumb.jpg' => 100000]);

Validator in above example will look for

thumb.jpg

You can also mix multiple files with name-only or name+size validation:

php
new ZipContent(['thumb.jpg' => 100000, 'logo.png']);

Multiple files with "OR" validation

You can also pass multiple files with

|

php
new ZipContent('thumb.jpg|thumb.png|thumb.svg');

Validator in above example will look if

thumb.jpg

thumb.png

thumb.svg

Of course, you can also validate file size with "OR" validation:

php
new ZipContent(['thumb.jpg|thumb.png' => 100000]);

Above example will look if

thumb.jpg

thumb.png

Important to keep in mind that when using "OR" validation with additional file size validation, validator will compare file size with the first matching element in ZIP archive.

Rejecting empty files

By default, validator only checks if file with given name exists, it will return true even if file with matching name is empty (has size of 0 bytes).

You can pass array of files as first argument and

false

php
new ZipContent(['thumb.jpg', 'style.css'], false);

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Orkhan Ahmadov
• All Contributors

License

The MIT License (MIT). Please see License File for more information.