PHP

Create an FTP Upload Plan

Demonstrates the Chilkat Ftp2.CreatePlan method, which creates and returns a textual upload plan for a local directory. The only argument is the local directory. The object must be connected, because the plan records the current absolute remote directory together with the local source paths.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: A plan is a saved, resumable description of an upload — the list of local files and their absolute remote destinations — computed once and executed later (or on another run) with PutPlan. Separating planning from execution suits large or unreliable transfers: the plan can be reviewed, stored, and re-run, and because it records absolute remote paths it stays correct even if the working directory later changes.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ftp2;
use Chilkat2\StringBuilder;

// Demonstrates the Ftp2.CreatePlan method, which creates and returns a textual upload plan for a
// local directory.  The only argument is the local directory.  The object must be connected,
// because the plan records the current absolute remote directory.

$ftp = new Ftp2();

$ftp->Hostname = 'ftp.example.com';
$ftp->Username = 'myFtpLogin';

// 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.
$ftp->Password = 'myPassword';

try {
    $ftp->Connect();

    $ftp->ChangeRemoteDir('public_html');

    // The plan captures which local files to upload and the absolute remote destination.  Save it so
    // the upload can be run (or resumed) later with PutPlan.
    $plan = $ftp->CreatePlan('qa_data/site');

    // Persist the plan text for later use.
    $sbPlan = new StringBuilder();
    $sbPlan->Append($plan);
    $sbPlan->WriteFile('qa_output/upload_plan.txt', 'utf-8', false);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Upload plan created.\n";

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