Creates the FtpClient object. It accepts one optional argument that will set the URL for the FTP connection; the path is ignored in the URL, however the username, password, hostname and port are respected; additionally if the protocol is "ftps", the client will attempt to establish a secure connection to the server according to RFC-4217 when the first connection is established.

FtpClient::constructor()

FtpClient::constructor(string $url)

my FtpClient $ftp("ftp://user:pass@hostname");

Destroys the object.

delete $ftp;

EVENT_CHANNEL_CLOSED, EVENT_DELETED

Throws an exception; objects of this class cannot be copied.

Connects to the FTP server and attempts a login; if any errors occur, an exception is thrown.

This method does not need to be called explicitly; connections are established implicitly by all methdods that communicate with FTP servers.

nothing FtpClient::connect()

$ftp.connect(); # connects to the URL set in the constructor

EVENT_CONNECTING, EVENT_CONNECTED,EVENT_HOSTNAME_LOOKUP, EVENT_HOSTNAME_RESOLVED, EVENT_START_SSL, EVENT_SSL_ESTABLISHED, EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Disconnects from an FTP server.

nothing FtpClient::disconnect()

$ftp.disconnect();

EVENT_CHANNEL_CLOSED

Make an FTPS connection to the server on the next connect. This method can only be called before a connection is established; if called when a connection has already been established, an exception will be thrown.

nothing FtpClient::setSecure(softbool $secure = True)

$ftp.setSecure();

Make a non-encrypted connection to the server on the next connect.

nothing FtpClient::setInsecure()

$ftp.setInsecure();

Make a non-encrypted data connection to the server on the next connect even if the control connection is secure.

nothing FtpClient::setInsecureData()

$ftp.setInsecureData();

Returns True if the control connection is a secure TLS/SSL connection.

bool FtpClient::isSecure()

my bool $b = $ftp.isSecure();

Returns True if the data connections are secure TLS/SSL connections.

bool FtpClient::isDataSecure()

my bool $b = $ftp.isDataSecure();

Returns the name of the cipher for an encrypted connection.

*string FtpClient::getSSLCipherName()

my *string $str = $ftp.getSSLCipherName();

Returns the version string of the cipher for encrypted connections.

*string FtpClient::getSSLCipherVersion()

my *string $str = $ftp.getSSLCipherVersion();

Returns a string code giving the result of verifying the remote certificate for secure (FTPS) connections. Return value are the keys described in the X509_VerificationReasons hash constant. This hash can also be used to generate a textual description of the verification result.

*string FtpClient::verifyPeerCertificate()

my *string $str = $ftp.verifyPeerCertificate();

Sets the object to automatically try to negotiate the data connections in EPSV, PASV, and PORT modes, in this order.

nothing FtpClient::setModeAuto()

$ftp.setModeAuto();

Sets the object to only try to make data connections using EPSV (RFC-2428 extended passive) mode.

nothing FtpClient::setModeEPSV()

$ftp.setModeEPSV();

Sets the object to only try to make data connections using PASV (RFC-959 passive) mode.

nothing FtpClient::setModePASV()

$ftp.setModePASV();

Sets the object to only try to make data connections using PORT mode.

nothing FtpClient::setModePORT()

$ftp.setModePORT();

Gets a string giving the list of files from the FTP server in the server's long format in the current working directory; returns NOTHING if the path cannot be found.

*string FtpClient::list()

*string FtpClient::list(string $path)

my *string $str = $ftp.list();

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Gets a list of file names in the current working directory from the FTP server.

*string FtpClient::nlst()

*string FtpClient::nlst(string $path)

my *string $str = $ftp.nlst();

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Returns the server-side current working directory.

string FtpClient::pwd()

my string $str = $ftp.pwd();

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Changes the current working directory on the server.

nothing FtpClient::cwd(string $dir)

$ftp.cwd("/pub/gnu");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Gets a file from the FTP server and stores it on the local system. If any errors occur, an exception is thrown.

This method accesses the filesystem, so it is not available if PO_NO_FILESYSTEM is set.

nothing FtpClient::get(string $remote_file)

nothing FtpClient::get(string $remote_file, string $local_file)

$ftp.get("file.txt", "/tmp/file-1.txt");

Not available with PO_NO_FILESYSTEM

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Gets a file from the FTP server and returns the file's contents as a binary value. For a similar function returning the file's contents as a string, see FtpClient::getAsString(); for a function that will get a remote file and save it on the local filesystem, see FtpClient::get().

binary FtpClient::getAsBinary(string $remote_file)

my binary $b = $ftp.getAsBinary("file.bin");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Gets a file from the FTP server and returns the file's contents as a string. For a similar function returning the file's contents as a binary, see FtpClient::getAsBinary(); for a function that will get a remote file and save it on the local filesystem, see FtpClient::get().

string FtpClient::getAsString(string $remote_file)

my string $str = $ftp.getAsString("file.txt");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Transfers a file to the FTP server. If any errors occur, an exception is thrown.

This method accesses the filesystem, so it is not available if PO_NO_FILESYSTEM is set.

int FtpClient::put(string $local_file)

int FtpClient::put(string $local_file, string $remote_file)

$ftp.put("/tmp/file-1.txt", "file.txt");

Not available with PO_NO_FILESYSTEM

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Transfers a data to the FTP server and saves it as a file on the remote machine; if any errors occur, an exception is thrown.

nothing FtpClient::putData(data $file_data, string $remote_file_name)

$ftp.putData($str, "file.txt");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Deletes a file on the FTP server; if any errors occur, an exception is thrown.

nothing FtpClient::del(string $remote_file)

$ftp.del("file-2.txt");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Creates a directory on the remote FTP server; if any errors occur, an exception is thrown.

nothing FtpClient::mkdir(string $remote_dir)

$ftp.mkdir("tmp");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Removes a directory on the remote FTP server; if any errors occur, an exception is thrown.

nothing FtpClient::rmdir(string $remote_dir)

$ftp.rmdir("tmp");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Renames/moves a file or directory; if any errors occur, an exception is thrown.

nothing FtpClient::rename(string $from, string $to)

$ftp.rename("file.txt", "file.txt.orig");

EVENT_FTP_SEND_MESSAGE, EVENT_FTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_PACKET_SENT

Sets the username for logging in to the FTP server.

nothing FtpClient::setUserName(string $user)

$ftp.setUserName("ftp");

Sets the login password for the FTP server to connect to.

nothing FtpClient::setPassword(string $pass)

$ftp.setPassword("ftp");

Sets the hostname value for the FTP server to connect to.

nothing FtpClient::setHostName(string $host)

$ftp.setHostName("hostname");

Sets the control port value (default is 21).

nothing FtpClient::setPort(softint $port)

$ftp.setPort(21);

Sets the connection and login parameters based on the URL passed as an argument.

nothing FtpClient::setURL(string $url)

$ftp.setURL("ftps://user:pass@host");

Retrieves the current username.

*string FtpClient::getUserName()

my *string $user = $ftp.getUserName();

Retrieves the current login password value for this object.

*string FtpClient::getPassword()

my *string $pass = $ftp.getPassword();

Retrieves the current hostname value for this object.

*string FtpClient::getHostName()

my *string $host = $ftp.getHostName();

Retrieves the current connection port value for this object.

int FtpClient::getPort()

my int $port = $ftp.getPort();

Retrieves the current connection URL string for this object.

string FtpClient::getURL()

my string $url = $ftp.getURL();

Sets a Queue object to receive socket and FtpClient events on both the data and control connections.

To remove the event queue and stop monitoring socket events, pass NOTHING to the method. See Event Handling for more information.

To control monitoring of network events on just the data connection or just the control connection, use FtpClient::setDataEventQueue or FtpClient::setControlEventQueue respectively

nothing FtpClient::setEventQueue()

nothing FtpClient::setEventQueue(Queue $queue)

$ftp.setEventQueue($queue);

Sets a Queue object to receive socket and FtpClient events on the data connection when retrieving data from an FTP server.

To remove the event queue and stop monitoring network events, pass NOTHING to the method. See Event Handling for more information.

To control monitoring of network events on just the control connection or on both connections with the same queue, use FtpClient::setControlEventQueue or FtpClient::setEventQueue respectively.

nothing FtpClient::setDataEventQueue()

nothing FtpClient::setDataEventQueue(Queue $queue)

$ftp.setDataEventQueue($queue);

Sets a Queue object to receive socket and FtpClient events on both the control connection.

To remove the event queue and stop monitoring network events, pass NOTHING to the method. See Event Handling for more information.

To control monitoring of network events on just the data connection or for both data and control connections simultaneously, use FtpClient::setDataEventQueue or FtpClient::setEventQueue respectively

nothing FtpClient::setControlEventQueue()

nothing FtpClient::setControlEventQueue(Queue $queue)

$ftp.setControlEventQueue($queue);