PHP ActiveX

REST Upload Bandwidth Throttle

See more REST Examples

Demonstrates how to use upload bandwidth throttling with the REST API. This example will upload a file to Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer. PHP ActiveX

<?php

$success = 0;

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

// A Dropbox access token should have been previously obtained.
// Dropbox access tokens do not expire.
// See Dropbox Access Token.

// To use bandwidth throttling, the connection should be made using the socket API.
// This provides numerous properties to customize the connection, such as
// BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
// KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
// SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

$socket = new COM("Chilkat.Socket");
$maxWaitMs = 5000;
$success = $socket->Connect('content.dropboxapi.com',443,1,$maxWaitMs);
if ($success != 1) {
    print $socket->LastErrorText . "\n";
    print 'Connect Fail Reason: ' . $socket->ConnectFailReason . "\n";
    exit;
}

// Set the upload bandwidth throttle rate to 50000 bytes per second.
$socket->BandwidthThrottleUp = 50000;

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

// Tell the REST object to use the connected socket.
$rest->UseConnection($socket,1);

// The remainder of this example is identical to the example at:
// Dropbox File Stream Upload.

// Add request headers.
$rest->AddHeader('Content-Type','application/octet-stream');
$rest->AddHeader('Authorization','Bearer DROPBOX_ACCESS_TOKEN');

// The upload "parameters" contained in JSON passed in an HTTP request header.
// This is the JSON to be added in this example:
// { 
//    "path": "/Homework/lit/hamlet.xml",
//    "mode": "add",
//    "autorename": true,
//    "mute": false
// }

$json = new COM("Chilkat.JsonObject");
$json->AppendString('path','/Homework/lit/hamlet.xml');
$json->AppendString('mode','add');
$json->AppendBool('autorename',1);
$json->AppendBool('mute',0);
$rest->AddHeader('Dropbox-API-Arg',$json->emit());

// Almost ready to go...
// Let's setup a file stream to point to a file.
$fileStream = new COM("Chilkat.Stream");
$fileStream->SourceFile = 'qa_data/xml/hamlet.xml';

// Do the upload.  The URL is https://content.dropboxapi.com/2/files/upload.
// We already connected to content.dropboxapi.com using TLS (i.e. HTTPS),
// so now we only need to specify the path "/2/files/upload".

// Note: The file is streamed directly from disk.  (The entire
// file will not be loaded into memory.)
$responseStr = $rest->fullRequestStream('POST','/2/files/upload',$fileStream);
if ($rest->LastMethodSuccess == 0) {
    print $rest->LastErrorText . "\n";
    exit;
}

// When successful, Dropbox responds with a 200 response code.
if ($rest->ResponseStatusCode != 200) {
    // Examine the request/response to see what happened.
    print 'response status code = ' . $rest->ResponseStatusCode . "\n";
    print 'response status text = ' . $rest->ResponseStatusText . "\n";
    print 'response header: ' . $rest->ResponseHeader . "\n";
    print 'response body (if any): ' . $responseStr . "\n";
    print '---' . "\n";
    print 'LastRequestStartLine: ' . $rest->LastRequestStartLine . "\n";
    print 'LastRequestHeader: ' . $rest->LastRequestHeader . "\n";
    exit;
}

// The response is JSON.
$jsonResp = new COM("Chilkat.JsonObject");
$jsonResp->EmitCompact = 0;
$jsonResp->Load($responseStr);

// Show the JSON response.
print $jsonResp->emit() . "\n";

// Returns JSON that looks like this:
// { 
//   "name": "hamlet.xml",
//   "path_lower": "/homework/lit/hamlet.xml",
//   "path_display": "/Homework/lit/hamlet.xml",
//   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
//   "client_modified": "2016-06-02T23:19:00Z",
//   "server_modified": "2016-06-02T23:19:00Z",
//   "rev": "9482db15f",
//   "size": 279658
// }

// Sample code to get data from the JSON response:
$size = $jsonResp->IntOf('size');
print 'size = ' . $size . "\n";

$rev = $jsonResp->stringOf('rev');
print 'rev = ' . $rev . "\n";

$clientModified = $jsonResp->stringOf('client_modified');
$ckdt = new COM("Chilkat.CkDateTime");
$ckdt->SetFromTimestamp($clientModified);
$bLocalTime = 1;
$dt = new COM("Chilkat.DtObj");
$ckdt->ToDtObj($bLocalTime,$dt);

print $dt->Day . '/' . $dt->Month . '/' . $dt->Year . ' ' . $dt->Hour . ':' . $dt->Minute . "\n";

?>