PHP Extension

Send a Staged Form-URL-Encoded REST Request

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

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 Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

$rest = new CkRest();
$bTls = true;
$bAutoReconnect = true;
$success = $rest->Connect('example.com',443,$bTls,$bAutoReconnect);
if ($success == false) {
    print $rest->lastErrorText() . "\n";
    exit;
}

//  The form body is built from the query parameters added to the object.
$rest->AddQueryParam('username','alice');
$rest->AddQueryParam('action','login');

//  Send the application/x-www-form-urlencoded request.
$success = $rest->SendReqFormUrlEncoded('POST','/api/login');
if ($success == false) {
    print $rest->lastErrorText() . "\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) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print 'Response status code: ' . $statusCode . "\n";

//  Read the response body as text.
$responseBody = $rest->readRespBodyString();
if ($rest->get_LastMethodSuccess() == false) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print $responseBody . "\n";

?>