From 605f8e8d0e501057749c50581087ce05089c1af3 Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Fri, 15 May 2015 15:17:39 +0200 Subject: added composer setup and the first composer package php-archive --- vendor/splitbrain/php-archive/README.md | 61 +++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 vendor/splitbrain/php-archive/README.md (limited to 'vendor/splitbrain/php-archive/README.md') diff --git a/vendor/splitbrain/php-archive/README.md b/vendor/splitbrain/php-archive/README.md new file mode 100644 index 000000000..4fb673259 --- /dev/null +++ b/vendor/splitbrain/php-archive/README.md @@ -0,0 +1,61 @@ +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. + +[![Build Status](https://travis-ci.org/splitbrain/php-archive.svg)](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 source code comments for more info + +```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 getData() it: +$tar = new Tar(); +$tar->create(); +$tar->addFile(...); +$tar->addData(...); +... +$tar->save('myfile.tgz'); // compresses and saves it +echo $tar->getArchive(Archive::COMPRESS_GZIP); // 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()``` functions. + +The FileInfo class can be used to specify additional info like ownership or permissions when adding a file to +an archive. \ No newline at end of file -- cgit v1.2.3 From 2b6c681901bfed9efc7d09dca27aee308d48341d Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Tue, 30 Jun 2015 21:17:23 +0200 Subject: updated archive library via composer --- vendor/splitbrain/php-archive/README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) (limited to 'vendor/splitbrain/php-archive/README.md') diff --git a/vendor/splitbrain/php-archive/README.md b/vendor/splitbrain/php-archive/README.md index 4fb673259..6c5780a7a 100644 --- a/vendor/splitbrain/php-archive/README.md +++ b/vendor/splitbrain/php-archive/README.md @@ -18,24 +18,29 @@ Use composer: 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 source code comments for more info +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 source code +comments 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: +// 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: +// 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, +// To create a new TAR archive directly on the filesystem (low memory +// requirements), create() it: $tar = new Tar(); $tar->create('myfile.tgz'); $tar->addFile(...); @@ -43,8 +48,8 @@ $tar->addData(...); ... $tar->close(); -// To create a TAR archive directly in memory, create() it, add*() files and then either save() -// or getData() it: +// To create a TAR archive directly in memory, create() it, add*() +// files and then either save() or getArchive() it: $tar = new Tar(); $tar->create(); $tar->addFile(...); @@ -54,8 +59,8 @@ $tar->save('myfile.tgz'); // compresses and saves it echo $tar->getArchive(Archive::COMPRESS_GZIP); // 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()``` functions. +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. \ No newline at end of file -- cgit v1.2.3