<!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>Stores a file on the FTP server (non-blocking)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-get.html">ftp_nb_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nlist.html">ftp_nlist</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-nb-put" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_nb_put</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">ftp_nb_put</span> — <span class="dc-title">Stores a file on the FTP server (non-blocking)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-nb-put-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ftp_nb_put</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">$remote_file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_file</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = <strong><code>FTP_IMAGE</code></strong></span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$startpos</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_nb_put()</strong></span> stores a local file on the FTP server.
</p>
<p class="para">
The difference between this function and the <span class="function"><a href="function.ftp-put.html" class="function">ftp_put()</a></span>
is that this function uploads the file asynchronously, so your program can
perform other operations while the file is being uploaded.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-nb-put-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">ftp_stream</code></dt>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt>
<code class="parameter">remote_file</code></dt>
<dd>
<p class="para">
The remote file path.
</p>
</dd>
<dt>
<code class="parameter">local_file</code></dt>
<dd>
<p class="para">
The local file path.
</p>
</dd>
<dt>
<code class="parameter">mode</code></dt>
<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>
<code class="parameter">startpos</code></dt>
<dd>
<p class="para">The position in the remote file to start uploading to.</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-nb-put-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>FTP_FAILED</code></strong> or <strong><code>FTP_FINISHED</code></strong>
or <strong><code>FTP_MOREDATA</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.ftp-nb-put-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.3.0</td>
<td>
The <code class="parameter">mode</code> parameter is now optional. Formerly it
has been mandatory.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-nb-put-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5457">
<p><strong>Example #1 <span class="function"><strong>ftp_nb_put()</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">// Initiate the Upload<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_put</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #DD0000">"test.remote"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test.local"</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /> <br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue uploading...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error uploading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-5458">
<p><strong>Example #2 Resuming an upload with <span class="function"><strong>ftp_nb_put()</strong></span></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">// Initiate<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_put</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #DD0000">"test.remote"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test.local"</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">, </span><span style="color: #0000BB">ftp_size</span><span style="color: #007700">(</span><span style="color: #DD0000">"test.remote"</span><span style="color: #007700">));<br /></span><span style="color: #FF8000">// OR: $ret = ftp_nb_put($my_connection, "test.remote", "test.local", <br />// FTP_BINARY, FTP_AUTORESUME);<br /><br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /> <br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue uploading...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error uploading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-nb-put-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.ftp-nb-fput.html" class="function" rel="rdfs-seeAlso">ftp_nb_fput()</a> - Stores a file from an open file to the FTP server (non-blocking)</span></li>
<li class="member"><span class="function"><a href="function.ftp-nb-continue.html" class="function" rel="rdfs-seeAlso">ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</span></li>
<li class="member"><span class="function"><a href="function.ftp-put.html" class="function" rel="rdfs-seeAlso">ftp_put()</a> - Uploads a file to the FTP server</span></li>
<li class="member"><span class="function"><a href="function.ftp-fput.html" class="function" rel="rdfs-seeAlso">ftp_fput()</a> - Uploads from an open file to the FTP server</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-nb-get.html">ftp_nb_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nlist.html">ftp_nlist</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>
