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

Element index for package apidoc

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

a

addExtension
in file FTP.php, method Net_FTP::addExtension()
    Adds an extension to a mode-directory The mode-directory saves file-extensions coresponding to filetypes (ascii e.g.: 'php', 'txt', 'htm',...; binary e.g.: 'jpg', 'gif', 'exe',...).
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
top

e

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

g

get
in file FTP.php, method Net_FTP::get()
    This function will download a file from the ftp-server. You can either spcify a absolute
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
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.
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

i

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

l

login
in file FTP.php, method Net_FTP::login()
    This logges 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
top

p

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
putRecursive
in file FTP.php, method Net_FTP::putRecursive()
    This functionality allows you to transfer a whole directory-structure from your local host to the remote-ftp. You have to give a remote-directory (ending with '/') and the local directory (ending with '/') where to put the files you download.
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

setActive
in file FTP.php, method Net_FTP::setActive()
    Set the transfer-method to active mode
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
setTimeout
in file FTP.php, method Net_FTP::setTimeout()
    Set the timeout for FTP operations Use this method to set a timeout for FTP operation. Timeout has to be an integer.
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 Mon, 11 Mar 2019 13:55:47 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.