PHPackages imritesh/zipper - 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. [Utility & Helpers](/categories/utility) 4. / 5. imritesh/zipper ActiveLibrary[Utility & Helpers](/categories/utility) imritesh/zipper =============== This is a little neat helper for the ZipArchive methods with handy functions 05.2k1PHPCI failing Since Oct 10Pushed 6y ago1 watchersCompare [ Source](https://github.com/riteshsingh1/zipper)[ Packagist](https://packagist.org/packages/imritesh/zipper)[ RSS](/packages/imritesh-zipper/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependenciesVersions (1)Used By (0) Note ==== [](#note) This is an compatibility update for `laravel 6.0+` of [Chumper/Zipper](https://github.com/Chumper/Zipper). All Credit goes to [Chumper/Zipper](https://github.com/Chumper/Zipper) Zipper ====== [](#zipper) This is a simple Wrapper around the ZipArchive methods with some handy functions. Installation ------------ [](#installation) 2. Run `composer require imritesh/zipper` 3. Go to `app/config/app.php` - add to providers `imritesh\Zipper\ZipperServiceProvider::class` - add to aliases `'Zipper' => imritesh\Zipper\Zipper::class` You can now access Zipper with the `Zipper` alias. Simple example -------------- [](#simple-example) ``` $files = glob('public/files/*'); Zipper::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 \imritesh\Zipper\Zipper; $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('',array('mySuperPackage/composer.json'),Zipper::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 ``` Zipper::make('test.zip')->folder('test')->add('composer.json'); Zipper::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 = Zipper::make('test.zip')->listFiles('/\.log$/i'); $notLogFiles = Zipper::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 ``` Zipper::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 `Zipper::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 > **Zipper::WHITELIST** ``` Zipper::make('test.zip')->extractTo('public', array('vendor'), Zipper::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 > **Zipper::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. ``` Zipper::make('test.zip')->extractTo('public', array('vendor'), Zipper::BLACKLIST); ``` > **Zipper::EXACT\_MATCH** ``` Zipper::make('test.zip') ->folder('vendor') ->extractTo('public', array('composer', 'bin/phpunit'), Zipper::WHITELIST | Zipper::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 Zipper::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. ``` Zipper::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. ``` Zipper::make('test.zip')->folder('src')->extractMatchingRegex($path, '/^(?!.*test\.php).*$/i'); ``` If you need other functions or got errors, please leave an issue on github. ### Health Score 22 — LowBetter than 22% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity19 Limited adoption so far Community8 Small or concentrated contributor base Maturity35 Early-stage or recently created project Bus Factor1 Top contributor holds 100% 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/b2591aebd258ff4ad90a431c7fa6071ab72bad7aeb886946142f69de859402e7?d=identicon)[riteshsingh1](/maintainers/riteshsingh1) --- Top Contributors [![riteshsingh1](https://avatars.githubusercontent.com/u/12195263?v=4)](https://github.com/riteshsingh1 "riteshsingh1 (2 commits)") ### Embed Badge ![Health badge](/badges/imritesh-zipper/health.svg) ``` [![Health](https://phpackages.com/badges/imritesh-zipper/health.svg)](https://phpackages.com/packages/imritesh-zipper) ``` ### Alternatives [pulkitjalan/ip-geolocation IP Geolocation Wrapper with Laravel Support 89164.9k1](/packages/pulkitjalan-ip-geolocation) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)