ZipStream-PHP

Unstable Branch

The main branch is not stable. Please see the releases for a stable version.

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

For detailed instructions, please check the Documentation.

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');

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

Upgrade to version 2.0.0

Only the self opened streams will be closed (#139) If you were relying on ZipStream to close streams that the library didn't open, you'll need to close them yourself now.

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 .github/CONTRIBUTING.md file.

About the Authors

Paul Duncan pabs@pablotron.org - https://pablotron.org/
Jonatan Männchen jonatan@maennchen.ch - https://maennchen.dev
Jesse G. Donat donatj@gmail.com - https://donatstudios.com
Nicolas CARPi nico-git@deltablot.email - https://www.deltablot.com
Nik Barham nik@brokencube.co.uk - https://www.brokencube.co.uk

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

README.md 5.7 KB Előzmények Nyers