(PHP Extension) SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

include("chilkat_9_5_0.php");

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

// Important: It is helpful to send the contents of the
// sftp.LastErrorText property when requesting support.

$sftp = new CkSFtp();

// Set some timeouts, in milliseconds:
$sftp->put_ConnectTimeoutMs(5000);
$sftp->put_IdleTimeoutMs(10000);

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
$hostname = 'www.my-sftp-server.com';
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
$success = $sftp->AuthenticatePw('myLogin','myPassword');
if ($success != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if ($success != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Open a directory on the server...
// Paths starting with a slash are "absolute", and are relative 
// to the root of the file system. Names starting with any other 
// character are relative to the user's default directory (home directory).
// A path component of ".." refers to the parent directory, 
// and "." refers to the current directory. 
$handle = $sftp->openDir('.');
if ($sftp->get_LastMethodSuccess() != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Download the directory listing:
// dirListing is a CkSFtpDir
$dirListing = $sftp->ReadDir($handle);
if ($sftp->get_LastMethodSuccess() != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Close the handle for the directory listing.
$success = $sftp->CloseHandle($handle);
if ($success != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Iterate over the files.
$i = 0;
$n = $dirListing->get_NumFilesAndDirs();
while ($i < $n) {
    // fileObj is a CkSFtpFile
    $fileObj = $dirListing->GetFileObject($i);

    print $fileObj->filename() . "\n";
    print $fileObj->fileType() . "\n";
    print 'Size in bytes: ' . $fileObj->get_Size32() . "\n";
    print '----' . "\n";

    $i = $i + 1;
}

print 'Success.' . "\n";

?>