Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PHP Extension Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PHP Extension) Async FTP Progress Info

Demonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an FTP download.

Chilkat PHP Downloads

PHP Extension for Windows, Linux, MAC OS X,
Alpine Linux, Solaris, OpenBSD, FreeBSD,
and Linux armhf/aarch64

<?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 assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$ftp = new CkFtp2();

$ftp->put_Hostname('ftp.someFtpServer.com');
$success = $ftp->ConnectOnly();
if ($success != true) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

$ftp->put_Username('myLogin');
$ftp->put_Password('myPassword');
$success = $ftp->LoginAfterConnectOnly();
if ($success != true) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

// Change to the remote directory where the file is located.
// This step is only necessary if the file is not in the root directory
// for the FTP account.
$success = $ftp->ChangeRemoteDir('someRemoteDirectory');
if ($success != true) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

$localFilename = '/temp/romeo.xml';
$remoteFilename = 'romeo.xml';

// --------------------
// Download a file
// --------------------

// Call the async version of the GetFile method to return a task object.
// The task object is loaded, but is in the Inert state -- meaning it is
// not yet scheduled to run on Chilkat's background thread pool.
// task is a CkTask
$task = $ftp->GetFileAsync($remoteFilename,$localFilename);
if ($ftp->get_LastMethodSuccess() == false) {
    print $ftp->lastErrorText() . "\n";
    exit;
}

// Before starting the task, tell it to keep an in-memory log of what would've been
// ProgressInfo callbacks.
$task->put_KeepProgressLog(true);

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
$success = $task->Run();
if ($success != true) {
    print $task->lastErrorText() . "\n";

    exit;
}

// The application is now free to do anything else
// while the file is being downloaded.

// For this example, we'll simply sleep and periodically
// check to see if the download is finished, and report the progress
// along the way.
$curPctDone = 0;

while ($task->get_Finished() != true) {

    if ($task->get_PercentDone() != $curPctDone) {
        $curPctDone = $task->get_PercentDone();
        print $curPctDone . ' percent done' . "\n";
    }

    // Check the progress info log.
    // Emit any log entries..
    while (($task->get_ProgressLogSize() > 0)) {
        // Get the 1st entry, emit it, and then remove it..
        $name = $task->progressInfoName(0);
        $value = $task->progressInfoValue(0);

        // Entries reporting the received byte count will have the name "RcvByteCount"
        // Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec"

        print $name . ': ' . $value . "\n";
        $task->RemoveProgressInfo(0);
    }

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

}

// Just in case there are any remaining entries...
while (($task->get_ProgressLogSize() > 0)) {
    // Get the 1st entry, emit it, and then remove it..
    $name = $task->progressInfoName(0);
    $value = $task->progressInfoValue(0);
    print $name . ': ' . $value . "\n";
    $task->RemoveProgressInfo(0);
}

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

// 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 the result obtained via a GetResult* method.  (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 ($task->get_StatusInt() != 7) {
    print 'Task did not complete.' . "\n";
    print 'task status: ' . $task->status() . "\n";

    exit;
}

// The GetFile method returns a boolean.  Therefore, after the task is finished,
// we can get the boolean result by calling GetResultBool.  This is the return value had
// we called GetFile synchronously.
$success = $task->GetResultBool();
if ($success != true) {
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the GetFile method been called synchronously.
    print $task->resultErrorText() . "\n";
}
else {
    print 'File downloaded asynchronously.' . "\n";
}

$success = $ftp->Disconnect();

?>

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.