Source of: /manual/en/function.ftp-get.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ftp.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ftp-get.php',
1 => 'ftp_get',
),
'up' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'prev' =>
array (
0 => 'function.ftp-get-option.php',
1 => 'ftp_get_option',
),
'next' =>
array (
0 => 'function.ftp-login.php',
1 => 'ftp_login',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ftp-get" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_get</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_get</span> — <span class="dc-title">Downloads a file from the FTP server</span></p>
</div>
<a name="function.ftp-get.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ftp_get</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$ftp_stream</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$local_file</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$remote_file</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$resumepos</tt><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<b>ftp_get()</b> retrieves a remote file from the FTP server,
and saves it into a local file.
</p>
</div>
<a name="function.ftp-get.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">ftp_stream</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">local_file</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The local file path (will be overwritten if the file already exists).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">remote_file</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The remote file path.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The transfer mode. Must be either <b><tt class="constant">FTP_ASCII</tt></b> or
<b><tt class="constant">FTP_BINARY</tt></b>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">resumepos</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The position in the remote file to start downloading from.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftp-get.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.ftp-get.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ftp_get()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// define some variables<br /></span><span style="color: #0000BB">$local_file </span><span style="color: #007700">= </span><span style="color: #DD0000">'local.zip'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$server_file </span><span style="color: #007700">= </span><span style="color: #DD0000">'server.zip'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// set up basic connection<br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// login with username and password<br /></span><span style="color: #0000BB">$login_result </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_pass</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// try to download $server_file and save to $local_file<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ftp_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$local_file</span><span style="color: #007700">, </span><span style="color: #0000BB">$server_file</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Successfully written to </span><span style="color: #0000BB">$local_file</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"There was a problem\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// close the connection<br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.ftp-get.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">4.3.0</td>
<td align="left">
<i><tt class="parameter">resumepos</tt></i>
was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.ftp-get.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ftp-pasv.php" class="function" rel="rdfs-seeAlso">ftp_pasv()</a> - Turns passive mode on or off</li>
<li class="member"><a href="function.ftp-fget.php" class="function" rel="rdfs-seeAlso">ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</li>
<li class="member"><a href="function.ftp-nb-get.php" class="function" rel="rdfs-seeAlso">ftp_nb_get()</a> - Retrieves a file from the FTP server and writes it to a local file (non-blocking)</li>
<li class="member"><a href="function.ftp-nb-fget.php" class="function" rel="rdfs-seeAlso">ftp_nb_fget()</a> - Retrieves a file from the FTP server and writes it to an open file (non-blocking)</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
