[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
sander Fri Mar 29 14:20:41 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: Removed incorrect para tags. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.45 phpdoc/en/functions/ftp.xml:1.46 --- phpdoc/en/functions/ftp.xml:1.45Fri Mar 29 14:08:10 2002 +++ phpdoc/en/functions/ftp.xml Fri Mar 29 14:20:38 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.45 $ -- +!-- $Revision: 1.46 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -32,9 +32,7 section id=ftp.configuration titleConfiguration/title - para -no.config; - /para + no.config; /section section id=ftp.resources
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml readline.xml
sander Thu Mar 28 11:23:51 2002 EDT Modified files: /phpdoc/en/functionsftp.xml readline.xml Log: Updated ftp and readline docs: splitted the intro-sections. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.43 phpdoc/en/functions/ftp.xml:1.44 --- phpdoc/en/functions/ftp.xml:1.43Sat Mar 23 12:31:02 2002 +++ phpdoc/en/functions/ftp.xml Thu Mar 28 11:23:51 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.43 $ -- +!-- $Revision: 1.44 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -11,21 +11,54 ulink url=spec.ftp;spec.ftp;/ulink. /para + section id=ftp.requirements + titleRequirements/title + para +The FTP-extension has no special requirements. It's completely contained +in PHP. + /para + /section + + section id=ftp.installation + titleInstallation/title + para +In order to use FTP functions with your PHP configuration, you should +add the link linkend=install.configure.enable-ftp +option role=configure--enable-ftp/option/link option when +installing PHP 4, and link linkend=install.configure.with-ftp +option role=configure--with-ftp/option/link when using PHP 3. + /para + /section + + section id=ftp.configuration + titleConfiguration/title + para +This extensions does not define any configuration directives. + /para + /section + + section id=ftp.resources + titleResource types/title + para +This extension uses one resource-type, which is the link-identifier +of the ftp-connection. + /para + /section + + section id=ftp.constants + titleConstants/title para The following constants are defined when using the FTP module: constantFTP_ASCII/constant and constantFTP_BINARY/constant. /para - para - In order to use FTP functions with your PHP configuration, you should - add the link linkend=install.configure.enable-ftp - option--enable-ftp/option/link option when installing PHP 4, - and link linkend=install.configure.with-ftp - option--with-ftp/option/link when using PHP 3. - /para - para - example -titleFTP/title - programlisting + /section + + section id=ftp.examples + titleExample/title + para +example + titleFTP example/title + programlisting role=php ![CDATA[ ?php // set up basic connection -57,9 +90,10 ftp_close($conn_id); ? ]] - /programlisting -/example - /para + /programlisting + /example +/para + /section /partintro refentry id=function.ftp-connect Index: phpdoc/en/functions/readline.xml diff -u phpdoc/en/functions/readline.xml:1.17 phpdoc/en/functions/readline.xml:1.18 --- phpdoc/en/functions/readline.xml:1.17 Sat Feb 2 10:36:08 2002 +++ phpdoc/en/functions/readline.xmlThu Mar 28 11:23:51 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.17 $ -- +!-- $Revision: 1.18 $ -- reference id=ref.readline titleGNU Readline/title titleabbrevReadline/titleabbrev -15,11 +15,46 but may be useful when writing scripts meant to be run from a shell. /simpara - simpara -The home page of the GNU Readline project is -ulink url=url.readline;url.readline;/ulink. It's maintained -by Chet Ramey, who's also the author of Bash. - /simpara + + section id=readline.requirements +titleRequirements/title +para + To use the readline functions, you need to install libreadline and + compile PHP with support for readline. +/para + /section + + section id=readline.installation +titleInstallation/title +para + To compile PHP with readline support, you need to configure PHP + option role=configure--with-readline/option after you've installed + libreadline. You can find libreadline on the home page of the GNU + Readline project, at ulink url=url.readline;url.readline;/ulink. + It's maintained by Chet Ramey, who's also the author of Bash. +/para + /section + + section id=readline.configuration +titleRuntime Configuration/title +para + This extensions does not define any configuration directives. +/para + /section + + section id=readline.resources +titleResource types/title +para + This extension does not define any resource types. +/para + /section + + section id=readline.constants +titlePredefined constants/title +para + This extension does not define any constants. +/para + /section /partintro refentry id=function.readline
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
cortesi Sat Mar 23 12:27:43 2002 EDT
Modified files:
/phpdoc/en/functionsftp.xml
Log:
ftp is not a function name, so removing from example title
more uppercasing ftp
removing dots from refpurpose, where needed
Index: phpdoc/en/functions/ftp.xml
diff -u phpdoc/en/functions/ftp.xml:1.41 phpdoc/en/functions/ftp.xml:1.42
--- phpdoc/en/functions/ftp.xml:1.41Fri Mar 22 17:18:47 2002
+++ phpdoc/en/functions/ftp.xml Sat Mar 23 12:27:43 2002
-1,5 +1,5
?xml version=1.0 encoding=iso-8859-1?
-!-- $Revision: 1.41 $ --
+!-- $Revision: 1.42 $ --
reference id=ref.ftp
titleFTP functions/title
titleabbrevFTP/titleabbrev
-24,7 +24,7
/para
para
example
-titlefunctionftp/function example/title
+titleFTP/title
programlisting
![CDATA[
?php
-36,7 +36,7
// check connection
if ((!$conn_id) || (!$login_result)) {
-echo Ftp connection has failed!;
+echo FTP connection has failed!;
echo Attempted to connect to $ftp_server for user $ftp_user_name;
die;
} else {
-48,7 +48,7
// check upload status
if (!$upload) {
-echo Ftp upload has failed!;
+echo FTP upload has failed!;
} else {
echo Uploaded $source_file to $ftp_server as $destination_file;
}
-222,7 +222,7
refentry id=function.ftp-nlist
refnamediv
refnameftp_nlist/refname
-refpurposeReturns a list of files in the given directory./refpurpose
+refpurposeReturns a list of files in the given directory/refpurpose
/refnamediv
refsect1
titleDescription/title
-266,7 +266,7
refnamediv
refnameftp_systype/refname
refpurpose
- Returns the system type identifier of the remote FTP server.
+ Returns the system type identifier of the remote FTP server
/refpurpose
/refnamediv
refsect1
-284,7 +284,7
refentry id=function.ftp-pasv
refnamediv
refnameftp_pasv/refname
-refpurposeTurns passive mode on or off./refpurpose
+refpurposeTurns passive mode on or off/refpurpose
/refnamediv
refsect1
titleDescription/title
-309,7 +309,7
refentry id=function.ftp-get
refnamediv
refnameftp_get/refname
-refpurposeDownloads a file from the FTP server./refpurpose
+refpurposeDownloads a file from the FTP server/refpurpose
/refnamediv
refsect1
titleDescription/title
-339,8 +339,7
refentry id=function.ftp-fget
refnamediv
refnameftp_fget/refname
-refpurposeDownloads a file from the FTP server and saves to an
- open file./refpurpose
+refpurposeDownloads a file from the FTP server and saves to an open
+file/refpurpose
/refnamediv
refsect1
titleDescription/title
-367,7 +366,7
refentry id=function.ftp-put
refnamediv
refnameftp_put/refname
-refpurposeUploads a file to the FTP server./refpurpose
+refpurposeUploads a file to the FTP server/refpurpose
/refnamediv
refsect1
titleDescription/title
-403,7 +402,7
refentry id=function.ftp-fput
refnamediv
refnameftp_fput/refname
-refpurposeUploads from an open file to the FTP server./refpurpose
+refpurposeUploads from an open file to the FTP server/refpurpose
/refnamediv
refsect1
titleDescription/title
-430,7 +429,7
refentry id=function.ftp-size
refnamediv
refnameftp_size/refname
-refpurposeReturns the size of the given file./refpurpose
+refpurposeReturns the size of the given file/refpurpose
/refnamediv
refsect1
titleDescription/title
-453,7 +452,7
refentry id=function.ftp-mdtm
refnamediv
refnameftp_mdtm/refname
-refpurposeReturns the last modified time of the given file./refpurpose
+refpurposeReturns the last modified time of the given file/refpurpose
/refnamediv
refsect1
titleDescription/title
-482,7 +481,7
refentry id=function.ftp-rename
refnamediv
refnameftp_rename/refname
-refpurposeRenames a file on the ftp server./refpurpose
+refpurposeRenames a file on the FTP server/refpurpose
/refnamediv
refsect1
titleDescription/title
-507,7 +506,7
refentry id=function.ftp-delete
refnamediv
refnameftp_delete/refname
-refpurposeDeletes a file on the ftp server./refpurpose
+refpurposeDeletes a file on the FTP server/refpurpose
/refnamediv
refsect1
titleDescription/title
-529,7 +528,7
refentry id=function.ftp-site
refnamediv
refnameftp_site/refname
-refpurposeSends a SITE command to the server./refpurpose
+refpurposeSends a SITE command to the server/refpurpose
/refnamediv
refsect1
titleDescription/title
-751,4 +750,3
vim: et tw=78 syn=xml
vi: ts=1 sw=1
--
-
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
cortesi Sat Mar 23 12:31:02 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: some dots where left Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.42 phpdoc/en/functions/ftp.xml:1.43 --- phpdoc/en/functions/ftp.xml:1.42Sat Mar 23 12:27:43 2002 +++ phpdoc/en/functions/ftp.xml Sat Mar 23 12:31:02 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.42 $ -- +!-- $Revision: 1.43 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -241,9 +241,7 refentry id=function.ftp-rawlist refnamediv refnameftp_rawlist/refname -refpurpose - Returns a detailed list of files in the given directory. -/refpurpose +refpurposeReturns a detailed list of files in the given directory/refpurpose /refnamediv refsect1 titleDescription/title -265,9 +263,7 refentry id=function.ftp-systype refnamediv refnameftp_systype/refname -refpurpose - Returns the system type identifier of the remote FTP server -/refpurpose +refpurposeReturns the system type identifier of the remote FTP +server/refpurpose /refnamediv refsect1 titleDescription/title -595,9 +591,7 refentry id='function.ftp-exec' refnamediv refnameftp_exec/refname -refpurpose - Request execution of a program on the FTP server. -/refpurpose +refpurposeRequest execution of a program on the FTP server/refpurpose /refnamediv refsect1 titleDescription/title -617,9 +611,7 refentry id='function.ftp-set-option' refnamediv refnameftp_set_option/refname -refpurpose - Set miscellaneous runtime FTP options. -/refpurpose +refpurposeSet miscellaneous runtime FTP options/refpurpose /refnamediv refsect1 titleDescription/title -677,9 +669,7 refentry id='function.ftp-get-option' refnamediv refnameftp_get_option/refname -refpurpose - Retrieves various runtime behaviours of the current FTP stream. -/refpurpose +refpurposeRetrieves various runtime behaviours of the current FTP +stream/refpurpose /refnamediv refsect1 titleDescription/title
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
cortesi Fri Mar 22 13:20:50 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: correcting function prototype as of PHP source code: it returns mixed and not bool. Plus some rewording: check my bad english, please Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.39 phpdoc/en/functions/ftp.xml:1.40 --- phpdoc/en/functions/ftp.xml:1.39Wed Mar 20 06:50:38 2002 +++ phpdoc/en/functions/ftp.xml Fri Mar 22 13:20:50 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.39 $ -- +!-- $Revision: 1.40 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -99,7 +99,6 /refsect1 /refentry - refentry id=function.ftp-login refnamediv refnameftp_login/refname -686,7 +685,7 refsect1 titleDescription/title methodsynopsis - typebool/typemethodnameftp_get_option/methodname + typemixed/typemethodnameftp_get_option/methodname methodparamtyperesource/typeparameterstream/parameter/methodparam methodparamtypeint/typeparameteroption/parameter/methodparam /methodsynopsis -696,14 +695,14 /para /note para - Returns the value on success or false; if the given - parameteroption/parameter is not supposed. In the latter case a + Returns the value on success, or false; if the given + parameteroption/parameter is not supported. In the latter case, a warning message is also thrown. /para para - This function returns the parametervalue/parameter for the requested - parameteroption/parameter from the specified parameterFTP - stream/parameter. Currently, the following options are supported: + This function returns the value for the requested + parameteroption/parameter from the specified parameterstream + /parameter. Currently, the following options are supported: table titleSupported runtime FTP options/title tgroup cols=2
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
cortesi Fri Mar 22 17:18:47 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: FTP to uppercase and linking to FTP specs Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.40 phpdoc/en/functions/ftp.xml:1.41 --- phpdoc/en/functions/ftp.xml:1.40Fri Mar 22 13:20:50 2002 +++ phpdoc/en/functions/ftp.xml Fri Mar 22 17:18:47 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.40 $ -- +!-- $Revision: 1.41 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -8,7 +8,7 para The functions in this extension implement client access to file servers speaking the File Transfer Protocol FTP as defined in -spec.ftp;. +ulink url=spec.ftp;spec.ftp;/ulink. /para para -597,7 +597,7 refnamediv refnameftp_exec/refname refpurpose - Request execution of a program on the ftp server. + Request execution of a program on the FTP server. /refpurpose /refnamediv refsect1 -608,7 +608,7 methodparamtypestring/typeparametercommand/parameter/methodparam /methodsynopsis para - Sends a SITE EXEC parametercommand/parameter request to the ftp + Sends a SITE EXEC parametercommand/parameter request to the FTP server. Returns false; if the request fails, returns the output of the command otherwise. /para
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
cortesi Wed Mar 20 06:50:39 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: typo Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.38 phpdoc/en/functions/ftp.xml:1.39 --- phpdoc/en/functions/ftp.xml:1.38Sat Feb 2 10:35:59 2002 +++ phpdoc/en/functions/ftp.xml Wed Mar 20 06:50:38 2002 -1,5 +1,5 ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.38 $ -- +!-- $Revision: 1.39 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev -92,7 +92,7 functionftp_get_option/function. note para - This is parameter is only available in CVS. + This parameter is only available in CVS. /para /note /para
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
irc-htmlWed Jan 16 11:44:59 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: incorporated user note; ftp_size returns size in bytes Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.36 phpdoc/en/functions/ftp.xml:1.37 --- phpdoc/en/functions/ftp.xml:1.36Sat Jan 12 11:28:50 2002 +++ phpdoc/en/functions/ftp.xml Wed Jan 16 11:44:59 2002 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.36 $ -- +!-- $Revision: 1.37 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -477,9 +477,10 @@ /funcprototype /funcsynopsis para - functionftp_size/function returns the size of a file. If an + functionftp_size/function returns the size of a file in bytes. If an error occurs, of if the file does not exist, -1 is returned. Not - all servers support this feature./para + all servers support this feature. +/para para Returns the file size on success, or -1 on error. /para
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
mfischerWed Jan 2 21:43:12 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: - Go along with latest CVS changes. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.31 phpdoc/en/functions/ftp.xml:1.32 --- phpdoc/en/functions/ftp.xml:1.31Tue Jan 1 20:07:03 2002 +++ phpdoc/en/functions/ftp.xml Wed Jan 2 21:43:12 2002 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.31 $ -- +!-- $Revision: 1.32 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -73,8 +73,8 @@ funcprototype funcdefresource functionftp_connect/function/funcdef paramdefstring parameterhost/parameter/paramdef - paramdefint parameteroptionalport/optional - /parameter/paramdef + paramdefint parameteroptionalport/optional/paramdef/paramdef + paramdefint parameteroptionaltimeout/optional/parameter/paramdef /funcprototype /funcsynopsis para @@ -86,6 +86,18 @@ parameter specifies an alternate port to connect to. If it is omitted or zero, then the default FTP port, 21, will be used. /para +para + The parametertimeout/parameter parameter specifies the timeout for all + subsequent network operations. If ommited, the default value is 90 + seconds. The timeout can be changed and queried anytime with + functionftp_set_option/function and + functionftp_get_option/function. + note + para + This is parameter is only available in CVS. + /para + /note +/para /refsect1 /refentry @@ -616,6 +628,123 @@ /funcsynopsis para warn.undocumented.func; +/para + /refsect1 + /refentry + + refentry id='function.ftp-set-option' + refnamediv +refnameftp_set_option/refname +refpurpose + Set miscellaneous runtime FTP options. +/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefbool functionftp_set_option/function/funcdef + paramdefresource parameterstream/parameter/paramdef + paramdefint parameteroption/parameter/paramdef + paramdefmixed parametervalue/parameter/paramdef + /funcprototype +/funcsynopsis +note + para + This function is only available in CVS. + /para +/note +para + Returns true; if the option could be set; false; if not. A warning + message will be thrown if the parameteroption/parameter is not + supported or the passed parametervalue/parameter doesn't match the + expected value for the given parameteroption/parameter. +/para +para + This function controls various runtime options for the specified FTP + stream. The parametervalue/parameter parameter depends on which + parameteroption/parameter parameter is choosen to be altered. + Currently, the following options are supported: + table + titleSupported runtime FTP options/title + tgroup cols=2 + tbody +row + entrymemberFTP_TIMEOUT_SEC/member/entry + entryChanges the timeout in seconds used for all network related + functions. Parameter parametervalue/parameter has be to of type + int and must be greater than 0. The default timeout is 90 + seconds./entry +/row + /tbody + /tgroup + /table +/para +para + example + titlefunctionftp_set_option/function example/title + programlisting role=php +![CDATA[ +// Set the network timeout down to 10 seconds +ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10); +]] + /programlistuing +/para + /refsect1 + /refentry + + refentry id='function.ftp-get-option' + refnamediv +refnameftp_get_option/refname +refpurpose + Retrieves various runtime behaviours of the current FTP stream. +/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefbool functionftp_get_option/function/funcdef + paramdefresource parameterstream/parameter/paramdef + paramdefint parameteroption/parameter/paramdef + /funcprototype +/funcsynopsis +note + para + This function is only available in CVS. + /para +/note +para + Returns the value on success or false; if the given + parameteroption/parameter is not supposed. In the latter case a + warning message is also thrown. +/para +para + This function returns the parametervalue/parameter for the requested + parameteroption/parameter from the specified parameterFTP + stream/parameter. Currently, the following options are supported: + table + titleSupported runtime FTP options/title + tgroup cols=2 + tbody +row + entrymemberFTP_TIMEOUT_SEC/member/entry + entryReturns the current timeout used for network related + operations./entry +/row + /tbody +
Re: [PHP-DOC] cvs: phpdoc /en/functions ftp.xml
/phpdoc/en/functions/ftp.xml is broken. Did you happen to make test? Best Regards, Kenneth Schwartz E-mail: [EMAIL PROTECTED] On Thu, 03 Jan 2002 02:43:12 - Markus Fischer [EMAIL PROTECTED] wrote: mfischer Wed Jan 2 21:43:12 2002 EDT Modified files: /phpdoc/en/functions ftp.xml Log: - Go along with latest CVS changes. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.31 phpdoc/en/functions/ftp.xml:1.32 --- phpdoc/en/functions/ftp.xml:1.31 Tue Jan 1 20:07:03 2002 +++ phpdoc/en/functions/ftp.xml Wed Jan 2 21:43:12 2002 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.31 $ -- +!-- $Revision: 1.32 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -73,8 +73,8 @@ funcprototype funcdefresource functionftp_connect/function/funcdef paramdefstring parameterhost/parameter/paramdef - paramdefint parameteroptionalport/optional - /parameter/paramdef + paramdefint parameteroptionalport/optional/paramdef/paramdef + paramdefint parameteroptionaltimeout/optional/parameter/paramdef /funcprototype /funcsynopsis para @@ -86,6 +86,18 @@ parameter specifies an alternate port to connect to. If it is omitted or zero, then the default FTP port, 21, will be used. /para +para + The parametertimeout/parameter parameter specifies the timeout for all + subsequent network operations. If ommited, the default value is 90 + seconds. The timeout can be changed and queried anytime with + functionftp_set_option/function and + functionftp_get_option/function. + note + para + This is parameter is only available in CVS. + /para + /note +/para /refsect1 /refentry @@ -616,6 +628,123 @@ /funcsynopsis para warn.undocumented.func; +/para + /refsect1 + /refentry + + refentry id='function.ftp-set-option' + refnamediv +refnameftp_set_option/refname +refpurpose + Set miscellaneous runtime FTP options. +/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefbool functionftp_set_option/function/funcdef + paramdefresource parameterstream/parameter/paramdef + paramdefint parameteroption/parameter/paramdef + paramdefmixed parametervalue/parameter/paramdef + /funcprototype +/funcsynopsis +note + para + This function is only available in CVS. + /para +/note +para + Returns true; if the option could be set; false; if not. A warning + message will be thrown if the parameteroption/parameter is not + supported or the passed parametervalue/parameter doesn't match the + expected value for the given parameteroption/parameter. +/para +para + This function controls various runtime options for the specified FTP + stream. The parametervalue/parameter parameter depends on which + parameteroption/parameter parameter is choosen to be altered. + Currently, the following options are supported: + table + titleSupported runtime FTP options/title + tgroup cols=2 + tbody +row + entrymemberFTP_TIMEOUT_SEC/member/entry + entryChanges the timeout in seconds used for all network related + functions. Parameter parametervalue/parameter has be to of type + int and must be greater than 0. The default timeout is 90 + seconds./entry +/row + /tbody + /tgroup + /table +/para +para + example + titlefunctionftp_set_option/function example/title + programlisting role=php +![CDATA[ +// Set the network timeout down to 10 seconds +ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10); +]] + /programlistuing +/para + /refsect1 + /refentry + + refentry id='function.ftp-get-option' + refnamediv +refnameftp_get_option/refname +refpurpose + Retrieves various runtime behaviours of the current FTP stream. +/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefbool functionftp_get_option/function/funcdef + paramdefresource parameterstream/parameter/paramdef + paramdefint parameteroption/parameter/paramdef + /funcprototype +/funcsynopsis +note + para + This function is only available in CVS. + /para +/note +para + Returns the value on success or false; if the given + parameteroption/parameter is not supposed. In the latter case a + warning message is also thrown. +/para +para + This function returns the parametervalue/parameter for the requested + parameteroption/parameter from the specified parameterFTP +
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
irc-htmlWed Jan 2 22:34:32 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: fixed errors, makeable now Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.32 phpdoc/en/functions/ftp.xml:1.33 --- phpdoc/en/functions/ftp.xml:1.32Wed Jan 2 21:43:12 2002 +++ phpdoc/en/functions/ftp.xml Wed Jan 2 22:34:31 2002 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.32 $ -- +!-- $Revision: 1.33 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -73,8 +73,12 @@ funcprototype funcdefresource functionftp_connect/function/funcdef paramdefstring parameterhost/parameter/paramdef - paramdefint parameteroptionalport/optional/paramdef/paramdef - paramdefint parameteroptionaltimeout/optional/parameter/paramdef + paramdefint + parameteroptionalport/optional/parameter + /paramdef + paramdefint + parameteroptionaltimeout/optional/parameter + /paramdef /funcprototype /funcsynopsis para @@ -670,7 +674,7 @@ tgroup cols=2 tbody row - entrymemberFTP_TIMEOUT_SEC/member/entry + entryFTP_TIMEOUT_SEC/entry entryChanges the timeout in seconds used for all network related functions. Parameter parametervalue/parameter has be to of type int and must be greater than 0. The default timeout is 90 @@ -688,7 +692,8 @@ // Set the network timeout down to 10 seconds ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10); ]] - /programlistuing + /programlisting + /example /para /refsect1 /refentry @@ -728,7 +733,7 @@ tgroup cols=2 tbody row - entrymemberFTP_TIMEOUT_SEC/member/entry + entryFTP_TIMEOUT_SEC/entry entryReturns the current timeout used for network related operations./entry /row @@ -744,7 +749,8 @@ // Get the timeout of the given FTP stream $timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC); ]] - /programlistuing + /programlisting + /example /para /refsect1 /refentry
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
zak Thu Jan 3 02:11:56 2002 EDT Modified files: /phpdoc/en/functionsftp.xml Log: Added documentation for ftp_close and ftp_exec. Fixed docs for ftp_quit. Minor return value fixes. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.33 phpdoc/en/functions/ftp.xml:1.34 --- phpdoc/en/functions/ftp.xml:1.33Wed Jan 2 22:34:31 2002 +++ phpdoc/en/functions/ftp.xml Thu Jan 3 02:11:55 2002 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.33 $ -- +!-- $Revision: 1.34 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -54,7 +54,7 @@ } // close the FTP stream -ftp_quit($conn_id); +ftp_close($conn_id); ? ]] /programlisting @@ -316,7 +316,7 @@ funcsynopsis funcprototype funcdefbool functionftp_pasv/function/funcdef - paramdefint parameterftp_stream/parameter/paramdef + paramdefresource parameterftp_stream/parameter/paramdef paramdefbool parameterpasv/parameter/paramdef /funcprototype /funcsynopsis @@ -595,6 +595,25 @@ /refsect1 /refentry + refentry id=function.ftp-close + refnamediv +refnameftp_close/refname +refpurposeCloses an FTP connection/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefvoid functionftp_close/function/funcdef + paramdefresource parameterftp_stream/parameter/paramdef + /funcprototype +/funcsynopsis +para + functionftp_close/function closes parameterftp_stream/parameter. +/para + /refsect1 + /refentry + refentry id=function.ftp-quit refnamediv refnameftp_quit/refname @@ -604,12 +623,13 @@ titleDescription/title funcsynopsis funcprototype - funcdefboid functionftp_quit/function/funcdef + funcdefvoid functionftp_quit/function/funcdef paramdefresource parameterftp_stream/parameter/paramdef /funcprototype /funcsynopsis para - functionftp_quit/function closes parameterftp_stream/parameter. + functionftp_quit/function is an alias for + functionftp_close/function. /para /refsect1 /refentry @@ -631,7 +651,9 @@ /funcprototype /funcsynopsis para - warn.undocumented.func; + Sends a SITE EXEC parametercommand/parameter request to the ftp + server. Returns false; if the request fails, returns the output of the + command otherwise. /para /refsect1 /refentry
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
mfischerTue Jan 1 20:07:04 2002 EDT
Modified files:
/phpdoc/en/functionsftp.xml
Log:
- Fixed prototypes and removed superfluous quotes in examples.
Index: phpdoc/en/functions/ftp.xml
diff -u phpdoc/en/functions/ftp.xml:1.30 phpdoc/en/functions/ftp.xml:1.31
--- phpdoc/en/functions/ftp.xml:1.30Sat Dec 15 09:37:18 2001
+++ phpdoc/en/functions/ftp.xml Tue Jan 1 20:07:03 2002
@@ -1,5 +1,5 @@
?xml version=1.0 encoding=iso-8859-1?
-!-- $Revision: 1.30 $ --
+!-- $Revision: 1.31 $ --
reference id=ref.ftp
titleFTP functions/title
titleabbrevFTP/titleabbrev
@@ -29,10 +29,10 @@
![CDATA[
?php
// set up basic connection
-$conn_id = ftp_connect($ftp_server);
+$conn_id = ftp_connect($ftp_server);
// login with username and password
-$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
+$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
// check connection
if ((!$conn_id) || (!$login_result)) {
@@ -44,7 +44,7 @@
}
// upload the file
-$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY);
+$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY);
// check upload status
if (!$upload) {
@@ -71,7 +71,7 @@
titleDescription/title
funcsynopsis
funcprototype
- funcdefint functionftp_connect/function/funcdef
+ funcdefresource functionftp_connect/function/funcdef
paramdefstring parameterhost/parameter/paramdef
paramdefint parameteroptionalport/optional
/parameter/paramdef
@@ -99,8 +99,8 @@
titleDescription/title
funcsynopsis
funcprototype
- funcdefint functionftp_login/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ funcdefbool functionftp_login/function/funcdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterusername/parameter/paramdef
paramdefstring parameterpassword/parameter/paramdef
/funcprototype
@@ -124,7 +124,7 @@
funcsynopsis
funcprototype
funcdefstring functionftp_pwd/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ paramdefresource parameterftp_stream/parameter/paramdef
/funcprototype
/funcsynopsis
para
@@ -142,8 +142,8 @@
titleDescription/title
funcsynopsis
funcprototype
- funcdefint functionftp_cdup/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ funcdefbool functionftp_cdup/function/funcdef
+ paramdefresource parameterftp_stream/parameter/paramdef
/funcprototype
/funcsynopsis
para
@@ -164,8 +164,8 @@
titleDescription/title
funcsynopsis
funcprototype
- funcdefint functionftp_chdir/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ funcdefbool functionftp_chdir/function/funcdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterdirectory/parameter/paramdef
/funcprototype
/funcsynopsis
@@ -187,7 +187,7 @@
funcsynopsis
funcprototype
funcdefstring functionftp_mkdir/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterdirectory/parameter/paramdef
/funcprototype
/funcsynopsis
@@ -195,7 +195,8 @@
Creates the specified parameterdirectory/parameter.
/para
para
- Returns the newly created directory name on success, false; on error./para
+ Returns the newly created directory name on success, false; on error.
+/para
/refsect1
/refentry
@@ -208,8 +209,8 @@
titleDescription/title
funcsynopsis
funcprototype
- funcdefint functionftp_rmdir/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ funcdefbool functionftp_rmdir/function/funcdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterdirectory/parameter/paramdef
/funcprototype
/funcsynopsis
@@ -231,12 +232,13 @@
funcsynopsis
funcprototype
funcdefarray functionftp_nlist/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterdirectory/parameter/paramdef
/funcprototype
/funcsynopsis
para
- Returns an array of filenames on success, false; on error.
+ Returns an array of filenames from the specified directory
+ on success, false; on error.
/para
/refsect1
/refentry
@@ -253,7 +255,7 @@
funcsynopsis
funcprototype
funcdefarray functionftp_rawlist/function/funcdef
- paramdefint parameterftp_stream/parameter/paramdef
+ paramdefresource parameterftp_stream/parameter/paramdef
paramdefstring parameterdirectory/parameter/paramdef
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
hholzgraSat Dec 15 09:37:18 2001 EDT Modified files: /phpdoc/en/functionsftp.xml Log: added skeleton for missing function Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.29 phpdoc/en/functions/ftp.xml:1.30 --- phpdoc/en/functions/ftp.xml:1.29Wed Dec 12 15:46:48 2001 +++ phpdoc/en/functions/ftp.xml Sat Dec 15 09:37:18 2001 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.29 $ -- +!-- $Revision: 1.30 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -595,7 +595,29 @@ /refsect1 /refentry -/reference + refentry id='function.ftp-exec' + refnamediv +refnameftp_exec/refname +refpurpose + Request execution of a program on the ftp server */ +/refpurpose + /refnamediv + refsect1 +titleDescription/title +funcsynopsis + funcprototype + funcdefint functionftp_exec/function/funcdef + paramdefint parameterstream/parameter/paramdef + paramdefstring parametercommand/parameter/paramdef + /funcprototype +/funcsynopsis +para + warn.undocumented.func; +/para + /refsect1 + /refentry + + /reference !-- Keep this comment at the end of the file Local variables: mode: sgml
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
jimwThu Dec 6 21:03:34 2001 EDT Modified files: /phpdoc/en/functionsftp.xml Log: ftp_get: see also ftp_fget Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.27 phpdoc/en/functions/ftp.xml:1.28 --- phpdoc/en/functions/ftp.xml:1.27Sat Nov 17 22:07:18 2001 +++ phpdoc/en/functions/ftp.xml Thu Dec 6 21:03:33 2001 @@ -1,5 +1,5 @@ ?xml version=1.0 encoding=iso-8859-1? -!-- $Revision: 1.27 $ -- +!-- $Revision: 1.28 $ -- reference id=ref.ftp titleFTP functions/title titleabbrevFTP/titleabbrev @@ -340,6 +340,9 @@ /para para Returns true; on success, false; on error. +/para +para + See also functionftp_fget/function. /para /refsect1 /refentry
Re: [PHP-DOC] cvs: phpdoc /en/functions ftp.xml
perugini Mon Nov 12 10:33:28 2001 EDT Modified files: /phpdoc/en/functions ftp.xml Log: Fixing Vim syntax option: syn=xml This is sgml in all the files. Modifying it in one place is Not a Good Idea (TM) IMHO. Either leave it as SGML, or start discussion about modifying it to be XML. There were some reasons to put sgml here... I am not using vim, so I don't now what was exactly the reason. Goba
Re: [PHP-DOC] cvs: phpdoc /en/functions ftp.xml
Hi Goba, On Wed, 2001-11-14 at 11:06, Gabor Hojtsy wrote: perugini Mon Nov 12 10:33:28 2001 EDT Modified files: /phpdoc/en/functions ftp.xml Log: Fixing Vim syntax option: syn=xml This is sgml in all the files. Modifying it in one place is Not a Good Idea (TM) IMHO. Either leave You're right. Infact it's on every file, so I've just fixed it on ftp.xml file it as SGML, or start discussion about modifying it to be XML. There were some reasons to put sgml here... I am not using vim, so I don't now what was exactly the reason. You need it for syntax highlight. Luk Goba -- Ing. Luca Perugini o Linux Consultant Editor PHP Manual Italian language o mailto:[EMAIL PROTECTED]
Re: [PHP-DOC] cvs: phpdoc /en/functions ftp.xml
it as SGML, or start discussion about modifying it to be XML. There were some reasons to put sgml here... I am not using vim, so I don't now what was exactly the reason. You need it for syntax highlight. I know that, but there were some discussion about xml and sgml syntax highlighting and as I can remember it turned out, that xml is bit buggy in vim, so, it stayed sgml. This is the same, why the emacs comment is still SGML. But I neither use emacs or vim, vi or vim600, so I don't have any personal problems... Goba
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
gobaTue Sep 4 10:49:38 2001 EDT
Modified files:
/phpdoc/en/functionsftp.xml
Log:
Closing bug 13124, and another one in ftp_quit
Index: phpdoc/en/functions/ftp.xml
diff -u phpdoc/en/functions/ftp.xml:1.19 phpdoc/en/functions/ftp.xml:1.20
--- phpdoc/en/functions/ftp.xml:1.19Sun Aug 19 07:42:10 2001
+++ phpdoc/en/functions/ftp.xml Tue Sep 4 10:49:38 2001
@@ -1,5 +1,5 @@
?xml encoding=iso-8859-1?
-!-- $Revision: 1.19 $ --
+!-- $Revision: 1.20 $ --
reference id=ref.ftp
titleFTP functions/title
titleabbrevFTP/titleabbrev
@@ -36,10 +36,10 @@
// check connection
if ((!$conn_id) || (!$login_result)) {
echo Ftp connection has failed!;
-echo Attempted to connect to $ftp_server for user $user;
+echo Attempted to connect to $ftp_server for user $ftp_user_name;
die;
} else {
-echo Connected to $ftp_server, for user $user;
+echo Connected to $ftp_server, for user $ftp_user_name;
}
// upload the file
@@ -557,7 +557,7 @@
/funcprototype
/funcsynopsis
para
- functionftp_connect/function closes parameterftp_stream/parameter.
+ functionftp_quit/function closes parameterftp_stream/parameter.
/para
/refsect1
/refentry
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
damsMon Jul 30 07:39:12 2001 EDT Modified files: /phpdoc/en/functionsftp.xml Log: Added link to configuration's chapter Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.16 phpdoc/en/functions/ftp.xml:1.17 --- phpdoc/en/functions/ftp.xml:1.16Tue Jul 17 12:03:35 2001 +++ phpdoc/en/functions/ftp.xml Mon Jul 30 07:39:12 2001 @@ -13,6 +13,13 @@ The following constants are defined when using the FTP module: constantFTP_ASCII/constant and constantFTP_BINARY/constant. /para + para + In order to use FTP functions with your PHP configuration, you should + add the link linkend=install.configure.enable-ftp + option--enable-ftp/option/link option when installing PHP 4, + and link linkend=install.configure.with-ftp + option--with-ftp/option/link when using PHP 3. + /para para example titlefunctionftp/function example/title
[PHP-DOC] cvs: phpdoc /en/functions ftp.xml
hholzgraWed May 2 12:16:26 2001 EDT Modified files: /phpdoc/en/functionsftp.xml Log: oops Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.12 phpdoc/en/functions/ftp.xml:1.13 --- phpdoc/en/functions/ftp.xml:1.12Wed May 2 12:16:02 2001 +++ phpdoc/en/functions/ftp.xml Wed May 2 12:16:24 2001 @@ -6,7 +6,7 @@ para The functions in this extension implement client access to file servers speaking the File Transfer Protocol FTP as defined in -spef.ftp;. +spec.ftp;. /para para
