PHP

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. Chilkat2 PHP

<?php

use Chilkat2\DateTime;
use Chilkat2\DtObj;
use Chilkat2\JsonObject;
use Chilkat2\Rest;
use Chilkat2\Socket;
use Chilkat2\Stream;

// 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 Socket();
$maxWaitMs = 5000;
try {
    $socket->Connect('content.dropboxapi.com', 443, true, $maxWaitMs);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    echo 'Connect Fail Reason: ', $socket->ConnectFailReason, "\n";
    exit;
}

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

$rest = new Rest();

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

// 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 JsonObject();
$json->AppendString('path', '/Homework/lit/hamlet.xml');
$json->AppendString('mode', 'add');
$json->AppendBool('autorename', true);
$json->AppendBool('mute', false);
$rest->AddHeader('Dropbox-API-Arg', $json->Emit());

// Almost ready to go...
// Let's setup a file stream to point to a file.
$fileStream = new 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.)
try {
    $responseStr = $rest->FullRequestStream('POST', '/2/files/upload', $fileStream);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

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

// The response is JSON.
$jsonResp = new JsonObject();
$jsonResp->EmitCompact = false;
$jsonResp->Load($responseStr);

// Show the JSON response.
echo $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');
echo 'size = ', $size, "\n";

$rev = $jsonResp->StringOf('rev');
echo 'rev = ', $rev, "\n";

$clientModified = $jsonResp->StringOf('client_modified');
$ckdt = new DateTime();
$ckdt->SetFromTimestamp($clientModified);
$bLocalTime = true;
$dt = new DtObj();
$ckdt->ToDtObj($bLocalTime, $dt);

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