PHP Extension

HttpPostJson2Async Example

Demonstrates use of the HttpPostJson2Async method. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

// See PostJson2 Example for the synchronous equivalent of this example.

$http = new CkHttp();

// Sends a POST equivalent to the following CURL command:

// curl -X POST https://sandbox.plaid.com/institutions/get \
//   -H 'content-type: application/json' \
//   -d '{
//     "client_id": String,
//     "secret":String,
//     "count": Number,
//     "offset": Number
//   }'

// Suppress some default headers that would automatically added..
$http->put_AcceptCharset('');
$http->put_UserAgent('');
$http->put_AcceptLanguage('');
$http->put_AllowGzip(false);

$jsonBody = '{\'client_id\': \'PLAID_CLIENT_ID\', \'secret\':\'PLAID_SECRET\', \'count\': 10, \'offset\': 0}';
// task is a CkTask
$task = $http->PostJson2Async('https://sandbox.plaid.com/institutions/get','application/json',$jsonBody);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Start the background task.
$success = $task->Run();
if (!$success) {
    print $task->lastErrorText() . "\n";

    exit;
}

// The application is now free to do anything else
// while the HTTP POST is in progress

// For this example, we'll simply sleep and periodically
// check to see if the HTTP POST is finished.  
while ($task->get_Finished() != true) {
    // Sleep 100 ms.
    $task->SleepMs(100);
}

// When we get here, the task is either finished successfully or not, or was canceled/aborted.

// If the task was "canceled", it was canceled prior to actually starting.  This could
// happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
// background thread pool scheduler.  

// If the task was "aborted", it indicates that it was canceled while running in a background thread.  
// The ResultErrorText will likely indicate that the task was aborted.

// If the task "completed", then it ran to completion, but the actual success/failure of the method
// is determined by getting the result of the underlying method call.
// A task status of 7 indicates completion.
if ($task->get_StatusInt() != 7) {
    print 'Task did not complete.' . "\n";
    print 'task status: ' . $task->status() . "\n";

    exit;
}

// When called synchronously, the PostJson2 method returns an HTTP response object,
// unless the method failed and there was no response to be had.
// Check to see if PostJson2 method failed (and thus there is no response object).
if ($task->get_TaskSuccess() == false) {
    print 'The underlying task failed, and there is no HTTP response object.' . "\n";
    print 'The LastErrorText for the underlying method call is:' . "\n";
    print $task->resultErrorText() . "\n";

    exit;
}

// To get the HTTP response object, create a new instance and load it with the result from the task.
$resp = new CkHttpResponse();
$resp->LoadTaskResult($task);

$statusCode = $resp->get_StatusCode();
print 'Response status code = ' . $statusCode . "\n";

// Examine the JSON response..
$json = new CkJsonObject();
$json->Load($resp->bodyStr());
$json->put_EmitCompact(false);
print 'JSON Response Body:' . "\n";
print $json->emit() . "\n";

?>