jmathai/s3-bucket-stream-zip-php

PHP library to efficiently stream contents from an AWS S3 bucket or folder as a zip file

Maintainers

Details

github.com/jmathai/s3-bucket-stream-zip-php

Homepage

Source

Issues

Installs: 112 391

Dependents: 0

Suggesters: 0

Security: 0

Stars: 56

Watchers: 4

Forks: 16

Open Issues: 8

v2.0 2017-03-02 19:06 UTC

Requires

Requires (Dev)

MIT 9d09a932a0da5564b534c7c2fd81cbf4cb6ed7b0

phpstreamamazons3awsdownloadzip

This package is not auto-updated.

Last update: 2025-04-12 21:23:07 UTC

README

Build Status Scrutinizer Code Quality Code Coverage

Overview

This library lets you efficiently stream the contents of an S3 bucket/folder as a zip file to the client.

Installation

Installation is done via composer by adding the a dependency on jmathai/s3-bucket-stream-zip-php.

composer require jmathai/s3-bucket-stream-zip-php
composer install

Usage

// taken from examples/simple.php
// since large buckets may take lots of time we remove any time limits
set_time_limit(0);
require sprintf('%s/../vendor/autoload.php', __DIR__);

use JMathai\S3BucketStreamZip\S3BucketStreamZip;
use JMathai\S3BucketStreamZip\Exception\InvalidParameterException;

$stream = new S3BucketStreamZip(
            // $auth
            array(
              'key'     => '*********',   // required
              'secret'  => '*********'    // required
            ),
            // $params
            array(
              'Bucket'  => 'bucketname',  // required
              'Prefix'  => 'subfolder/'   // optional (path to folder to stream)
            )
          );

$stream->send('name-of-zipfile-to-send.zip');

Authors

Dependencies