<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Downloads a file from the FTP server</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ftp-get-option.html">ftp_get_option</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ftp-login.html">ftp_login</a></div> <div class="up"><a href="ref.ftp.html">FTP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><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> <div class="refsect1 description" id="refsect1-function.ftp-get-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ftp_get</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_file</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$remote_file</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$resumepos</code><span class="initializer"> = 0</span></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><strong>ftp_get()</strong></span> retrieves a remote file from the FTP server, and saves it into a local file. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ftp-get-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">ftp_stream</code></em></span> <dd> <p class="para"> The link identifier of the FTP connection. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">local_file</code></em></span> <dd> <p class="para"> The local file path (will be overwritten if the file already exists). </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">remote_file</code></em></span> <dd> <p class="para"> The remote file path. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">mode</code></em></span> <dd> <p class="para"> The transfer mode. Must be either <strong><code>FTP_ASCII</code></strong> or <strong><code>FTP_BINARY</code></strong>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">resumepos</code></em></span> <dd> <p class="para"> The position in the remote file to start downloading from. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ftp-get-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.ftp-get-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4285"> <p><strong>Example #1 <span class="function"><strong>ftp_get()</strong></span> example</strong></p> <div class="example-contents"> <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> </div> <div class="refsect1 changelog" id="refsect1-function.ftp-get-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>4.3.0</td> <td> <em><code class="parameter">resumepos</code></em> was added. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ftp-get-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.ftp-pasv.html" class="function" rel="rdfs-seeAlso">ftp_pasv()</a> - Turns passive mode on or off</span></li> <li class="member"> <span class="function"><a href="function.ftp-fget.html" class="function" rel="rdfs-seeAlso">ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</span></li> <li class="member"> <span class="function"><a href="function.ftp-nb-get.html" 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)</span></li> <li class="member"> <span class="function"><a href="function.ftp-nb-fget.html" 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)</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ftp-get-option.html">ftp_get_option</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ftp-login.html">ftp_login</a></div> <div class="up"><a href="ref.ftp.html">FTP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>