splitbrain / php-archive
Pure-PHP implementation to read and write TAR and ZIP archives
Fund package maintenance!
splitbrain
Installs: 990 324
Dependents: 19
Suggesters: 3
Security: 0
Stars: 100
Watchers: 9
Forks: 36
Open Issues: 6
Requires
- php: >=7.0
Requires (Dev)
- ext-bz2: *
- ext-zip: *
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^8
Suggests
- ext-bz2: For bz2 compression
- ext-iconv: Used for proper filename encode handling
- ext-mbstring: Can be used alternatively for handling filename encoding
- ext-zlib: For zlib compression
README
This library allows to handle new ZIP and TAR archives without the need for any special PHP extensions (gz and bzip are needed for compression). It can create new files or extract existing ones.
To keep things simple, the modification (adding or removing files) of existing archives is not supported.
Install
Use composer:
php composer.phar require splitbrain/php-archive
Usage
The usage for the Zip and Tar classes are basically the same. Here are some examples for working with TARs to get you started.
Check the API docs for more info.
require_once 'vendor/autoload.php'; use splitbrain\PHPArchive\Tar; // To list the contents of an existing TAR archive, open() it and use // contents() on it: $tar = new Tar(); $tar->open('myfile.tgz'); $toc = $tar->contents(); print_r($toc); // array of FileInfo objects // To extract the contents of an existing TAR archive, open() it and use // extract() on it: $tar = new Tar(); $tar->open('myfile.tgz'); $tar->extract('/tmp'); // To create a new TAR archive directly on the filesystem (low memory // requirements), create() it: $tar = new Tar(); $tar->create('myfile.tgz'); $tar->addFile(...); $tar->addData(...); ... $tar->close(); // To create a TAR archive directly in memory, create() it, add*() // files and then either save() or getArchive() it: $tar = new Tar(); $tar->setCompression(9, Archive::COMPRESS_BZIP); $tar->create(); $tar->addFile(...); $tar->addData(...); ... $tar->save('myfile.tbz'); // compresses and saves it echo $tar->getArchive(); // compresses and returns it
Differences between Tar and Zip: Tars are compressed as a whole, while Zips compress each file individually. Therefore
you can call setCompression
before each addFile()
and addData()
function call.
The FileInfo class can be used to specify additional info like ownership or permissions when adding a file to an archive.