(PHP Extension) Parse Multipart Binary Http Response

This example demonstrates how to parse an HTTP response that is multipart and contains a binary file, such as a .zip or .pdf.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$req = new CkHttpRequest();

// ...
// Insert code here to construct some kind of HTTP request.
// this example is to show how to parse a particular kind of response.
// ...
// ...

// Send the request (whatever it may be in your case) to get the HTTP response object.
// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('www.somedomain.com',443,true,$req);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Get the response body (which is expected to be binary)
$respBody = new CkBinData();
$resp->GetBodyBd($respBody);

// For this example, the response body contains something like this:

// ------=_Part_21302_2029949381.1547401515443
// Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
// Content-Transfer-Encoding: 8bit
// Content-ID: <rootpart@ws.jboss.org>
// 
// <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'><env:Header></env:Header><env:Body>...</env:Body></env:Envelope>
// ------=_Part_21302_2029949381.1547401515443
// Content-Type: application/octet-stream
// Content-Transfer-Encoding: binary
// Content-Id: <fileArchivio-7d302908-4d64-43d3-bf4e-79ce806d43b3@ws.jboss.org>
// 
// BINARY_CONTENT_HERE...
// 
// ------=_Part_21302_2029949381.1547401515443--
// 

// Load it into a Chilkat MIME object.
$mime = new CkMime();
$success = $mime->LoadMimeBd($respBody);
if ($success != true) {
    print $mime->lastErrorText() . "\n";
    exit;
}

$numParts = $mime->get_NumParts();
if ($numParts < 2) {
    print 'Expected multipart MIME with at least 2 sub-parts.' . "\n";
    exit;
}

// Get the 1st sub-part, which is the XML.
// part0 is a CkMime
$part0 = $mime->GetPart(0);
// Should be OK because we checked NumParts above..
$xmlStr = $part0->getBodyDecoded();
print $xmlStr . "\n";
print '----' . "\n";

// Save the 2nd part to a file.  (It is a .zip file in our test case..)
// part1 is a CkMime
$part1 = $mime->GetPart(1);
$success = $part1->SaveBody('qa_output/attachedZip.zip');

// Alternatively, we could extract the binary data to a BinData and use elsewhere..
$zipData = new CkBinData();
$success = $part1->GetBodyBd($zipData);
$success = $zipData->WriteFile('qa_output/attachedZip_again.zip');

print 'OK.' . "\n";

?>