cvs: /phpdoc/functions ftp.sgml

askalski Mon Sep 27 10:03:06 1999 EDT Modified files: /phpdoc/functions ftp.sgml Log: Added docs for ftp_pasv, ftp_size, ftp_mdtm, ftp_fget, and ftp_fput. Index: phpdoc/functions/ftp.sgml diff -u phpdoc/functions/ftp.sgml:1.6 phpdoc/functions/ftp.sgml:1.7 --- phpdoc/functions/ftp.sgml:1.6 Wed Sep 22 12:07:13 1999 +++ phpdoc/functions/ftp.sgml Mon Sep 27 10:03:06 1999 @@ -207,6 +207,29 @@ </refsect1> </refentry> + <refentry id="function.ftp-pasv"> + <refnamediv> + <refname>ftp_pasv</refname> + <refpurpose>Turns passive mode on or off.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>ftp_pasv</function></funcdef> + <paramdef>int <parameter>ftp_stream</parameter></paramdef> + <paramdef>int <parameter>pasv</parameter></paramdef> + </funcsynopsis> + <para> + Returns true on success, false on error. + <para> + <function>ftp_pasv</function> turns on passive mode if the + <parameter>pasv</parameter> parameter is true (it turns off + passive mode if <parameter>pasv</parameter> is false.) In + passive mode, data connections are initiated by the client, + rather than by the server. + </refsect1> + </refentry> + <refentry id="function.ftp-get"> <refnamediv> <refname>ftp_get</refname> @@ -231,6 +254,31 @@ </refsect1> </refentry> + <refentry id="function.ftp-fget"> + <refnamediv> + <refname>ftp_fget</refname> + <refpurpose>Downloads a file from the FTP server and saves to an + open file.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>ftp_fget</function></funcdef> + <paramdef>int <parameter>ftp_stream</parameter></paramdef> + <paramdef>int <parameter>fp</parameter></paramdef> + <paramdef>string <parameter>remote_file</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcsynopsis> + <para> + Returns true on success, false on error. + <para> + <function>ftp_fget</function> retrieves <parameter>remote_file</parameter> + from the FTP server, and writes it to the given file pointer, + <parameter>fp</parameter>. The transfer <parameter>mode</parameter> + specified must be either FTP_ASCII or FTP_BINARY. + </refsect1> + </refentry> + <refentry id="function.ftp-put"> <refnamediv> <refname>ftp_put</refname> @@ -252,6 +300,74 @@ on the FTP server, as <parameter>remote_file</parameter>. The transfer <parameter>mode</parameter> specified must be either FTP_ASCII or FTP_BINARY. + </refsect1> + </refentry> + + <refentry id="function.ftp-fput"> + <refnamediv> + <refname>ftp_fput</refname> + <refpurpose>Uploads from an open file to the FTP server.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>ftp_fput</function></funcdef> + <paramdef>int <parameter>ftp_stream</parameter></paramdef> + <paramdef>string <parameter>remote_file</parameter></paramdef> + <paramdef>int <parameter>fp</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcsynopsis> + <para> + Returns true on success, false on error. + <para> + <function>ftp_fput</function> uploads the data from the file pointer + <parameter>fp</parameter> until end of file. The results are stored + in <parameter>remote_file</parameter> on the FTP server. The transfer + <parameter>mode</parameter> specified must be either FTP_ASCII or + FTP_BINARY. + </refsect1> + </refentry> + + <refentry id="function.ftp-size"> + <refnamediv> + <refname>ftp_size</refname> + <refpurpose>Returns the size of the given file.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>ftp_size</function></funcdef> + <paramdef>int <parameter>ftp_stream</parameter></paramdef> + <paramdef>string <parameter>remote_file</parameter></paramdef> + </funcsynopsis> + <para> + Returns the file size on success, or -1 on error. + <para> + <function>ftp_size</function> returns the size of a file. If an + error occurs, of if the file does not exist, -1 is returned. Not + all servers support this feature. + </refsect1> + </refentry> + + <refentry id="function.ftp-mdtm"> + <refnamediv> + <refname>ftp_mdtm</refname> + <refpurpose>Returns the last modified time of the given file.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>int <function>ftp_mdtm</function></funcdef> + <paramdef>int <parameter>ftp_stream</parameter></paramdef> + <paramdef>string <parameter>remote_file</parameter></paramdef> + </funcsynopsis> + <para> + Returns a UNIX timestamp on success, or -1 on error. + <para> + <function>ftp_mdtm</function> checks the last-modified time for a + file, and returns it as a UNIX timestamp. If an error occurs, or + the file does not exist, -1 is returned. Note that not all servers + support this feature. </refsect1> </refentry>