(PHP Extension) PostXml vs. PostUrlEncoded

This example shows the differences in the HTTP requests sent by PostXml vs. PostUrlEncoded. With PostXml, the body of the request is the XML document itself. With PostUrlEncoded, the body of the request is composed of URL encoded params, as shown in the example below.

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();

$strXml = '<pets><lizard>Pip</lizard><dog>Fido</dog></pets>';

//  We can log the exact HTTP requests/responses to a session log file.
$http->put_SessionLogFilename('qa_output/sessionLog.txt');

//  Send a POST w/ content-type of "application/xml"
$http->SetRequestHeader('Content-Type','application/xml');

//  Note: This example is only interested in examining (via the session log)
//  the HTTP requests that are sent.  We're just sending the post to chilkatsoft.com
//  even though it's not an endpoint designed to handle the POST. We don't care about
//  the response, even if it's an error response status code..
// resp is a CkHttpResponse
$resp = $http->PostXml('https://www.chilkatsoft.com/',$strXml,'utf-8');
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

//  This is the HTTP request that is sent.
//  You'll notice the body of the request is the XML document itself.

//  	POST / HTTP/1.1
//  	Content-Type: application/xml
//  	Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
//  	Connection: keep-alive
//  	User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0
//  	Accept-Language: en-us,en;q=0.5
//  	Accept-Encoding: gzip
//  	Host: www.chilkatsoft.com
//  	Content-Length: 48
// 
//  	<pets><lizard>Pip</lizard><dog>Fido</dog></pets>

//  --------
//  Now let's do a PostUrlEncoded...
//  The XML is passed in a query param that is contained in the body of the POST.
$req = new CkHttpRequest();
$req->AddParam('theXml',$strXml);
// resp is a CkHttpResponse
$resp = $http->PostUrlEncoded('https://www.chilkatsoft.com/',$req);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

//  This is the HTTP request that is sent.
//  You'll notice the body of the request is composed of URL encoded query params.

//  	POST / HTTP/1.1
//  	Content-Type: application/x-www-form-urlencoded
//  	Host: www.chilkatsoft.com
//  	Content-Length: 85
// 
//  	theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E
// 

//  --------
//  Let's try one more thing...
//  If the query params are not too large, they can be passed in the URL (which means the query params are passed
//  in the HTTP start line.  This is what happens when a URL w/ query params are pasted in a browser.
//  The HTTP verb is "GET" instead of "POST".

$sbUrl = new CkStringBuilder();
$sbUrl->Append('https://www.chilkatsoft.com/?');
$sbUrl->Append($req->getUrlEncodedParams());
print 'URL with query params: ' . $sbUrl->getAsString() . "\n";
$strResponse = $http->quickGetStr($sbUrl->getAsString());

//  The URL with query params is:  https://www.chilkatsoft.com/?theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E

//  The HTTP request looks like this.  You can see there is no request body, and the query params
//  are in the path part of the start line.

//  	GET /?theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E HTTP/1.1
//  	Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
//  	Connection: keep-alive
//  	User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0
//  	Accept-Language: en-us,en;q=0.5
//  	Accept-Encoding: gzip
//  	Host: www.chilkatsoft.com

?>