wgenial/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/wgenial/s3-bucket-stream-zip-php

Homepage

Source

Issues

Installs: 292

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 16

1.0.2 2016-11-02 11:09 UTC

Requires

Requires (Dev)

MIT 9400a297cdfff50ce86202e0b4774aa242d74209

phpstreamamazons3awsdownloadzip

This package is auto-updated.

Last update: 2024-11-09 06:00:03 UTC

README

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

$stream->sendFiles('name-of-zipfile-to-send-2.zip', array(
  'files' => array(
    array(
      'key' => 'filename1.jpg',
    },
    array(
      'key' => 'filename2.jpg',
      'name' => 'image2.jpg'
    },
  )
);

Authors

Dependencies