cvs: phpdoc /en/reference/ftp/functions ftp-nb-continue.xml ftp-nb-fget.xml ftp-nb-fput.xml ftp-nb-get.xml ftp-nb-put.xml

From:	Gabor Hojtsy	Date:	Mon, 14 Oct 2002 16:18:32 +0000
Subject:	cvs: phpdoc /en/reference/ftp/functions ftp-nb-continue.xml ftp-nb-fget.xml ftp-nb-fput.xml ftp-nb-get.xml ftp-nb-put.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969349140@lists.php.net to get a copy of this message

goba Mon Oct 14 12:18:32 2002 EDT Added files: /phpdoc/en/reference/ftp/functions ftp-nb-continue.xml ftp-nb-get.xml ftp-nb-fget.xml ftp-nb-put.xml ftp-nb-fput.xml Log: Adding new functions. They will come in 4.3.0

Index: phpdoc/en/reference/ftp/functions/ftp-nb-continue.xml +++ phpdoc/en/reference/ftp/functions/ftp-nb-continue.xml <?xml version="1.0" encoding="iso-8859-1"?>  <refentry id="function.ftp-nb-continue"> <refnamediv> <refname>ftp_nb_continue</refname> <refpurpose>Continues retrieving/sending a file nbronly</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>ftp_nb_continue</methodname> <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> </methodsynopsis> <para> Continues retrieving/sending a file nbronously </para> <para> Returns <constant>FTP_FAILED</constant> or <constant>FTP_FINISHED</constant> or <constant>FTP_MOREDATA</constant>. </para> </refsect1> </refentry>  Index: phpdoc/en/reference/ftp/functions/ftp-nb-get.xml +++ phpdoc/en/reference/ftp/functions/ftp-nb-get.xml <?xml version="1.0" encoding="iso-8859-1"?>  <refentry id="function.ftp-nb-get"> <refnamediv> <refname>ftp_nb_get</refname> <refpurpose>Retrieves a file from the FTP server nbronly and writes it to a local file</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>ftp_nb_get</methodname> <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>local_file</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>resumepos</parameter></methodparam> </methodsynopsis> <para> <function>ftp_nb_get</function> retrieves <parameter>remote_file</parameter> from the FTP server, and saves it to <parameter>local_file</parameter> locally. The transfer <parameter>mode</parameter> specified must be either <constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>. The difference between this function and the <function>ftp_get</function> is that this function retrieves the file asynchronously, so your program can perform other operations while the file is being downloaded. </para> <para> Returns &true; on success or &false; on error. </para> <para> <example> <title><function>ftp_nb_get</function> example</title> <programlisting role="php"> <![CDATA[ // Initate the download $ret = ftp_nb_get($my_connection, "test", "README", FTP_BINARY); while ($ret == FTP_MOREDATA) { // Do whatever you want echo "."; // Continue downloading... $ret = ftp_nb_continue ($my_connection); } if ($ret != FTP_FINISHED) { echo "There was an error downloading the file..."; exit(1); } ]]> </programlisting> </example> <example> <title>Resuming a download with <function>ftp_nb_get</function></title> <programlisting role="php"> <![CDATA[ // Initate $ret = ftp_nb_get ($my_connection, "test", "README", FTP_BINARY, filesize("test")); // OR: $ret = ftp_nb_get ($my_connection, "test", "README", // FTP_BINARY, FTP_AUTORESUME); while ($ret == FTP_MOREDATA) { // Do whatever you want echo "."; // Continue downloading... $ret = ftp_nb_continue ($my_connection); } if ($ret != FTP_FINISHED) { echo "There was an error downloading the file..."; exit(1); } ]]> </programlisting> </example> <example> <title> Resuming a download at position 100 to a new file with <function>ftp_nb_get</function> </title> <programlisting role="php"> <![CDATA[ // Disable Autoseek ftp_set_option ($my_connection, FTP_AUTOSEEK, FALSE); // Initiate $ret = ftp_nb_get ($my_connection, "newfile", "README", FTP_BINARY, 100); while ($ret == FTP_MOREDATA) { ... // Continue downloading... $ret = ftp_nb_continue ($my_connection); } ]]> </programlisting> </example> </para> <para> In the example above, <filename>"newfile"</filename> is 100 bytes smaller than <filename>"README"</filename> on the FTP server because we started reading at offset 100. If we have not have disabled <constant>FTP_AUTOSEEK</constant>, the first 100 bytes of newfile will be <literal>'\0'</literal>. </para> <para> See also <function>ftp_nb_fget</function>, <function>ftp_nb_continue</function>, <function>ftp_get</function> and <function>ftp_fget</function>. </para> </refsect1> </refentry>  Index: phpdoc/en/reference/ftp/functions/ftp-nb-fget.xml +++ phpdoc/en/reference/ftp/functions/ftp-nb-fget.xml <?xml version="1.0" encoding="iso-8859-1"?>  <refentry id="function.ftp-nb-fget"> <refnamediv> <refname>ftp_nb_fget</refname> <refpurpose>Retrieves a file from the FTP server nbronly and writes it to an open file</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>ftp_nb_fget</methodname> <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>resource</type><parameter>fp</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>resumepos</parameter></methodparam> </methodsynopsis> <para> <function>ftp_nb_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 <constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>. The difference between this function and the <function>ftp_fget</function> is that this function retrieves the file asynchronously, so your program can perform other operations while the file is being downloaded. </para> <para> Returns &true; on success or &false; on error. </para> <para> See also <function>ftp_nb_get</function>. </para> </refsect1> </refentry>  Index: phpdoc/en/reference/ftp/functions/ftp-nb-put.xml +++ phpdoc/en/reference/ftp/functions/ftp-nb-put.xml <?xml version="1.0" encoding="iso-8859-1"?>  <refentry id="function.ftp-nb-put"> <refnamediv> <refname>ftp_nb_put</refname> <refpurpose>Stores a file on the FTP server nbronly</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>ftp_nb_put</methodname> <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>string</type><parameter>local_file</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>startpos</parameter></methodparam> </methodsynopsis> <para> <function>ftp_nb_put</function> stores <parameter>local_file</parameter> on the FTP server, as <parameter>remote_file</parameter>. The transfer <parameter>mode</parameter> specified must be either <constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>. The difference between this function and the <function>ftp_put</function> is that this function uploads the file asynchronously, so your program can perform other operations while the file is being downloaded. </para> <para> Returns &true; on success or &false; on error. </para> <para> <example> <title><function>ftp_nb_put</function> example</title> <programlisting role="php"> <![CDATA[ // Initiate the Upload $ret = ftp_nb_put($my_connection, "test.remote", "test.local", FTP_BINARY); while ($ret == FTP_MOREDATA) { // Do whatever you want echo "."; // Continue uploading... $ret = ftp_nb_continue ($my_connection); } if ($ret != FTP_FINISHED) { echo "There was an error uploading the file..."; exit(1); } ]]> </programlisting> </example> <example> <title>Resuming an upload with <function>ftp_nb_put</function></title> <programlisting role="php"> <![CDATA[ // Initiate $ret = ftp_nb_put ($my_connection, "test.remote", "test.local", FTP_BINARY, ftp_size("test.remote")); // OR: $ret = ftp_nb_put ($my_connection, "test.remote", "test.local", // FTP_BINARY, FTP_AUTORESUME); while ($ret == FTP_MOREDATA) { // Do whatever you want echo "."; // Continue uploading... $ret = ftp_nb_continue ($my_connection); } if ($ret != FTP_FINISHED) { echo "There was an error uploading the file..."; exit(1); } ]]> </programlisting> </example> </para> <para> See also <function>ftp_nb_fput</function>, <function>ftp_nb_continue</function>, <function>ftp_put</function> and <function>ftp_fput</function>. </para> </refsect1> </refentry>  Index: phpdoc/en/reference/ftp/functions/ftp-nb-fput.xml +++ phpdoc/en/reference/ftp/functions/ftp-nb-fput.xml <?xml version="1.0" encoding="iso-8859-1"?>  <refentry id="function.ftp-nb-fput"> <refnamediv> <refname>ftp_nb_fput</refname> <refpurpose>Stores a file from an open file to the FTP server nbronly</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>ftp_nb_fput</methodname> <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>resource</type><parameter>fp</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>startpos</parameter></methodparam> </methodsynopsis> <para> <function>ftp_nb_fput</function> uploads the data from the file pointer <parameter>fp</parameter> until it reaches the end of the file. The results are stored in <parameter>remote_file</parameter> on the FTP server. The transfer <parameter>mode</parameter> specified must be either <constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>. The difference between this function and the <function>ftp_fput</function> is that this function uploads the file asynchronously, so your program can perform other operations while the file is being downloaded. </para> <para> Returns &true; on success or &false; on error. </para> <para> See also <function>ftp_nb_put</function>, <function>ftp_nb_continue</function>, <function>ftp_put</function> and <function>ftp_fput</function>. </para> </refsect1> </refentry>