Skip to content

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

License

Notifications You must be signed in to change notification settings

plexus77/s3-bucket-stream-zip-php

 
 

Repository files navigation

S3BucketStreamZip

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

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

Usage

// taken from examples/simple.php

require 'vendor/autoload.php';

use JMathai\S3BucketStreamZip\S3BucketStreamZip;

$stream = new S3BucketStreamZip([
    'key'    => 'your-key-goes-here',
    'secret' => 'your-secret-goes-here',
    'bucket' => 'the-name-of-your-bucket',
    'region' => 'the-region-of-your-bucket',
    'prefix' => 'prefix-of-the-files-to-zip',
  ]);

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

Authors

Dependencies

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%