PHP Extension

Write Text at a String Offset in a Remote SFTP File

Demonstrates the Chilkat SFtp.WriteFileText64s method, which is like WriteFileText64 but takes the byte offset as a decimal string. The arguments are the handle, the offset string, the charset, and the text.

Background: Some programming languages Chilkat targets lack a native 64-bit integer type, or make large integer literals awkward. Passing the offset as a decimal string sidesteps that entirely — the value is parsed by the library — while addressing the same large-file positions as the int64 form.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the SFtp.WriteFileText64s method, which is like WriteFileText64 but takes the
//  byte offset as a decimal string.  The 1st argument is the handle, the 2nd is the offset string,
//  the 3rd is the charset, and the 4th 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;
}

$handle = $sftp->openFile('subdir/hugefile.dat','readWrite','openOrCreate');
if ($sftp->get_LastMethodSuccess() == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  Supplying the offset as a string is convenient in languages without a native 64-bit integer.
$offset = '5000000000';
$success = $sftp->WriteFileText64s($handle,$offset,'utf-8','MARKER');
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

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

print 'Wrote at the string offset.' . "\n";

$sftp->Disconnect();

?>