maennchen/zipstream-php

ZipStream is a library for dynamically streaming dynamic zip files from PHP without writing to the disk at all on the server.

v0.5.0 2017-08-28 13:31 UTC

README

Build Status Scrutinizer Code Quality Code Coverage

Please see the file LICENSE.md for licensing and warranty information. The latest version of this software is available at the following URL: https://github.com/maennchen/ZipStream-PHP

Installation

Simply add a dependency on maennchen/zipstream-php to your project's composer.json file if you use Composer to manage the dependencies of your project. Use following command to add the package to your project's dependencies:

composer require maennchen/zipstream-php

Overview

A fast and simple streaming zip file downloader for PHP. Here's a simple example:

# Autoload the dependencies
require 'vendor/autoload.php';

# create a new zipstream object
$zip = new ZipStream\ZipStream('example.zip');

# create a file named 'hello.txt' 
$zip->addFile('hello.txt', 'This is the contents of hello.txt');

# add a file named 'some_image.jpg' from a local file 'path/to/image.jpg'
$zip->addFileFromPath('some_image.jpg', 'path/to/image.jpg');

# add a file named 'goodbye.txt' from an open stream resource
$fp = tmpfile();
fwrite($fp, 'The quick brown fox jumped over the lazy dog.');
$zip->addFileFromStream('goodbye.txt', $fp);
fclose($fp);

# finish the zip stream
$zip->finish();

You can also add comments, modify file timestamps, and customize (or disable) the HTTP headers. It is also possible to specify the storage method when adding files, the current default storage method is 'deflate' i.e files are stored with Compression mode 0x08. See the class file for details. There are a couple of additional examples in the initial release announcement at the following URL: http://pablotron.org/?cid=1535

Requirements

  • PHP version 7.0 or newer.

Further Documentation

Contributors

Please take a look at the CONTRIBUTOR-README.md File.

About the Authors