PHP Extension

Async Task Chain (another example)

See more Async Examples

Demonstrates using a task chain to run a sequence of FTP tasks asynchronously. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$success = false;

$ftp = new CkFtp2();

$ftp->put_Hostname('ftp.example.com');
$ftp->put_Username('login');
$ftp->put_Password('password');

// Connect and login to the FTP server.
$success = $ftp->Connect();
if ($success != true) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

$taskChain = new CkTaskChain();

// Create a task to change to the remote directory where the file will be uploaded.
// task is a CkTask
$task = $ftp->ChangeRemoteDirAsync('junk');
if ($ftp->get_LastMethodSuccess() == false) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

// Add this task to the task chain.
$success = $taskChain->Append($task);

// Create a task to upload a file.
$localFilename = 'c:/temp/hamlet.xml';
$remoteFilename = 'hamlet.xml';

// task is a CkTask
$task = $ftp->PutFileAsync($localFilename,$remoteFilename);
if ($ftp->get_LastMethodSuccess() == false) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

// Add this task to the task chain.
$success = $taskChain->Append($task);

// Start the task chain running in a background thread.
// Each task is run one after the other (on the same background thread) until all tasks have completed.
// The task chain will stop at the first task that fails.
$taskChain->put_StopOnFailedTask(true);
$success = $taskChain->Run();
if (!$success) {
    print $taskChain->lastErrorText() . "\n";
    exit;
}

// The application is now free to do anything else
// while the FTP commands are being run...

// For this example, we'll simply sleep and periodically
// check to see if the taskchain if finished. 
while ($taskChain->get_Finished() != true) {

    // Sleep 100 ms.
    $taskChain->SleepMs(100);

}

// A finished task chain could be one that was canceled, aborted, or truly finished.  

// If the task chain "completed", then it ran to completion.  A "completed" task will
// have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
// been aborted or canceled:
if ($taskChain->get_StatusInt() != 7) {
    print 'Task did not complete.' . "\n";
    print 'task chain status: ' . $taskChain->status() . "\n";
    exit;
}

// If we got to this point, the ChangeRemoteDir and PutFile were successful.
// We can visually verify by examining the LastErrorText that was recorded for each
// of these method calls..
$numTasks = $taskChain->get_NumTasks();
$taskIdx = 0;

while (($taskIdx < $numTasks)) {

    // task is a CkTask
    $task = $taskChain->GetTask($taskIdx);

    // Examine the status of this task, and the ResultErrorText
    // (the ResultErrorText is the ftp.LastErrorText captured for FTP method called by the task).
    // Everything should indicate success.
    print 'task status: ' . $task->status() . "\n";
    print 'task log: ' . $task->resultErrorText() . "\n";

    $taskIdx = $taskIdx + 1;
}

$success = $ftp->Disconnect();

?>