PHP

REST Stream Response to File (Streaming Download) (Amazon S3)

See more Amazon S3 (new) Examples

Demonstrates how to stream the response body directly to a file. (The example shows how to stream a JPG from the Amazon S3 service.) Chilkat2 PHP

<?php

use Chilkat2\AuthAws;
use Chilkat2\Rest;
use Chilkat2\Stream;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new Rest();

// Connect to the Amazon AWS REST server.
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$rest->Connect('s3.amazonaws.com', $port, $bTls, $bAutoReconnect);

// ----------------------------------------------------------------------------
// Important: For buckets created in regions outside us-east-1,
// there are three important changes that need to be made.
// See Working with S3 Buckets in Non-us-east-1 Regions for the details.
// ----------------------------------------------------------------------------

// Provide AWS credentials for the REST call.
$authAws = new AuthAws();
$authAws->AccessKey = 'AWS_ACCESS_KEY';
$authAws->SecretKey = 'AWS_SECRET_KEY';
$authAws->ServiceName = 's3';
$rest->SetAuthAws($authAws);

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat100".
$rest->Host = 'chilkat100.s3.amazonaws.com';

// Send the request to download the JPG.
try {
    $rest->SendReqNoBody('GET', '/starfish.jpg');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read the response header.
$responseStatusCode = $rest->ReadResponseHeader();
if ($responseStatusCode < 0) {
    echo $rest->LastErrorText, "\n";
    exit;
}

echo 'Response status code = ', $responseStatusCode, "\n";

// We expect a 200 response status if the JPG data is coming.
// Otherwise, we'll get a string response body with an error message(or no response body).
if ($responseStatusCode == 200) {
    $bodyStream = new Stream();

    // The stream's sink will be a file.
    $bodyStream->SinkFile = 'qa_output/starfish.jpg';

    // Read the response body to the stream.  Given that we've
    // set the stream's sink to a file, it will stream directly
    // to the file.
    try {
        $rest->ReadRespBodyStream($bodyStream, true);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo "Successfully received the JPG file.\n";
} else {
    try {
        $errResponse = $rest->ReadRespBodyString();
        echo $errResponse, "\n";
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
    }
}