PHPackages                             madnest/madzipper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. madnest/madzipper

ActiveLibrary[File & Storage](/categories/file-storage)

madnest/madzipper
=================

Easier zip file handling for Laravel applications.

1.6.0(1y ago)1382.3M—10%26[2 issues](https://github.com/madnest/madzipper/issues)[2 PRs](https://github.com/madnest/madzipper/pulls)6MITPHPPHP ^8.2CI passing

Since Sep 5Pushed 1y ago6 watchersCompare

[ Source](https://github.com/madnest/madzipper)[ Packagist](https://packagist.org/packages/madnest/madzipper)[ Docs](https://github.com/madnest/madzipper)[ RSS](/packages/madnest-madzipper/feed)WikiDiscussions 1.6 Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (24)Used By (6)

Madzipper
=========

[](#madzipper)

This is a simple Wrapper around the ZipArchive methods with some handy functions.

[![Build Status](https://github.com/madnest/madzipper/workflows/Tests/badge.svg)](https://github.com/madnest/madzipper/actions)

Installation
------------

[](#installation)

1. `madnest/madzipper` can be installed by running:

```
composer require madnest/madzipper
```

2. Optionally when using with Laravel, go to `app/config/app.php`

- add to providers `Madnest\Madzipper\MadzipperServiceProvider::class`

You can now access Madzipper with the `Madzipper` alias.

Versions
--------

[](#versions)

PackageLaravelPHP**v1.6**`11.*` `12.*``^8.2`**v1.5**`11.*``^8.2`**v1.4**`10.*``^8.1`**v1.3**`9.*``^8.0`**v1.2**`8.*``^8.0`Simple Laravel example by using Madzipper facade
------------------------------------------------

[](#simple-laravel-example-by-using-madzipper-facade)

```
$files = glob('public/files/*');
Madzipper::make('public/test.zip')->add($files)->close();
```

- by default the package will create the `test.zip` in the project route folder but in the example above we changed it to `project_route/public/`.

Another example
---------------

[](#another-example)

```
$zipper = new \Madnest\Madzipper\Madzipper;

$zipper->make('test.zip')->folder('test')->add('composer.json');
$zipper->zip('test.zip')->folder('test')->add('composer.json','test');

$zipper->remove('composer.lock');

$zipper->folder('mySuperPackage')->add(
    array(
        'vendor',
        'composer.json'
    ),
);

$zipper->getFileContent('mySuperPackage/composer.json');

$zipper->make('test.zip')->extractTo('', ['mySuperPackage/composer.json'], Madzipper::WHITELIST);

$zipper->close();
```

Note: Please be aware that you need to call `->close()` at the end to write the zip file to disk.

You can easily chain most functions, except `getFileContent`, `getStatus`, `close` and `extractTo` which must come at the end of the chain.

The main reason I wrote this little package is the `extractTo` method since it allows you to be very flexible when extracting zips. So you can for example implement an update method which will just override the changed files.

Functions
=========

[](#functions)

make($pathToFile)
-----------------

[](#makepathtofile)

`Create` or `Open` a zip archive; if the file does not exists it will create a new one. It will return the Zipper instance so you can chain easily.

add($files/folder)
------------------

[](#addfilesfolder)

You can add an array of Files, or a Folder and all the files in that folder will then be added, so from the first example we could instead do something like `$files = 'public/files/';`.

addString($filename, $content)
------------------------------

[](#addstringfilename-content)

add a single file to the zip by specifying a name and the content as strings.

remove($file/s)
---------------

[](#removefiles)

removes a single file or an array of files from the zip.

folder($folder)
---------------

[](#folderfolder)

Specify a folder to 'add files to' or 'remove files from' from the zip, example

```
Madzipper::make('test.zip')->folder('test')->add('composer.json');
Madzipper::make('test.zip')->folder('test')->remove('composer.json');
```

listFiles($regexFilter = null)
------------------------------

[](#listfilesregexfilter--null)

Lists all files within archive (if no filter pattern is provided). Use `$regexFilter` parameter to filter files. See [Pattern Syntax](http://php.net/manual/en/reference.pcre.pattern.syntax.php) for regular expression syntax

> NB: `listFiles` ignores folder set with `folder` function

Example: Return all files/folders ending/not ending with '.log' pattern (case insensitive). This will return matches in sub folders and their sub folders also

```
$logFiles = Madzipper::make('test.zip')->listFiles('/\.log$/i');
$notLogFiles = Madzipper::make('test.zip')->listFiles('/^(?!.*\.log).*$/i');
```

home()
------

[](#home)

Resets the folder pointer.

zip($fileName)
--------------

[](#zipfilename)

Uses the ZipRepository for file handling.

getFileContent($filePath)
-------------------------

[](#getfilecontentfilepath)

get the content of a file in the zip. This will return the content or false.

getStatus()
-----------

[](#getstatus)

get the opening status of the zip as integer.

close()
-------

[](#close)

closes the zip and writes all changes.

extractTo($path)
----------------

[](#extracttopath)

Extracts the content of the zip archive to the specified location, for example

```
Madzipper::make('test.zip')->folder('test')->extractTo('foo');
```

This will go into the folder `test` in the zip file and extract the content of that folder only to the folder `foo`, this is equal to using the `Madzipper::WHITELIST`.

This command is really nice to get just a part of the zip file, you can also pass a 2nd & 3rd param to specify a single or an array of files that will be

> NB: Php ZipArchive uses internally '/' as directory separator for files/folders in zip. So Windows users should not set whitelist/blacklist patterns with '' as it will not match anything

white listed

> **Madzipper::WHITELIST**

```
Madzipper::make('test.zip')->extractTo('public', array('vendor'), Madzipper::WHITELIST);
```

Which will extract the `test.zip` into the `public` folder but **only** files/folders starting with `vendor` prefix inside the zip will be extracted.

or black listed

> **Madzipper::BLACKLIST**Which will extract the `test.zip` into the `public` folder except files/folders starting with `vendor` prefix inside the zip will not be extracted.

```
Madzipper::make('test.zip')->extractTo('public', array('vendor'), Madzipper::BLACKLIST);
```

> **Madzipper::EXACT\_MATCH**

```
Madzipper::make('test.zip')
    ->folder('vendor')
    ->extractTo('public', array('composer', 'bin/phpunit'), Madzipper::WHITELIST | Madzipper::EXACT_MATCH);
```

Which will extract the `test.zip` into the `public` folder but **only** files/folders **exact matching names**. So this will:

- extract file or folder named `composer` in folder named `vendor` inside zip to `public` resulting `public/composer`
- extract file or folder named `bin/phpunit` in `vendor/bin/phpunit` folder inside zip to `public` resulting `public/bin/phpunit`

> **NB:** extracting files/folder from zip without setting Madzipper::EXACT\_MATCH When zip has similar structure as below and only `test.bat` is given as whitelist/blacklist argument then `extractTo` would extract all those files and folders as they all start with given string

```
test.zip
 |- test.bat
 |- test.bat.~
 |- test.bat.dir/
    |- fileInSubFolder.log

```

extractMatchingRegex($path, $regex)
-----------------------------------

[](#extractmatchingregexpath-regex)

Extracts the content of the zip archive matching regular expression to the specified location. See [Pattern Syntax](http://php.net/manual/en/reference.pcre.pattern.syntax.php) for regular expression syntax.

Example: extract all files ending with `.php` from `src` folder and its sub folders.

```
Madzipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/\.php$/i');
```

Example: extract all files **except** those ending with `test.php` from `src` folder and its sub folders.

```
Madzipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/^(?!.*test\.php).*$/i');
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Development
-----------

[](#development)

Maybe it is a good idea to add other compression functions like rar, phar or bzip2 etc... Everything is setup for that, if you want just fork and develop further.

If you need other functions or got errors, please leave an issue on github.

Credits
-------

[](#credits)

Big thank you goes to [@Chumper](https://github.com/Chumper) for creating the original package [Chumper/Zipper](https://github.com/Chumper/Zipper)

###  Health Score

56

—

FairBetter than 98% of packages

Maintenance43

Moderate activity, may be stable

Popularity58

Moderate usage in the ecosystem

Community28

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 76.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~95 days

Recently: every ~82 days

Total

22

Last Release

447d ago

Major Versions

v0.0.1 → v1.0.02019-09-05

PHP version history (5 changes)v0.0.1PHP >=7.2.0

v1.1.1PHP ^7.3|^8.0

v1.3.1PHP ^8.0

v1.4.0PHP ^8.1

v1.5.0PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/581117abe0f4b50c0ed62f6072f506571a3be5351311f447f10e120c24e2ddca?d=identicon)[theimerj](/maintainers/theimerj)

---

Top Contributors

[![repl6669](https://avatars.githubusercontent.com/u/5587309?v=4)](https://github.com/repl6669 "repl6669 (49 commits)")[![ndum](https://avatars.githubusercontent.com/u/18392323?v=4)](https://github.com/ndum "ndum (5 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (5 commits)")[![sgarwood](https://avatars.githubusercontent.com/u/13749959?v=4)](https://github.com/sgarwood "sgarwood (2 commits)")[![NinoSkopac](https://avatars.githubusercontent.com/u/1783732?v=4)](https://github.com/NinoSkopac "NinoSkopac (1 commits)")[![BBrunekreeft](https://avatars.githubusercontent.com/u/9114578?v=4)](https://github.com/BBrunekreeft "BBrunekreeft (1 commits)")[![scs-ben](https://avatars.githubusercontent.com/u/2318300?v=4)](https://github.com/scs-ben "scs-ben (1 commits)")

---

Tags

laravellaravel-packagezipziparchivephplaravelzipziparchive

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/madnest-madzipper/health.svg)

```
[![Health](https://phpackages.com/badges/madnest-madzipper/health.svg)](https://phpackages.com/packages/madnest-madzipper)
```

###  Alternatives

[unisharp/laravel-filemanager

A file upload/editor intended for use with Laravel 5 to 10 and CKEditor / TinyMCE

2.2k3.3M74](/packages/unisharp-laravel-filemanager)[zanysoft/laravel-zip

laravel-zip is the world's leading zip utility for file compression and backup.

3142.8M15](/packages/zanysoft-laravel-zip)[spatie/laravel-google-cloud-storage

Google Cloud Storage filesystem driver for Laravel

2408.9M13](/packages/spatie-laravel-google-cloud-storage)[zing/laravel-flysystem-obs

Flysystem Adapter for OBS

1211.2k](/packages/zing-laravel-flysystem-obs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)