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.

Installs: 1 939 445

Dependents: 27

Suggesters: 0

Stars: 439

Watchers: 25

Forks: 44

Open Issues: 5

1.1.0 2019-04-30 17:14 UTC

README

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads License

Overview

A fast and simple streaming zip file downloader for PHP. Using this library will save you from having to write the Zip to disk. You can directly send it to the user, which is much faster. It can work with S3 buckets or any PSR7 Stream.

Please see the LICENSE file for licensing and warranty information.

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

Usage and options

Here's a simple example:

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

# enable output of HTTP headers
$options = new ZipStream\Option\Archive();
$options->setSendHttpHeaders(true);

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

# 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.');
rewind($fp);
$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 Wiki for details.

Upgrade to version 1.0.0

  • All options parameters to all function have been moved from an array to structured option objects. See the wiki for examples.
  • The whole library has been refactored. The minimal PHP requirement has been raised to PHP 7.1.

Usage with Symfony and S3

You can find example code on the wiki.

Contributing

ZipStream-PHP is a collaborative project. Please take a look at the CONTRIBUTING.md file.

About the Authors