PHP Extension

REST Asynchronous Streaming Upload File

See more REST Examples

Demonstrates how to asynchronous streaming upload a file to cloud storage. This particular example demonstrates an upload to the Azure Cloud Storage service. The same concepts apply to S3, Google Cloud, and Google Drive. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$rest = new CkRest();

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

// Provide Azure Cloud credentials for the REST call.
$azAuth = new CkAuthAzureStorage();
$azAuth->put_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->put_Account('chilkat');
$azAuth->put_Scheme('SharedKey');
$azAuth->put_Service('Blob');
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
$azAuth->put_XMsVersion('2021-08-06');
$success = $rest->SetAuthAzureStorage($azAuth);

// Set some request headers.
$success = $rest->AddHeader('x-ms-blob-content-disposition','attachment; filename=\'thisIsATest.txt\'');
$success = $rest->AddHeader('x-ms-blob-type','BlockBlob');
$success = $rest->AddHeader('x-ms-meta-m1','v1');
$success = $rest->AddHeader('x-ms-meta-m2','v2');

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

$sendStream = new CkStream();

// Define the source data for the stream to be a file.
$sendStream->put_SourceFile('qa_data/hamlet.xml');

// Create a background thread task to upload from the stream
// The name of the Azure storage container is "test".
// task is a CkTask
$task = $rest->FullRequestStreamAsync('PUT','/test/thisIsATest.txt',$sendStream);

// Start the task. 
$success = $task->Run();

// In this example, we'll simply sleep and periodically
// check to see if the REST upload if finished.
$curPctDone = 0;
while ($task->get_Finished() != true) {
    $task->SleepMs(100);
}

// Check to see if the call to FullRequestStream in the background thread pool succeeded.
if ($task->get_TaskSuccess() != true) {
    // Show what would've been the LastErrorText had FullRequestStream been called synchronously
    print $task->resultErrorText() . "\n";

    exit;
}

$responseStatusCode = $rest->get_ResponseStatusCode();

// When successful, the Azure Storage service will respond with a 201 response code,
// with an empty body.  Therefore, in the success condition, the responseStr is empty.
if ($responseStatusCode == 201) {
    print 'File uploaded.' . "\n";
}
else {
    // It failed, so examine the response body, if one was returned:
    // Given that FullRequestStream returns a string, the return value is obtained via GetResultString.
    $responseBodyStr = $task->getResultString();
    print 'response body (if any): ' . $responseBodyStr . "\n";

    // Examine the request/response to see what happened.
    print 'response status code = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'response status text = ' . $rest->responseStatusText() . "\n";
    print 'response header: ' . $rest->responseHeader() . "\n";
    print '---' . "\n";
    print 'LastRequestStartLine: ' . $rest->lastRequestStartLine() . "\n";
    print 'LastRequestHeader: ' . $rest->lastRequestHeader() . "\n";
}


?>