PHP

Detect End-of-File on a Remote SFTP File

Demonstrates the Chilkat SFtp.Eof method, which returns whether the most recent read for a handle received the SFTP end-of-file status. The only argument is the handle. This example reads until Eof is true.

Background: The timing here is worth understanding: reading exactly through the final byte does not immediately set EOF. The next read succeeds, returns zero bytes, sets the status to SSH_FX_EOF, and only then does Eof report true. That is why the loop tests Eof after each read rather than assuming a short read means the end — a short read can also just be the server returning less than requested.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\SFtp;
use Chilkat2\StringBuilder;

// Demonstrates the SFtp.Eof method, which returns whether the most recent read for a handle
// received the SFTP end-of-file status.  The only argument is the handle.

$sftp = new SFtp();

// Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
try {
    $sftp->Connect('sftp.example.com', $port);

    // Normally you would not hard-code the password in source.  You should instead obtain it
    // from an interactive prompt, environment variable, or a secrets vault.
    $password = 'mySshPassword';

    $sftp->AuthenticatePw('mySshLogin', $password);

    $sftp->InitializeSftp();

    $handle = $sftp->OpenFile('subdir/data.txt', 'readOnly', 'openExisting');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read until Eof reports the end of the file.  Note that reading exactly through the final byte
// does not set EOF; the next read returns zero bytes and then Eof becomes true.
$sbContent = new StringBuilder();
$chunkSize = 4096;
$reading = true;
while ($reading) {
    $chunk = $sftp->ReadFileText($handle, $chunkSize, 'utf-8');
    if ($sftp->LastReadFailed($handle)) {
        echo $sftp->LastErrorText, "\n";
        exit;
    }

    $sbContent->Append($chunk);
    $reading = !$sftp->Eof($handle);
}

try {
    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $sbContent->GetAsString(), "\n";

$sftp->Disconnect();