(PHP Extension) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

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

<?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.

$sftp = new CkSFtp();

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

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
$hostname = 'sftp.example.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 file on the server:

$handle = $sftp->openFile('hamlet.xml','readOnly','openExisting');
if ($sftp->get_LastMethodSuccess() != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// Get the total size of this file (in bytes)
$bFollowLinks = false;
$bIsHandle = true;

// bFollowLinks is ignored because we are passing a handle
// and not a remote filename.
// There are alternative methods for handling file sizes
// greater than 32-bit.  (See the reference documentation.)
$numBytes = $sftp->GetFileSize32($handle,$bFollowLinks,$bIsHandle);
if ($numBytes < 0) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

// The charset indicates the character encoding of the text
// file on the SSH server.   Setting the charset correctly
// allows the Chilkat SFTP component to correctly interpret
// the bytes that represent the characters.

$charset = 'ansi';

$fileContents = $sftp->readFileText($handle,$numBytes,$charset);
if ($sftp->get_LastMethodSuccess() != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}
else {
    print 'Received file:' . "\n";
    print $fileContents . "\n";
}

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

print 'Success.' . "\n";

?>