mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Adding new functions. They will come in 4.3.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99712 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gabor Hojtsy
parent
3a62a534a6
commit
a4c45591da
5 changed files with 396 additions and 0 deletions
43
reference/ftp/functions/ftp-nb-continue.xml
Normal file
43
reference/ftp/functions/ftp-nb-continue.xml
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.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>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
56
reference/ftp/functions/ftp-nb-fget.xml
Normal file
56
reference/ftp/functions/ftp-nb-fget.xml
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.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>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
58
reference/ftp/functions/ftp-nb-fput.xml
Normal file
58
reference/ftp/functions/ftp-nb-fput.xml
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.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>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
134
reference/ftp/functions/ftp-nb-get.xml
Normal file
134
reference/ftp/functions/ftp-nb-get.xml
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.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>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
105
reference/ftp/functions/ftp-nb-put.xml
Normal file
105
reference/ftp/functions/ftp-nb-put.xml
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.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>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
Loading…
Reference in a new issue