smuuf / zip-reader
A simple-to-use library for browsing and reading Zip files with friendly API.
1.0
2022-09-17 23:41 UTC
Requires
- php: ^8.0
- ext-zip: *
- smuuf/strict-object: ^1.0
Requires (Dev)
- nette/tester: ^2
- phpstan/phpstan: ^1.8
This package is auto-updated.
Last update: 2024-10-18 04:15:35 UTC
README
You just need to read Zip files in PHP? Say no more! đ This is a simple-to-use library for browsing and reading Zip files with friendly API. Just reading, nothing else (like creating or modifying Zip files - if you need that, look elsewhere).
Installation
composer require smuuf/zip-reader
âšī¸ This package uses the \ZipArchive
class internally, so you need to have PHP extension Zip
installed and enabled.
Usage
<?php use \Smuuf\StrictObject; use \Smuuf\ZipReader\ZippedDir; use \Smuuf\ZipReader\ZippedFile; require __DIR__ . '/../bootstrap.php'; // Loads some existing Zip file. (Or throws \Smuuf\ZipReader\Exc\ZipOpenError) $zipReader = new ZipReader('/some/zipped/file.zip'); // This returns a dict array of items that are present in the root directory // of the zip. For example:. // [ // 'dir_a/' => ZippedDir object, // 'dir_b/' => ZippedDir object, // 'some_file_a.txt' => ZippedFile object, // ] $entries = $zipReader->getEntries(); // When browsing, directory path must have a trailing slash. $item = $zipReader->browse('dir_a/'); // Instance of ZippedDir. $item = $zipReader->browse('not_present_dir/'); // null $item = $zipReader->browse('some_file_a.txt'); // Instance of ZippedFile. $item = $zipReader->browse('not_present_dir/'); // null // You can do nested browsing. $dir = $zipReader->browse('dir_a/inner_dir/'); // Instance of ZippedDir. $somefile = $zipReader->browse('dir_a/inner_dir/some_file.txt'); // Instance of ZippedFile. // You can also browse further in the ZippedDir object. // This will return ZippedFile that represents 'dir_a/inner_dir/some_other_file.txt'. $someOtherFile = $dir->browse('some_other_file.txt'); // You can get contents of zipped file (done lazily). $bytes = $someOtherFile->read(); // You can get stat array of a zipped file or a dir (done lazily). // See https://www.php.net/manual/en/ziparchive.statname.php to see what // items the stat array can returns. $fileStat = $someOtherFile->stat(); $dirStat = $dir->stat();