devtoolboxuk/aws

PHP Library to access the AWS SDK

1.0.7 2019-11-01 12:04 UTC

Requires

• aws/aws-sdk-php: 2.*

Requires (Dev)

• phpunit/phpunit: *

MIT

README

Version: 1.0.0

Table of Contents

• Summary
• Install
  • Compile
• Usage
  • [Call AWS Service](#Call AWS Service)
  • S3
  • [Call S3](#Call S3)
  • [Set S3 Bucket](#Set S3 Bucket)
  • [S3 List Objects](#S3 List Objects)
  • [S3 Stream Objects](#S3 Stream Objects)
• Maintainers

Summary

PHP Library to connect to the AWS Services

Install

Install Composer:

$ php -r "readfile('https://getcomposer.org/installer');" | php

Install dependencies:

$ php composer.phar install

Add to PHP

require 'vendor/autoload.php';

AWS Credentials

The code here will not allow for the credentials to be added to the code. We'll use the environment variables, or if in AWS, use IAMS The AWS SDK will use this by default, you dont need to configure it

Bash

$ export AWS_ACCESS_KEY_ID=
$ export AWS_SECRET_ACCESS_KEY=
$ export AWS_DEFAULT_REGION=

PowerShell

PS C:\> $Env:AWS_ACCESS_KEY_ID=""
PS C:\> $Env:AWS_SECRET_ACCESS_KEY=""
PS C:\> $Env:AWS_DEFAULT_REGION=""

Call AWS Service

$this->aws = new aws();

S3

Call S3

$this->s3 = $this->aws->s3();

Set S3 Bucket

$this->s3->setBucket('test-bucket');

S3 Commands

List Objects

S3 List Objects in a "folder"

$list = $this->s3->listObjects('folder');
foreach ($list as $object) {
    print_r($object['Key']);
}

Get object

Get object ($s3filename) from S3 and save it locally $localFilename

$this->s3->getObject($localFilename, $s3filename)

S3 Streaming

Opening a streaming wrapper

You can

$awsS3 = $this->aws->s3();
$awsS3->setBucket('test-bucket');
$streamWrapper = $awsS3->getStreamWrapper()

####= Download an object via a stream

$awsS3 = $this->aws->s3();
$awsS3->setBucket('test-bucket');

$objectName = 'folder/folder/file.xml';
$chunkCount =  $awsS3->countDownloadStreamChunks($objectName);

echo sprintf(
    "\nUsing a stream, there were %d chunks\n",
    $chunkCount
);

// Opens the file for Streaming
$awsS3->openDownloadStream($objectName);

//outputs the streamed data
for($i=0;$i<$chunkCount;$i++) {
    echo $awsS3->getDownloadStream($i);
}

// Closes the streamed file
$awsS3->closeDownloadStream();

Upload an object via a stream

Coming soon

Thanks

@halfer for adding in the stream wrapper

Maintainers

@devtoolboxuk.