Friday, 23 December 2011

PHP FTP Functions Reference


PHP FTP Introduction

The FTP functions give client access to file servers through the File Transfer Protocol (FTP).
The FTP functions are used to open, login and close connections, as well as upload, download, rename, delete, and get information on files from file servers. Not all of the FTP functions will work with every server or return the same results. The FTP functions became available with PHP 3.
These functions are meant for detailed access to an FTP server. If you only wish to read from or write to a file on an FTP server, consider using the ftp:// wrapper with the Filesystem functions.

Installation

The windows version of PHP has built-in support for the FTP extension. So, the FTP functions will work automatically.
However, if you are running the Linux version of PHP, you will have to compile PHP with --enable-ftp(PHP 4+) or --with-ftp (PHP 3) to get the FTP functions to work.

PHP FTP Functions

PHP: indicates the earliest version of PHP that supports the function.
FunctionDescriptionPHP
ftp_alloc()Allocates space for a file to be uploaded to the FTP server5
ftp_cdup()Changes the current directory to the parent directory on the FTP server3
ftp_chdir()Changes the current directory on the FTP server3
ftp_chmod()Sets permissions on a file via FTP5
ftp_close()Closes an FTP connection4
ftp_connect()Opens an FTP connection3
ftp_delete()Deletes a file on the FTP server3
ftp_exec()Executes a program/command on the FTP server4
ftp_fget()Downloads a file from the FTP server and saves it to an open file3
ftp_fput()Uploads from an open file and saves it to a file on the FTP server3
ftp_get_option()Returns runtime behaviors of the FTP connection4
ftp_get()Downloads a file from the FTP server3
ftp_login()Logs on to an FTP connection3
ftp_mdtm()Returns the last modified time of a specified file3
ftp_mkdir()Creates a new directory on the FTP server3
ftp_nb_continue()Continues retrieving/sending a file (non-blocking)4
ftp_nb_fget()Downloads a file from the FTP server and saves it to an open file (non-blocking)4
ftp_nb_fput()Uploads from an open file and saves it to a file on the FTP server (non-blocking)4
ftp_nb_get()Downloads a file from the FTP server (non-blocking)4
ftp_nb_put()Uploads a file to the FTP server (non-blocking)4
ftp_nlist()Lists the files in a specified directory on the FTP server3
ftp_pasv()Turns passive mode on or off3
ftp_put()Uploads a file to the FTP server3
ftp_pwd()Returns the current directory name3
ftp_quit()Alias of ftp_close()3
ftp_raw()Sends a raw command to the FTP server5
ftp_rawlist()Returns a detailed list of files in the specified directory3
ftp_rename()Renames a file or directory on the FTP server3
ftp_rmdir()Removes a directory on the FTP server3
ftp_set_option()Sets runtime options for the FTP connection4
ftp_site()Sends a SITE command to the server3
ftp_size()Returns the size of the specified file3
ftp_ssl_connect()Opens a secure SSL-FTP connection4
ftp_systype()Returns the system type identifier of the FTP server3


PHP FTP Constants

PHP: indicates the earliest version of PHP that supports the constant.
ConstantDescriptionPHP
FTP_ASCII 3
FTP_TEXT 3
FTP_BINARY 3
FTP_IMAGE 3
FTP_TIMEOUT_SEC 3
FTP_AUTOSEEK 4
FTP_AUTORESUMEDetermine resume position and start position for get and put requests automatically4
FTP_FAILEDAsynchronous transfer has failed4
FTP_FINISHEDAsynchronous transfer has finished4
FTP_MOREDATAAsynchronous transfer is still active4

1 comment: