1
0
mirror of https://github.com/splitbrain/php-archive.git synced 2025-01-29 03:27:57 +01:00
Andreas Gohr c08ee5ac36 Add script and travis setup to automatically create docs
Squashed commit of the following:

commit aa7366d65b8b24542c08651d1f8b8bb3ce6f5001
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 21:06:13 2015 +0200

    removed apigen.phar, setup .gitignore

commit 12a3da7477614ecc1d55318fe4551fbe1b92a0bc
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 21:03:45 2015 +0200

    added some info within the generate-api script

commit 47215ea47472db6e15a07795861c83962339cf77
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:56:11 2015 +0200

    added API docs to readme

commit d67bda30107c0280c9f562e5e2156a0b0b6c2b6b
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:53:19 2015 +0200

    abort when DST does not exist

commit 2e769082a64040b1dc3583218ca96be6e8c481de
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:52:25 2015 +0200

    Revert "try to set autocomplete values"

    This reverts commit 914d42546a1390250f858b08c172df4cc0d783df.

commit 914d42546a1390250f858b08c172df4cc0d783df
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:50:21 2015 +0200

    try to set autocomplete values

commit e53cd155119ffb6be273f31233bd7ff3ad9f67cc
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:44:32 2015 +0200

    added apigen config

commit c32fa34db6cc67eeff4f6f0504759214876dfbdf
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:34:47 2015 +0200

    fixed trigger branch

commit 5bb8f757197cca9169a0264ce1e8f85aa4f6a74a
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:31:04 2015 +0200

    another go

commit 9e806b62360f315e24ae5586c1a9cbd94644acfa
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:26:53 2015 +0200

    adjusted logic for travis compile

commit 1b4e03ebd792d10ba67914404f357c1678d5a950
Author: Andreas Gohr <andi@splitbrain.org>
Date:   Wed Aug 5 20:22:45 2015 +0200

    first go at automatic apidoc building
2015-08-05 21:07:59 +02:00
2015-07-24 13:36:49 +02:00
2015-02-20 15:47:52 +01:00
2015-02-20 15:38:09 +01:00
2015-02-20 10:50:44 +01:00

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

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->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() function call.

The FileInfo class can be used to specify additional info like ownership or permissions when adding a file to an archive.

Description
No description provided
Readme MIT 1.9 MiB
Languages
PHP 98.6%
Shell 1.4%