FTP
[ class tree: FTP ] [ index: FTP ] [ all elements ]

Element index for package FTP

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ]

a

addExtension
in file FTP.php, method Net_FTP::addExtension()
    Adds an extension to a mode-directory
attach
in file FTP.php, method Net_FTP::attach()
    Adds a Net_FTP_Observer instance to the list of observers that are listening for messages emitted by this Net_FTP instance.
top

c

cd
in file FTP.php, method Net_FTP::cd()
    This changes the currently used directory. You can use either an absolute directory-path (e.g. "/home/blah") or a relative one (e.g. "../test").
checkFileExtension
in file FTP.php, method Net_FTP::checkFileExtension()
    This checks, whether a file should be transfered in ascii- or binary-mode by it's file-extension. If the file-extension is not set or the extension is not inside one of the extension-dirs, the actual set transfer-mode is returned.
chmod
in file FTP.php, method Net_FTP::chmod()
    This method will try to chmod the file specified on the server Currently, you must give a number as the the permission argument (777 or similar). The file can be either a relative or absolute path.
chmodRecursive
in file FTP.php, method Net_FTP::chmodRecursive()
    This method will try to chmod a folder and all of its contents on the server. The target argument must be a folder or an array of folders and the permissions argument have to be an integer (i.e. 777).
connect
in file FTP.php, method Net_FTP::connect()
    This function generates the FTP-connection. You can optionally define a hostname and/or a port. If you do so, this data is stored inside the object.
top

d

detach
in file FTP.php, method Net_FTP::detach()
    Removes a Net_FTP_Observer instance from the list of observers.
disconnect
in file FTP.php, method Net_FTP::disconnect()
    This function close the FTP-connection
dump
in file socket.php, function dump()
    Function used by the test suit.
top

e

execute
in file FTP.php, method Net_FTP::execute()
    This method tries executing a command on the ftp, using SITE EXEC.
top

f

ftp_alloc
in file Socket.php, function ftp_alloc()
    boolean ftp_alloc ( resource stream, integer bytes [, string &message ] );
FTP_ASCII
in file Socket.php, constant FTP_ASCII
    Default FTP extension constants
FTP_BINARY
in file Socket.php, constant FTP_BINARY
ftp_cdup
in file Socket.php, function ftp_cdup()
    Changes to the parent directory Returns TRUE on success or FALSE on failure
ftp_chdir
in file Socket.php, function ftp_chdir()
    boolean ftp_chdir ( resource stream, string directory );
ftp_chmod
in file Socket.php, function ftp_chmod()
    Set permissions on a file via FTP Returns the new file permission on success or false on error
ftp_close
in file Socket.php, function ftp_close()
    Alias to ftp_quit()
ftp_connect
in file Socket.php, function ftp_connect()
    &resource ftp_connect ( string host [, int port [, int timeout ] ] );
ftp_delete
in file Socket.php, function ftp_delete()
    Deletes a file on the FTP server Returns TRUE on success or FALSE on failure
ftp_exec
in file Socket.php, function ftp_exec()
    Requests execution of a program on the FTP server NOTE; SITE EXEC is *not* supported by the standart Returns TRUE on success or FALSE on error
ftp_get
in file Socket.php, function ftp_get()
    Retrieve a remote file to a local file Returns TRUE on success or FALSE on failure
FTP_IMAGE
in file Socket.php, constant FTP_IMAGE
ftp_login
in file Socket.php, function ftp_login()
    boolean ftp_login ( resource stream, string username, string password );
ftp_pasv
in file Socket.php, function ftp_pasv()
    boolean ftp_pasv ( resource stream, boolean passive );
ftp_put
in file Socket.php, function ftp_put()
    bool ftp_put ( resource stream, string remote_file, string local_file, int mode [, int startpos ] );
ftp_pwd
in file Socket.php, function ftp_pwd()
    string ftp_pwd ( resource stream );
ftp_quit
in file Socket.php, function ftp_quit()
    boolean ftp_quit ( resource stream );
ftp_rawlist
in file Socket.php, function ftp_rawlist()
    array ftp_rawlist ( resource stream, string directory [,bool recursive] );
ftp_systype
in file Socket.php, function ftp_systype()
    string ftp_systype ( resource stream );
FTP_TEXT
in file Socket.php, constant FTP_TEXT
FTP_TIMEOUT_SEC
in file Socket.php, constant FTP_TIMEOUT_SEC
FTP.php
procedural page FTP.php
top

g

get
in file FTP.php, method Net_FTP::get()
    This function will download a file from the ftp-server. You can either specify an absolute path to the file (beginning with "/") or a relative one, which will be completed with the actual directory you selected on the server.
getExtensionMode
in file FTP.php, method Net_FTP::getExtensionMode()
    Returns the mode set for a file-extension
getExtensionsFile
in file FTP.php, method Net_FTP::getExtensionsFile()
    This get's both (ascii- and binary-mode-directories) from the given file.
getHostname
in file FTP.php, method Net_FTP::getHostname()
    Returns the hostname
getId
in file Observer.php, method Net_FTP_Observer::getId()
    Returns the listener's identifier
getMode
in file FTP.php, method Net_FTP::getMode()
    Returns the transfermode
getPassword
in file FTP.php, method Net_FTP::getPassword()
    Returns the password
getPort
in file FTP.php, method Net_FTP::getPort()
    Returns the port
getRecursive
in file FTP.php, method Net_FTP::getRecursive()
    This functionality allows you to transfer a whole directory-structure from the remote-ftp to your local host. You have to give a remote-directory (ending with '/') and the local directory (ending with '/') where to put the files you download.
getSsl
in file FTP.php, method Net_FTP::getSsl()
    Returns whether to connect through secure SSL connection
getTimeout
in file FTP.php, method Net_FTP::getTimeout()
    Get the currently set timeout.
getUsername
in file FTP.php, method Net_FTP::getUsername()
    Returns the username
top

h

head
in file index.php, function head()
    Headline function for XHTML output
top

i

isPassive
in file FTP.php, method Net_FTP::isPassive()
    Returns, whether the connection is set to passive mode or not
index.php
procedural page index.php
top

l

login
in file FTP.php, method Net_FTP::login()
    This logs you into the ftp-server. You are free to specify username and password in this method. If you specify it, the values will be taken into the corresponding attributes, if do not specify, the attributes are taken.
ls
in file FTP.php, method Net_FTP::ls()
    This method returns a directory-list of the current directory or given one.
top

m

mdtm
in file FTP.php, method Net_FTP::mdtm()
    This will return the last modification-time of a file. You can either give this function a relative or an absolute path to the file to check.
mkdir
in file FTP.php, method Net_FTP::mkdir()
    This works similar to the mkdir-command on your local machine. You can either give it an absolute or relative path. The relative path will be completed with the actual selected server-path. (see: pwd())
top

n

Net_FTP
in file FTP.php, method Net_FTP::Net_FTP()
    This generates a new FTP-Object. The FTP-connection will not be established, yet.
Net_FTP
in file FTP.php, class Net_FTP
    Class for comfortable FTP-communication
NET_FTP_BLOCKING
in file FTP.php, constant NET_FTP_BLOCKING
    Option to indicate that non-blocking features should not be used in put(). This will also disable the listener functionality as a side effect.
NET_FTP_DIRS_FILES
in file FTP.php, constant NET_FTP_DIRS_FILES
    Option to let the ls() method return directories and files (default).
NET_FTP_DIRS_ONLY
in file FTP.php, constant NET_FTP_DIRS_ONLY
    Option to let the ls() method return only directories.
NET_FTP_ERR_BADOPTIONS
in file FTP.php, constant NET_FTP_ERR_BADOPTIONS
    Error code indicating that bad options were supplied to the put() method.
NET_FTP_ERR_CHMOD_FAILED
in file FTP.php, constant NET_FTP_ERR_CHMOD_FAILED
    Error code to indicate that the CHMOD command failed.
NET_FTP_ERR_CONNECT_FAILED
in file FTP.php, constant NET_FTP_ERR_CONNECT_FAILED
    Error code to indicate a failed connection This error code indicates, that the connection you tryed to set up could not be established. Check your connection settings (host & port)!
NET_FTP_ERR_CREATEDIR_FAILED
in file FTP.php, constant NET_FTP_ERR_CREATEDIR_FAILED
    Error code to indicate that the creation of a directory failed The directory you tryed to create could not be created. Check the access rights on the parent directory!
NET_FTP_ERR_CREATELOCALDIR_FAILED
in file FTP.php, constant NET_FTP_ERR_CREATELOCALDIR_FAILED
    Error code to indicate that a local directory failed to be created You tried to create a local directory through getRecursive() method, which has failed. Ensure that you have the appropriate access rights to create it.
NET_FTP_ERR_DATEFORMAT_FAILED
in file FTP.php, constant NET_FTP_ERR_DATEFORMAT_FAILED
    Error code to indicate that a date returned by the server was misformated
NET_FTP_ERR_DELETEDIR_FAILED
in file FTP.php, constant NET_FTP_ERR_DELETEDIR_FAILED
    Error code to indicate that the deletion of a directory faild The specified file could not be deleted. Ensure to have sufficient access rights to delete the file.
NET_FTP_ERR_DELETEFILE_FAILED
in file FTP.php, constant NET_FTP_ERR_DELETEFILE_FAILED
    Error code to indicate that the deletion of a file failed The specified file could not be deleted. Ensure to have sufficient access rights to delete the file.
NET_FTP_ERR_DETERMINEPATH_FAILED
in file FTP.php, constant NET_FTP_ERR_DETERMINEPATH_FAILED
    Error code to indicate that Net_FTP could not determine the current path The pwd() method failed and could not determine the path you currently reside in on the FTP server.
NET_FTP_ERR_DIRCHANGE_FAILED
in file FTP.php, constant NET_FTP_ERR_DIRCHANGE_FAILED
    Error code to indicate a failed directory change The cd() method failed. Ensure that the directory you wanted to access exists.
NET_FTP_ERR_DIRLIST_UNSUPPORTED
in file FTP.php, constant NET_FTP_ERR_DIRLIST_UNSUPPORTED
    Error code to indicate that the directory listing failed
NET_FTP_ERR_DISCONNECT_FAILED
in file FTP.php, constant NET_FTP_ERR_DISCONNECT_FAILED
    Error code to indicate failed disconnecting This error code indicates, that disconnection was not possible.
NET_FTP_ERR_EXEC_FAILED
in file FTP.php, constant NET_FTP_ERR_EXEC_FAILED
    Error code to indicate that the EXEC execution failed.
NET_FTP_ERR_EXTFILELOAD_FAILED
in file FTP.php, constant NET_FTP_ERR_EXTFILELOAD_FAILED
    Error code to indicate that the provided extension file is not loadable The provided extension file is not loadable. Ensure to have a correct file syntax.
NET_FTP_ERR_EXTFILENOTEXIST
in file FTP.php, constant NET_FTP_ERR_EXTFILENOTEXIST
    Error code to indicate that the provided extension file doesn't exist The provided extension file does not exist. Ensure to provided an existant extension file.
NET_FTP_ERR_EXTFILEREAD_FAILED
in file FTP.php, constant NET_FTP_ERR_EXTFILEREAD_FAILED
    Error code to indicate that the provided extension file is not readable The provided extension file is not readable. Ensure to have sufficient access rights for it.
NET_FTP_ERR_HOSTNAMENOSTRING
in file FTP.php, constant NET_FTP_ERR_HOSTNAMENOSTRING
    Error code to indicate that the provided hostname was incorrect The hostname you provided was invalid. Ensure to provide either a full qualified domain name or an IP address.
NET_FTP_ERR_ILLEGALMAP
in file FTP.php, constant NET_FTP_ERR_ILLEGALMAP
    Error code to indicate that the directory listing matcher map provided is not an array.
NET_FTP_ERR_ILLEGALMAPVALUE
in file FTP.php, constant NET_FTP_ERR_ILLEGALMAPVALUE
    Error code to indicate that the directory listing matcher map provided contains wrong values (ie: it contains non-numerical values)
NET_FTP_ERR_ILLEGALPATTERN
in file FTP.php, constant NET_FTP_ERR_ILLEGALPATTERN
    Error code to indicate that the directory listing pattern provided is not a string.
NET_FTP_ERR_LOCALFILENOTEXIST
in file FTP.php, constant NET_FTP_ERR_LOCALFILENOTEXIST
    Error code to indicate that the file you wanted to upload does not exist The file you tried to upload does not exist. Ensure that it exists.
NET_FTP_ERR_LOCALPATHNODIR
in file FTP.php, constant NET_FTP_ERR_LOCALPATHNODIR
    Error code to indicate that you specified an incorrect directory path The local path you specified seems not to be a directory. Ensure that the path you specify is a directory and that the path string ends with a /.
NET_FTP_ERR_LOGIN_FAILED
in file FTP.php, constant NET_FTP_ERR_LOGIN_FAILED
    Error code to indicate a failed login This error code indicates, that the login to the FTP server failed. Check your user data (username & password).
NET_FTP_ERR_MDTMDIR_UNSUPPORTED
in file FTP.php, constant NET_FTP_ERR_MDTMDIR_UNSUPPORTED
    Error code to indicate that the MDTM command failed The MDTM command is not supported for directories. Ensure that you gave a file path to the mdtm() method, not a directory path.
NET_FTP_ERR_MDTM_FAILED
in file FTP.php, constant NET_FTP_ERR_MDTM_FAILED
    Error code to indicate that the MDTM command failed The MDTM command failed. Ensure that your server supports the MDTM command.
NET_FTP_ERR_NOMODECONST
in file FTP.php, constant NET_FTP_ERR_NOMODECONST
    Error code to indicate that you provided an invalid mode constant The mode constant you provided was invalid. You may only provide FTP_ASCII or FTP_BINARY.
NET_FTP_ERR_NOSSL
in file FTP.php, constant NET_FTP_ERR_NOSSL
    Error code indicating that SSL connection is not supported as either the ftp module or OpenSSL support is not statically built into php.
NET_FTP_ERR_OVERWRITELOCALFILE_FAILED
in file FTP.php, constant NET_FTP_ERR_OVERWRITELOCALFILE_FAILED
    Error code to indicate that a local file could not be overwritten Also you specified to overwrite the local file you want to download to, it has not been possible to do so. Check that you have the appropriate access rights on the local file to overwrite it.
NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN
in file FTP.php, constant NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN
    Error code to indicate that a local file could not be overwritten You specified not to overwrite files. Therefore the local file has not been overwriten. If you want to get the file overwriten, please set the option to do so.
NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN
in file FTP.php, constant NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN
    Error code to indicate that a remote file could not be overwritten You specified not to overwrite files. Therefore the remote file has not been overwriten. If you want to get the file overwriten, please set the option to do so.
NET_FTP_ERR_PASSWORDNOSTRING
in file FTP.php, constant NET_FTP_ERR_PASSWORDNOSTRING
    Error code to indicate that the username you provided was invalid.
NET_FTP_ERR_PORTLESSZERO
in file FTP.php, constant NET_FTP_ERR_PORTLESSZERO
    Error code to indicate that the provided port was incorrect The port number you provided was invalid. Ensure to provide either a a numeric port number greater zero.
NET_FTP_ERR_RAWDIRLIST_FAILED
in file FTP.php, constant NET_FTP_ERR_RAWDIRLIST_FAILED
    Error code to indicate that the directory listing failed PHP could not list the directory contents on the server. Ensure that your server is configured appropriate.
NET_FTP_ERR_REMOTEPATHNODIR
in file FTP.php, constant NET_FTP_ERR_REMOTEPATHNODIR
    Error code to indicate that you specified an incorrect directory path The remote path you specified seems not to be a directory. Ensure that the path you specify is a directory and that the path string ends with a /.
NET_FTP_ERR_RENAME_FAILED
in file FTP.php, constant NET_FTP_ERR_RENAME_FAILED
    Error code to indicate that a file rename failed The renaming of a file on the server failed. Ensure that you have the appropriate access rights to rename the file.
NET_FTP_ERR_SETTIMEOUT_FAILED
in file FTP.php, constant NET_FTP_ERR_SETTIMEOUT_FAILED
    Error code to indicate that you provided an invalid timeout An error occured while setting the timeout. Ensure that you provide a valid integer for the timeount and that your PHP installation works correctly.
NET_FTP_ERR_SITE_FAILED
in file FTP.php, constant NET_FTP_ERR_SITE_FAILED
    Error code to indicate that the SITE command failed.
NET_FTP_ERR_SIZE_FAILED
in file FTP.php, constant NET_FTP_ERR_SIZE_FAILED
    Error code to indicate that the SIZE command failed The determination of the filesize of a file failed. Ensure that your server supports the SIZE command.
NET_FTP_ERR_TIMEOUTLESSZERO
in file FTP.php, constant NET_FTP_ERR_TIMEOUTLESSZERO
    Error code to indicate that you provided an invalid timeout The timeout you provided was invalid. You have to provide a timeout greater or equal to zero.
NET_FTP_ERR_UPLOADFILE_FAILED
in file FTP.php, constant NET_FTP_ERR_UPLOADFILE_FAILED
    Error code to indicate that the upload of a file failed The upload you tried failed. Ensure that you have appropriate access rights to upload the desired file.
NET_FTP_ERR_USERNAMENOSTRING
in file FTP.php, constant NET_FTP_ERR_USERNAMENOSTRING
    Error code to indicate that the username you provided was invalid.
NET_FTP_FILES_ONLY
in file FTP.php, constant NET_FTP_FILES_ONLY
    Option to let the ls() method return only files.
NET_FTP_NONBLOCKING
in file FTP.php, constant NET_FTP_NONBLOCKING
    Option to indicate that non-blocking features should be used if available in put(). This will also enable the listener functionality.
Net_FTP_Observer
in file Observer.php, method Net_FTP_Observer::Net_FTP_Observer()
    Creates a new basic Net_FTP_Observer instance.
Net_FTP_Observer
in file Observer.php, class Net_FTP_Observer
    This class implements the Observer part of a Subject-Observer design pattern. It listens to the events sent by a Net_FTP instance.
NET_FTP_RAWLIST
in file FTP.php, constant NET_FTP_RAWLIST
    Option to let the ls() method return the raw directory listing from ftp_rawlist()
notify
in file observer.php, method Observer_ProgressUpload::notify()
    Notification method
notify
in file Observer.php, method Net_FTP_Observer::notify()
    This is a stub method to make sure that Net_FTP_Observer classes do something when they are notified of a message. The default behavior is to just do nothing.
top

o

observer.php
procedural page observer.php
Observer.php
procedural page Observer.php
Observer_ProgressUpload
in file observer.php, method Observer_ProgressUpload::Observer_ProgressUpload()
    Constructor for the upload observer
Observer_ProgressUpload
in file observer.php, class Observer_ProgressUpload
    
  1. Defines the FTP/Progress Observer
top

p

$progress
in file observer.php, variable Observer_ProgressUpload::$progress
put
in file FTP.php, method Net_FTP::put()
    This function will upload a file to the ftp-server. You can either specify a absolute path to the remote-file (beginning with "/") or a relative one, which will be completed with the actual directory you selected on the server.
putRecursive
in file FTP.php, method Net_FTP::putRecursive()
    This functionality allows you to transfer a whole directory-structure from
pwd
in file FTP.php, method Net_FTP::pwd()
    Show's you the actual path on the server This function questions the ftp-handle for the actual selected path and returns it.
top

r

removeExtension
in file FTP.php, method Net_FTP::removeExtension()
    This function removes an extension from the mode-directories (described above).
rename
in file FTP.php, method Net_FTP::rename()
    Rename or move a file or a directory from the ftp-server
rm
in file FTP.php, method Net_FTP::rm()
    This method will delete the given file or directory ($path) from the server (maybe recursive).
top

s

socket.php
procedural page socket.php
Socket.php
procedural page Socket.php
setActive
in file FTP.php, method Net_FTP::setActive()
    Set the transfer-method to active mode
setDirMatcher
in file FTP.php, method Net_FTP::setDirMatcher()
    Sets the directory listing matcher
setHostname
in file FTP.php, method Net_FTP::setHostname()
    Set the hostname
setMode
in file FTP.php, method Net_FTP::setMode()
    Set the transfer-mode. You can use the predefined constants FTP_ASCII or FTP_BINARY. The mode will be stored for any further transfers.
setPassive
in file FTP.php, method Net_FTP::setPassive()
    Set the transfer-method to passive mode
setPort
in file FTP.php, method Net_FTP::setPort()
    Set the Port
setSsl
in file FTP.php, method Net_FTP::setSsl()
    Set to connect through secure SSL connection
setTimeout
in file FTP.php, method Net_FTP::setTimeout()
    Set the timeout for FTP operations
setUsername
in file FTP.php, method Net_FTP::setUsername()
    Set the Username
site
in file FTP.php, method Net_FTP::site()
    Execute a SITE command on the server This method tries to execute a SITE command on the ftp server.
size
in file FTP.php, method Net_FTP::size()
    This will return the size of a given file in bytes. You can either give this function a relative or an absolute file-path. NOTE: Some servers do not support this feature!
top

Documentation generated on Wed, 09 Dec 2015 23:13:38 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.