PHP ActiveX

Streaming Download Large File to the Local Filesystem

See more Azure Cloud Storage Examples

Downloads a large file in a streaming fashion to the local filesystem. PHP ActiveX

<?php

$success = 0;

// Azure File Service Example: Downloads a large file to the local filesystem using a Chilkat stream.
// See:  https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

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

$rest = new COM("Chilkat.Rest");

// Connect to the Azure Storage Blob Service
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
// In this example, the storage account name is "chilkat".
$success = $rest->Connect('chilkat.file.core.windows.net',$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// Provide Azure Cloud credentials for the REST calls.
$azAuth = new COM("Chilkat.AuthAzureStorage");
$azAuth->AccessKey = 'AZURE_ACCESS_KEY';
// The account name used here should match the 1st part of the domain passed in the call to Connect (above).
$azAuth->Account = 'chilkat';
$azAuth->Scheme = 'SharedKey';
$azAuth->Service = 'File';
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
$azAuth->XMsVersion = '2021-08-06';
$success = $rest->SetAuthAzureStorage($azAuth);

// Note: The application does not need to explicitly set the following
// headers: x-ms-date, Authorization.  These headers
// are automatically set by Chilkat.

// When streaming a download to the local filesystem or directed elsewhere,
// the complete HTTP GET operation must be broken into parts.
// For example, an HTTP GET consists of sending the request, followed by reading the response header,
// and then finally the response body.  We'll want to read the response header, and then based
// on the information received (such as success or failure), either read the response body
// as an error message, or as the file data.

// Send the HTTP GET request to download the file.
// The share is named "pip".
$success = $rest->SendReqNoBody('GET','/pip/somethingBig.zip');
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

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

print 'Response status code = ' . $responseStatusCode . "\n";

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

    $bodyStream = new COM("Chilkat.Stream");

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

    // 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.
    $success = $rest->ReadRespBodyStream($bodyStream,1);
    if ($success != 1) {
        print $rest->LastErrorText . "\n";
        exit;
    }

    print 'Successfully received the large file.' . "\n";

}
else {
    $errResponse = $rest->readRespBodyString();
    if ($rest->LastMethodSuccess != 1) {
        print $rest->LastErrorText . "\n";
    }
    else {
        print $errResponse . "\n";
    }

}


?>