mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
7b19b82b59
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@211482 c90b9560-bf6c-de11-be94-00142212c4b1
167 lines
4.1 KiB
XML
167 lines
4.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.12 $ -->
|
|
<refentry id="function.ftp-get">
|
|
<refnamediv>
|
|
<refname>ftp_get</refname>
|
|
<refpurpose>Downloads a file from the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_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_get</function> retrieves a remote file from the FTP server,
|
|
and saves it into a local file.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ftp_stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The link identifier of the FTP connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>local_file</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The local file path (will be overwritten if the file already exists).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>remote_file</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The remote file path.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The transfer mode. Must be either <constant>FTP_ASCII</constant> or
|
|
<constant>FTP_BINARY</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>resumepos</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The position in the remote file to start downloading from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_get</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// define some variables
|
|
$local_file = 'local.zip';
|
|
$server_file = 'server.zip';
|
|
|
|
// set up basic connection
|
|
$conn_id = ftp_connect($ftp_server);
|
|
|
|
// login with username and password
|
|
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
|
|
|
|
// try to download $server_file and save to $local_file
|
|
if (ftp_get($conn_id, $local_file, $server_file, FTP_BINARY)) {
|
|
echo "Successfully written to $local_file\n";
|
|
} else {
|
|
echo "There was a problem\n";
|
|
}
|
|
|
|
// close the connection
|
|
ftp_close($conn_id);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>4.3.0</entry>
|
|
<entry>
|
|
<parameter>resumepos</parameter> was added.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ftp_pasv</function></member>
|
|
<member><function>ftp_fget</function></member>
|
|
<member><function>ftp_nb_get</function></member>
|
|
<member><function>ftp_nb_fget</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|