PHP

Send a Staged REST Request with a Streamed Body

Demonstrates Rest.SendReqStreamBody, which sends a request whose body is read from a Stream, then reads the response in separate steps.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Rest;
use Chilkat2\Stream;

$rest = new Rest();
$bTls = true;
$bAutoReconnect = true;
try {
    $rest->Connect('example.com', 443, $bTls, $bAutoReconnect);

    // The file paths are relative to the application's current working directory.  Absolute paths
    // may also be used.  Supply the paths appropriate to your own environment.

    // The request body is read from a Stream whose source is a local file.
    $bodyStream = new Stream();
    $bodyStream->SourceFile = 'qa_data/upload.json';

    $rest->AddHeader('Content-Type', 'application/json');

    // Send the request, reading the body from the stream.  The 3rd argument is the Stream.
    $rest->SendReqStreamBody('POST', '/api/upload', $bodyStream);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// After sending, read the response status line and header fields.  The return value is the HTTP
// status code, or -1 if no response was received.
$statusCode = $rest->ReadResponseHeader();
if ($statusCode < 0) {
    echo $rest->LastErrorText, "\n";
    exit;
}

echo 'Response status code: ', $statusCode, "\n";

// Read the response body as text.
try {
    $responseBody = $rest->ReadRespBodyString();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $responseBody, "\n";