PHP Extension

Write Text to a Remote SFTP File (Sequential)

Demonstrates the Chilkat SFtp.WriteFileText method, which encodes text using a charset and writes it at the current sequential write position of an open handle. The arguments are the handle, the charset, and the text.

Background: Chilkat tracks a write position per handle, so successive WriteFileText calls append naturally — the pattern for building a file a piece at a time, such as writing rows to a report. Opening with openOrCreate starts writing at the current end of the file. The charset determines the bytes actually stored, which matters whenever the text contains non-ASCII characters.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the SFtp.WriteFileText method, which encodes text and writes it at the current
//  sequential write position of an open handle.  The 1st argument is the handle, the 2nd is the
//  charset, and the 3rd is the text.

$sftp = new CkSFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
$success = $sftp->Connect('sftp.example.com',$port);
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  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';

$success = $sftp->AuthenticatePw('mySshLogin',$password);
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

$success = $sftp->InitializeSftp();
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  Open (creating/truncating) the remote file for writing.
$handle = $sftp->openFile('subdir/notes.txt','writeOnly','createTruncate');
if ($sftp->get_LastMethodSuccess() == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  Write text as UTF-8.  Successive writes continue from where the previous write ended.
$success = $sftp->WriteFileText($handle,'utf-8','First line.\n');
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

$success = $sftp->WriteFileText($handle,'utf-8','Second line.\n');
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

$success = $sftp->CloseHandle($handle);
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

print 'Wrote text file.' . "\n";

$sftp->Disconnect();

?>