diff options
Diffstat (limited to 'wiki/vendor/splitbrain/php-archive/README.md')
-rw-r--r-- | wiki/vendor/splitbrain/php-archive/README.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/wiki/vendor/splitbrain/php-archive/README.md b/wiki/vendor/splitbrain/php-archive/README.md deleted file mode 100644 index f18764b..0000000 --- a/wiki/vendor/splitbrain/php-archive/README.md +++ /dev/null @@ -1,70 +0,0 @@ -PHPArchive - Pure PHP ZIP and TAR handling -========================================== - -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. - -[](https://travis-ci.org/splitbrain/php-archive) - -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](https://splitbrain.github.io/php-archive/) for more -info. - - -```php -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. |