phpzip/phpzip

Package to create and stream archives of compressed files in ZIP format with PHP 5.3+

PHP Zip

A pair of PHP classes to generate zip files., _(*1)

The projects that started these two classes are hosted on PHPClasses.org at the addresses: Zip : http://www.phpclasses.org/package/6110 ZipStream: http://www.phpclasses.org/package/6616, _(*2)

WARNING: THE CURRENT VERSION OF PHPZip MAY FAIL IF THE SERVER HAS mbstring.func_overload INSTALLED AND ACTIVE! OLDER VERSIONS OF PHPZip WILL FAIL IF THE SERVER HAS mbstring.func_overload INSTALLED AND ACTIVE! EXPERIMENTAL FEATURES HAVE BEEN ADDED TO ALLEVIATE THE LOBOTOMIZATION OF PHP, CAUSED BY mbstring.func_overload, _(*3)

Note: PHPZip currently uses the 32-bit deflate, and is limited by that. The largest files that can be added are 4GB, and the total size of the archive can't exceed 4GB either., _(*4)

Zip.php generates the Zip file in memory (or temp file) allowing the parent script to save the final Zip file elsewhere, and/or send it to the user. ZipStream has much of the same features and functions of Zip.php, with a few notable differences, it does not cache and build the zip file on the server, instead it'll send the file to the user as a stream., _(*5)

See the examples for example usage. The php files have "some" documentation in them in the form of Javadoc style function headers., _(*6)

NOTE: Please ensure that output buffering is disabled when using especially ZipStream. It defeats the purpose of the class, and large zip files may cause a memory exceeded exception. NOTE2: THe Zip and ZipStream classes support UTF-8 in file paths and file comments, and will autodetect UTF-8 strings to that end, however it is up to the user to ensure that other Multibyte chracter sets aren't sent to the class., _(*7)

Installation

Import

Add this requirement to your composer.json file:, _(*8)

    "phpzip/phpzip": ">=2.0.7"

Composer

If you already have Composer installed, skip this part., _(*9)

Packagist, the main composer repository has a neat and very short guide., _(*10)

Or you can look at the guide at the Composer site., _(*11)

The easiest for first time users, is to have the composer installed in the same directory as your composer.json file, though there are better options., _(*12)

Run this from the command line:, _(*13)

php -r "readfile('https://getcomposer.org/installer');" | php

This will check your PHP installation, and download the composer.phar, which is the composer binary. This file is not needed on the server though., _(*14)

Once composer is installed you can create the composer.json file to import this package., _(*15)

{
    "require": {
        "phpzip/phpzip": ">=2.0.7",
        "php": ">=5.3.0"
    }
}

Followed by telling Composer to install the dependencies., _(*16)

php composer.phar install

this will download and place all dependencies defined in your composer.json file in the vendor directory., _(*17)

Finally, you include the autoload.php file in the new vendor directory., _(*18)

<?php
    require 'vendor/autoload.php';
    .
    .
    .

TODO:

• Documentation, no one reads it, but everyone complains if it is missing.
• Better examples to fully cover the capabilities of the Zip classes.
• more TODO's.