FTP Module¶

The FTP Module provides Non-Blocking FTP transfers for XPSPL.

Note

Currently only uploading files to a remote server is supported.

Installation¶

The FTP Module is bundled with XPSPL as of version 3.0.0.

Requirements¶

PHP¶

PHP FTP extension must be installed and enabled.

XPSPL¶

XPSPL >= 3.0

Configuration¶

The FTP Module has no runtime configuration options available.

Usage¶

Importing¶

<?php

xp_import('ftp');

Uploading Files¶

<?php

xp_import('ftp');

$files = ['/tmp/myfile_1.txt', '/tmp/myfile_2.txt'];
$server = [
    'hostname' => 'ftp.myhost.com',
    'username' => 'foo',
    'password' => 'bar'
];

$upload = ftp\upload($files, $server);

ftp\complete($upload, xp_null_exhaust(function(\ftp\SIG_Complete $sig){
    $file = $sig->get_file();
    echo sprintf('%s has uploaded'.PHP_EOL,
        $file->get_name()
    );
}));

ftp\failure($upload, xp_null_exhaust(function(\ftp\SIG_Failure $sig){
    $file = $sig->get_file();
    echo sprintf('%s has failed to upload'.PHP_EOL,
        $file->get_name()
    );
}));

ftp\finished($upload, function(\ftp\SIG_Finished $sig){
    echo 'FTP Transfer complete';
})

API¶

All functions and classes are under the ftp namespace.

ftp\upload(array $files, array $connection, [callable $callback = null])

Performs a non-blocking FTP upload of the given file(s).

When multiple files are given they will be uploaded simultaneously using separate connections to the given $connection.

The $callback will be called once the files begin uploading.

It is expected that the absolute path to the file will be given, failure to do so will cause unexpected behavior.

The connection array accepts,

hostname - Hostname of the server to upload.
username - Username to use when connecting.
password - Password to use when connecting.
port - Port number to connect on. Default=21
timeout - Connection timeout in seconds. Default=90

Parameters:	$files (array) – Files to upload $connection (array) – FTP Connection options $callback (callable) – Function to call when upload begins
Return object:	SIG_Upload