(PHP ActiveX) SFTP SyncTreeDownload - Find out what files were downloaded

See more SFTP Examples

Demonstrates how to find out which files were downloaded in a SyncTreeDownload method call.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.SFtp')
$sftp = new COM("Chilkat.SFtp");

$success = $sftp->Connect('my-ssh-server.com',22);
if ($success == 1) {
    $success = $sftp->AuthenticatePw('mySshLogin','mySshPassword');
}

if ($success == 1) {
    $success = $sftp->InitializeSftp();
}

if ($success != 1) {
    print $sftp->LastErrorText . "\n";
    exit;
}

// Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
// with the local directory tree rooted at "qa_output"
// Both directories are relative paths.  The remote directory
// is relative to the HOME directory of the SSH user account.
// The local directory is relative to the current working directory of the process.
// It is also possible to use absolute paths.

$remoteDir = 'syncDownloadTest';
$localDir = 'qa_output';

// Possible modes that can be passed to the SyncTreeDownload method are:
// mode=0: Download all files
// mode=1: Download all files that do not exist on the local filesystem.
// mode=2: Download newer or non-existant files.
// mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
// mode=5: Download only missing files or files with size differences.
// mode=6: Same as mode 5, but also download newer files.
// mode=99: Do not download files, but instead delete remote files that do not exist locally.

// This example will use mode 6 to download missing, newer, or files with size differences.
$mode = 6;
// This example will turn on recursion to synchronize the entire tree. 
// Recursion can be turned off to synchronize the files of a single directory.
$recursive = 1;
$success = $sftp->SyncTreeDownload($remoteDir,$localDir,$mode,$recursive);
if ($success != 1) {
    print $sftp->LastErrorText . "\n";
    exit;
}

// Examine the list of downloaded files.
// The downloaded files are listed one per line in the SyncedFiles property.
// Local directories that were created will be listed with a trailing "/" char.
$fileList = $sftp->SyncedFiles;
print $fileList . "\n";
print '' . "\n";

// For example:

// data/
// chiliPepper.gif
// helloWorld.pdf
// alice.key
// anter_cert.pem
// text/
// accentedLatin1.txt
// accentedUtf8.txt
// abc/
// abc/chiliPepper.gif
// abc/ghk/
// text/something/
// text/PolishEmailBody.txt
// text/frenchUtf8.txt
// text/helloWorld.txt
// data/chiliPepper.gif
// data/xyz/
// data/xyz/dkimHtmlBody.txt
// data/xyz/emailForCreateDsn.eml
// data/xyz/dkimVerifyTest.eml

// You could load the strings into a Chilkat string table..
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sb = new COM("Chilkat.StringBuilder");
$sb->Append($fileList);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringTable')
$st = new COM("Chilkat.StringTable");
$st->AppendFromSb($sb);

// Find out how many files + dirs
print 'Total count = ' . $st->Count . "\n";

$i = 0;
while ($i < $st->Count) {
    print $st->stringAt($i) . "\n";
    $i = $i + 1;
}

print 'Success.' . "\n";

?>