PHP Extension

Remove a Query Parameter from a REST Request

Demonstrates Rest.RemoveQueryParam, which removes all query parameters whose name matches the supplied value. Name matching is case-sensitive.

Background. Removing individual parameters is useful when reusing a Rest object for requests that share most, but not all, of their query parameters.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

$rest = new CkRest();

//  Connect to the REST server.  The 3rd argument enables TLS (use true for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
$bTls = true;
$bAutoReconnect = true;
$success = $rest->Connect('example.com',443,$bTls,$bAutoReconnect);
if ($success == false) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$rest->AddQueryParam('q','chilkat');
$rest->AddQueryParam('limit','10');

//  Remove a query parameter by name.  Name matching is case-sensitive.
$rest->RemoveQueryParam('limit');

$responseText = $rest->fullRequestNoBody('GET','/api/search');
if ($rest->get_LastMethodSuccess() == false) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print $responseText . "\n";

?>