Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orkhanahmadov/laravel-zip-validator
Laravel ZIP file content validator
https://github.com/orkhanahmadov/laravel-zip-validator
laravel php validation validator zip
Last synced: about 2 months ago
JSON representation
Laravel ZIP file content validator
- Host: GitHub
- URL: https://github.com/orkhanahmadov/laravel-zip-validator
- Owner: orkhanahmadov
- License: mit
- Created: 2020-01-09T23:17:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T20:54:22.000Z (9 months ago)
- Last Synced: 2024-05-02T05:04:14.402Z (5 months ago)
- Topics: laravel, php, validation, validator, zip
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 123
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel ZIP file validator
[](https://plant.treeware.earth/orkhanahmadov/laravel-zip-validator)
[](https://packagist.org/packages/orkhanahmadov/laravel-zip-validator)
[](https://packagist.org/packages/orkhanahmadov/laravel-zip-validator)
[](https://packagist.org/packages/orkhanahmadov/laravel-zip-validator)
[](https://github.com/orkhanahmadov/laravel-zip-validator/blob/master/LICENSE.md)
[](https://travis-ci.org/orkhanahmadov/laravel-zip-validator)
[](https://codeclimate.com/github/orkhanahmadov/laravel-zip-validator/test_coverage)
[](https://codeclimate.com/github/orkhanahmadov/laravel-zip-validator/maintainability)
[](https://scrutinizer-ci.com/g/orkhanahmadov/laravel-zip-validator)
[](https://github.styleci.io/repos/232924943)
Custom Laravel validation rule for checking ZIP file content.
## Requirements
- Laravel **9** or higher
- PHP **8.0** or higher with `zip` extension enabled
## Installation
You can install the package via composer:
```bash
composer require orkhanahmadov/laravel-zip-validator
```
## Usage
Use `ZipContent` rule with list of required files.
``` php
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` file with maximum size of 100000 bytes (100KB).
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 `|` symbol, if any of them exist in ZIP file validator will succeed.
``` php
new ZipContent('thumb.jpg|thumb.png|thumb.svg');
```
Validator in above example will look if `thumb.jpg` or `thumb.png` or `thumb.svg` file exists in ZIP.
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` or `thumb.png` file exists in ZIP and its file size is not bigger than 100000 bytes (100KB).
**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` as second argument to constructor if you want validator to reject files with 0 bytes.
``` php
new ZipContent(['thumb.jpg', 'style.css'], false);
```
### Wildcard filename matching
Additionally, you can use wildcard filename matching with `*` symbol.
```php
new ZipContent('*.jpg');
```
This will return true if Zip archive contains any file with `.jpg` extension.
Filename matching is using [fnmatch](https://www.php.net/manual/en/function.fnmatch.php) function. You can use any of its [patterns](https://www.php.net/manual/en/function.fnmatch.php#refsect1-function.fnmatch-parameters).
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Orkhan Ahmadov](https://github.com/orkhanahmadov)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.