PHP Requires Chilkat v11.0.0+

SFTP Read Directory Listing

See more SFTP Examples

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

<?php

use Chilkat2\SFtp;
use Chilkat2\SFtpDir;
use Chilkat2\SFtpFile;

// 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 SFtp();

// Set some timeouts, in milliseconds:
$sftp->ConnectTimeoutMs = 5000;
$sftp->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;
try {
    $sftp->Connect($hostname, $port);

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    $sftp->AuthenticatePw('myLogin', 'myPassword');

    // After authenticating, the SFTP subsystem must be initialized:
    $sftp->InitializeSftp();

    // 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('.');

    // Download the directory listing:

    $dirListing = new SFtpDir();
    $sftp->ReadDirListing($handle, $dirListing);

    // Close the handle for the directory listing.
    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Iterate over the files.
$fileObj = new SFtpFile();
$i = 0;
$n = $dirListing->NumFilesAndDirs;
while ($i < $n) {
    try {
        $dirListing->FileAt($i, $fileObj);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo $fileObj->Filename, "\n";
    echo $fileObj->FileType, "\n";
    echo 'Size in bytes: ', $fileObj->Size32, "\n";
    echo "----\n";

    $i = $i + 1;
}

echo "Success.\n";