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


Classes:
Net_FTP
Net_FTP_Observer
Observer_ProgressUpload
Files:
FTP.php
index.php
observer.php
Observer.php
Socket.php
socket.php

File: FTP.php

Source Location: /Net_FTP-1.4.0a2/Net/FTP.php

Classes:

Net_FTP
Class for comfortable FTP-communication

Page Details:

Net_FTP main file.

This file must be included to use the Net_FTP package.

PHP versions 4 and 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.

Includes:

require_once('PEAR.php') [line 31]
Include PEAR.php to obtain the PEAR base class

NET_FTP_BLOCKING [line 77]

NET_FTP_BLOCKING = 1,true
Option to indicate that non-blocking features should not be used in put(). This will also disable the listener functionality as a side effect.

[ Top ]


NET_FTP_DIRS_FILES [line 58]

NET_FTP_DIRS_FILES = 2,true
Option to let the ls() method return directories and files (default).

[ Top ]


NET_FTP_DIRS_ONLY [line 49]

NET_FTP_DIRS_ONLY = 1,true
Option to let the ls() method return only directories.

[ Top ]


NET_FTP_ERR_BADOPTIONS [line 531]

NET_FTP_ERR_BADOPTIONS = -39
Error code indicating that bad options were supplied to the put() method.

[ Top ]


NET_FTP_ERR_CHMOD_FAILED [line 177]

NET_FTP_ERR_CHMOD_FAILED = -7
Error code to indicate that the CHMOD command failed.

The execution of CHMOD failed. Ensure, that your FTP server supports the CHMOD command and that you have the appropriate access rights to use CHMOD.


[ Top ]


NET_FTP_ERR_CONNECT_FAILED [line 100]

NET_FTP_ERR_CONNECT_FAILED = -1
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)!

[ Top ]


NET_FTP_ERR_CREATEDIR_FAILED [line 143]

NET_FTP_ERR_CREATEDIR_FAILED = -4
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!

[ Top ]


NET_FTP_ERR_CREATELOCALDIR_FAILED [line 326]

NET_FTP_ERR_CREATELOCALDIR_FAILED = -20
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.

[ Top ]


NET_FTP_ERR_DATEFORMAT_FAILED [line 222]

NET_FTP_ERR_DATEFORMAT_FAILED = -11
Error code to indicate that a date returned by the server was misformated

A date string returned by your server seems to be missformated and could not be parsed. Check that the server is configured correctly. If you're sure, please send an email to the auhtor with a dumped output of $ftp->ls('./', NET_FTP_RAWLIST); to get the date format supported.


[ Top ]


NET_FTP_ERR_DELETEDIR_FAILED [line 426]

NET_FTP_ERR_DELETEDIR_FAILED = -29
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.
  • See: Net_FTP::rm()
  • Since: 1.3
  • Name: NET_FTP_ERR_EXTFILEREAD_FAILED

[ Top ]


NET_FTP_ERR_DELETEFILE_FAILED [line 415]

NET_FTP_ERR_DELETEFILE_FAILED = -28
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.
  • See: Net_FTP::rm()
  • Since: 1.3
  • Name: NET_FTP_ERR_EXTFILEREAD_FAILED

[ Top ]


NET_FTP_ERR_DETERMINEPATH_FAILED [line 132]

NET_FTP_ERR_DETERMINEPATH_FAILED = 4
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.
  • See: Net_FTP::pwd()
  • Since: 1.3
  • Name: NET_FTP_ERR_DETERMINEPATH_FAILED

[ Top ]


NET_FTP_ERR_DIRCHANGE_FAILED [line 121]

NET_FTP_ERR_DIRCHANGE_FAILED = 2
Error code to indicate a failed directory change The cd() method failed. Ensure that the directory you wanted to access exists.
  • See: Net_FTP::cd()
  • Since: 1.3
  • Name: NET_FTP_ERR_DIRCHANGE_FAILED

[ Top ]


NET_FTP_ERR_DIRLIST_UNSUPPORTED [line 450]

NET_FTP_ERR_DIRLIST_UNSUPPORTED = -31
Error code to indicate that the directory listing failed

The directory listing format your server uses seems not to be supported by Net_FTP. Please send the output of the call ls('./', NET_FTP_RAWLIST); to the author of this class to get it supported.

  • See: Net_FTP::ls()
  • Since: 1.3
  • Name: NET_FTP_ERR_DIRLIST_UNSUPPORTED

[ Top ]


NET_FTP_ERR_DISCONNECT_FAILED [line 460]

NET_FTP_ERR_DISCONNECT_FAILED = -32
Error code to indicate failed disconnecting This error code indicates, that disconnection was not possible.

[ Top ]


NET_FTP_ERR_EXEC_FAILED [line 154]

NET_FTP_ERR_EXEC_FAILED = -5
Error code to indicate that the EXEC execution failed.

The execution of a command using EXEC failed. Ensure, that your FTP server supports the EXEC command.


[ Top ]


NET_FTP_ERR_EXTFILELOAD_FAILED [line 491]

NET_FTP_ERR_EXTFILELOAD_FAILED = -35
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.

[ Top ]


NET_FTP_ERR_EXTFILENOTEXIST [line 393]

NET_FTP_ERR_EXTFILENOTEXIST = -26
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.

[ Top ]


NET_FTP_ERR_EXTFILEREAD_FAILED [line 404]

NET_FTP_ERR_EXTFILEREAD_FAILED = -27
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.

[ Top ]


NET_FTP_ERR_HOSTNAMENOSTRING [line 337]

NET_FTP_ERR_HOSTNAMENOSTRING = -21
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.

[ Top ]


NET_FTP_ERR_ILLEGALMAP [line 511]

NET_FTP_ERR_ILLEGALMAP = -37
Error code to indicate that the directory listing matcher map provided is not an array.

[ Top ]


NET_FTP_ERR_ILLEGALMAPVALUE [line 521]

NET_FTP_ERR_ILLEGALMAPVALUE = -38
Error code to indicate that the directory listing matcher map provided contains wrong values (ie: it contains non-numerical values)

[ Top ]


NET_FTP_ERR_ILLEGALPATTERN [line 501]

NET_FTP_ERR_ILLEGALPATTERN = -36
Error code to indicate that the directory listing pattern provided is not a string.

[ Top ]


NET_FTP_ERR_LOCALFILENOTEXIST [line 267]

NET_FTP_ERR_LOCALFILENOTEXIST = -15
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.

[ Top ]


NET_FTP_ERR_LOCALPATHNODIR [line 314]

NET_FTP_ERR_LOCALPATHNODIR = -19
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 /.

[ Top ]


NET_FTP_ERR_LOGIN_FAILED [line 111]

NET_FTP_ERR_LOGIN_FAILED = -2
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).

[ Top ]


NET_FTP_ERR_MDTMDIR_UNSUPPORTED [line 199]

NET_FTP_ERR_MDTMDIR_UNSUPPORTED = -9
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.

[ Top ]


NET_FTP_ERR_MDTM_FAILED [line 209]

NET_FTP_ERR_MDTM_FAILED = -10
Error code to indicate that the MDTM command failed The MDTM command failed. Ensure that your server supports the MDTM command.

[ Top ]


NET_FTP_ERR_NOMODECONST [line 359]

NET_FTP_ERR_NOMODECONST = -23
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.

[ Top ]


NET_FTP_ERR_OVERWRITELOCALFILE_FAILED [line 257]

NET_FTP_ERR_OVERWRITELOCALFILE_FAILED = -14
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.

[ Top ]


NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN [line 245]

NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN = -13
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.

[ Top ]


NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN [line 279]

NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN = -16
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.

[ Top ]


NET_FTP_ERR_PASSWORDNOSTRING [line 480]

NET_FTP_ERR_PASSWORDNOSTRING = -34
Error code to indicate that the username you provided was invalid.

Check that you provided a non-empty string as the username.

  • See: Net_FTP::setPassword()
  • Since: 1.3
  • Name: NET_FTP_ERR_PASSWORDNOSTRING

[ Top ]


NET_FTP_ERR_PORTLESSZERO [line 348]

NET_FTP_ERR_PORTLESSZERO = -22
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.

[ Top ]


NET_FTP_ERR_RAWDIRLIST_FAILED [line 437]

NET_FTP_ERR_RAWDIRLIST_FAILED = -30
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.
  • See: Net_FTP::ls()
  • Since: 1.3
  • Name: NET_FTP_ERR_RAWDIRLIST_FAILED

[ Top ]


NET_FTP_ERR_REMOTEPATHNODIR [line 302]

NET_FTP_ERR_REMOTEPATHNODIR = -18
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 /.

[ Top ]


NET_FTP_ERR_RENAME_FAILED [line 188]

NET_FTP_ERR_RENAME_FAILED = -8
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.

[ Top ]


NET_FTP_ERR_SETTIMEOUT_FAILED [line 382]

NET_FTP_ERR_SETTIMEOUT_FAILED = -25
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.

[ Top ]


NET_FTP_ERR_SITE_FAILED [line 165]

NET_FTP_ERR_SITE_FAILED = -6
Error code to indicate that the SITE command failed.

The execution of a command using SITE failed. Ensure, that your FTP server supports the SITE command.


[ Top ]


NET_FTP_ERR_SIZE_FAILED [line 233]

NET_FTP_ERR_SIZE_FAILED = -12
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.

[ Top ]


NET_FTP_ERR_TIMEOUTLESSZERO [line 370]

NET_FTP_ERR_TIMEOUTLESSZERO = -24
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.

[ Top ]


NET_FTP_ERR_UPLOADFILE_FAILED [line 290]

NET_FTP_ERR_UPLOADFILE_FAILED = -17
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.

[ Top ]


NET_FTP_ERR_USERNAMENOSTRING [line 470]

NET_FTP_ERR_USERNAMENOSTRING = -33
Error code to indicate that the username you provided was invalid.

Check that you provided a non-empty string as the username.


[ Top ]


NET_FTP_FILES_ONLY [line 40]

NET_FTP_FILES_ONLY = 0,true
Option to let the ls() method return only files.

[ Top ]


NET_FTP_NONBLOCKING [line 89]

NET_FTP_NONBLOCKING = 2,true
Option to indicate that non-blocking features should be used if available in put(). This will also enable the listener functionality.

This is the default behaviour.


[ Top ]


NET_FTP_RAWLIST [line 67]

NET_FTP_RAWLIST = 3,true
Option to let the ls() method return the raw directory listing from ftp_rawlist()

[ Top ]


Documentation generated on Mon, 19 May 2008 16:00:05 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.